Appearance
runner.update_gcp_environment ​
Update GCP runner environment metadata
Refresh GCP runner metadata after config change.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-runners-gcp |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this GCP/GCE step 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. |
workflow_run_id | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this GCP/GCE step 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. |
workflow_run_id | string | No | — | — |
backend_type | string | No | — | — |
cloud_connection_uuid | uuid | No | — | UUID of the CloudConnection backing this runner group's GCE backend, picked from the organization's connections. |
region | string | No | — | — |
project_id | string | No | — | — |
zone | string | No | — | — |
machine_type | string | No | — | — |
mig_name | string | No | — | — |
gce_mig_name | string | No | — | — |
status | string | No | — | — |
vpc_network | string | No | — | — |
subnetwork | string | No | — | — |
service_account_email | string | No | — | — |
instance_template_name | string | No | — | — |
instance_template_self_link | string | No | — | — |
initiated_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
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 | — | run | — |
run | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | run | run | — |
run | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.update_gcp_environment",
"initial_data": {
"runner_group_uuid": "value",
"organization_uuid": "value",
"workflow_run_id": "value"
}
}