From 087290c9e0b918b899b49a7573865a23433dd217 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 11 Jun 2020 17:48:18 -0500 Subject: [PATCH] Fix ES versions --- src/_data/toc/configuration-guide.yml | 3 -- src/_includes/layout/page-header.html | 2 +- .../comp-mgr/prereq/prereq-elasticsearch.md | 36 ++++++------------- .../elasticsearch/es-downgrade.md | 36 ------------------- .../config-guide/elasticsearch/es-overview.md | 6 +--- .../v2.4/install-gde/prereq/elasticsearch.md | 8 ++--- .../install-gde/system-requirements-tech.md | 15 +++----- .../backward-incompatible-changes/index.md | 19 +++------- 8 files changed, 24 insertions(+), 101 deletions(-) delete mode 100644 src/guides/v2.4/config-guide/elasticsearch/es-downgrade.md diff --git a/src/_data/toc/configuration-guide.yml b/src/_data/toc/configuration-guide.yml index b78ba691976..5a2740d9977 100644 --- a/src/_data/toc/configuration-guide.yml +++ b/src/_data/toc/configuration-guide.yml @@ -322,9 +322,6 @@ pages: - label: Configure Magento to use Elasticsearch url: /config-guide/elasticsearch/configure-magento.html - - - label: Change the Elasticsearch client - url: /config-guide/elasticsearch/es-downgrade.html - label: Message Queues url: /config-guide/mq/rabbitmq-overview.html diff --git a/src/_includes/layout/page-header.html b/src/_includes/layout/page-header.html index fb6c5f750dc..000ecfc7546 100644 --- a/src/_includes/layout/page-header.html +++ b/src/_includes/layout/page-header.html @@ -21,7 +21,7 @@ {% if page.url contains "guides/v2.4/comp-mgr/" %}
- You must install and configure Elasticsearch 6.x or 7.x before upgrading to {{ site.data.var.ee }} or {{ site.data.var.ce }} 2.4.0. See Check the catalog search engine for details. + You must install and configure Elasticsearch 7.6.x before upgrading to {{ site.data.var.ee }} or {{ site.data.var.ce }} 2.4.0. See Check the catalog search engine for details.
{% endif %} diff --git a/src/guides/v2.4/comp-mgr/prereq/prereq-elasticsearch.md b/src/guides/v2.4/comp-mgr/prereq/prereq-elasticsearch.md index 4ba5200f848..c77203d8f46 100644 --- a/src/guides/v2.4/comp-mgr/prereq/prereq-elasticsearch.md +++ b/src/guides/v2.4/comp-mgr/prereq/prereq-elasticsearch.md @@ -9,47 +9,33 @@ Before you upgrade from Magento 2.3.x to Magento 2.4, you must check whether you You can use the CLI or the Admin to determine your catalog search engine: -* Enter the `bin/magento config:show catalog/search/engine` command. The command returns a value of `mysql`, `elasticsearch` (which indicates Elasticsearch 2 is configured), `elasticsearch5`, `elasticsearch6`, `elasticsearch7`, or a custom value, indicating you have installed a third-party search engine. +- Enter the `bin/magento config:show catalog/search/engine` command. The command returns a value of `mysql`, `elasticsearch` (which indicates Elasticsearch 2 is configured), `elasticsearch5`, `elasticsearch6`, `elasticsearch7`, or a custom value, indicating you have installed a third-party search engine. -* From the Admin, check the value of the **Stores** > Settings > **Configuration** > **Catalog** > **Catalog** > **Catalog Search** > **Search Engine** field. +- From the Admin, check the value of the **Stores** > Settings > **Configuration** > **Catalog** > **Catalog** > **Catalog Search** > **Search Engine** field. -The following sections describe what actions you must take before upgrading to Magento 2.4. +The following sections describe what actions you must take before upgrading to Magento 2.4.0. ## MySQL -Magento 2.4 does not support MySQL as a catalog search engine. You must install and configure Elasticsearch 7.x or 6.x before upgrading. Use the following resources to help guide you through this process: +Magento 2.4 does not support MySQL as a catalog search engine. You must install and configure Elasticsearch 7.6.x before upgrading. Use the following resources to help guide you through this process: -* [Install and configure Elasticsearch]({{site.baseurl}}/guides/v2.3/config-guide/elasticsearch/es-overview.html) -* [Installing Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html) -* Configure Elasticsearch to work with [nginx]({{site.baseurl}}/guides/v2.3/config-guide/elasticsearch/es-config-nginx.html) or [Apache]({{site.baseurl}}/guides/v2.3/config-guide/elasticsearch/es-config-apache.html) -* [Configure Magento to use Elasticsearch]({{site.baseurl}}/guides/v2.3/config-guide/elasticsearch/configure-magento.html) and reindex +- [Install and configure Elasticsearch]({{ page.baseurl }}/config-guide/elasticsearch/es-overview.html) +- [Installing Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html) +- Configure Elasticsearch to work with [nginx]({{ page.baseurl }}/config-guide/elasticsearch/es-config-nginx.html) or [Apache]({{ page.baseurl }}/config-guide/elasticsearch/es-config-apache.html) +- [Configure Magento to use Elasticsearch]({{ page.baseurl }}/config-guide/elasticsearch/configure-magento.html) and reindex Some third-party catalog search engines run on top of Magento's search engine. Contact your vendor to determine whether you need to update your extension. -## Elasticsearch 2 +## Elasticsearch -Magento does not support Elasticsearch 2. You must update to a more recent version. Elasticsearch 7 is recommended. +You must install and configure Elasticsearch 7.6.x before upgrading to Magento 2.4.0. Magento does not support Elasticsearch 2.x, 5.x, and 6.x. Refer to [Upgrading Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html) for full instructions on backing up your data, detecting potential migration issues, and testing upgrades before deploying to production. Depending on your current version of Elasticsearch, a full cluster restart may or may not be required. {:.bs-callout-info} Elasticsearch requires JDK 1.8 or higher. See [Install the Java Software Development Kit (JDK)]({{page.baseurl}}/install-gde/prereq/elasticsearch.html#prereq-java) to check which version of JDK is installed. -[Configure Magento to use Elasticsearch]({{site.baseurl}}/guides/v2.3/config-guide/elasticsearch/configure-magento.html) describes the tasks you must perform after updating Elasticsearch 2 to a supported version. - -## Elasticsearch 5 - -Elasticsearch 5 has reached its [End of Life](https://www.elastic.co/support/eol), and Magento support for Elasticsearch 5 has been deprecated. - -Although you can upgrade to Magento 2.4 without updating Elasticsearch 5, Magento recommends that you update to Elasticsearch 7. - -Refer to [Upgrading Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html) for full instructions on backing up your data, detecting potential migration issues, and testing upgrades before deploying to production. Depending on your current version of Elasticsearch, a full cluster restart may or may not be required. - -[Configure Magento to use Elasticsearch]({{site.baseurl}}/guides/v2.3/config-guide/elasticsearch/configure-magento.html) describes the tasks you must perform after updating Elasticsearch 5. - -## Elasticsearch 6 or 7 - -If you are using Elasticsearch 6 or 7 as your catalog search engine, you are not required to perform any additional steps before upgrading to Magento 2.4. +[Configure Magento to use Elasticsearch]({{ page.baseurl }}/config-guide/elasticsearch/configure-magento.html) describes the tasks you must perform after updating Elasticsearch 2 to a supported version. ## Third-party extensions diff --git a/src/guides/v2.4/config-guide/elasticsearch/es-downgrade.md b/src/guides/v2.4/config-guide/elasticsearch/es-downgrade.md deleted file mode 100644 index f8eeddb2c87..00000000000 --- a/src/guides/v2.4/config-guide/elasticsearch/es-downgrade.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -group: configuration-guide -title: Change the Elasticsearch Client -functional_areas: - - Configuration - - Search - - System - - Setup ---- - -Magento 2.4 requires Elasticsearch 6.x or 7.x. Magento, but expects Elasticseach 7.x by default. If you have installed Elasticsearch 6.x, you might need to downgrade the PHP package to ensure compatibility. - -{:.bs-callout-info} -Both Elasticsearch 2.x and 5.x are [End of Life][] and are no longer supported in Magento. - -## Change the Elasticsearch Client version - -1. To change the package to Elasticsearch 6.8.x, run the following command: - - ```bash - composer require "elasticsearch/elasticsearch:~6.8" - ``` - - To change the package back to Elasticsearch 7.1.x, run the following command: - - ```bash - composer require "elasticsearch/elasticsearch:~7.1" - ``` - -1. Then configure Elasticsearch within [Magento Admin][]. - - - -[End of Life]: https://www.elastic.co/support/eol -[PHP client]: https://github.com/elastic/elasticsearch-php -[Magento Admin]: https://docs.magento.com/m2/ee/user_guide/catalog/search-elasticsearch.html diff --git a/src/guides/v2.4/config-guide/elasticsearch/es-overview.md b/src/guides/v2.4/config-guide/elasticsearch/es-overview.md index 57ae0885222..a006fe57e16 100644 --- a/src/guides/v2.4/config-guide/elasticsearch/es-overview.md +++ b/src/guides/v2.4/config-guide/elasticsearch/es-overview.md @@ -8,18 +8,16 @@ functional_areas: - Setup --- -As of version 2.4.0, Magento requires [Elasticsearch][] to be the catalog search engine. Refer to the following topics for details about installing Elasticsearch and initial configuration: +As of version 2.4, Magento requires [Elasticsearch][] to be the catalog search engine. Refer to the following topics for details about installing Elasticsearch and initial configuration: * [Elasticsearch prerequisites][] * [Configure nginx and Elasticsearch][] * [Configure Apache and Elasticsearch][] -* [Setup Wizard installation][] * [Install the Magento software][] (command line interface) After you install and integrate Elasticsearch with Magento, you might need to perform additional maintenance: * [Configure Elasticsearch stopwords][] -* [Change the Elasticsearch Client][] * [Configure Magento to use Elasticsearch][] ## Additional resources {#es-resources} @@ -34,6 +32,4 @@ For additional information, see the [Elasticsearch documentation][] [Elasticsearch]: https://www.elastic.co [Configure Magento to use Elasticsearch]: {{page.baseurl}}/config-guide/elasticsearch/configure-magento.html [Elasticsearch documentation]: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html -[Change the Elasticsearch Client]: {{page.baseurl}}/config-guide/elasticsearch/es-downgrade.html -[Setup Wizard installation]: {{page.baseurl}}/install-gde/install/web/install-web.html [Install the Magento software]: {{page.baseurl}}/install-gde/install/cli/install-cli-install.html diff --git a/src/guides/v2.4/install-gde/prereq/elasticsearch.md b/src/guides/v2.4/install-gde/prereq/elasticsearch.md index 8097fcbcac2..b2670c393b2 100644 --- a/src/guides/v2.4/install-gde/prereq/elasticsearch.md +++ b/src/guides/v2.4/install-gde/prereq/elasticsearch.md @@ -23,10 +23,10 @@ As of Magento 2.4, all installations must be configured to use [Elasticsearch][] ## Supported versions {#es-spt-versions} -Magento version 2.4 supports the following Elasticsearch versions: +You must install and configure Elasticsearch 7.6.x before upgrading to Magento 2.4.0. -* Elasticsearch 7.x.x -* Elasticsearch 6.8.x +{:.bs-callout-info} +Magento does not support Elasticsearch 2.x, 5.x, and 6.x. ## Recommended configuration {#es-arch} @@ -116,9 +116,7 @@ For additional information, see [Elasticsearch documentation][]{:target="_blank" [Elasticsearch clustering documentation]: https://www.elastic.co/guide/en/elasticsearch/guide/current/distributed-cluster.html [Elasticsearch Ubuntu documentation]: https://www.elastic.co/guide/en/elasticsearch/reference/current/deb.html [Configuring Elasticsearch]: https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html -[End of Life]: https://www.elastic.co/support/eol [Upgrading Elasticsearch]: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html [Full cluster restart upgrade]: https://www.elastic.co/guide/en/elasticsearch/reference/current/restart-upgrade.html [Elasticsearch documentation]: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html -[Change Elasticsearch Client]: {{page.baseurl}}/config-guide/elasticsearch/es-downgrade.html [Installing Elasticsearch]: https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html diff --git a/src/guides/v2.4/install-gde/system-requirements-tech.md b/src/guides/v2.4/install-gde/system-requirements-tech.md index 13e66dedf1f..663e8f5c38e 100644 --- a/src/guides/v2.4/install-gde/system-requirements-tech.md +++ b/src/guides/v2.4/install-gde/system-requirements-tech.md @@ -77,16 +77,10 @@ For more information, see [Required PHP settings][]. ## Elasticsearch -* As of Magento 2.4.0, MySQL is no longer used for search. You must use [Elasticsearch]({{page.baseurl}}/install-gde/prereq/elasticsearch.html). The following Elasticsearch versions are supported: +As of Magento 2.4.0, MySQL is no longer used for search. You must use [Elasticsearch]({{page.baseurl}}/install-gde/prereq/elasticsearch.html). Magento supports Elasticsearch 7.6.x. - * Elasticsearch 7.x - - * Elasticsearch 6.x (6.8 or higher is recommended) - - {:.bs-callout-warning} - Magento no longer provides support for Elasticsearch [2.x and 5.x][] as they are End of Life. - - Follow the instructions in [Change Elasticsearch Module][]. +{:.bs-callout-warning} +Magento no longer supports Elasticsearch [2.x, 5.x, and 6.x][]. ## SSL @@ -153,7 +147,6 @@ There is a known issue with `xdebug` that can affect Magento installations or ac [php]: http://www.php.net/ [sed]: https://www.gnu.org/software/sed/manual/sed.html [tar]: https://linux.die.net/man/1/tar -[Change Elasticsearch Module]: {{ page.baseurl }}/config-guide/elasticsearch/es-downgrade.html [Composer]: https://glossary.magento.com/composer [Apache 2.4]: http://httpd.apache.org/download.cgi [`mod_rewrite`]: https://httpd.apache.org/docs/2.4/mod/mod_rewrite.html @@ -172,5 +165,5 @@ There is a known issue with `xdebug` that can affect Magento installations or ac [Redis]: {{page.baseurl}}/config-guide/redis/config-redis.html [Varnish]: {{page.baseurl}}/config-guide/varnish/config-varnish.html [Elasticsearch]: {{page.baseurl}}/install-gde/prereq/elasticsearch.html -[2.x and 5.x]: https://www.elastic.co/support/eol +[2.x, 5.x, and 6.x]: https://www.elastic.co/support/eol [RabbitMQ]: {{page.baseurl}}/config-guide/mq/rabbitmq-overview.html diff --git a/src/guides/v2.4/release-notes/backward-incompatible-changes/index.md b/src/guides/v2.4/release-notes/backward-incompatible-changes/index.md index e7f8ca5cc2b..8211114c427 100644 --- a/src/guides/v2.4/release-notes/backward-incompatible-changes/index.md +++ b/src/guides/v2.4/release-notes/backward-incompatible-changes/index.md @@ -9,26 +9,15 @@ This page highlights backward incompatible changes between releases that have a ### Elasticsearch -In Magento 2.4.0, we removed support for two deprecated catalog search engines: +MySQL is no longer used for search. You must use [Elasticsearch]({{page.baseurl}}/install-gde/prereq/elasticsearch.html). -- MySQL -- Elasticsearch 2.x +You must [install and configure]{{ page.baseurl }}/install-gde/prereq/elasticsearch.html) Elasticsearch 7.6.x before upgrading to Magento 2.4.0. New installations require a connection to Elasticsearch to complete. -Merchants must [install and configure]{{ page.baseurl }}/install-gde/prereq/elasticsearch.html) a supported version of Elasticsearch before they upgrade to Magento 2.4.0. New installations require a connection to Elasticsearch to complete. - -{:.bs-calllout-warning} -If you attempt to upgrade Magento before installing and configuring a supported search engine, Magento could go into an inconsistent state and the Admin will become inaccessible. - -The following Elasticsearch versions are supported: - -- Elasticsearch 7.x -- Elasticsearch 6.x (6.8 or higher is recommended) +{:.bs-callout-warning} +Magento does not support Elasticsearch 2.x, 5.x, and 6.x. If you attempt to upgrade Magento before installing and configuring a supported search engine, Magento could go into an inconsistent state and the Admin will become inaccessible. Extension developers must update any module that depends on the unsupported search engines. -{:.bs-callout-warning} -Magento no longer provides support for Elasticsearch [2.x and 5.x](https://www.elastic.co/support/eol) as they are End of Life. If you are using ES2, follow the instructions in [Change Elasticsearch Module]({{ page.baseurl }}/config-guide/elasticsearch/es-downgrade.html) before upgrading. - The changes with removing values from the `system.xml` file require eliminating ES2 support from the Admin UI. Other API classes were removed to clean up the code when we deprecated ES2 and ES5 in Magento 2.3.5. The following modules have been refactored to use the `ElasticSearchResultApplier` class and avoid usage of `CatalogSearch` and `SearchResultApplier`, which was based on MySQL: