Set up Elasticsearch service
Elasticsearch is an open source product that enables you to take data from any source, any format, and search and visualize it in real time.
- Elasticsearch performs quick and advanced searches on products in the product catalog
- Elasticsearch Analyzers support multiple languages
- Supports stop words and synonyms
- Indexing does not impact customers until the reindex operation completes
Magento Commerce supports Elasticsearch versions 1.4, 1.7, 2.4, and 5.2 (requires Magento Commerce v2.2.3 or later). The recommended version is 5.2.
To enable Elasticsearch:
elasticsearchservice to the
.magento/services.yamlfile with the Elasticsearch version and allocated disk space in MB.
1 2 3
elasticsearch: type: elasticsearch:5.2 disk: 1024
relationshipsproperty in the
relationships: elasticsearch: "elasticsearch:elasticsearch"
Add, commit, and push code changes.
git add -A && git commit -m "Enable Elasticsearch" && git push origin <branch-name>
For information on how these changes affect your environments, see Services.
Verify the relationships and configure Elasticsearch in the Admin UI.
Add Elasticsearch plugins
Optionally, you can add plugins with the
.magento/services.yaml file. For example, to enable the ICU analysis plugin and Python script support plugin, add the
configuration:plugins section with the listed plugin codes:
1 2 3 4 5 6 7 elasticsearch: type: elasticsearch:5.2 disk: 1024 configuration: plugins: - analysis-icu - lang-python
The following are supported Elasticsearch plugins for version 2.4:
analysis-icu: ICU Analysis Plugin, Support ICU Unicode text analysis
analysis-kuromoji: Japanese (kuromoji) Analysis Plugin, Japanese language support
analysis-phonetic: Phonetic Analysis Plugin, Phonetic analysis
analysis-smartcn: Smart Chinese Analysis Plugins
analysis-stempel: Stempel Polish Analysis Plugin
cloud-aws: AWS Cloud Plugin, allows storing indices on AWS S3
cloud-azure: Azure Cloud Plugin
cloud-gce: GCE Cloud Plugin
delete-by-query: Support for deleting documents matching a given query
discovery-multicast: Ability to form a cluster using TCP/IP multicast messages
lang-python: Python language plugin, allows the use of Python in Elasticsearch scripts
mapper-attachments: Mapper attachments plugin for indexing common file types
mapper-murmur3: Murmur3 mapper plugin for computing hashes at index-time
mapper-size: Size mapper plugin, enables the
If you use the ElasticSuite third-party plugin, you must update the
ece-tools package to version 2002.0.19 or later.
Magento Commerce Cloud uses the MAGENTO_CLOUD_RELATIONSHIPS variable to retrieve the environment-related relationships. You must use this information when you configure Elasticsearch through the Magento Admin.
To verify information used for configurations and settings:
Use SSH to log in to the remote environment.
pretty-printof all relationships for services and configuration data for that environment.
php -r 'print_r(json_decode(base64_decode($_ENV["MAGENTO_CLOUD_RELATIONSHIPS"])));'
Staging and Production environments that are in the same cluster share a single Elasticsearch instance, so you must specify a unique Elasticsearch prefix for each of these environments.