Skip to content

Update Migration Assistant basic auth secret format documentation #10186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update Migration Assistant basic auth secret format documentation #10186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c87257e
Update MA secret format documentation
lewijacn Jul 3, 2025
6c1a7f7
Updates per PR feedback
lewijacn Jul 3, 2025
a655e05
Apply suggestions from code review
Naarcha-AWS Jul 8, 2025
06f28d1
Update getting-started-data-migration.md
Naarcha-AWS Jul 8, 2025
eb7978c
Update _migration-assistant/deploying-migration-assistant/getting-sta…
natebower Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions _migration-assistant/deploying-migration-assistant/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ The following CDK performs a backfill migrations using RFS:
"endpoint": <TARGET_CLUSTER_ENDPOINT>,
"auth": {
"type": "basic",
"username": <TARGET_CLUSTER_USERNAME>,
"passwordFromSecretArn": <TARGET_CLUSTER_PASSWORD_SECRET>
"userSecretArn": <SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>
}
},
"reindexFromSnapshotServiceEnabled": true,
Expand Down Expand Up @@ -93,8 +92,7 @@ The following sample CDK performs a live capture migration with C&R:
"endpoint": <TARGET_CLUSTER_ENDPOINT>,
"auth": {
"type": "basic",
"username": <TARGET_CLUSTER_USERNAME>,
"passwordFromSecretArn": <TARGET_CLUSTER_PASSWORD_SECRET>
"userSecretArn": <SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>
}
},
"captureProxyServiceEnabled": true,
Expand Down Expand Up @@ -144,8 +142,7 @@ Both the source and target cluster can use no authentication, authentication lim
"version": "ES 7.10",
"auth": {
"type": "basic",
"username": <TARGET_CLUSTER_USERNAME>,
"passwordFromSecretArn": <TARGET_CLUSTER_PASSWORD_SECRET>
"userSecretArn": <SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>
}
}
```
Expand Down
15 changes: 10 additions & 5 deletions ...ation-assistant/deploying-migration-assistant/getting-started-data-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,14 @@ 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 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!"}
```

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
Expand All @@ -130,17 +137,15 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant,
"endpoint": "<TARGET CLUSTER ENDPOINT>",
"auth": {
"type": "basic",
"username": "<TARGET CLUSTER USERNAME>",
"passwordFromSecretArn": "<TARGET CLUSTER PASSWORD SECRET>"
"userSecretArn": "<SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>"
}
},
"sourceCluster": {
"endpoint": "<SOURCE CLUSTER ENDPOINT>",
"version": "<SOURCE ENGINE VERSION>",
"auth": {
"type": "basic",
"username": "<TARGET CLUSTER USERNAME>",
"passwordFromSecretArn": "<TARGET CLUSTER PASSWORD SECRET>"
"userSecretArn": "<SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>"
}
},
"reindexFromSnapshotExtraArgs": "<RFS PARAMETERS (see below)>",
Expand Down