AWS solutions documentation change
Summary
Restructured uninstallation documentation with detailed procedures for Amazon EKS deployment, added cleanup timing guidance, and separated legacy ECS instructions with end-of-support date.
Security assessment
The changes focus on operational procedures for uninstalling the solution, including timing considerations and resource deletion steps. No security vulnerabilities, weaknesses, or incidents are mentioned. The warning about S3 bucket deletion relates to data loss prevention, not security vulnerabilities.
Diff
diff --git a/solutions/latest/migration-assistant-for-amazon-opensearch-service/uninstall-the-solution.md b/solutions/latest/migration-assistant-for-amazon-opensearch-service/uninstall-the-solution.md index d818cb0df..433035060 100644 --- a//solutions/latest/migration-assistant-for-amazon-opensearch-service/uninstall-the-solution.md +++ b//solutions/latest/migration-assistant-for-amazon-opensearch-service/uninstall-the-solution.md @@ -7 +7 @@ -Using the AWS Management ConsoleUsing AWS Command Line Interface +Uninstall the Amazon EKS deploymentUninstall the legacy Amazon ECS deployment @@ -11 +11,12 @@ Using the AWS Management ConsoleUsing AWS Command Line Interface -You can uninstall the Migration Assistant for Amazon OpenSearch Service solution from the AWS Management Console or by using the AWS Command Line Interface. Manually remove the contents of the bucket that matches cdk-` _< unique id>_ `-assets-` _< account id>_ `-` _< region>_ ` created by this solution. Migration Assistant for Amazon OpenSearch Service does not automatically delete S3 buckets in case you have stored data to retain. +Cleanup should happen last, not immediately after the first successful run. Wait until: + + * Production traffic has been stable on the Amazon OpenSearch Service domain or Amazon OpenSearch Serverless collection. + + * You no longer need the source for rollback (typically 24–72 hours after cutover). + + * You no longer need replay or comparison checks. + + * Any snapshot artifacts you want to keep have been retained intentionally. + + + @@ -15 +26,55 @@ You can uninstall the Migration Assistant for Amazon OpenSearch Service solution -After your migration is complete, remove all solution resources. +After your migration is complete and the rollback window has passed, remove all solution resources to stop incurring costs. The default Amazon S3 migrations bucket and snapshot bucket are not automatically deleted, in case you have stored data to retain. + +## Uninstall the Amazon EKS deployment + +The Amazon EKS deployment is removed in two phases: first the Helm release on the cluster, then the AWS CloudFormation stack. + +### Step 1: Uninstall the Helm release and clear PVCs + +From a terminal with `kubectl` and `helm` configured for the Amazon EKS cluster: + + + helm uninstall -n ma ma + kubectl -n ma delete pvc --all + kubectl delete namespace ma + +The `kubectl -n ma delete pvc --all` command removes the Apache Kafka persistent volumes used for capture and replay. Skip this step if you are not also deleting the cluster and want to redeploy Migration Assistant later with the same data. + +### Step 2: Delete the AWS CloudFormation stack + + + aws cloudformation delete-stack --stack-name <STACK_NAME> + aws cloudformation wait stack-delete-complete --stack-name <STACK_NAME> + +This removes the Amazon EKS cluster, networking, IAM roles, and supporting AWS resources created by the bootstrap script. + +### Step 3: Clean up Amazon S3 artifacts (optional) + +The default migrations bucket is not automatically deleted. The bucket name follows the format: + + + s3://migrations-default-<ACCOUNT_ID>-<STAGE>-<REGION> + +Be deliberate about Amazon S3 cleanup. The bucket is often still useful for: + + * audit and rollback investigation, + + * preserving snapshots for future reference, + + * and comparing post-cutover behavior. + + + + +Delete it only after you are certain you no longer need the contents: + + + aws s3 rb s3://migrations-default-<ACCOUNT_ID>-<STAGE>-<REGION> --force + +###### Warning + +The `--force` flag deletes all objects in the bucket. Make sure you have copied any snapshots or artifacts you want to retain to another location first. + +## Uninstall the legacy Amazon ECS deployment + +If you originally deployed the legacy Amazon ECS deployment of Migration Assistant, follow these steps instead. The Amazon ECS deployment is in support-only mode and will reach end of support on **July 15, 2026**. @@ -17 +82 @@ After your migration is complete, remove all solution resources. -## Using the AWS Management Console +### Using the AWS Management Console @@ -19 +84 @@ After your migration is complete, remove all solution resources. - 1. Sign in to the [CloudFormation console](https://console.aws.amazon.com/cloudformation/home?). + 1. Sign in to the [AWS CloudFormation console](https://console.aws.amazon.com/cloudformation/home?). @@ -44 +109 @@ After your migration is complete, remove all solution resources. -## Using AWS Command Line Interface +### Using the AWS Command Line Interface @@ -46 +111 @@ After your migration is complete, remove all solution resources. -To remove all the CDK stacks, which the solution creates during a deployment, you can run a command similar to the following within the CDK directory. +To remove all the AWS CDK stacks that the solution creates during a legacy Amazon ECS deployment, run a command similar to the following within the AWS CDK directory. @@ -54 +119 @@ Log in to the `bootstrap` container, as described in [Deploy the solution](./dep -After the Migration Assistant for Amazon OpenSearch Service solution stacks _(see step 2. in theUsing the AWS Management Console section)_ have been removed, remove the bootstrap CloudFormation template. +After the Migration Assistant for Amazon OpenSearch Service solution stacks _(see step 2. inUsing the AWS Management Console)_ have been removed, remove the bootstrap AWS CloudFormation template. @@ -56 +121 @@ After the Migration Assistant for Amazon OpenSearch Service solution stacks _(se -Determine whether the AWS Command Line Interface (AWS CLI) is available in your environment. For installation instructions, see [What Is the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) in the _AWS CLI User Guide_. After confirming that the AWS CLI is available, set the default Region to the Region that was used for deployment. Then perform the AWS CLI command to delete the given AWS CloudFormation bootstrap stack name: +Determine whether the AWS Command Line Interface (AWS CLI) is available in your environment. For installation instructions, see [What Is the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) in the _AWS CLI User Guide_. After confirming that the AWS CLI is available, set the default Region to the Region used for deployment. Then run the AWS CLI command to delete the AWS CloudFormation bootstrap stack: