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.

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

Add migration phases pages #8828

Merged
merged 31 commits into from
Dec 3, 2024
Merged

Add migration phases pages #8828

merged 31 commits into from
Dec 3, 2024

Conversation

Naarcha-AWS
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS commented Nov 29, 2024

This PR consolidates the migration phases documentation for Migration Assistant into single pages and edits the Migration Console pages.

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.

@Naarcha-AWS Naarcha-AWS added 3 - Tech review PR: Tech review in progress migration backport 2.18 PR: Backport label for 2.18 labels Nov 29, 2024
@Naarcha-AWS Naarcha-AWS self-assigned this Nov 29, 2024
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.

Copy link
Contributor

@sumobrian sumobrian left a comment

Choose a reason for hiding this comment

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

Sugested a change for consistency but no further reviews are needed.


# Verifying tools for migration

Before using the migration assistant, take the following steps to verify that you're cluster is ready for migration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Inconsistent casing. (As a side note, I know we use “Migration Assistant,” but since Migration Assistant is the name of a product, I think we can remove “the” in each of these occurrences. These changes should be applied consistently.)

_migrations/migration-phases/backfill.md Show resolved Hide resolved
_migrations/migration-phases/migrating-metadata.md Outdated Show resolved Hide resolved
_migrations/migration-phases/migrating-metadata.md Outdated Show resolved Hide resolved
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress labels Dec 3, 2024
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/migration-console/index.md Outdated Show resolved Hide resolved
_migrations/migration-console/index.md Outdated Show resolved Hide resolved
### Kafka
The clear all captured traffic from the Kafka topic, the following command can be executed.

This command will result in the loss of any captured traffic data up to this point by the capture proxy and thus should be used with caution.
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
This command will result in the loss of any captured traffic data up to this point by the capture proxy and thus should be used with caution.
This command will result in the loss of any traffic data captured by the capture proxy up to this point and thus should be used with caution.


### Target cluster

To clear non-system indexes from the target cluster that may have been created from testing, the following command can be executed.
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
To clear non-system indexes from the target cluster that may have been created from testing, the following command can be executed.
To clear non-system indexes from the target cluster that may have been created from testing, you can run the following command.

### Target cluster

To clear non-system indexes from the target cluster that may have been created from testing, the following command can be executed.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Line 188: "from" => "as a result of"?


To clear non-system indexes from the target cluster that may have been created from testing, the following command can be executed.

This command will result in the loss of all data on the target cluster and should be used with caution.
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
This command will result in the loss of all data on the target cluster and should be used with caution.
This command will result in the loss of all data in the target cluster and should be used with caution.

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit 1fcf278 into main Dec 3, 2024
6 checks passed
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.18 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.18 2.18
# Navigate to the new working tree
pushd ../.worktrees/backport-2.18
# Create a new branch
git switch --create backport/backport-8828-to-2.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 1fcf2785a8db8d67e7584f359d52e78e0ce96810
# Push it to GitHub
git push --set-upstream origin backport/backport-8828-to-2.18
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.18

Then, create a pull request where the base branch is 2.18 and the compare/head branch is backport/backport-8828-to-2.18.

Naarcha-AWS added a commit that referenced this pull request Dec 3, 2024
* Add first three migration phases pages

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Add backfill page.

Signed-off-by: Archer <[email protected]>

* Update backfill.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Add replayer page.

Signed-off-by: Archer <[email protected]>

* Fix grammar.

Signed-off-by: Archer <[email protected]>

* Add final migration phases page.

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/verifying-tools-for-migration.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/backfill.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Add migration phase links

Signed-off-by: Archer <[email protected]>

* Edit migration console section

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update migrating-metadata.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Rename traffic replacer.

Signed-off-by: Archer <[email protected]>

* Update _migrations/migration-phases/verifying-tools-for-migration.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Add sentence about live traffic capture

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/backfill.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/verifying-tools-for-migration.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/verifying-tools-for-migration.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Add editorial review.

Signed-off-by: Archer <[email protected]>

* Additional editorial comments.

Signed-off-by: Archer <[email protected]>

* Editorial for infra and traffic

Signed-off-by: Archer <[email protected]>

* Editorial comments for using traffic replayer.

Signed-off-by: Archer <[email protected]>

* Add final editorial comments.

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 1fcf278)
Naarcha-AWS added a commit that referenced this pull request Dec 3, 2024
* Add migration phases pages (#8828)

* Add first three migration phases pages

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Add backfill page.

Signed-off-by: Archer <[email protected]>

* Update backfill.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Add replayer page.

Signed-off-by: Archer <[email protected]>

* Fix grammar.

Signed-off-by: Archer <[email protected]>

* Add final migration phases page.

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/verifying-tools-for-migration.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/backfill.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Add migration phase links

Signed-off-by: Archer <[email protected]>

* Edit migration console section

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update migrating-metadata.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Rename traffic replacer.

Signed-off-by: Archer <[email protected]>

* Update _migrations/migration-phases/verifying-tools-for-migration.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Add sentence about live traffic capture

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/backfill.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/verifying-tools-for-migration.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _migrations/migration-phases/verifying-tools-for-migration.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Add editorial review.

Signed-off-by: Archer <[email protected]>

* Additional editorial comments.

Signed-off-by: Archer <[email protected]>

* Editorial for infra and traffic

Signed-off-by: Archer <[email protected]>

* Editorial comments for using traffic replayer.

Signed-off-by: Archer <[email protected]>

* Add final editorial comments.

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 1fcf278)

* Update getting-started-data-migration.md

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS deleted the migration-phases branch December 19, 2024 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress backport 2.18 PR: Backport label for 2.18 migration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants