From 15de6603caeb83ef6d9a615887779939259674a6 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Mon, 11 Sep 2023 16:09:32 +0200 Subject: [PATCH 1/3] Removed the Upgrade to OpenSearch topic --- _redirects | 2 + _toc.yml | 7 +-- .../concepts/opensearch-vs-elasticsearch.rst | 2 + .../opensearch/howto/list-upgrade.rst | 16 ----- .../howto/upgrade-clients-to-opensearch.rst | 3 +- .../howto/upgrade-to-opensearch.rst | 59 ------------------- 6 files changed, 7 insertions(+), 82 deletions(-) delete mode 100644 docs/products/opensearch/howto/list-upgrade.rst delete mode 100644 docs/products/opensearch/howto/upgrade-to-opensearch.rst diff --git a/_redirects b/_redirects index 20e0d6f223..5ee9bbf78e 100644 --- a/_redirects +++ b/_redirects @@ -56,6 +56,8 @@ /docs/products/clickhouse/concepts/databases-and-tables.html /docs/products/clickhouse/howto/manage-databases-tables.html /docs/products/clickhouse/howto/integrate-pg.html /docs/products/clickhouse/howto/integrate-postgresql.html /docs/platform/concepts/byoa.html /docs/platform/concepts/byoc.html +/docs/products/opensearch/howto/list-upgrade /docs/products/opensearch/howto +/docs/products/opensearch/howto/upgrade-to-opensearch /docs/products/opensearch/concepts/opensearch-vs-elasticsearch # Moved to https://aiven.io/developer /docs/tools/terraform/reference/cookbook https://aiven.io/developer/terraform diff --git a/_toc.yml b/_toc.yml index c828787b35..c1efec7d23 100644 --- a/_toc.yml +++ b/_toc.yml @@ -1062,11 +1062,8 @@ entries: entries: - file: docs/products/opensearch/howto/opensearch-log-integration - file: docs/products/opensearch/howto/integrate-with-grafana - - file: docs/products/opensearch/howto/list-upgrade - title: Upgrade to OpenSearch - entries: - - file: docs/products/opensearch/howto/upgrade-to-opensearch - - file: docs/products/opensearch/howto/upgrade-clients-to-opensearch + - file: docs/products/opensearch/howto/upgrade-clients-to-opensearch + title: Upgrade Elasticsearch clients - file: docs/products/opensearch/dashboards title: OpenSearch Dashboards entries: diff --git a/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst b/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst index c48d803502..86066461c1 100644 --- a/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst +++ b/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst @@ -5,6 +5,8 @@ OpenSearch® is the open source continuation of the original Elasticsearch proje The v1.0 release of OpenSearch should be very much similar to the Elasticsearch release that it is based on and Aiven encourages all customers to upgrade at their earliest convenience. This is to ensure that your platforms are in a position to continue to receive upgrades in the future. +To start exploring Aiven for OpenSearch, check out the `Get Started with Aiven for OpenSearch® <../opensearch/getting-started>` . + ----- *Elasticsearch is a trademark of Elasticsearch B.V., registered in the U.S. and in other countries.* diff --git a/docs/products/opensearch/howto/list-upgrade.rst b/docs/products/opensearch/howto/list-upgrade.rst deleted file mode 100644 index 428c8afb01..0000000000 --- a/docs/products/opensearch/howto/list-upgrade.rst +++ /dev/null @@ -1,16 +0,0 @@ -Upgrade to Aiven for OpenSearch® -================================== - -Learn how to upgrade to Aiven for OpenSearch®. - -.. grid:: 1 2 2 2 - - .. grid-item-card:: :doc:`Upgrade to OpenSearch® ` - :shadow: md - :margin: 2 2 0 0 - - .. grid-item-card:: :doc:`Upgrade Elasticsearch clients to OpenSearch® ` - :shadow: md - :margin: 2 2 0 0 - - diff --git a/docs/products/opensearch/howto/upgrade-clients-to-opensearch.rst b/docs/products/opensearch/howto/upgrade-clients-to-opensearch.rst index 69d231bc87..a9c5fdc785 100644 --- a/docs/products/opensearch/howto/upgrade-clients-to-opensearch.rst +++ b/docs/products/opensearch/howto/upgrade-clients-to-opensearch.rst @@ -14,8 +14,7 @@ In order to upgrade the Elasticsearch clients to OpenSearch follow these steps: .. note:: - You can migrate your cluster from Elasticsearch to OpenSearch either before or after switching the clients. Read :doc:`our article ` for more details. - + You can migrate your cluster from Elasticsearch to OpenSearch either before or after switching the clients. What if you can't upgrade immediately? diff --git a/docs/products/opensearch/howto/upgrade-to-opensearch.rst b/docs/products/opensearch/howto/upgrade-to-opensearch.rst deleted file mode 100644 index 43fe79ce55..0000000000 --- a/docs/products/opensearch/howto/upgrade-to-opensearch.rst +++ /dev/null @@ -1,59 +0,0 @@ -Upgrade to OpenSearch® -====================== - -For current Aiven for Elasticsearch customers, we recommend you upgrade as soon as possible so that we can continue to support your database requirements. Depending on your needs, the various options for testing and upgrading the service are detailed here. The upgrade does not require downtime, and any Kibana service alongside Elasticsearch will be upgraded to OpenSearch® Dashboards at the same time. - -.. warning:: - We strongly recommend that you avoid upgrading any library dependencies as part of this upgrade process. Keep your current dependencies at their current versions. - -There are three approaches that you can use to upgrade an existing service: - -* Create a :doc:`fork ` of Aiven for OpenSearch from your existing Aiven for Elasticsearch service. This is a good way to get a fast preview of how Aiven for OpenSearch will work for you. -* Create a fork of Aiven for Elasticsearch from your existing Aiven for Elasticsearch service. This gives you the opportunity to test the process of upgrading an existing Elasticsearch service to OpenSearch without experimenting on your live database. -* Upgrade from Aiven for Elasticsearch to Aiven for OpenSearch to move either a test or production database to the upgraded state. - -The steps for each of these options are detailed in this article. - -Fork an existing Elasticsearch to OpenSearch --------------------------------------------- - -1. In the Elasticsearch service overview on `Aiven Console `_, select **New database fork** to create a new service from a backup. -2. When forking Aiven for Elasticsearch services, there in an additional option to specify the **Service type** as either Elasticsearch or OpenSearch. Choose OpenSearch and give your new service a name. - -Use the new OpenSearch service to test your application against before performing an upgrade. We recommend upgrading any dependencies at the same time. - -Fork an existing Elasticsearch to Elasticsearch ------------------------------------------------ - -The database fork acts as a clone of your existing Elasticsearch service, but allows you to test that an upgrade will run smoothly. - -1. In the service overview of the web console, choose the **New database fork** button to create a new service from a backup. -2. Check that the **Service type** field is set to Elasticsearch and give your new service a name. - -You can use this service to test the upgrade to OpenSearch (instructions in the next section). - -Upgrade from Elasticsearch to OpenSearch ----------------------------------------- - -To perform the upgrade, visit the service overview page and choose the button labelled **Upgrade Elasticsearch**. This operation cannot be reversed. - -When the operation completes, your Aiven for OpenSearch service should continue to operate much as your Elasticsearch service did. - -.. note:: - You can upgrade to OpenSearch® using :doc:`Aiven Provider for Terraform ` as well. - - -More resources --------------- - -Here are some related resources that may help you with your upgrade process - -* :doc:`Understand how OpenSearch relates to Elasticsearch <../concepts/opensearch-vs-elasticsearch>` -* :doc:`Upgrade your application client libraries for OpenSearch ` -* :doc:`Plugins available on for Aiven for OpenSearch <../reference/plugins>` -* :doc:`OpenSearch Dashboards <../dashboards>` as a replacement to Kibana - ------- - -*Elasticsearch is a trademark of Elasticsearch B.V., registered in the U.S. and in other countries.* -*Kibana is a trademark of Elasticsearch BV, registered in the U.S. and in other countries.* From 0390c681922a3ead43ebc6b6acec908562c4b291 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Mon, 11 Sep 2023 16:31:15 +0200 Subject: [PATCH 2/3] Fixed vale error --- .../opensearch/concepts/opensearch-vs-elasticsearch.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst b/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst index 86066461c1..5e00f8684d 100644 --- a/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst +++ b/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst @@ -5,7 +5,7 @@ OpenSearch® is the open source continuation of the original Elasticsearch proje The v1.0 release of OpenSearch should be very much similar to the Elasticsearch release that it is based on and Aiven encourages all customers to upgrade at their earliest convenience. This is to ensure that your platforms are in a position to continue to receive upgrades in the future. -To start exploring Aiven for OpenSearch, check out the `Get Started with Aiven for OpenSearch® <../opensearch/getting-started>` . +To start exploring Aiven for OpenSearch®, check out the :doc:`Get Started with Aiven for OpenSearch® <../getting-started>`. ----- From c9352e51bce36072e52a151143a2ce4e70c030d2 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Fri, 13 Oct 2023 10:30:07 +0200 Subject: [PATCH 3/3] addressed feedback --- .../opensearch/concepts/opensearch-vs-elasticsearch.rst | 2 +- .../products/opensearch/howto/upgrade-clients-to-opensearch.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst b/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst index 5e00f8684d..7c6d76b1b3 100644 --- a/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst +++ b/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.rst @@ -3,7 +3,7 @@ OpenSearch® vs Elasticsearch OpenSearch® is the open source continuation of the original Elasticsearch project. When `Elastic moved to a restrictive license `_, the changes meant that third parties were not able to continue to offer Elasticsearch as a service. The community (including Aiven) joined forces to create and maintain OpenSearch based on the last open source licensed releases of both Elasticsearch and Kibana (v7.10.2). -The v1.0 release of OpenSearch should be very much similar to the Elasticsearch release that it is based on and Aiven encourages all customers to upgrade at their earliest convenience. This is to ensure that your platforms are in a position to continue to receive upgrades in the future. +Version 1.0 release of OpenSearch should be very similar to the Elasticsearch release that it is based on, and Aiven encourages all customers to upgrade at their earliest convenience. This is to ensure that your platforms can continue to receive upgrades in the future. To start exploring Aiven for OpenSearch®, check out the :doc:`Get Started with Aiven for OpenSearch® <../getting-started>`. diff --git a/docs/products/opensearch/howto/upgrade-clients-to-opensearch.rst b/docs/products/opensearch/howto/upgrade-clients-to-opensearch.rst index a9c5fdc785..6e7573534a 100644 --- a/docs/products/opensearch/howto/upgrade-clients-to-opensearch.rst +++ b/docs/products/opensearch/howto/upgrade-clients-to-opensearch.rst @@ -14,7 +14,7 @@ In order to upgrade the Elasticsearch clients to OpenSearch follow these steps: .. note:: - You can migrate your cluster from Elasticsearch to OpenSearch either before or after switching the clients. + You can migrate your cluster from Elasticsearch to OpenSearch either before or after switching the clients. What if you can't upgrade immediately?