From c87257eee302fbd7b3b2f615fea4fceab0d3715c Mon Sep 17 00:00:00 2001 From: Tanner Lewis Date: Thu, 3 Jul 2025 13:39:15 -0500 Subject: [PATCH 1/5] Update MA secret format documentation Signed-off-by: Tanner Lewis --- .../configuration-options.md | 9 +++------ .../getting-started-data-migration.md | 13 ++++++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 5fa28e44c43..bbb88f819aa 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -51,8 +51,7 @@ The following CDK performs a backfill migrations using RFS: "endpoint": , "auth": { "type": "basic", - "username": , - "passwordFromSecretArn": + "userSecretArn": } }, "reindexFromSnapshotServiceEnabled": true, @@ -93,8 +92,7 @@ The following sample CDK performs a live capture migration with C&R: "endpoint": , "auth": { "type": "basic", - "username": , - "passwordFromSecretArn": + "userSecretArn": } }, "captureProxyServiceEnabled": true, @@ -144,8 +142,7 @@ Both the source and target cluster can use no authentication, authentication lim "version": "ES 7.10", "auth": { "type": "basic", - "username": , - "passwordFromSecretArn": + "userSecretArn": } } ``` diff --git a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md index 856d2e53aa5..eb2b8054f88 100644 --- a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md +++ b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md @@ -118,7 +118,12 @@ These commands deploy the following stacks: Use the following steps to configure and deploy RFS, deploy Migration Assistant, and verify installation of the required stacks: -1. Add the source and target cluster password as separate **Secrets** in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) as an unstructured string. Be sure to copy the secret Amazon Resource Name (ARN) for use during deployment. +1. Add the basic auth details (username/password) for the source and target cluster as separate **Secrets** in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). Each secret should contain two Key/value pairs, one for username and one for password. This will result in the secret Plaintext looking like the example below. + ```json + {"username":"admin","password":"myStrongPassword123!"} + ``` + Be sure to copy the secret Amazon Resource Name (ARN) for use during deployment. + 2. From the same shell as the Bootstrap instance, modify the `cdk.context.json` file located in the `/opensearch-migrations/deployment/cdk/opensearch-service-migration` directory and configure the following settings: ```json @@ -130,8 +135,7 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, "endpoint": "", "auth": { "type": "basic", - "username": "", - "passwordFromSecretArn": "" + "userSecretArn": "" } }, "sourceCluster": { @@ -139,8 +143,7 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, "version": "", "auth": { "type": "basic", - "username": "", - "passwordFromSecretArn": "" + "userSecretArn": "" } }, "reindexFromSnapshotExtraArgs": "", From 6c1a7f7e42f174eada0783348e883fe9b6fabfbb Mon Sep 17 00:00:00 2001 From: Tanner Lewis Date: Thu, 3 Jul 2025 17:53:32 -0500 Subject: [PATCH 2/5] Updates per PR feedback Signed-off-by: Tanner Lewis --- .../getting-started-data-migration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md index eb2b8054f88..3dd085a513e 100644 --- a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md +++ b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md @@ -118,7 +118,7 @@ These commands deploy the following stacks: Use the following steps to configure and deploy RFS, deploy Migration Assistant, and verify installation of the required stacks: -1. Add the basic auth details (username/password) for the source and target cluster as separate **Secrets** in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). Each secret should contain two Key/value pairs, one for username and one for password. This will result in the secret Plaintext looking like the example below. +1. Add the basic auth details (username/password) for the source and target cluster as separate secrets in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). Each secret should contain two key/value pairs, one for username and one for password. This will result in the secret plaintext looking like the example below. ```json {"username":"admin","password":"myStrongPassword123!"} ``` From a655e0556555923a7de8e2957b4de081aa091644 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 8 Jul 2025 06:00:43 -0500 Subject: [PATCH 3/5] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../getting-started-data-migration.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md index 3dd085a513e..99b042fd8cd 100644 --- a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md +++ b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md @@ -118,7 +118,8 @@ These commands deploy the following stacks: Use the following steps to configure and deploy RFS, deploy Migration Assistant, and verify installation of the required stacks: -1. Add the basic auth details (username/password) for the source and target cluster as separate secrets in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). Each secret should contain two key/value pairs, one for username and one for password. This will result in the secret plaintext looking like the example below. +1. Add the basic authentication details (username and password) for both the source and target clusters as separate secrets in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). Each secret must include two key-value pairs: one for the username and one for the password. The plaintext of each secret should resemble the following example: + ```json {"username":"admin","password":"myStrongPassword123!"} ``` From 06f28d16b9125a1455730601baa6c44f9e36c87e Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 8 Jul 2025 06:23:42 -0500 Subject: [PATCH 4/5] Update getting-started-data-migration.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../getting-started-data-migration.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md index 99b042fd8cd..f9b5509dd98 100644 --- a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md +++ b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md @@ -123,6 +123,7 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, ```json {"username":"admin","password":"myStrongPassword123!"} ``` + Be sure to copy the secret Amazon Resource Name (ARN) for use during deployment. 2. From the same shell as the Bootstrap instance, modify the `cdk.context.json` file located in the `/opensearch-migrations/deployment/cdk/opensearch-service-migration` directory and configure the following settings: From eb7978c5e56a19597824b09a45acd9d630e03144 Mon Sep 17 00:00:00 2001 From: Nathan Bower Date: Tue, 8 Jul 2025 09:13:56 -0400 Subject: [PATCH 5/5] Update _migration-assistant/deploying-migration-assistant/getting-started-data-migration.md Signed-off-by: Nathan Bower --- .../getting-started-data-migration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md index f9b5509dd98..d21602a48a4 100644 --- a/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md +++ b/_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md @@ -118,7 +118,7 @@ These commands deploy the following stacks: Use the following steps to configure and deploy RFS, deploy Migration Assistant, and verify installation of the required stacks: -1. Add the basic authentication details (username and password) for both the source and target clusters as separate secrets in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). Each secret must include two key-value pairs: one for the username and one for the password. The plaintext of each secret should resemble the following example: +1. Add the basic authentication information (username and password) for both the source and target clusters as separate secrets in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). Each secret must include two key-value pairs: one for the username and one for the password. The plaintext of each secret should resemble the following example: ```json {"username":"admin","password":"myStrongPassword123!"}