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

Add Migrations - Capture and Replay release documentation #4991

Merged
merged 5 commits into from
Sep 12, 2023
Merged

Add Migrations - Capture and Replay release documentation #4991

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b5b8610
Add Migrations - Capture and Replay release documentation
sumobrian Sep 8, 2023
98fc51c
Merge branch 'main' into migrations-tooling-v0.1-capture-and-replay
Naarcha-AWS Sep 11, 2023
f20d0b7
Merge branch 'main' into migrations-tooling-v0.1-capture-and-replay
Naarcha-AWS Sep 12, 2023
ea9a9dd
Apply suggestions from code review
Naarcha-AWS Sep 12, 2023
d84a381
Apply suggestions from code review
Naarcha-AWS Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _install-and-configure/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,6 @@ After you've installed OpenSearch, learn about [configuring]({{site.url}}{{site.

For more information about upgrading your OpenSearch cluster, see the [upgrade guide]({{site.url}}{{site.baseurl}}/install-and-configure/upgrade-opensearch/index/).

For tools to aid in upgrades, see [OpenSearch upgrade, migration, and comparison tools]({{site.url}}{{site.baseurl}}/tools/index/#opensearch-upgrade-migration-and-comparison-tools).
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

For plugin installation, see [Installing plugins]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/).
15 changes: 14 additions & 1 deletion _tools/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This section provides documentation for OpenSearch-supported tools, including:
- [Agents and ingestion tools](#agents-and-ingestion-tools)
- [OpenSearch CLI](#opensearch-cli)
- [OpenSearch Kubernetes operator](#opensearch-kubernetes-operator)
- [OpenSearch upgrade, migration, and comparison tools](#opensearch-upgrade-migration-and-comparison-tools)

For information about Data Prepper, the server-side data collector for filtering, enriching, transforming, normalizing, and aggregating data for downstream analytics and visualization, see [Data Prepper]({{site.url}}{{site.baseurl}}/data-prepper/index/).

Expand Down Expand Up @@ -110,4 +111,16 @@ The OpenSearch CLI command line interface (opensearch-cli) lets you manage your

## OpenSearch Kubernetes operator
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
## OpenSearch Kubernetes operator
## OpenSearch Kubernetes Operator


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/)
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/)
Copy link
Collaborator

Choose a reason for hiding this comment

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

"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.

Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

## 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.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ideally, the noun would follow "deploy". Deploy your [noun] to AWS.


After set up and deployment of the migration’s tools and test environment, you can perform the following steps to begin migrating your OpenSearch target cluster:
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

1. Redirect your production traffic from a source cluster to a provisioned OpenSearch target cluster, enabling a comparison of results between the two clusters. All traffic directed to the source cluster is stored for future replay.

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).
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

Capitalizing "migration" implies that we have an offering called "OpenSearch Migration".

2 changes: 2 additions & 0 deletions _upgrade-to/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Regardless of your approach, to safeguard against data loss, we recommend that y

If your existing clients include a version check, such as recent versions of Logstash OSS and Filebeat OSS, [check compatibility]({{site.url}}{{site.baseurl}}/tools/index/#compatibility-matrices) before upgrading.

For details on tools to help in migrating to OpenSearch, see [OpenSearch upgrade, migration, and comparison tools]({{site.url}}{{site.baseurl}}/tools/index/#opensearch-upgrade-migration-and-comparison-tools)
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

## Upgrading from Open Distro

For steps to upgrade from Open Distro to OpenSearch, refer to the blog post [How To: Upgrade from Open Distro to OpenSearch](https://opensearch.org/blog/technical-posts/2021/07/how-to-upgrade-from-opendistro-to-opensearch/).