Skip to content

docs: in place upgrade #602

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.

Sign up for GitHub

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
merged 6 commits into from
Oct 1, 2025
Merged

docs: in place upgrade #602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e0a5418
docs: in place upgrade
shemau Jul 30, 2025
90f1d54
Merge branch 'main' into ipu-doc
shemau Aug 4, 2025
f830157
Merge branch 'main' into ipu-doc
shemau Aug 21, 2025
d6e9ba7
Merge branch 'main' into ipu-doc
shemau Sep 8, 2025
8eee243
Merge branch 'main' into ipu-doc
shemau Sep 25, 2025
0e9f8f1
fix: address review comments
shemau Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .secrets.baseline
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"files": "go.sum|^.secrets.baseline$",
"lines": null
},
"generated_at": "2025-07-17T12:16:53Z",
"generated_at": "2025-09-25T11:20:32Z",
"plugins_used": [
{
"name": "AWSKeyDetector"
Expand Down Expand Up @@ -82,7 +82,7 @@
"hashed_secret": "ff9ee043d85595eb255c05dfe32ece02a53efbb2",
"is_secret": false,
"is_verified": false,
"line_number": 25,
"line_number": 27,
"type": "Secret Keyword",
"verified_result": null
}
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@

This module implements an instance of the IBM Cloud Databases for MongoDB service.

:exclamation: The module does not support major version upgrades or updates to encryption and backup encryption keys. To upgrade the version, create another instance of Databases for MongoDB with the updated version and follow the steps in [Upgrading to a new major version](https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-upgrading) in the IBM Cloud Docs.
: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.
## Upgrade steps

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.

## Usage

Expand Down