Configure Catalog Search Engine with Magento CLI

Submitted by Eric on Fri, 02/15/2019 - 11:44

Since we installed Magento 2.3 we started receiving a notice that Catalog Search using MySQL will go away as it is deprecated. This is ok as we are going to use Elasticsearch anyway, but we have to setup Magento to connect to the correct hostname when the container starts and not manually in the admin or using CLI, but the CLI is helpful as we can run scripts after the container is up and running.

If you want more information on how to do via the admin you will find the tutorial in the Magento Docs:

You just really need to configure two settings via the CLI and they are:

magento config:set catalog/search/engine 'elasticsearch5'
magento config:set catalog/search/elasticsearch5_server_hostname 'elasticsearch-hostname.env'

The first option is the engine which it can be: mysql, elasticsearch or elasticsearch5.
The second option is the server hostname. You can either use IP or a DNS. We have Magento set up on a Kubernetes cluster, so elasticsearch has its own container running and the hostname is based on the store name, so you can also use variables:

magento config:set catalog/search/elasticsearch5_server_hostname "elasticsearch-$MY_VARIABLE.env"

Just pay attention that now it needs double quotes. You can also set other configurations:

magento config:set catalog/search/elasticsearch5_server_port '9200'
magento config:set catalog/search/elasticsearch5_index_prefix 'magento2'
magento config:set catalog/search/elasticsearch5_enable_auth '0'
magento config:set catalog/search/elasticsearch5_server_timeout '15'

These are the default settings for elasticsearch and elasticsearch5, so change what you need to.

I hope you find this article helpful and see you on the next one.


Add new comment

Restricted HTML

  • Allowed HTML tags: <a href hreflang> <em> <strong> <cite> <blockquote cite> <code> <ul type> <ol start type> <li> <dl> <dt> <dd> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>
  • Lines and paragraphs break automatically.
  • Web page addresses and email addresses turn into links automatically.
This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.