Appearance
deploy.release.rollback ​
Ship the release from a previously COMPLETED DeploymentRollout back to its DeploymentTarget by dispatching the same strategy. Creates a new rollout row; logs ABORTED on the rollout being rolled away from.
Roll a target back to a previously completed rollout's release.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-deployments |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
deployment_target_uuid | uuid | Yes | — | — |
to_rollout_uuid | uuid | Yes | — | A past, COMPLETED DeploymentRollout for the same target. Its release is shipped again. |
reason | string | No | — | Human reason for the rollback. Stored on the new rollout's config and event_data. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
deployment_target_uuid | uuid | No | — | — |
to_rollout_uuid | uuid | No | — | — |
reason | string | No | — | — |
rollout_uuid | uuid | No | — | — |
release_uuid | uuid | No | — | — |
rollback_of_rollout_uuid | uuid | No | — | — |
strategy | string | No | — | — |
strategy_workflow_type | string | No | — | — |
child_workflow_uuid | 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 | Rollback request accepted; will dispatch strategy |
waiting | No | No | — | — | Polling the strategy sub-workflow |
completed | No | Yes | Yes | — | Rollback completed; previous release re-published |
failed | No | Yes | No | — | Rollback failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | dispatch | waiting | Lock target, create rollback 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 | Rollback moves to failed |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "deploy.release.rollback",
"initial_data": {
"deployment_target_uuid": "value",
"to_rollout_uuid": "value"
}
}