AWS documentdb documentation change
Summary
Updated major version upgrade documentation with expanded upgrade paths, added critical scaling requirement for burstable instances, fixed broken links, and clarified post-upgrade behavior
Security assessment
The changes focus on operational procedures and feature documentation without addressing security vulnerabilities. The critical note about scaling burstable instances prevents upgrade failures and downtime but addresses resource availability rather than security flaws. No security patches, vulnerabilities, or security-specific features are mentioned in the changes.
Diff
diff --git a/documentdb/latest/devguide/docdb-mvu.md b/documentdb/latest/devguide/docdb-mvu.md index 254f87429..b964c4cc3 100644 --- a//documentdb/latest/devguide/docdb-mvu.md +++ b//documentdb/latest/devguide/docdb-mvu.md @@ -11 +11 @@ Supported upgrade pathsPrerequisitesBest practicesWhat changes after upgrading f -You can perform an in-place major version upgrade (MVU) of your Amazon DocumentDB cluster while keeping the same endpoints, storage, and tags. Your applications continue to work without modifications. This feature is available at no additional cost in all regions where Amazon DocumentDB is available. +You can perform an in-place major version upgrade (MVU) of your Amazon DocumentDB cluster while keeping the same endpoints, storage, and tags. Your applications continue to work without modifications. This feature is available at no additional cost in all AWS Regions where Amazon DocumentDB is available. @@ -40,5 +40,15 @@ Once upgraded, you cannot downgrade to a previous version. You can restore your -Source version | Target version ----|--- -Amazon DocumentDB 3.6 | Amazon DocumentDB 5.0 -Amazon DocumentDB 4.0 | Amazon DocumentDB 5.0 -Amazon DocumentDB 5.0 | Amazon DocumentDB 8.0 +The following table lists every supported in-place major version upgrade path. You can select any published minor version on the target major as the target engine version. + +Source major version | Target major version | Notes +---|---|--- +Amazon DocumentDB 3.6 | Amazon DocumentDB 5.0 (any published minor version) | See Post-upgrade considerations for clusters upgraded from 3.6 or 4.0 for post-upgrade considerations. +Amazon DocumentDB 4.0 | Amazon DocumentDB 5.0 (any published minor version) | See Post-upgrade considerations for clusters upgraded from 3.6 or 4.0 for post-upgrade considerations. +Amazon DocumentDB 5.0 (any published minor version) | Amazon DocumentDB 8.0 (any published minor version) | See What changes after upgrading from Amazon DocumentDB 5.0 to 8.0 for feature changes. + +To view the minor versions available in your AWS Region, use the AWS CLI command `aws docdb describe-db-engine-versions`. For a list of released minor versions, see [Release notes](./release-notes.html). + +###### Note + +Each MVU can target any published minor version on the destination major. For example, upgrading from Amazon DocumentDB 3.6 or 4.0 can go directly to the latest published 5.0 minor version; there is no requirement to first upgrade to 5.0.0 and then apply a minor version upgrade. + +To reach 8.0 from 3.6 or 4.0, perform two MVUs: first to a 5.0 minor version of your choice, then to an 8.0 minor version of your choice. There is no direct 3.6→8.0 or 4.0→8.0 MVU path. @@ -52 +62,3 @@ In-place MVU is not supported for global clusters or elastic clusters. To upgrad - * **Instance type** — Amazon DocumentDB 4.0+ does not support db.r4 instances. Modify any `db.r4.*` instances to `db.r5.*` instances or newer before upgrading. See [Modifying an Amazon DocumentDB instance](./db-instance-modify.html) and [Supported instance classes by region](./db-instance-classes.html#db-instance-classes-by-region). +###### Important + +**Scale up burstable instances before upgrading.** If your cluster uses burstable instance types (for example, `db.t3.medium` or `db.t4g.medium`), we strongly recommend scaling up the primary instance to at least `db.r5.large` or `db.r6g.large` before initiating the upgrade. Burstable instances may not have sufficient CPU and memory to complete the upgrade process, which can result in upgrade failures and extended cluster unavailability. You can scale back down after the upgrade completes. @@ -54 +66 @@ In-place MVU is not supported for global clusters or elastic clusters. To upgrad - * **Burstable instances** — If your cluster uses burstable instance types (for example, `db.t3.medium` or `db.t4g.medium`), we strongly recommend scaling up the primary instance to at least `db.r5.large` or `db.r6g.large` before initiating the upgrade. Burstable instances may not have sufficient CPU and memory to complete the upgrade process, which can result in upgrade failures and extended cluster unavailability. You can scale back down after the upgrade completes. + * **Instance type** — Amazon DocumentDB 4.0+ does not support db.r4 instances. Modify any `db.r4.*` instances to `db.r5.*` instances or newer before upgrading. See [Modifying an Amazon DocumentDB instance](./db-instance-modify.html) and [Supported instance classes by Region](./db-instance-classes.html#db-instance-classes-by-region). @@ -190 +202 @@ Contact AWS support if the index metadata refresh process hasn't completed withi - 3. **Update your driver.** To use new features (for example, collation, views, or Zstd compression in 8.0), upgrade to the corresponding MongoDB API version. For more information, see [What's new in Amazon DocumentDB 8.0](https://docs.aws.amazon.com/documentdb/latest/devguide/compatibility.html#compatibility-whatsnew-8). + 3. **Update your driver.** To use new features (for example, collation, views, or Zstd compression in 8.0), upgrade to the corresponding MongoDB API version. For more information, see [What's new in Amazon DocumentDB 8.0](./compatibility.html#compatibility-whatsnew-8). @@ -201 +213 @@ After performing a major version upgrade from Amazon DocumentDB 5.0 to 8.0, the - * **Collation.** Amazon DocumentDB 8.0 supports [collation](https://docs.aws.amazon.com/documentdb/latest/devguide/collation.html). After the upgrade, new collections and their indexes, and new indexes on existing collections, have collation enabled by default. + * **Collation.** Amazon DocumentDB 8.0 supports [collation](./collation.html). After the upgrade, new collections and their indexes, and new indexes on existing collections, have collation enabled by default. @@ -205 +217 @@ After performing a major version upgrade from Amazon DocumentDB 5.0 to 8.0, the - * **Query planner version.** If you did not have a custom parameter group, a new default parameter group is created for Amazon DocumentDB 8.0 with Planner Version 3 automatically selected. With query planner version 3, [views](https://docs.aws.amazon.com/documentdb/latest/devguide/views.html) are also available. + * **Query planner version.** If you did not have a custom parameter group, a new default parameter group is created for Amazon DocumentDB 8.0 with Planner Version 3 automatically selected. With query planner version 3, [views](./views.html) are also available. @@ -207 +219 @@ After performing a major version upgrade from Amazon DocumentDB 5.0 to 8.0, the - * **Compression.** Amazon DocumentDB 8.0 supports dictionary-based document compression using the Zstd algorithm. After the upgrade, new collections are created with Zstd compression enabled by default. Existing collections from 5.0 retain their compression settings. To take advantage of Zstd compression on existing collections, you can modify their compression settings. For more information, see [Dictionary-based compression](https://docs.aws.amazon.com/documentdb/latest/devguide/dict-compression.html). + * **Compression.** Amazon DocumentDB 8.0 supports dictionary-based document compression using the Zstd algorithm. After the upgrade, new collections are created with Zstd compression enabled by default. Existing collections from 5.0 retain their compression settings. To take advantage of Zstd compression on existing collections, you can modify their compression settings. For more information, see [Managing dictionary-based compression in Amazon DocumentDB 8.0](./dict-compression.html).