Add Migrations - Capture and Replay release documentation #4991
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: Brian Presley <[email protected]>
sumobrian
requested review from
cwillum,
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
Naarcha-AWS
requested changes
Sep 12, 2023
Naarcha-AWS
added
4 - Doc review
|
Reviewed these changes. They look good to me. One optional change is that I would update the github URL to point to the specific release branch: https://github.com/opensearch-project/opensearch-migrations/tree/capture-and-replay-v0.1.0 |
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
approved these changes
Sep 12, 2023
natebower
reviewed
Sep 12, 2023
There was a problem hiding this comment.
@Naarcha-AWS @sumobrian Please see my comments and changes and let me know if you have any questions. Thanks!
_tools/index.md
Outdated
| The OpenSearch Kubernetes (K8s) Operator is an open-source Kubernetes operator that helps automate the deployment and provisioning of OpenSearch and OpenSearch Dashboards in a containerized environment. For information about how to use the K8s operator, see [OpenSearch Kubernetes operator]({{site.url}}{{site.baseurl}}/tools/k8s-operator/) |
There was a problem hiding this comment.
"Operator" is capitalized as part of the name in the documentation (https://opensearch.org/docs/latest/tools/k8s-operator/), so I've followed suit here. Also, the page this links to does not actually have a title.
_tools/index.md
Outdated
| ## OpenSearch upgrade, migration, and comparison tools | ||
|
|
||
| The OpenSearch Migration tools facilitate migrations to OpenSearch and upgrades to newer version of OpenSearch. These can help you can set up a proof-of-concept environment locally using Docker containers or deploy to AWS using a one-click deployment script. This empowers you to fine-tune cluster configurations and manage workloads more effectively before migration. |
There was a problem hiding this comment.
Ideally, the noun would follow "deploy". Deploy your [noun] to AWS.
_tools/index.md
Outdated
| 2. Meanwhile, traffic to the target cluster is replayed at an identical rate to ensure a direct comparison between the source cluster and the target. | ||
|
|
||
| For more information about OpenSearch Migration tools, see the documentation in the [OpenSearch Migration GitHub repository](https://github.com/opensearch-project/opensearch-migrations/tree/capture-and-replay-v0.1.0). |
There was a problem hiding this comment.
Capitalizing "migration" implies that we have an offering called "OpenSearch Migration".
| @@ -110,4 +111,16 @@ The OpenSearch CLI command line interface (opensearch-cli) lets you manage your | |||
|
|
|||
| ## OpenSearch Kubernetes operator | |||
There was a problem hiding this comment.
Suggested change
| ## OpenSearch Kubernetes operator | |
| ## OpenSearch Kubernetes Operator |
Naarcha-AWS
added
5 - Editorial review
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 12, 2023
* Add Migrations - Capture and Replay release documentation Signed-off-by: Brian Presley <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Brian Presley <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Brian Presley <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit b024b6c) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS
added a commit
that referenced
this pull request
Sep 12, 2023
) * Add Migrations - Capture and Replay release documentation * Apply suggestions from code review * Apply suggestions from code review --------- (cherry picked from commit b024b6c) Signed-off-by: Brian Presley <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Brian Presley <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
vagimeli
pushed a commit
that referenced
this pull request
Sep 19, 2023
* Add Migrations - Capture and Replay release documentation Signed-off-by: Brian Presley <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Brian Presley <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Brian Presley <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
vagimeli
added a commit
that referenced
this pull request
Sep 19, 2023
)" This reverts commit 815a191.
harshavamsi
pushed a commit
to harshavamsi/documentation-website
that referenced
this pull request
Oct 31, 2023
…-project#4991) * Add Migrations - Capture and Replay release documentation Signed-off-by: Brian Presley <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Brian Presley <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Brian Presley <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
vagimeli
pushed a commit
that referenced
this pull request
Dec 21, 2023
* Add Migrations - Capture and Replay release documentation Signed-off-by: Brian Presley <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Brian Presley <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Brian Presley <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
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
This PR provides the initial documentation for the first Migrations release. The release is the first release in a series of incremental releases leading up to a 1.0 release.
Issues Resolved
Fixes #4855
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.