AWS opensearch-service documentation change
Summary
Updated documentation structure, simplified section titles, reorganized configuration change tracking details, and improved dry run procedure instructions
Security assessment
Changes focus on documentation structure, process clarification, and status tracking improvements. No explicit references to security vulnerabilities, patches, or new security features. Mention of KMS keys in status descriptions refers to existing configuration options rather than new security documentation.
Diff
diff --git a/opensearch-service/latest/developerguide/managedomains-configuration-changes.md b/opensearch-service/latest/developerguide/managedomains-configuration-changes.md index 81ec2bdaf..3bc32461b 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 deploymentInitiating and tracking 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 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 @@ -12,0 +13,21 @@ Data is migrated from the blue environment to the green environment. When the ne +###### Topics + + * Changes that usually cause blue/green deployments + + * Changes that usually don't cause blue/green deployments + + * Determining whether a change will cause a blue/green deployment + + * Tracking a configuration change + + * Stages of a configuration change + + * Performance impact of blue/green deployments + + * Charges for configuration changes + + * Troubleshooting validation errors + + + + @@ -114,5 +135 @@ Console - 4. On the **Edit cluster configuration** page, you can make changes to the instance type, the number of nodes, and any other configurations. After you've confirmed your changes in the summary panel, choose **Run**. - - 5. Once your dry run is complete, the results automatically display at the bottom of the page, along with a dry run ID. These results notify you which category your change falls into: - - * Initiates a blue/green deployment + 4. Make changes to the domain, such as changin the instance type or the number of nodes. @@ -120 +137 @@ Console - * Doesn't require a blue/green deployment + 5. Under **Dry run analysis** , choose **Run**. The dry run validates your configuration change for errors and determines whether it requires a blue/green deployment. @@ -122 +139 @@ Console - * Contains validation errors that you need to address before you can save your changes + 6. When the dry run is complete, the results appear at the bottom of the page, along with a dry run ID. The analysis indicate whether or not the configuration change requires a blue/green deployment. @@ -124 +141 @@ Console -Note that each dry run overwrites the one before it. To look up the details of each dry run later on, make sure you save your dry run ID. Each dry run is available for 90 days, or until you make a configuration update. +Each dry run overwrites the previous one. To retain the details of each run, save its dry run ID. Dry runs are available for 90 days or until you make a configuration update. @@ -126 +143 @@ Note that each dry run overwrites the one before it. To look up the details of e - 6. To proceed with your configuration update, choose **Save changes**. Otherwise, choose **Cancel**. Either option takes you back to the **Cluster configuration** tab. On this tab, you can choose **Dry run details** to see the details of your latest dry run. This page also includes a side-by-side comparison between the configuration before the dry run and the dry run configuration. + 7. To proceed with your configuration update, choose **Save changes**. Otherwise, choose **Cancel**. Either option takes you back to the **Cluster configuration** tab. On this tab, you can choose **Dry run details** to see the details of your latest dry run. This page also includes a side-by-side comparison between the configuration before the dry run and the dry run configuration. @@ -269,7 +286 @@ The following Python code uses the [UpdateDomainConfig](https://docs.aws.amazon. -## Initiating and tracking a configuration change - -###### Note - -You can request one configuration change at a time. You can also group multiple configuration changes in a single request. Wait for the status of your domain to become `Active` before requesting any additional configuration changes. - -You can view the **Domain Processing Status** and **Config Change Status** fields in the Amazon OpenSearch Service console to track domain and configuration changes. You can also track domain and configuration changes through the `DomainProcessingStatus` and `ConfigChangeStatus` parameters in the API responses. For more information, see the [DomainStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainStatus.html) data type in the OpenSearch Service API reference. +## Tracking a configuration change @@ -277 +288 @@ You can view the **Domain Processing Status** and **Config Change Status** field -**Domain processing status visibility** : You can easily determine the configuration status of a domain by looking at the **Domain Processing Status** field in the console. Similarly, the `DomainProcessingStatus` API parameter can be used to identify the status. The following values are processing statuses for a domain: +You can request one configuration change at a time, or group multiple changes in a single request. Use the **Domain processing status** and **Configuration change status** fields in the console to track configuration changes. Wait for the domain status to become `Active` before you request additional changes. @@ -279 +290 @@ You can view the **Domain Processing Status** and **Config Change Status** field - * `Active`: No configuration change is in progress. You can submit a new configuration change request. +A domain can have the following **processing statuses** : @@ -281 +292 @@ You can view the **Domain Processing Status** and **Config Change Status** field - * `Creating`: Domain is being created. + * `Active` – No configuration change is in progress. You can submit a new configuration change request. @@ -283 +294 @@ You can view the **Domain Processing Status** and **Config Change Status** field - * `Modifying`: Configuration changes, such as the addition of new data nodes, EBS, gp3, IOPS provisioning, or setting up KMS keys, are in progress. + * `Creating` – Domain is being created. @@ -285 +296 @@ You can view the **Domain Processing Status** and **Config Change Status** field -###### Note + * `Modifying` – Configuration changes, such as the addition of new data nodes, EBS, gp3, IOPS provisioning, or setting up KMS keys, are in progress. @@ -287 +298 @@ You can view the **Domain Processing Status** and **Config Change Status** field -You might see the status as `Modifying` in situations where a domain requires shard movement to complete the configuration changes. For backwards compatibility, the behavior of the `Processing` parameter is kept unchanged in the API responses, and is set to false as soon as core configuration changes are complete, without waiting for shard movement completion. + * `Upgrading engine version` – An engine version upgrade is in progress. @@ -289 +300 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Upgrading Engine Version`: An engine version upgrade is in progress. + * `Updating service software` – A service software update is in progress. @@ -291 +302 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Updating Service Software`: A service software update is in progress. + * `Deleting` – The domain is being deleted. @@ -293 +304 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Deleting`: The domain is being deleted. + * `Isolated` – The domain is suspended. @@ -295 +305,0 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Isolated`: The domain is suspended. @@ -298,0 +309 @@ You might see the status as `Modifying` in situations where a domain requires sh +A domain can have the following **configuration change statuses** : @@ -300 +311 @@ You might see the status as `Modifying` in situations where a domain requires sh -**Configuration status visibility** : Configuration changes can be initiated by the operator (e.g. new data node addition, instance type change) or by the service (e.g. Auto-Tune and off-peak hour updates). You can find the status of the latest configuration change details in the **Configuration Change Status** field of the Amazon OpenSearch Service console, and in the `ConfigChangeStatus` API response. The following values indicate the configuration status of a domain: + * `Pending` – A configuration change request has been submitted. @@ -302 +313 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Pending`: A configuration change request has been submitted. + * `Initializing` – The service is initializing a configuration change. @@ -304 +315 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Initializing`: Service is initializing a configuration change request. + * `Validating` – The service is validating the requested changes and resources required. @@ -306 +317 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Validating`: Service is validating the requested changes and resources required. + * `Awaiting user inputs` – The service expects configuration changes, such as an instance type change, to proceed. You can edit the configuration changes. @@ -308 +319 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Awaiting user inputs`: Applies when operator expects some configuration changes such as instance type change to proceed further. You are able to edit configuration changes. + * `Applying changes` – Service is applying the requested configuration changes. @@ -310 +321 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Applying changes`: Service is applying requested configuration changes. + * `Cancelled` – The configuration change is cancelled. Choose **Cancel** roll back all changes. @@ -312 +323 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Cancelled`: Configuration change is cancelled. If you receive the validation failed status, you can click **Cancel** in the console or call the `CancelDomainConfigChange` API operation. If you do this, all the applied changes are rolled back. + * `Completed` – The requested configuration changes have been successfully completed. @@ -314,3 +325 @@ You might see the status as `Modifying` in situations where a domain requires sh - * `Completed`: Requested configuration changes have been completed with success. - - * `Validation Failed`: Requested changes failed validation. No configuration changes are applied. + * `Validation failed` – The requested configuration changes failed to complete. No configuration changes were applied. @@ -320,2 +329 @@ You might see the status as `Modifying` in situations where a domain requires sh -Validation failures could be the result of red indexes present in your domain, unavailability of a chosen instance type, or low disk space. For a list of validation errors, see Troubleshooting validation errors. During a validation failure event, you can cancel, retry, or edit configuration changes. - +Validation failures can be the result of red indexes present in your domain, unavailability of a chosen instance type, or low disk space. For a list of validation errors, see Troubleshooting validation errors. During a validation failure event, you can cancel, retry, or edit configuration changes. @@ -325 +332,0 @@ Validation failures could be the result of red indexes present in your domain, u -**API Summary** : You can use the `DescribeDomain`, `DescribeDomainChangeProgress`, and `DescribeDomainConfig` API operations to get detailed configuration update statuses. In addition, you can use `CancelDomainConfigChange` to cancel the updates in the event of validation failures. For more information, see the [OpenSearch Service API documentation](https://docs.aws.amazon.com/cli/latest/reference/opensearch/) @@ -327 +334 @@ Validation failures could be the result of red indexes present in your domain, u -When the configuration changes are complete, the domain state changes back to `Active`. +When the configuration changes are complete, the domain status changes back to `Active`.