AWS documentdb documentation change
Summary
Added new documentation page for Amazon DocumentDB Long-Term Support (LTS) releases, explaining LTS concept, current LTS version (5.0.0), who should use LTS, patch version management, and procedures for creating/upgrading to LTS clusters
Security assessment
This change documents LTS releases which receive 'critical stability and security patches' and explains patch management for security updates. It clarifies that required patches contain critical updates and will be automatically applied, while optional patches contain non-critical improvements. The documentation helps users understand security patching processes for DocumentDB, but does not address a specific security vulnerability or incident.
Diff
diff --git a/documentdb/latest/developerguide/docdb-lts-release.md b/documentdb/latest/developerguide/docdb-lts-release.md index 8b1378917..c2230194d 100644 --- a//documentdb/latest/developerguide/docdb-lts-release.md +++ b//documentdb/latest/developerguide/docdb-lts-release.md @@ -0,0 +1 @@ +[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#docdb-lts-release "Open PDF") @@ -1,0 +3,152 @@ +[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html) + +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 + +# Using a long-term support (LTS) release + +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. + +## Current LTS Release + +The current LTS release for Amazon DocumentDB is: + + * Engine Version 5.0.0, Required Engine Patch Version 3.0.17983 or later + + + + +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. + +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. + +###### Note + +An LTS release for Amazon DocumentDB 8.0 has not yet been designated. If you require LTS, use engine version 5.0.0 with Patch Version 3.0.17983 or later. + +## Who Should Use LTS + +Amazon DocumentDB LTS releases are designed for clusters with limited upgrade windows. LTS is ideal for production environments where database availability directly impacts business operations. + +**Consider LTS releases if:** + + * Your application has strict uptime requirements that limit upgrade opportunities + + * You have all required database engine features and enhancements your application needs + + + + +**Consider standard releases instead if:** + + * Your application can handle minimal interruption + + * You want the latest capabilities and enhancements as soon as they're released + + + + +## 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/developerguide/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/developerguide/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 + + + + +###### Important + + * Updates are **one-way operations** \- you cannot downgrade after updating + + * Your cluster will experience brief downtime during the update process + + + + +## How to create a new LTS cluster + +To create an LTS cluster, follow these steps: + + 1. In the Management Console, create a new engine version 5.0.0 cluster + + 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})` + + + + +**Example** + + + { + engineVersion: '3.0.17983', + ok: 1, + operationTime: Timestamp({ t: timestamp_value, i: 1 }) + } + +## How to upgrade from engine version 3.6.0 or 4.0.0 to a 5.0.0 LTS cluster + +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/developerguide/docdb-mvu.html) + + 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})` + + + + +## How to check if my existing engine version 5.0.0 cluster is on LTS + +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})` + + 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/developerguide/db-cluster-version-upgrade.html) + + + + + **Javascript is disabled or is unavailable in your browser.** + +To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions. + +[Document Conventions](/general/latest/gr/docconventions.html) + +Upgrading using AWS DMS + +Extended Support + +Did this page help you? - Yes + +Thanks for letting us know we're doing a good job! + +If you've got a moment, please tell us what we did right so we can do more of it. + +Did this page help you? - No + +Thanks for letting us know this page needs work. We're sorry we let you down. + +If you've got a moment, please tell us how we can make the documentation better.