-
Notifications
You must be signed in to change notification settings - Fork 305
ADD userguide/managingApp/rolling-back-a-deployment #6410
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
eeshaanSA
merged 6 commits into
pipe-cd:master
from
rahulshendre:userguide/managingApp/rolling-back-a-deployment
Feb 2, 2026
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0813760
ADD managingApp/rolling-back-a-deployment
rahulshendre afe3a82
readability improvements
rahulshendre c25da4d
Enhance rollback documentation
eeshaanSA b10d658
Fix typo
eeshaanSA 81c6868
changed bash to yaml
rahulshendre 8e74c66
add cancelling-a- deployment reference
rahulshendre File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
38 changes: 38 additions & 0 deletions
38
...ent/en/docs-v1.0.x/user-guide/managing-application/rolling-back-a-deployment.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: "Rolling back a deployment" | ||
| linkTitle: "Rolling back a deployment" | ||
| weight: 6 | ||
| description: > | ||
| This page describes when a deployment is rolled back automatically and how to manually roll back a deployment. | ||
| --- | ||
|
|
||
| Rollbacks allow you to revert your application to a previous stable state when something goes wrong during deployment. PipeCD supports both automatic and manual rollbacks, giving you flexibility in handling deployment failures. | ||
|
|
||
| ## Automatic rollback | ||
| You can automate rollbacks by enabling the `autoRollback` field in your application configuration: | ||
|
|
||
| ```bash | ||
| spec: | ||
| pipeline: | ||
| stages: | ||
| - name: K8S_CANARY_ROLLOUT | ||
| - name: K8S_PRIMARY_ROLLOUT | ||
| autoRollback: true | ||
| ``` | ||
|
|
||
| When `autoRollback` is enabled, the deployment will be rolled back if any of the following conditions are met: | ||
|
|
||
| - A deployment pipeline stage fails | ||
| - An analysis stage determines that the deployment has a negative impact | ||
| - An error occurs while deploying | ||
|
|
||
| If a rollback is triggered, PipeCD adds a new `ROLLBACK` stage to the deployment pipeline and reverts all applied changes. | ||
|
|
||
| ## Manual rollback | ||
|
|
||
| If you need to roll back a deployment that has already completed, or want to intervene during a deployment which is in-progress, you can trigger a rollback manually from the Web UI by clicking the `Cancel with Rollback` button. | ||
|
|
||
|  | ||
| <p style="text-align: center;"> | ||
| A deployment bring rolled back | ||
|
rahulshendre marked this conversation as resolved.
Outdated
|
||
| </p> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.