Appearance
deploy.release.start ​
Create a DeploymentRelease + DeploymentRollout for a target and dispatch the appropriate strategy workflow. Rejects with target_busy if another rollout is active.
Start a release against a DeploymentTarget by dispatching the right strategy.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-deployments |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
deployment_target_uuid | uuid | Yes | — | — |
image_tag | string | Yes | — | Container image tag to deploy. Substituted into target.image_template. |
strategy_override | string | No | — | Override target.default_strategy (immediate |
source_type | string | No | — | Where the release came from (manual |
source_ref | string | No | — | Git ref / release tag if known. Defaults to image_tag. |
commit_sha | string | No | — | — |
build_metadata | json | No | — | Free-form metadata stored on DeploymentRelease.build_metadata. |
runtime_overrides | json | No | — | Cloud Run runtime overrides forwarded to the strategy child. |
secrets | list | No | — | Cloud Run runtime secret requirements forwarded to the strategy child. |
canary_policy | json | No | — | Cloud Run canary stages, health checks, and rollback policy. |
stable_revision | string | No | — | Cloud Run stable revision used for canary traffic splits. |
auto_rollback | boolean | No | — | Override canary auto-rollback behavior. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
deployment_target_uuid | uuid | No | — | — |
image_tag | string | No | — | — |
strategy_override | string | No | — | — |
source_type | string | No | — | — |
source_ref | string | No | — | — |
commit_sha | string | No | — | — |
build_metadata | json | No | — | — |
runtime_overrides | json | No | — | — |
secrets | list | No | — | — |
canary_policy | json | No | — | — |
stable_revision | string | No | — | — |
auto_rollback | boolean | No | — | — |
release_uuid | uuid | No | — | — |
rollout_uuid | uuid | No | — | — |
strategy | string | No | — | — |
strategy_workflow_type | string | No | — | — |
child_workflow_uuid | string | No | — | — |
image | string | No | — | — |
poll_attempts | integer | No | — | — |
timed_out_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failed_at_state | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | 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 |
|---|---|---|---|---|---|
pending | Yes | No | — | dispatch | Release request accepted; will dispatch strategy |
waiting | No | No | — | — | Polling the strategy sub-workflow |
completed | No | Yes | Yes | — | Release completed; DeploymentRelease.status = PUBLISHED |
failed | No | Yes | No | — | Release failed; DeploymentRelease.status = FAILED |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | dispatch | waiting | Lock target, create release+rollout, start strategy |
waiting | poll | waiting | Re-poll while the strategy is still running |
waiting | complete | completed | Strategy reached terminal-success |
* (any state) | fail | failed | Lifecycle moves to failed |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "deploy.release.start",
"initial_data": {
"deployment_target_uuid": "value",
"image_tag": "value"
}
}