Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 2fa5ff1

Browse files
authored
Merge pull request #7394 from magento/MC-35039-elasticsearch-support
Clarify support for Elasticsearch in Magento 2.4.0
2 parents 8d4b214 + 9d020e7 commit 2fa5ff1

File tree

8 files changed

+24
-101
lines changed

8 files changed

+24
-101
lines changed

src/_data/toc/configuration-guide.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -322,9 +322,6 @@ pages:
322322

323323
- label: Configure Magento to use Elasticsearch
324324
url: /config-guide/elasticsearch/configure-magento.html
325-
326-
- label: Change the Elasticsearch client
327-
url: /config-guide/elasticsearch/es-downgrade.html
328325

329326
- label: Message Queues
330327
url: /config-guide/mq/rabbitmq-overview.html

src/_includes/layout/page-header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
{% if page.url contains "guides/v2.4/comp-mgr/" %}
2323
<div class="message-banner">
24-
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 <a href="{{ page.baseurl }}/comp-mgr/prereq/prereq-elasticsearch.html">Check the catalog search engine</a> for details.
24+
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 <a href="{{ page.baseurl }}/comp-mgr/prereq/prereq-elasticsearch.html">Check the catalog search engine</a> for details.
2525
</div>
2626
{% endif %}
2727

src/guides/v2.4/comp-mgr/prereq/prereq-elasticsearch.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,33 @@ Before you upgrade from Magento 2.3.x to Magento 2.4, you must check whether you
99

1010
You can use the CLI or the Admin to determine your catalog search engine:
1111

12-
* 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.
12+
- 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.
1313

14-
* From the Admin, check the value of the **Stores** > Settings > **Configuration** > **Catalog** > **Catalog** > **Catalog Search** > **Search Engine** field.
14+
- From the Admin, check the value of the **Stores** > Settings > **Configuration** > **Catalog** > **Catalog** > **Catalog Search** > **Search Engine** field.
1515

16-
The following sections describe what actions you must take before upgrading to Magento 2.4.
16+
The following sections describe what actions you must take before upgrading to Magento 2.4.0.
1717

1818
## MySQL
1919

20-
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:
20+
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:
2121

22-
* [Install and configure Elasticsearch]({{site.baseurl}}/guides/v2.3/config-guide/elasticsearch/es-overview.html)
23-
* [Installing Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html)
24-
* 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)
25-
* [Configure Magento to use Elasticsearch]({{site.baseurl}}/guides/v2.3/config-guide/elasticsearch/configure-magento.html) and reindex
22+
- [Install and configure Elasticsearch]({{ page.baseurl }}/config-guide/elasticsearch/es-overview.html)
23+
- [Installing Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html)
24+
- 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)
25+
- [Configure Magento to use Elasticsearch]({{ page.baseurl }}/config-guide/elasticsearch/configure-magento.html) and reindex
2626

2727
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.
2828

29-
## Elasticsearch 2
29+
## Elasticsearch
3030

31-
Magento does not support Elasticsearch 2. You must update to a more recent version. Elasticsearch 7 is recommended.
31+
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.
3232

3333
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.
3434

3535
{:.bs-callout-info}
3636
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.
3737

38-
[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.
39-
40-
## Elasticsearch 5
41-
42-
Elasticsearch 5 has reached its [End of Life](https://www.elastic.co/support/eol), and Magento support for Elasticsearch 5 has been deprecated.
43-
44-
Although you can upgrade to Magento 2.4 without updating Elasticsearch 5, Magento recommends that you update to Elasticsearch 7.
45-
46-
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.
47-
48-
[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.
49-
50-
## Elasticsearch 6 or 7
51-
52-
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.
38+
[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.
5339

5440
## Third-party extensions
5541

src/guides/v2.4/config-guide/elasticsearch/es-downgrade.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

src/guides/v2.4/config-guide/elasticsearch/es-overview.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,16 @@ functional_areas:
88
- Setup
99
---
1010

11-
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:
11+
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:
1212

1313
* [Elasticsearch prerequisites][]
1414
* [Configure nginx and Elasticsearch][]
1515
* [Configure Apache and Elasticsearch][]
16-
* [Setup Wizard installation][]
1716
* [Install the Magento software][] (command line interface)
1817

1918
After you install and integrate Elasticsearch with Magento, you might need to perform additional maintenance:
2019

2120
* [Configure Elasticsearch stopwords][]
22-
* [Change the Elasticsearch Client][]
2321
* [Configure Magento to use Elasticsearch][]
2422

2523
## Additional resources {#es-resources}
@@ -34,6 +32,4 @@ For additional information, see the [Elasticsearch documentation][]
3432
[Elasticsearch]: https://www.elastic.co
3533
[Configure Magento to use Elasticsearch]: {{page.baseurl}}/config-guide/elasticsearch/configure-magento.html
3634
[Elasticsearch documentation]: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
37-
[Change the Elasticsearch Client]: {{page.baseurl}}/config-guide/elasticsearch/es-downgrade.html
38-
[Setup Wizard installation]: {{page.baseurl}}/install-gde/install/web/install-web.html
3935
[Install the Magento software]: {{page.baseurl}}/install-gde/install/cli/install-cli-install.html

src/guides/v2.4/install-gde/prereq/elasticsearch.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ As of Magento 2.4, all installations must be configured to use [Elasticsearch][]
2323

2424
## Supported versions {#es-spt-versions}
2525

26-
Magento version 2.4 supports the following Elasticsearch versions:
26+
You must install and configure Elasticsearch 7.6.x before upgrading to Magento 2.4.0.
2727

28-
* Elasticsearch 7.x.x
29-
* Elasticsearch 6.8.x
28+
{:.bs-callout-info}
29+
Magento does not support Elasticsearch 2.x, 5.x, and 6.x.
3030

3131
## Recommended configuration {#es-arch}
3232

@@ -116,9 +116,7 @@ For additional information, see [Elasticsearch documentation][]{:target="_blank"
116116
[Elasticsearch clustering documentation]: https://www.elastic.co/guide/en/elasticsearch/guide/current/distributed-cluster.html
117117
[Elasticsearch Ubuntu documentation]: https://www.elastic.co/guide/en/elasticsearch/reference/current/deb.html
118118
[Configuring Elasticsearch]: https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html
119-
[End of Life]: https://www.elastic.co/support/eol
120119
[Upgrading Elasticsearch]: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html
121120
[Full cluster restart upgrade]: https://www.elastic.co/guide/en/elasticsearch/reference/current/restart-upgrade.html
122121
[Elasticsearch documentation]: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
123-
[Change Elasticsearch Client]: {{page.baseurl}}/config-guide/elasticsearch/es-downgrade.html
124122
[Installing Elasticsearch]: https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html

src/guides/v2.4/install-gde/system-requirements-tech.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,10 @@ For more information, see [Required PHP settings][].
7777

7878
## Elasticsearch
7979

80-
* 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:
80+
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.
8181

82-
* Elasticsearch 7.x
83-
84-
* Elasticsearch 6.x (6.8 or higher is recommended)
85-
86-
{:.bs-callout-warning}
87-
Magento no longer provides support for Elasticsearch [2.x and 5.x][] as they are End of Life.
88-
89-
Follow the instructions in [Change Elasticsearch Module][].
82+
{:.bs-callout-warning}
83+
Magento no longer supports Elasticsearch [2.x, 5.x, and 6.x][].
9084

9185
## SSL
9286

@@ -153,7 +147,6 @@ There is a known issue with `xdebug` that can affect Magento installations or ac
153147
[php]: http://www.php.net/
154148
[sed]: https://www.gnu.org/software/sed/manual/sed.html
155149
[tar]: https://linux.die.net/man/1/tar
156-
[Change Elasticsearch Module]: {{ page.baseurl }}/config-guide/elasticsearch/es-downgrade.html
157150
[Composer]: https://glossary.magento.com/composer
158151
[Apache 2.4]: http://httpd.apache.org/download.cgi
159152
[`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
172165
[Redis]: {{page.baseurl}}/config-guide/redis/config-redis.html
173166
[Varnish]: {{page.baseurl}}/config-guide/varnish/config-varnish.html
174167
[Elasticsearch]: {{page.baseurl}}/install-gde/prereq/elasticsearch.html
175-
[2.x and 5.x]: https://www.elastic.co/support/eol
168+
[2.x, 5.x, and 6.x]: https://www.elastic.co/support/eol
176169
[RabbitMQ]: {{page.baseurl}}/config-guide/mq/rabbitmq-overview.html

src/guides/v2.4/release-notes/backward-incompatible-changes/index.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,15 @@ This page highlights backward incompatible changes between releases that have a
99

1010
### Elasticsearch
1111

12-
In Magento 2.4.0, we removed support for two deprecated catalog search engines:
12+
MySQL is no longer used for search. You must use [Elasticsearch]({{page.baseurl}}/install-gde/prereq/elasticsearch.html).
1313

14-
- MySQL
15-
- Elasticsearch 2.x
14+
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.
1615

17-
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.
18-
19-
{:.bs-calllout-warning}
20-
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.
21-
22-
The following Elasticsearch versions are supported:
23-
24-
- Elasticsearch 7.x
25-
- Elasticsearch 6.x (6.8 or higher is recommended)
16+
{:.bs-callout-warning}
17+
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.
2618

2719
Extension developers must update any module that depends on the unsupported search engines.
2820

29-
{:.bs-callout-warning}
30-
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.
31-
3221
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.
3322

3423
The following modules have been refactored to use the `ElasticSearchResultApplier` class and avoid usage of `CatalogSearch` and `SearchResultApplier`, which was based on MySQL:

0 commit comments

Comments
 (0)