From b5b86101da7090f74f615943af41da59f660e07e Mon Sep 17 00:00:00 2001 From: Brian Presley Date: Thu, 7 Sep 2023 21:13:00 -0500 Subject: [PATCH 1/3] Add Migrations - Capture and Replay release documentation Signed-off-by: Brian Presley --- _install-and-configure/index.md | 2 ++ _tools/index.md | 7 ++++++- _upgrade-to/index.md | 2 ++ 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/_install-and-configure/index.md b/_install-and-configure/index.md index a61cc1b1a6..4e927fb572 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 tools to aid in upgrades, 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 517d2b35f5..61c10cff7a 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,8 @@ 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 (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/) + +## OpenSearch upgrade, migration, and comparison tools + +OpenSearch migration tooling facilitates OpenSearch migrations and upgrades. With these tools, you can set up a proof-of-concept environment locally using Docker containers or deploy to AWS using a one-click deployment script. Once set up and deployed, users can redirect their production traffic from a source cluster to a provisioned target cluster, enabling a comparison of results between the two clusters. All traffic directed to the source cluster is stored for future replay. Meanwhile, traffic to the target cluster is replayed at an identical rate to ensure a direct "apple-to-apple" comparison. This toolset empowers users to fine-tune cluster configurations and manage workloads more effectively. For more information, consult the documentation in the [OpenSearch Migration GitHub repository](https://github.com/opensearch-project/opensearch-migrations). \ No newline at end of file diff --git a/_upgrade-to/index.md b/_upgrade-to/index.md index c6ac302fca..1d6b0445ab 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 tools to aid in migrations, 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 From ea9a9dde48c7a4503c030c279f99f2e942ed2afe Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 12 Sep 2023 12:21:06 -0500 Subject: [PATCH 2/3] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _tools/index.md | 12 ++++++++++-- _upgrade-to/index.md | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/_tools/index.md b/_tools/index.md index 61c10cff7a..82a50d3c01 100644 --- a/_tools/index.md +++ b/_tools/index.md @@ -111,8 +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/) +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/) ## OpenSearch upgrade, migration, and comparison tools -OpenSearch migration tooling facilitates OpenSearch migrations and upgrades. With these tools, you can set up a proof-of-concept environment locally using Docker containers or deploy to AWS using a one-click deployment script. Once set up and deployed, users can redirect their production traffic from a source cluster to a provisioned target cluster, enabling a comparison of results between the two clusters. All traffic directed to the source cluster is stored for future replay. Meanwhile, traffic to the target cluster is replayed at an identical rate to ensure a direct "apple-to-apple" comparison. This toolset empowers users to fine-tune cluster configurations and manage workloads more effectively. For more information, consult the documentation in the [OpenSearch Migration GitHub repository](https://github.com/opensearch-project/opensearch-migrations). \ No newline at end of file +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. + + 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: + +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 1d6b0445ab..29f1b8c49a 100644 --- a/_upgrade-to/index.md +++ b/_upgrade-to/index.md @@ -21,7 +21,7 @@ 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 tools to aid in migrations, see [OpenSearch upgrade, migration, and comparison tools]({{site.url}}{{site.baseurl}}/tools/index/#opensearch-upgrade-migration-and-comparison-tools) +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) ## Upgrading from Open Distro From d84a381e260d835198cf6adb60a8e6e8c63f6aa8 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 12 Sep 2023 14:17:12 -0500 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _install-and-configure/index.md | 2 +- _tools/index.md | 8 ++++---- _upgrade-to/index.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/_install-and-configure/index.md b/_install-and-configure/index.md index 4e927fb572..d5f8269c5c 100644 --- a/_install-and-configure/index.md +++ b/_install-and-configure/index.md @@ -27,6 +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). +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 82a50d3c01..1e4a4b6499 100644 --- a/_tools/index.md +++ b/_tools/index.md @@ -111,16 +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/) +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 -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. +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 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: + 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 +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 29f1b8c49a..f870ddc524 100644 --- a/_upgrade-to/index.md +++ b/_upgrade-to/index.md @@ -21,7 +21,7 @@ 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) +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