Skip to content
Proud to collaborate with Microsoft for Startups

runner.environment-update-gcp ​

Update GCP/GCE environment for a runner group

Update GCP/GCE runner environment metadata for a runner group.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—UUID of the RunnerGroup this action operates on, picked from the organization's list of runner groups.
organization_uuiduuidNo—UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant.

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—Runner group whose GCE environment was refreshed
organization_uuiduuidNo—Organization that owns the runner group
cloud_connection_uuiduuidNo—Cloud connection used to talk to GCP
gce_mig_namestringNo—Managed Instance Group backing the runner group
project_idstringNo—GCP project ID the runner group lives in
zonestringNo—GCE zone for the runner group
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—
preparingNoNo—update_gcp_environment—
updatingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedpreparepreparing—
preparingupdate_gcp_environmentupdating—
updatingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.environment-update-gcp",
  "initial_data": {
    "runner_group_uuid": "value"
  }
}