deploy.cloudrun.rollout-canary ​
Roll out a Cloud Run revision through staged traffic percentages with rollback support.
Roll out a Cloud Run revision through staged traffic percentages.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-deployments |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID. |
deployment_target_uuid | uuid | Yes | — | Target UUID. |
release_uuid | uuid | Yes | — | DeploymentRelease UUID. |
rollout_uuid | uuid | No | — | DeploymentRollout UUID when already created. |
service_name | string | Yes | — | Logical service name. |
image_reference | string | Yes | — | Image reference to deploy. |
runtime_overrides | json | No | — | Config overrides. |
secrets | list | No | — | Runtime secret requirements. |
stable_revision | string | No | — | Revision currently serving stable traffic. |
stages | list | Yes | — | Canary stages with percent and optional gates. |
health_checks | list | No | — | Checks to evaluate after each stage. |
auto_rollback | boolean | No | — | Roll back on failed stage when true. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Echoed organization UUID. |
deployment_target_uuid | uuid | No | — | Target UUID. |
release_uuid | uuid | No | — | Release UUID. |
rollout_uuid | uuid | No | — | Rollout UUID. |
connection_uuid | uuid | No | — | GCP connection UUID. |
project_id | string | No | — | Effective project. |
region | string | No | — | Cloud Run region. |
service_name | string | No | — | Cloud Run service name. |
service_url | string | No | — | Cloud Run service URL. |
candidate_revision | string | No | — | Revision under canary. |
stable_revision | string | No | — | Previous stable revision. |
current_stage_index | integer | No | — | Current canary stage. |
current_percent | integer | No | — | Current candidate traffic percent. |
traffic | json | No | — | Final traffic split. |
stage_results | list | No | — | Applied stage results. |
rollback_result | json | No | — | Rollback output when auto-rollback runs. |
status | string | No | — | Rollout status. |
failure_reason | string | No | — | Failure reason. |
failed_step | json | No | — | Failed step envelope. |
failed_layer | json | No | — | Failed layer envelope. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | rollout | — |
rolling_out | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | rollout | rolling_out | — |
rolling_out | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "deploy.cloudrun.rollout-canary",
"initial_data": {
"organization_uuid": "value",
"deployment_target_uuid": "value",
"release_uuid": "value",
"service_name": "value"
}
}