AWS opensearch-service documentation change
Summary
Added documentation for Blue/Green Deployment options including Full Swap and Capacity Optimized strategies with console and API configuration details
Security assessment
The change introduces deployment strategy options for capacity management but does not address security vulnerabilities or document new security features. Focus is on operational availability and deployment mechanics.
Diff
diff --git a/opensearch-service/latest/developerguide/managedomains-configuration-changes.md b/opensearch-service/latest/developerguide/managedomains-configuration-changes.md index c3f868e40..9ea74846d 100644 --- a//opensearch-service/latest/developerguide/managedomains-configuration-changes.md +++ b//opensearch-service/latest/developerguide/managedomains-configuration-changes.md @@ -5 +5 @@ -Changes that usually cause blue/green deploymentsChanges that usually don't cause blue/green deploymentsDetermining whether a change will cause a blue/green deploymentTracking a configuration changeStages of a configuration changePerformance impact of blue/green deploymentsCharges for configuration changesTroubleshooting validation errors +Changes that usually cause blue/green deploymentsChanges that usually don't cause blue/green deploymentsBlue/Green Deployment optionsDetermining whether a change will cause a blue/green deploymentTracking a configuration changeStages of a configuration changePerformance impact of blue/green deploymentsCharges for configuration changesTroubleshooting validation errors @@ -18,0 +19,2 @@ Data is migrated from the blue environment to the green environment. When the ne + * Blue/Green Deployment options + @@ -119,0 +122,79 @@ There are some exceptions depending on your service software version. If you wan +## Blue/Green Deployment options + +Select a deployment strategy to control how your cluster handles deployments when sufficient capacity is not available at the time of update. + + 1. **Full Swap Blue/Green** — The default deployment behavior. Requires full instance capacity upfront, ensuring the fastest deployment when capacity is available. Deployment will not proceed if sufficient capacity cannot be allocated. + + 2. **Capacity Optimized** — Recommended for clusters with 30+ data nodes. Attempts a full blue/green swap first, and if capacity is insufficient, proceeds with deploying in batches. Ensures deployments can complete even when capacity is limited. Completion time may increase, as deployment will be done in batches. + + + + +Console + + +**For Edit Domain Flow:** + + 1. Open the Amazon OpenSearch Service console at [https://console.aws.amazon.com/aos/home](https://console.aws.amazon.com/aos/home). + + 2. In the navigation pane, under **Domains** , choose the domain name to open the Cluster Configuration. + + 3. Click on **Edit** button to right side in **Cluster Configuration** tab. + + 4. From **Deployment strategy** options choose required configurations for domain update: + + 1. **Full Swap Blue/Green** — The default deployment behavior. Requires full instance capacity upfront, ensuring the fastest deployment when capacity is available. Deployment will not proceed if sufficient capacity cannot be allocated. + + 2. **Capacity Optimized** — Recommended for clusters with 30+ data nodes. Attempts a full blue/green swap first, and if capacity is insufficient, proceeds with deploying in batches. Ensures deployments can complete even when capacity is limited. Completion time may increase, as deployment will be done in batches. + + 5. Choose **Save changes**. + + + + +**For Create Domain Flow:** + + 1. Open the Amazon OpenSearch Service console at [https://console.aws.amazon.com/aos/home](https://console.aws.amazon.com/aos/home). + + 2. In the left navigation pane, choose **Domains**. + + 3. Click on **Create Domain** button. + + 4. Select all required configurations for domain. + + 5. From **Deployment strategy** options choose required configurations for domain update: + + 1. **Full Swap Blue/Green** — The default deployment behavior. Requires full instance capacity upfront, ensuring the fastest deployment when capacity is available. Deployment will not proceed if sufficient capacity cannot be allocated. + + 2. **Capacity Optimized** — Recommended for clusters with 30+ data nodes. Attempts a full blue/green swap first, and if capacity is insufficient, proceeds with deploying in batches. Ensures deployments can complete even when capacity is limited. Completion time may increase, as deployment will be done in batches. + + 6. Click on **Create** button on **Domain Summary** panel on right hand side. + + + + +API + + +You can configure the deployment strategy using the [UpdateDomainConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdateDomainConfig.html) API. + +**Capacity Optimized option** + + + POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/my-domain/config + { + "DeploymentStrategyOptions": { + "DeploymentStrategy": "CapacityOptimized" + } + } + +**Default option** + + + POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/my-domain/config + { + "DeploymentStrategyOptions": { + "DeploymentStrategy": "Default" + } + } +