runner.environment-update-gcp ​
Update GCP/GCE environment for a runner group
Update GCP/GCE runner environment metadata for a runner group.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-runners-gcp |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | Yes | — | UUID of the RunnerGroup this action operates on, picked from the organization's list of runner groups. |
organization_uuid | uuid | No | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | Yes | — | Runner group whose GCE environment was refreshed |
organization_uuid | uuid | No | — | Organization that owns the runner group |
cloud_connection_uuid | uuid | No | — | Cloud connection used to talk to GCP |
gce_mig_name | string | No | — | Managed Instance Group backing the runner group |
project_id | string | No | — | GCP project ID the runner group lives in |
zone | string | No | — | GCE zone for the runner group |
failure_reason | string | No | — | Populated only when the workflow ends in FAILED |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | prepare | — |
preparing | No | No | — | update_gcp_environment | — |
updating | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | prepare | preparing | — |
preparing | update_gcp_environment | updating | — |
updating | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.environment-update-gcp",
"initial_data": {
"runner_group_uuid": "value"
}
}