package proto

Get desktop application:
View/edit binary Protocol Buffers messages

WorkflowService exposes various capabilities when it comes to starting and monitoring a workflow

• rpc GetWorkflowContexts (WorkflowContextRequest, stream WorkflowContext)

  workflow.proto:18

  message WorkflowContextRequest

  workflow.proto:25

  • string worker_id = 1

  message WorkflowContext

  workflow.proto:66

  WorkflowContext represents the state of the execution of this workflow in detail. How many tasks are currently executed, the number of actions and their state.

  • string workflow_id = 1

    The workflow ID

  • string current_worker = 2

  • string current_task = 3

  • string current_action = 4

    the name of the current action

  • int64 current_action_index = 5

    The index of the current action

  • State current_action_state = 6

    The state of the current action

  • int64 total_number_of_actions = 7

• rpc GetWorkflowActions (WorkflowActionsRequest, WorkflowActionList)

  workflow.proto:19

  message WorkflowActionsRequest

  workflow.proto:94

  WorkflowActionsRequest is used to get actions for a particular workflow

  • string workflow_id = 1

  message WorkflowActionList

  workflow.proto:101

  A list of actions

  • repeated WorkflowAction action_list = 1

• rpc ReportActionStatus (WorkflowActionStatus, Empty)

  workflow.proto:20

  message WorkflowActionStatus

  workflow.proto:160

  WorkflowActionStatus represents the state of all the action part of a workflow

  • string workflow_id = 1

    The workflow id

  • string task_name = 2

    The name of the task this action is part of

  • string action_name = 3

    The name of the action

  • State action_status = 4

    The state of the action. Those are the same described for workflow as well. pending, running, successful and so on.

  • int64 seconds = 5

    The execution time for the action

  • string message = 6

    The message returned from the action.

  • optional google.protobuf.Timestamp created_at = 7

    When the status got created for this aciton. You can see it as the time when the action started its execution inside the hardware itself.

  • string worker_id = 8

  message Empty

  workflow.proto:23

  (message has no fields)

The various state a workflow can be

Used in: WorkflowActionStatus, WorkflowContext

• STATE_PENDING = 0

  A workflow is in pending state when it is waiting for the hardware to pick it up and start the execution.

• STATE_RUNNING = 1

  A workflow is in a running state when the tink-worker started the exeuction of it, and it is currently in execution inside the device itself.

• STATE_FAILED = 2

  Failed is a final state. Something wrong happened during the execution of the workflow inside the target. Have a look at the logs to see if you can spot what is going on.

• STATE_TIMEOUT = 3

  Timeout is final state, almost like FAILED but it communicate to you that an action or the overall workflow reached the specified timeout.

• STATE_SUCCESS = 4

  This is the state we all deserve. The execution of the workflow is over and everything is just fine. Sit down, and enjoy your great work.

WorkflowAction represents a single aciton part of a workflow

Used in: WorkflowActionList

• string task_name = 1

  The name of the task the action belong to.

• string name = 2

  The name of the action

• string image = 3

  The docker/oci image the action starts from

• int64 timeout = 4

  Every action has a timeout, after that the execution stops and the action gets in a timeout state.

• repeated string command = 5

  You can override the command executed for the container

• repeated string on_timeout = 6

  On timeout used to be a way to execute an action if the current one times out but with the event system in place this is not needed anymore

• repeated string on_failure = 7

  On failure used to be a way to execute an action if the current one fails but with the event system in place this is not needed anymore

• string worker_id = 8

• repeated string volumes = 9

  You can mount directory from your host to the running action, mainly to share files, or state

• repeated string environment = 10

  Set environment variables usable from the action itself.

• string pid = 11

  Set the namespace that the process IDs will be in.