package machinist

Get desktop application:
View/edit binary Protocol Buffers messages

Controller is the service that workers will connect to to register themselves, and poll for actions to perform. Workers can be behind NAT or firewalls, or not have an IP address. The entire protocol is designed around workers connecting to an controller.

• rpc Download (DownloadRequest, stream DownloadResponse)

  machinist.proto:70

  The client will invoke Download when the server requests the client to upload a file.

  message DownloadRequest

  machinist.proto:50

  Client downloads a file from the server, as a result of a processing an ActionDownload.

  • string key = 1

  message DownloadResponse

  machinist.proto:53

  • bytes data = 1

• rpc Poll (stream PollRequest, stream PollResponse)

  machinist.proto:65

  Poll is the first request performed by the client. It is our main control channel. The client parses loops over the PollResponses, and performs the action requested.

  message PollRequest

  machinist.proto:7

  • oneof req

    • ClientRegister register = 1

      Sent only once, when the client first connects.

    • ClientPing ping = 2

      Sent periodicially, the server just replies with an ActionPong.

    • ClientResult result = 3

      Sent after completing an operation on behalf of the server.

  message PollResponse

  machinist.proto:18

  • oneof resp

    • ActionResult result = 1

      Response to a ClientRegister.

    • ActionPong pong = 2

      Response to a ClientPing.

    • ActionSession start = 3

      Starts an independent session.

    • ActionUpload upload = 4

      Send a file.

    • ActionDownload download = 5

      Receive a file.

• rpc Upload (stream UploadRequest, UploadResponse)

  machinist.proto:68

  The client will invoke Upload when the server requests the client to upload a file.

  message UploadRequest

  machinist.proto:38

  Client sends a file to the server, as a result of processing an ActionUpload.

  • string key = 1

    required in the first request only.

  • int32 total = 2

    optional. If it is provided, it is processed in the first request only.

  • bytes data = 3

  message UploadResponse

  machinist.proto:46

  (message has no fields)

Used in: PollResponse

(message has no fields)

Used in: PollResponse

• bytes payload = 1

(message has no fields)

Used in: PollResponse

• int32 status = 1

• string description = 2

Used in: PollResponse

(message has no fields)

Used in: PollResponse

(message has no fields)

Used in: PollRequest

• bytes payload = 1

Used in: PollRequest

• string token = 1

  Not implemented yet - TODO: at enrollment time, a certificate is issued. The token is generated from the certificate, the name and tags become obsolete.

• string name = 2

  Name of the machine.

• repeated string tag = 3

  Tags assigned to this machine.

• repeated string ips = 4

  IP Addresses to be allocated to the node

Used in: PollRequest

(message has no fields)