Skip to content

Commit 462c9b8

Browse files
lewijacnNaarcha-AWSnatebower
authored
Update Migration Assistant basic auth secret format documentation (#10186)
* Update MA secret format documentation Signed-off-by: Tanner Lewis <lewijacn@amazon.com> * Updates per PR feedback Signed-off-by: Tanner Lewis <lewijacn@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update getting-started-data-migration.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _migration-assistant/deploying-migration-assistant/getting-started-data-migration.md Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: Tanner Lewis <lewijacn@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
1 parent e63386b commit 462c9b8

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

_migration-assistant/deploying-migration-assistant/configuration-options.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ The following CDK performs a backfill migrations using RFS:
5151
"endpoint": <TARGET_CLUSTER_ENDPOINT>,
5252
"auth": {
5353
"type": "basic",
54-
"username": <TARGET_CLUSTER_USERNAME>,
55-
"passwordFromSecretArn": <TARGET_CLUSTER_PASSWORD_SECRET>
54+
"userSecretArn": <SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>
5655
}
5756
},
5857
"reindexFromSnapshotServiceEnabled": true,
@@ -93,8 +92,7 @@ The following sample CDK performs a live capture migration with C&R:
9392
"endpoint": <TARGET_CLUSTER_ENDPOINT>,
9493
"auth": {
9594
"type": "basic",
96-
"username": <TARGET_CLUSTER_USERNAME>,
97-
"passwordFromSecretArn": <TARGET_CLUSTER_PASSWORD_SECRET>
95+
"userSecretArn": <SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>
9896
}
9997
},
10098

@@ -155,8 +153,7 @@ Both the source and target cluster can use no authentication, authentication lim
155153
"version": "ES 7.10",
156154
"auth": {
157155
"type": "basic",
158-
"username": <TARGET_CLUSTER_USERNAME>,
159-
"passwordFromSecretArn": <TARGET_CLUSTER_PASSWORD_SECRET>
156+
"userSecretArn": <SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>
160157
}
161158
}
162159
```

_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,14 @@ These commands deploy the following stacks:
106106

107107
Use the following steps to configure and deploy RFS, deploy Migration Assistant, and verify installation of the required stacks:
108108

109-
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.
109+
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:
110+
111+
```json
112+
{"username":"admin","password":"myStrongPassword123!"}
113+
```
114+
115+
Be sure to copy the secret Amazon Resource Name (ARN) for use during deployment.
116+
110117
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:
111118

112119
```json
@@ -118,17 +125,15 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant,
118125
"endpoint": "<TARGET CLUSTER ENDPOINT>",
119126
"auth": {
120127
"type": "basic",
121-
"username": "<TARGET CLUSTER USERNAME>",
122-
"passwordFromSecretArn": "<TARGET CLUSTER PASSWORD SECRET>"
128+
"userSecretArn": "<SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>"
123129
}
124130
},
125131
"sourceCluster": {
126132
"endpoint": "<SOURCE CLUSTER ENDPOINT>",
127133
"version": "<SOURCE ENGINE VERSION>",
128134
"auth": {
129135
"type": "basic",
130-
"username": "<TARGET CLUSTER USERNAME>",
131-
"passwordFromSecretArn": "<TARGET CLUSTER PASSWORD SECRET>"
136+
"userSecretArn": "<SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>"
132137
}
133138
},
134139
"reindexFromSnapshotExtraArgs": "<RFS PARAMETERS (see below)>",

0 commit comments

Comments
 (0)