Skip to content
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

Jump to bottom

Update MA getting started #8797

Merged
merged 10 commits into from
Nov 27, 2024
Merged

Update MA getting started #8797

merged 10 commits into from
Nov 27, 2024

Conversation

Naarcha-AWS
Copy link
Collaborator

Edits the Migration assistant getting started page. This PR makes the following modifications:

  • Renames Quickstart to Getting started. Because use of the tool takes more than 30 minutes, I wouldn't define this as a "Quickstart".
  • Adds explanatory text for commands.
  • Reworks formatting.
  • Add brackets for future cross-links (will handle cross-links during the final PR publishing this section.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions GitHub Actions
Copy link

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
peternied reviewed Nov 22, 2024
View reviewed changes
Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making these changes. Overall looks great, I've weight in mostly around refining the 'technical' details.

I've made a couple of comments with [Editorial] where I suspect you'll have a better sense of any rewriting if needed.

_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
@Naarcha-AWS @peternied
Apply suggestions from code review
1d9408c 
Co-authored-by: Peter Nied <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
peternied
peternied approved these changes Nov 22, 2024
View reviewed changes
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Nov 26, 2024
natebower
natebower approved these changes Nov 26, 2024
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated Show resolved Hide resolved
_migrations/getting-started-data-migration.md Outdated
Before utilizing this quickstart, make sure you fulfill the following prerequisites:

* Verify your that migration path [is supported](https://opensearch.org/docs/latest/migrations/is-migration-assistant-right-for-you/#supported-migration-paths). Note that we test with the exact versions specified, but you should be able to migrate data on alternative minor versions as long as the major version is supported.
* The source cluster must be deployed with the S3 plugin.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the actual name of the plugin, or should it be "Amazon S3 plugin" or "Amazon Simple Storage Service (Amazon S3) plugin"? In other words, ensure that we use the actual name of the plugin.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets use the name.

_migrations/getting-started-data-migration.md Outdated
Shards unclaimed: 5
```

Logs and metrics are available in CloudWatch under the `OpenSearchMigrations` log group.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Logs and metrics are available in CloudWatch under the `OpenSearchMigrations` log group.
Logs and metrics are available in Amazon CloudWatch in the `OpenSearchMigrations` log group.

_migrations/getting-started-data-migration.md Outdated

---

## Step 12: Verify all documents were migrated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Step 12: Verify all documents were migrated
## Step 12: Verify that all documents were migrated

_migrations/getting-started-data-migration.md Outdated

## Step 12: Verify all documents were migrated

Use the following query in CloudWatch logs insights to identify failed documents:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use the following query in CloudWatch logs insights to identify failed documents:
Use the following query in CloudWatch Logs Insights to identify failed documents:

_migrations/getting-started-data-migration.md Outdated
| limit 10000
```

If any failed documents are identified, you can index the failed documents directly, as opposed to using RFS.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If any failed documents are identified, you can index the failed documents directly, as opposed to using RFS.
If any failed documents are identified, you can index the failed documents directly as opposed to using RFS.

_migrations/getting-started-data-migration.md

If any failed documents are identified, you can index the failed documents directly, as opposed to using RFS.

For more information, see [Backfill migration].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add link

Naarcha-AWS
Naarcha-AWS commented Nov 26, 2024
View reviewed changes
_migrations/getting-started-data-migration.md Outdated

These commands deploy the following stacks:

* Migration assistant network stack
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Migration assistant network stack
* Migration Assistant network stack

Naarcha-AWS
Naarcha-AWS commented Nov 26, 2024
View reviewed changes
_migrations/getting-started-data-migration.md Outdated
console backfill start
```

2. _(Optional)_ To speed up the migration, increase the number of documents processed at a time by using the following command:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. _(Optional)_ To speed up the migration, increase the number of documents processed at a time by using the following command:
2. _(Optional)_ To speed up the migration, increase the number of documents processed at a simultaneously by using the following command:

@Naarcha-AWS @natebower
Apply suggestions from code review
33fd044 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS @natebower
Apply suggestions from code review
42d8273 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit 8cd95c2 into main Nov 27, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natebower natebower natebower approved these changes

@peternied peternied peternied approved these changes

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@vagimeli vagimeli Awaiting requested review from vagimeli

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@epugh epugh Awaiting requested review from epugh epugh is a code owner

Assignees

@sumobrian sumobrian

@Naarcha-AWS Naarcha-AWS

Labels
5 - Editorial review PR: Editorial review in progress migration
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Naarcha-AWS @peternied @natebower @sumobrian