Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeLinear
LibraryApp-deployments
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID.
deployment_target_uuiduuidYes—Target UUID.
release_uuiduuidYes—DeploymentRelease UUID.
rollout_uuiduuidNo—DeploymentRollout UUID when already created.
service_namestringYes—Logical service name.
image_referencestringYes—Image reference to deploy.
runtime_overridesjsonNo—Config overrides.
secretslistNo—Runtime secret requirements.
stable_revisionstringNo—Revision currently serving stable traffic.
stageslistYes—Canary stages with percent and optional gates.
health_checkslistNo—Checks to evaluate after each stage.
auto_rollbackbooleanNo—Roll back on failed stage when true.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Echoed organization UUID.
deployment_target_uuiduuidNo—Target UUID.
release_uuiduuidNo—Release UUID.
rollout_uuiduuidNo—Rollout UUID.
connection_uuiduuidNo—GCP connection UUID.
project_idstringNo—Effective project.
regionstringNo—Cloud Run region.
service_namestringNo—Cloud Run service name.
service_urlstringNo—Cloud Run service URL.
candidate_revisionstringNo—Revision under canary.
stable_revisionstringNo—Previous stable revision.
current_stage_indexintegerNo—Current canary stage.
current_percentintegerNo—Current candidate traffic percent.
trafficjsonNo—Final traffic split.
stage_resultslistNo—Applied stage results.
rollback_resultjsonNo—Rollback output when auto-rollback runs.
statusstringNo—Rollout status.
failure_reasonstringNo—Failure reason.
failed_stepjsonNo—Failed step envelope.
failed_layerjsonNo—Failed layer envelope.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—rollout—
rolling_outNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingrolloutrolling_out—
rolling_outcompletecompleted—
* (any state)failfailed—

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"
  }
}