Skip to content
Proud to collaborate with Microsoft for Startups

deploy.cloudrun.rollout-immediate ​

Deploy a Cloud Run revision and move all traffic to it after readiness.

Overview ​

PropertyValue
Workflow typeDag
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.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Echoed organization UUID.
deployment_target_uuiduuidNo—Target UUID.
release_uuiduuidNo—Release UUID.
rollout_uuiduuidNo—Rollout UUID.
workflow_run_uuiduuidNo—DAG run UUID created by the engine.
image_referencestringNo—Image reference to deploy.
runtime_overridesjsonNo—Config overrides carried through DAG startup.
secretslistNo—Runtime secret requirements carried through DAG startup.
bind_configjsonNo—Intermediate bind-config step output.
bind_secretsjsonNo—Intermediate bind-secrets step output.
upsert_servicejsonNo—Intermediate Cloud Run service upsert output.
wait_readyjsonNo—Intermediate Cloud Run readiness output.
apply_invoker_policyjsonNo—Intermediate IAM policy step output.
shift_all_trafficjsonNo—Intermediate traffic shift output.
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.
revisionstringNo—Ready revision receiving 100 percent traffic.
trafficjsonNo—Final traffic split.
statusstringNo—Rollout status.
failure_reasonstringNo—Engine failure reason.
failed_stepjsonNo—Failed DAG step envelope.
failed_layerjsonNo—Failed DAG layer envelope.
failed_at_statestringNo—State where failure occurred.
compensation_triggerstringNo—DAG compensation trigger.
comp_queuelistNo—Remaining DAG compensation layer queue.
comp_current_layerintegerNo—Current DAG compensation layer index.
comp_retry_countintegerNo—DAG compensation retry count.
errorstringNo—Error message.
error_typestringNo—Error class.

DAG Layers ​

#LayerStepsCompensation
1bind_configdeploy.service.bind-config—
2bind_secretsdeploy.service.bind-secrets—
3deploy_revisiongcp.run.service.upsert—
4wait_revisiongcp.run.service.wait-ready—
5access_and_trafficgcp.run.service.set-iam-policy, gcp.run.service.update-traffic—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
deploy.service.bind-configbind_config
deploy.service.bind-secretsbind_secrets
gcp.run.service.upsertupsert_service
gcp.run.service.wait-readywait_ready
gcp.run.service.set-iam-policyapply_invoker_policy
gcp.run.service.update-trafficshift_all_traffic

API Usage ​

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

{
  "workflow_type": "deploy.cloudrun.rollout-immediate",
  "initial_data": {
    "organization_uuid": "value",
    "deployment_target_uuid": "value",
    "release_uuid": "value",
    "service_name": "value"
  }
}