Add instructions for deploying migration assistant. #8798
Merged
Conversation
This file contains 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: Archer <naarcha@amazon.com>
Naarcha-AWS
requested review from
kolchfa-aws,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
epugh
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. |
peternied
approved these changes
Nov 22, 2024
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
commented
Nov 25, 2024
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
commented
Nov 25, 2024
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
commented
Nov 25, 2024
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
commented
Nov 25, 2024
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Peter Nied <petern@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
added
4 - Doc review
natebower
approved these changes
Nov 26, 2024
There was a problem hiding this comment.
@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!
| Each of these migrations may depend on either a snapshot or a capture proxy. The CDK context blocks below are shown as separate context blocks for each migration type for simplicity. If performing multiple migration types, combine these options, as the actual execution of each migration is controlled from the Migration Console. | ||
| 1. **Metadata migration** | ||
| 2. **Backfill migration with `Reindex-from-Snapshot` (RFS)** | ||
| 3. **Live capture migration with Capture and Replay (C&R)** |
There was a problem hiding this comment.
In the intro file, we do not use C&R as an abbreviation for "Capture and Replay". Please make consistent across files.
There was a problem hiding this comment.
Switched to capitalized.
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
|
|
||
| ## Metadata Migration Options | ||
| For a complete list of configuration options, see [opensearch-migrations-options.md](https://github.com/opensearch-project/opensearch-migrations/blob/main/deployment/cdk/opensearch-service-migration/options.md). If there is a configuration option you would like that is not found on this page, open an issue in OpenSearch Migrations repository. | ||
| {: .tip } |
There was a problem hiding this comment.
Line 19: We should probably provide a link to the repo.
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
_migrations/deploying-migration-assistant/iam-and-security-groups-for-existing-clusters.md
Outdated
Show resolved
Hide resolved
|
|
||
| For an OpenSearch Domain, two main configurations are typically required to ensure proper functioning of the migration solution: | ||
|
|
||
| 1. **Security Group Configuration**: | ||
| The Domain should have a security group that allows communication from the applicable Migration services (Traffic Replayer, Migration Console, Reindex-from-Snapshot). The CDK will automatically create an `osClusterAccessSG` security group, which is applied to the Migration services. The user should then add this security group to their existing Domain to allow access. | ||
| 1. **Security Group Configuration** |
There was a problem hiding this comment.
Should this be in sentence case (fine as is if it's a UI element that's capitalized)?
There was a problem hiding this comment.
These are UI elements.
_migrations/deploying-migration-assistant/iam-and-security-groups-for-existing-clusters.md
Outdated
Show resolved
Hide resolved
| 1. **Security Group Configuration**: | ||
| The Domain should have a security group that allows communication from the applicable Migration services (Traffic Replayer, Migration Console, Reindex-from-Snapshot). The CDK will automatically create an `osClusterAccessSG` security group, which is applied to the Migration services. The user should then add this security group to their existing Domain to allow access. | ||
| 1. **Security Group Configuration** | ||
|
|
There was a problem hiding this comment.
To the best of my knowledge, "domain" is not capitalized as a proper noun. Please lowercase across this and the other files.
Naarcha-AWS
added
migration
5 - Editorial review
…s.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
commented
Nov 26, 2024
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
commented
Nov 26, 2024
_migrations/deploying-migration-assistant/configuration-options.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Dec 2, 2024
* Add instructions for deploying migration assistant. Signed-off-by: Archer <naarcha@amazon.com> * Apply suggestions from code review Co-authored-by: Peter Nied <petern@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix typos Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _migrations/deploying-migration-assistant/configuration-options.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Archer <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Peter Nied <petern@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit 6acaba1) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.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.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.