From b024b6ccc2e81abab6d07771bd145f71c1ada3c3 Mon Sep 17 00:00:00 2001 From: Brian Presley <42596015+sumobrian@users.noreply.github.com> Date: Tue, 12 Sep 2023 14:17:32 -0500 Subject: [PATCH] Add Migrations - Capture and Replay release documentation (#4991) * Add Migrations - Capture and Replay release documentation Signed-off-by: Brian Presley * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Brian Presley Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Brian Presley Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower --- _install-and-configure/index.md | 2 ++ _tools/index.md | 15 ++++++++++++++- _upgrade-to/index.md | 2 ++ 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/_install-and-configure/index.md b/_install-and-configure/index.md index a61cc1b1..d5f8269c 100644 --- a/_install-and-configure/index.md +++ b/_install-and-configure/index.md @@ -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 information about upgrade tools, see [OpenSearch upgrade, migration, and comparison tools]({{site.url}}{{site.baseurl}}/tools/index/#opensearch-upgrade-migration-and-comparison-tools). + For plugin installation, see [Installing plugins]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/). \ No newline at end of file diff --git a/_tools/index.md b/_tools/index.md index 517d2b35..1e4a4b64 100644 --- a/_tools/index.md +++ b/_tools/index.md @@ -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/). @@ -110,4 +111,16 @@ The OpenSearch CLI command line interface (opensearch-cli) lets you manage your ## 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/) \ No newline at end of file +The OpenSearch Kubernetes 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 operator, see [OpenSearch Kubernetes Operator]({{site.url}}{{site.baseurl}}/tools/k8s-operator/). + +## OpenSearch upgrade, migration, and comparison tools + +OpenSearch migration tools facilitate migrations to OpenSearch and upgrades to newer versions 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. + + After setup and deployment of the migration’s tools and test environment, you can perform the following steps to begin migrating your OpenSearch target cluster: + +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). \ No newline at end of file diff --git a/_upgrade-to/index.md b/_upgrade-to/index.md index c6ac302f..f870ddc5 100644 --- a/_upgrade-to/index.md +++ b/_upgrade-to/index.md @@ -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 more information about OpenSearch migration tools, see [OpenSearch upgrade, migration, and comparison tools]({{site.url}}{{site.baseurl}}/tools/index/#opensearch-upgrade-migration-and-comparison-tools). + ## 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/). \ No newline at end of file