AWS documentdb documentation change
Summary
Updated documentation for global cluster failover procedures including maintenance update sequencing (secondary clusters first), reduced failover time estimate, and clarified CLI/SDK steps
Security assessment
Changes focus on operational procedures and maintenance sequencing rather than addressing specific vulnerabilities. While maintenance updates might include security patches, the documentation changes themselves don't reference security fixes or vulnerabilities.
Diff
diff --git a/documentdb/latest/developerguide/global-clusters-disaster-recovery.md b/documentdb/latest/developerguide/global-clusters-disaster-recovery.md index a17811c92..c33580462 100644 --- a//documentdb/latest/developerguide/global-clusters-disaster-recovery.md +++ b//documentdb/latest/developerguide/global-clusters-disaster-recovery.md @@ -65 +65 @@ During a managed failover, the chosen secondary cluster is promoted to its new r -Typically, the chosen secondary cluster assumes the primary role within a few minutes. As soon as the new primary Region's writer node is available, you can connect your applications to it and resume your workloads. After Amazon DocumentDB promotes the new primary cluster, it automatically rebuilds all additional secondary Region clusters. +Typically, the chosen secondary cluster assumes the primary role within a minute. As soon as the new primary Region's writer node is available, you can connect your applications to it and resume your workloads. After Amazon DocumentDB promotes the new primary cluster, it automatically rebuilds all additional secondary Region clusters. @@ -307 +307 @@ Global cluster switchovers and failovers are blocked when not all regional clust -To resolve this error, please update all all secondary regions first, and then the primary region to the same engine version by applying any pending maintenance action items. To view pending maintenance action items, and to apply any needed changes to correct the issue, perform the instructions in one of the following tabs: +To resolve this error, please update all secondary regions first, and then the primary region to the same engine version by applying any pending maintenance action items. To view pending maintenance action items, and to apply any needed changes to correct the issue, perform the instructions in one of the following tabs: @@ -318 +318 @@ To unblock a global cluster switchover or failover, you must determine if there - 3. In the **Clusters** table, locate your global cluster in the **Cluster identifier** column. + 3. In the **Clusters** table, locate your global cluster in the **Cluster identifier** column. Under your global cluster, take note of each secondary cluster and the primary cluster for the given global cluster, and perform the following steps for each. @@ -320 +320 @@ To unblock a global cluster switchover or failover, you must determine if there - 4. If an update is available for your cluster, it is indicated by the word **Available** , **Required** , or **Next Window** in the **Maintenance** column. + 4. For each secondary cluster: @@ -322 +322 @@ To unblock a global cluster switchover or failover, you must determine if there - 5. To take an action, choose the cluster to show it's details, then choose **Maintenance & backups**. The **Pending Maintenance** items appear. + 1. If an update is available for your cluster, it is indicated as **Available** , **Required** , or **Next Window** in the **Maintenance** column. @@ -324 +324 @@ To unblock a global cluster switchover or failover, you must determine if there - 6. Under **Description** , if it indicates that a "New maintenance update is available", select it and then choose **Apply now**. + 2. To take an action, choose the cluster to show it's details, then choose **Maintenance & backups**. The **Pending Maintenance** items appear. @@ -325,0 +326,9 @@ To unblock a global cluster switchover or failover, you must determine if there + 3. Under **Description** , if it indicates that a "New maintenance update is available", select it and then choose **Apply now**. + + 5. For your primary cluster: + + 1. If an update is available for your cluster, it is indicated as **Available** , **Required** , or **Next Window** in the **Maintenance** column. + + 2. To take an action, choose the cluster to show it's details, then choose **Maintenance & backups**. The **Pending Maintenance** items appear. + + 3. Under **Description** , if it indicates that a "New maintenance update is available", select it and then choose **Apply now**. @@ -329 +337,0 @@ To unblock a global cluster switchover or failover, you must determine if there -Repeat this procedure for each secondary cluster in the global cluster to ensure that all region cluster engine versions match so that the switchover or failover can proceed. @@ -334 +342,3 @@ Using the AWS CLI -To unblock a global cluster switchover, you must determine if there are any pending maintenance actions for the cluster and apply them. Follow these steps to view and apply maintenance actions: +To unblock a global cluster switchover or failover, you must determine if there are any pending maintenance actions for the cluster and apply them. Follow these steps to view and apply maintenance actions first on the secondary clusters then on the primary cluster for your global cluster: + + 1. Run the following on each secondary region's regional cluster first and then for the primary regions regional cluster. @@ -336 +346 @@ To unblock a global cluster switchover, you must determine if there are any pend - 1. Run the [`describe-pending-maintenance-actions`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html) CLI command with the `--resource-identifier` option to determine if any maintenance actions are available for your Amazon DocumentDB global cluster. + 2. Run the [`describe-pending-maintenance-actions`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html) CLI command with the `--resource-identifier` option to determine if any maintenance actions are available for your Amazon DocumentDB regional cluster. @@ -370 +380 @@ The result looks similar to this: - 2. If a maintenance action is needed, run the [`apply-pending-maintenance-action`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html) CLI command with the following options: + 3. If a maintenance action is needed, run the [`apply-pending-maintenance-action`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html) CLI command with the following options: @@ -398 +408 @@ For Windows: - 3. Once the maintenance action has completed, run the [`describe-pending-maintenance-actions`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html) command again to ensure that there are no other actions pending for your cluster. + 4. Once the maintenance action has completed, run the [`describe-pending-maintenance-actions`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html) command again to ensure that there are no other actions pending for your cluster. @@ -409,2 +418,0 @@ The result you want is: -Repeat this procedure for each secondary cluster in the global cluster to ensure that all region cluster engine versions match so that the switchover or failover can proceed. - @@ -416 +424 @@ To unblock a global cluster switchover, you must determine if there are any pend - 1. Call the [`PendingMaintenanceAction`](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_PendingMaintenanceAction.html) API to determine if any maintenance actions are available for your Amazon DocumentDB global cluster. + 1. Run the following on each secondary region's regional cluster first and then for the primary regions regional cluster. @@ -418 +426 @@ To unblock a global cluster switchover, you must determine if there are any pend - 2. Apply any changes by calling the [`ApplyPendingMaintenanceAction`](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ApplyPendingMaintenanceAction.html) API. + 2. Call the [`PendingMaintenanceAction`](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_PendingMaintenanceAction.html) API to determine if any maintenance actions are available for your Amazon DocumentDB global cluster. @@ -419,0 +428 @@ To unblock a global cluster switchover, you must determine if there are any pend + 3. Apply any changes by calling the [`ApplyPendingMaintenanceAction`](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ApplyPendingMaintenanceAction.html) API. @@ -423 +431,0 @@ To unblock a global cluster switchover, you must determine if there are any pend -Repeat this procedure for each secondary cluster in the global cluster to ensure that all region cluster engine versions match so that the switchover or failover can proceed.