Update Migration Assistant basic auth secret format documentation #10186
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Tanner Lewis <lewijacn@amazon.com>
lewijacn
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable,
epugh and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
2 tasks
sumobrian
approved these changes
Jul 3, 2025
| @@ -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. | |||
There was a problem hiding this comment.
- Remove Secrets cap and bold type
- Lowercase "Key"
- Lowercase "Plaintext
|
Waiting on dependent change before merging: opensearch-project/opensearch-migrations#1620 |
Signed-off-by: Tanner Lewis <lewijacn@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates documentation for using basic auth with the Migration Assistant after updating the expected AWS SecretsManager secret format to use Key/value pairs now
Issues Resolved
Dependent on change from: opensearch-project/opensearch-migrations#1620
Version
Migration Assistant
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.