Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-launch-gcp ​

Launch one runner execution on GCE

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—Runner group UUID
organization_uuiduuidNo—Organization UUID (derived from runner group if omitted)
runner_execution_uuiduuidNo—Existing execution UUID to reuse
commandjsonNo—Command to run: string or list of strings (generic mode)
environmentdictNo—Extra environment variables to inject (vaulted — persisted state_data holds a [VAULT:...] reference)
extra_labelsdictNo—Additional GCP labels to attach to the VM (lowercase keys enforced, e.g. agent-session-id)

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_execution_uuiduuidYes—RunnerExecution row this workflow drove
runner_group_uuiduuidNo—Runner group the execution belongs to
organization_uuiduuidNo—Organization that owns the runner group
commandjsonNo—Command to run (passed through from input)
environmentdictNo—Extra environment variables (passed through from input; vaulted)
extra_labelsdictNo—Additional GCP labels (passed through from input)
provider_execution_idstringNo—LTIP/GCE VM reference the execution landed on
zone_usedstringNo—GCE zone the VM was actually placed in (after fallback)
completed_atstringNo—ISO timestamp when launch finalised
failed_atstringNo—ISO timestamp when launch failed
failure_reasonstringNo—Populated only when the workflow ends in FAILED
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—prepare—
getting_registration_tokenNoNo—launch_execution—
launching_executionNoNo—complete—
preparingNoNo—get_registration_token—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedpreparepreparing—
preparingget_registration_tokengetting_registration_token—
getting_registration_tokenlaunch_executionlaunching_execution—
launching_executioncompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "runner.execution-launch-gcp",
  "initial_data": {
    "runner_group_uuid": "value"
  }
}