package com.github.trace_machina.nativelink.remote_execution

Get desktop application:
View/edit binary Protocol Buffers messages

/ This API describes how schedulers communicate with Worker nodes. / / When a worker node comes online it must be pre-configured with the / endpoint of the scheduler it will register with. Once the worker / connects to the scheduler it must send a `ConnectWorkerRequest` / command to the scheduler. The scheduler will then use this information / to determine which jobs the worker can process.

• rpc ConnectWorker (stream UpdateForScheduler, stream UpdateForWorker)

  worker_api.proto:41

  / Registers this worker and informs the scheduler what properties / this worker supports. The response must be listened on the client / side for updates from the server. This is performed as a single / bi-directional call to ensure that the worker is always talking to the / same scheduler instance even if there's a load balancer in front. / The first message on the UpdateForScheduler stream will be a / ConnectWorkerRequest which will notify the scheduler of the available / properties and the first response will be a ConnectionResult to tell / the worker what worker ID to place in action results.

  message UpdateForScheduler

  worker_api.proto:174

  / Communication from the worker to the scheduler.

  • oneof update

    • ConnectWorkerRequest connect_worker_request = 1

      / The initial request sent to the scheduler informing it of the / supported properties of this worker.

    • KeepAliveRequest keep_alive_request = 2

      / Message used to let the scheduler know that it is still alive as / well as check to see if the scheduler is still alive. The scheduler / may close the connection if the worker has not sent any messages / after some amount of time (configured in the scheduler's / configuration).

    • GoingAwayRequest going_away_request = 3

      / Informs the scheduler that the service is going offline and / should stop issuing any new actions on this worker. / / The worker may stay connected even after sending this command / and may even send an `ExecuteResult` after sending this command. / It is up to the scheduler implementation to decide how to handle / this case. / / Any job that was running on this instance likely needs to be / executed again, but up to the scheduler on how or when to handle / this case.

    • ExecuteResult execute_result = 4

      / Informs the scheduler about the result of an execution request.

    • ExecuteComplete execute_complete = 5

      / Notify that the execution has completed, but result is uploading.

  message UpdateForWorker

  worker_api.proto:146

  / Communication from the scheduler to the worker.

  • oneof update

    • ConnectionResult connection_result = 1

      / This will be sent only as the first item in the stream after the node / has connected.

    • google.protobuf.Empty keep_alive = 2

      / Message used to let the worker know that it is still alive as well / as check to see if the worker is still alive. The worker / may close the connection if the scheduler has not sent any messages / after some amount of time (configured in the scheduler's / configuration).

    • StartExecute start_action = 3

      / Informs the worker about some work it should begin performing the / requested action.

    • google.protobuf.Empty disconnect = 4

      / Informs the worker that it has been disconnected from the pool. / The worker may discard any outstanding work that is being executed.

    • KillOperationRequest kill_operation_request = 5

      / Instructs the worker to kill a specific running operation.

/ Resource usage observed by the worker while running one action.

Used in: events.ResponseEvent, ExecuteResult

• uint64 peak_memory_kb = 1

  / Peak resident memory observed for the action process tree.

• bool sampled = 2

  / Whether this value came from worker-side sampling.

• string operation_id = 3

  / The operation ID that was sampled.

• string worker_id = 4

  / The worker ID that observed the resource usage.

/ Represents the initial request sent to the scheduler informing the / scheduler about this worker's capabilities and metadata.

Used in: UpdateForScheduler

• repeated build.bazel.remote.execution.v2.Platform.Property properties = 1

  / The list of properties this worker can support. The exact / implementation is driven by the configuration matrix between the / worker and scheduler. / / The scheduler may reject this worker if any property keys that / the scheduler is not configured to support, or may simply ignore / the unsupported properties. / / The details on how to use this property can be found here: / https://github.com/TraceMachina/nativelink/blob/3147265047544572e3483c985e4aab0f9fdded38/nativelink-config/src/cas_server.rs

• string worker_id_prefix = 2

  / Prefix to use for worker IDs. This is primarily used for debugging / or for other systems to identify workers. The scheduler will always / append this prefix to the assigned worker_id followed by a UUIDv6.

• uint64 max_inflight_tasks = 3

  / Maximum number of inflight tasks this worker can cope with at one time / The default (0) means unlimited.

/ Result sent back from the server when a node connects.

Used in: UpdateForWorker

• string worker_id = 1

  / The worker ID to place in the action results generated by this worker.

/ The result of an ExecutionComplete.

Used in: UpdateForScheduler

• string operation_id = 1

  / The operation ID that was executed.

/ The result of an ExecutionRequest.

Used in: UpdateForScheduler

• string instance_name = 1

  / The `instance_name` this task was initially assigned to. This is set by the client / that initially sent the job as part of the BRE protocol.

• string operation_id = 2

  / The operation ID that was executed.

• oneof result

  / The actual response data.

  • build.bazel.remote.execution.v2.ExecuteResponse execute_response = 3

    / Result of the execution. See `build.bazel.remote.execution.v2.ExecuteResponse` / for details.

  • google.rpc.Status internal_error = 4

    / An internal error. This is only present when an internal error happened that / was not recoverable. If the execution job failed but at no fault of the worker / it should not use this field and should send the error via execute_response.

• optional ActionResourceUsage resource_usage = 5

  / Worker-observed resource usage for this action execution.

/ Request object for going away requests.

Used in: UpdateForScheduler

(message has no fields)

/ This is a special message used to save actions into the CAS that can be used / by programs like bb_browswer to inspect the history of a build. / Note: Ensure this is always compatible with: / https://github.com/buildbarn/bb-remote-execution/blob/e95e066eb624dc9099682394ec18c12e218e8fc4/pkg/proto/cas/cas.proto#L23

• optional build.bazel.remote.execution.v2.Digest action_digest = 1

• optional build.bazel.remote.execution.v2.ExecuteResponse execute_response = 3

/ Request object for keep alive requests.

Used in: UpdateForScheduler

(message has no fields)

/ Request to kill a running operation sent from the scheduler to a worker.

Used in: UpdateForWorker

• string operation_id = 1

  / The the operation id for the operation to be killed.

Used in: events.RequestEvent, UpdateForWorker

• optional build.bazel.remote.execution.v2.ExecuteRequest execute_request = 1

  / The action information used to execute job.

• string operation_id = 4

  / Id of the operation.

• optional google.protobuf.Timestamp queued_timestamp = 3

  / The time at which the command was added to the queue to allow population / of the ActionResult.

• optional build.bazel.remote.execution.v2.Platform platform = 5

  / The post-computed platform properties that the scheduler has reserved for / the action.

• string worker_id = 6

  / The ID of the worker that is executing the action.