docs: update note on downtime during migration #31307
Merged
Conversation
This file contains 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
samson-keung
reviewed
Sep 3, 2024
| @@ -494,7 +494,8 @@ The following changes will take place: | |||
| No, following the migration steps does not cause any replacement of the existing `AWS::CloudFront::Distribution`, `AWS::S3::Bucket` nor `AWS::S3::BucketPolicy` resources. It will modify the bucket policy, create a `AWS::CloudFront::OriginAccessControl` resource, and delete the existing `AWS::CloudFront::CloudFrontOriginAccessIdentity`. | |||
|
|
|||
| **Will migrating from OAI to OAC have any availability implications for my application?** | |||
| While the above steps follow the order recommended by CloudFront, updates to CloudFront distributions and S3 bucket policies can take some time to propagate globally. Bucket configuration updates are eventually consistent. As such, you should be aware there is a possibility of downtime. | |||
|
|
|||
| Migrating from OAI to OAC following the steps above (requires a 2-step deployment) should not cause any downtime. However, if you decide to skip Step 1 and migrate to OAC in a single deployment, you should be aware there is a possibility of downtime. | |||
There was a problem hiding this comment.
Suggested change
| Migrating from OAI to OAC following the steps above (requires a 2-step deployment) should not cause any downtime. However, if you decide to skip Step 1 and migrate to OAC in a single deployment, you should be aware there is a possibility of downtime. | |
| Updates to Bucket Policies are eventually consistent, therefore, removing OAI permissions and adding OAC in the same CloudFormation stack deployment is not recommended as it may introduce downtime where CloudFront loses access to the Bucket. Following the steps above will lower this risk ask the Bucket Policy is updated to have both OAI and OAC permissions, then in a subsequent deployment, the OAI permissions are removed. |
There was a problem hiding this comment.
I like the suggestion is more nuanced - updated the answer :)
samson-keung
approved these changes
Sep 4, 2024
|
Comments on closed issues and PRs are hard for our team to see. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
update note on downtime, 2-step deployment should not cause any downtime