AWS documentdb documentation change
Summary
Updated LTS documentation by removing patch version requirements, simplifying version checks to focus on major version 5.0.0, and revising patch management explanations.
Security assessment
The changes clarify that LTS versions receive critical security patches and introduce optional patches for debugging. While it reinforces security practices, there's no evidence of addressing a specific vulnerability.
Diff
diff --git a/documentdb/latest/devguide/docdb-lts-release.md b/documentdb/latest/devguide/docdb-lts-release.md index 04fae0419..05f874472 100644 --- a//documentdb/latest/devguide/docdb-lts-release.md +++ b//documentdb/latest/devguide/docdb-lts-release.md @@ -7 +7 @@ -Current LTS ReleaseWho Should Use LTSUnderstanding LTS Patch VersionsHow to create a new LTS clusterHow to upgrade from engine version 3.6.0 or 4.0.0 to a 5.0.0 LTS clusterHow to check if my existing engine version 5.0.0 cluster is on LTS +Current LTS ReleaseWho Should Use LTSHow to create a new LTS clusterHow to upgrade from engine version 3.6.0 or 4.0.0 to a 5.0.0 LTS clusterHow to check if my existing engine version 5.0.0 cluster is on LTS @@ -11 +11 @@ Current LTS ReleaseWho Should Use LTSUnderstanding LTS Patch VersionsHow to crea -Amazon DocumentDB designates certain versions as Long-Term Support (LTS) releases. Database clusters that use LTS can stay on the same version longer and undergo fewer upgrade cycles than clusters that use non-LTS releases. LTS versions will receive only critical stability and security patches without introducing new features. +Amazon DocumentDB designates certain versions as Long-Term Support (LTS) releases. Database clusters that use LTS can stay on the same version longer and undergo fewer upgrade cycles than clusters that use non-LTS releases. LTS versions will be patched only in the event of critical stability and security patches without introducing new features. Additional optional patches may be released such as metrics to debug critical failures. These will be cumulatively applied with required patches. @@ -17 +17 @@ The current LTS release for Amazon DocumentDB is: - * Engine Version 5.0.0, Required Engine Patch Version 3.0.17983 or later + * Minor Version 5.0.0 @@ -22 +22 @@ The current LTS release for Amazon DocumentDB is: -To determine the patch version your cluster is on, see How to check if my existing engine version 5.0.0 cluster is on LTS. +To determine the version your cluster is on, see How to check if my existing engine version 5.0.0 cluster is on LTS. @@ -24 +24 @@ To determine the patch version your cluster is on, see How to check if my existi -For details about support timelines and release cycles for the LTS versions, see [Amazon DocumentDB engine version support dates](https://docs.aws.amazon.com/documentdb/latest/devguide/docdb-version-support-dates.html). Amazon DocumentDB will announce the next LTS version through standard communication channels. +For details about support timelines and release cycles for the LTS versions, see [Amazon DocumentDB engine version support dates](https://docs.aws.amazon.com/documentdb/latest/developerguide/docdb-version-support-dates.html). Amazon DocumentDB will announce the next LTS version through standard communication channels. @@ -52,33 +51,0 @@ Amazon DocumentDB LTS releases are designed for clusters with limited upgrade wi -## Understanding LTS Patch Versions - -Amazon DocumentDB Long Term Support (LTS) has a designated minimum required patch version. Your cluster is considered to be on the LTS version if you are running either: - - 1. The designated LTS required patch version, or - - 2. Any later patch version (whether required or optional) - - - - -Optional patches remain the same as defined in [Maintaining Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/devguide/db-instance-maintain.html#user-initiated-updates). - -**Required Patches vs. Optional Patches** - - * **Required patches** contain critical updates and will be automatically applied during your cluster's upgrade window - - * **Optional patches** contain non-critical improvements and have no automatic apply date - - - - -**How to Identify Patch Types** - -To determine whether a pending patch is required or optional, connect to your cluster and run the CLI `describe-pending-maintenance-actions` command or call the `DescribePendingMaintenanceActions` API operation. For more details on managing patches, see [Maintaining Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/devguide/db-instance-maintain.html#user-initiated-updates). - - * **Required patches** display specific dates for `CurrentApplyDate`, `ForcedApplyDate`, and `AutoAppliedAfterDate` - - * **Optional patches** display null values for these date fields - - - - @@ -87 +54 @@ To determine whether a pending patch is required or optional, connect to your cl - * Updates are **one-way operations** \- you cannot downgrade after updating + * Upgrades are **one-way operations** \- you cannot downgrade after upgrading @@ -89 +56 @@ To determine whether a pending patch is required or optional, connect to your cl - * Your cluster will experience brief downtime during the update process + * Your cluster will experience brief downtime during the upgrade process @@ -100 +67,3 @@ To create an LTS cluster, follow these steps: - 2. Verify you're on the required engine patch version after cluster creation or upgrade by connecting to your cluster and running the following command: `db.runCommand({getEngineVersion: 1})` + 2. Verify you're on engine version 5.0.0 after cluster creation using the AWS CLI: + + @@ -103,0 +73,3 @@ To create an LTS cluster, follow these steps: + aws docdb describe-db-clusters \ + --db-cluster-identifier mydocdbcluster \ + --query 'DBClusters[0].EngineVersion' @@ -105 +77 @@ To create an LTS cluster, follow these steps: -**Example** +Output from this operation looks something like the following: @@ -108,5 +80 @@ To create an LTS cluster, follow these steps: - { - engineVersion: '3.0.17983', - ok: 1, - operationTime: Timestamp({ t: timestamp_value, i: 1 }) - } + "5.0.0" @@ -118 +86 @@ To upgrade to an LTS cluster, follow these steps: - 1. In the Management Console, major version upgrade (MVU) your engine version 3.6.0 or 4.0.0 cluster to 5.0.0 following [Upgrading the Amazon DocumentDB engine version](https://docs.aws.amazon.com/documentdb/latest/devguide/docdb-mvu.html) + 1. In the Management Console, major version upgrade (MVU) your engine version 3.6.0 or 4.0.0 cluster to 5.0.0 following [Upgrading the Amazon DocumentDB engine version](https://docs.aws.amazon.com/documentdb/latest/developerguide/docdb-mvu.html) @@ -120 +88 @@ To upgrade to an LTS cluster, follow these steps: - 2. Verify you're on the required engine patch version after cluster creation or upgrade by connecting to your cluster and running the following command: `db.runCommand({getEngineVersion: 1})` + 2. Verify you're on engine version 5.0.0 after upgrade using the AWS CLI: @@ -124,0 +93,5 @@ To upgrade to an LTS cluster, follow these steps: + + aws docdb describe-db-clusters \ + --db-cluster-identifier mydocdbcluster \ + --query 'DBClusters[0].EngineVersion' + @@ -129 +102,5 @@ To check if your engine version 5.0.0 cluster is running an LTS version: - 1. Verify you're on engine version 5.0.0, **Required Engine Patch Version 3.0.17983 or later** by connecting to your cluster and running the following command: `db.runCommand({getEngineVersion: 1})` + 1. Verify you're on engine version 5.0.0 using the AWS CLI: + + aws docdb describe-db-clusters \ + --db-cluster-identifier mydocdbcluster \ + --query 'DBClusters[0].EngineVersion' @@ -131 +108 @@ To check if your engine version 5.0.0 cluster is running an LTS version: - 2. If needed, update your existing engine version 5.0.0 cluster following [Performing a patch update to a cluster's engine version](https://docs.aws.amazon.com/documentdb/latest/devguide/db-cluster-version-upgrade.html) + 2. If needed, upgrade your existing engine version 5.0.0 cluster following [Performing a patch update to a cluster's engine version](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-version-upgrade.html)