docs: in place upgrade #602
Merged
Conversation
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
Contributor
Author
|
/run pipeline |
Contributor
Author
|
/run pipeline |
rajatagarwal-ibm
requested changes
Sep 25, 2025
README.md
Outdated
| :exclamation: The module does not support updates to encryption and backup encryption keys. The module only supports setting the disk encryption and backup encryption key CRNs on creation. The KMS manual or automatic key rotation may be used to change the key value and initiate the re-encryption of the deployment. | ||
|
|
||
| :exclamation: The module only supports setting the disk encryption and backup encryption key CRNs on creation and no update support is available. The KMS manual or automatic key rotation may be used to change the key value and initiate the re-encryption of the deployment. | ||
| :exclamation: To upgrade to a new major version see [Upgrading to a new major version](https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-upgrading) in the IBM Cloud Docs. Before you begin, prepare for the upgrade by reviewing the [upgrade considerations](https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-upgrading&interface=terraform#upgrading-considerations). The database will be put into READ-ONLY mode during upgrade. It is highly recommended to test before upgrading. To upgrade, update the `mongodb_version` value in your configuration. There is an optional bool flag, `version_upgrade_skip_backup`, that can be set to skip backup. This is not recommended, but can reduce the upgrade time. For larger instances, there is an optional `timeouts_update` value that can be configured to avoid terraform timeouts. |
Member
There was a problem hiding this comment.
I think if we can give a header instead of an exclamation, it would be handy for the user.
Something like:
Upgrade Steps
text
Contributor
Author
|
/run pipeline |
rajatagarwal-ibm
approved these changes
Sep 25, 2025
Contributor
|
🎉 This PR is included in version 3.4.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Improve in place upgrade documentation, links and variables
Release required?
x.x.X)x.X.x)X.x.x)Release notes content
No release required, documentation only. This may change if reviews identify variable descriptions to be improved.
Run the pipeline
If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.
Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:
Checklist for reviewers
For mergers