Skip to content
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

feat(cli): cdk rollback #31407

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(cli): cdk rollback #31407

wants to merge 2 commits into from

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Sep 11, 2024

Add a CLI feature to roll a stuck change back.

This is mostly useful for deployments performed using --no-rollback: if a failure occurs, the stack gets stuck in an UPDATE_FAILED state from which there are 2 options:

  • Try again using a new template
  • Roll back to the last stable state

There used to be no way to perform the second operation using the CDK CLI, but there now is.

cdk rollback works in 2 situations:

  • A paused fail state; it will initiating a fresh rollback (on CREATE_FAILED, UPDATE_FAILED).
  • A paused rollback state; it will retry the rollback, optionally skipping some resources (on UPDATE_ROLLBACK_FAILED -- it seems there is no way to continue a rollback in ROLLBACK_FAILED state).

cdk rollback --orphan <logicalid> can be used to skip resource rollbacks that are causing problems.

cdk rollback --force will look up all failed resources and continue skipping them until the rollback has finished.

This change requires new bootstrap permissions, so the bootstrap stack is updated to add the following IAM permissions to the deploy-action role:

                  - cloudformation:RollbackStack
                  - cloudformation:ContinueUpdateRollback

These are necessary to call the 2 CloudFormation APIs that start and continue a rollback.

Relates to (but does not close yet) #30546.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Add a CLI feature to roll a stuck change back.

This is mostly useful for deployments performed using `--no-rollback`:
if a failure occurs, the stack gets stuck in an `UPDATE_FAILED` state
from which there are 2 options:

- Try again using a new template
- Roll back to the last stable state

There used to be no way to perform the second operation using the CDK
CLI, but there now is.

`cdk rollback` works in 2 situations:

- A paused fail state; it will initiating a fresh rollback.
- A paused rollback state; it will retry the rollback, optionally
  skipping some resources.

`cdk rollback --force` will look up all failed resources and continue
skipping them until the rollback has finished.
@rix0rrr rix0rrr requested a review from a team September 11, 2024 14:57
@aws-cdk-automation aws-cdk-automation requested a review from a team September 11, 2024 14:58
@github-actions github-actions bot added the p2 label Sep 11, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 11, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Sep 11, 2024
@rix0rrr rix0rrr added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Sep 11, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: c16c7a8
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@rix0rrr rix0rrr added pr/do-not-merge This PR should not be merged at this time. pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested labels Sep 12, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review September 12, 2024 14:19

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-cli-test-run This PR needs CLI tests run against it. labels Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. p2 pr/do-not-merge This PR should not be merged at this time. pr/needs-maintainer-review This PR needs a review from a Core Team Member pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested pr-linter/exempt-integ-test The PR linter will not require integ test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants