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

Commit caa18a7

Browse files
oshmyheliukmeker12
andauthored
MCLOUD-2789: [Cloud Docker] Add custom ES plugins (#7898)
* MCLOUD-2789: [Cloud Docker] Add support for adding custom ES plugins from services.yaml file to the docker-compose.yml file. Co-authored-by: Margaret Eker <meker@adobe.com>
1 parent b678eb1 commit caa18a7

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

src/cloud/docker/docker-containers-service.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,20 @@ See [Important Elasticsearch configuration][] in the Elasticsearch documentation
7575
{:.bs-callout-info}
7676
If your Cloud project uses Magento version 2.3.5 or earlier with MySQL search, add the `--no-es` option to skip the Elasticsearch container configuration when you generate the Docker Compose configuration file: `ece-docker build:compose --no-es`.
7777

78+
### Elasticsearch plugins
79+
80+
The `analysis-icu` and `analysis-phonetic` plugins are installed by default and can not be skipped.
81+
If you use Elasticsearch 6.5 and later, the default Elasticsearch plugins configured in `.magento/services.yaml` are installed automatically along with any custom plugins added to the `services.yaml`. When you generate the `docker-compose.yaml` file, custom plugins are added to the `ES_PLUGINS` environment configuration option.
82+
83+
You can change the list of plugins to install by updating the configuration for the `ES_PLUGINS` variable:
84+
85+
```yaml
86+
services:
87+
elasticsearch:
88+
environment:
89+
- 'ES_PLUGINS=analysis-stempel analysis-nori'
90+
```
91+
7892
### Troubleshooting
7993

8094
On some Linux systems, when you launch the Docker environment, the Elasticsearch service fails to start and the following error displays:

src/cloud/docker/docker-containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The following table shows the options to customize service container configurati
4343
| Name | Service | Key & options | Available Versions | Notes
4444
| ------------- | ---------- | ---------- | ------------------ |------------------
4545
| [db] | MariaDB or MySQL<br> | `--db`, `--db-image` (MySQL)<br>`--expose-db-port`<br>`--db-increment`<br>`--db-offset`<br>`--with-entrypoint`<br>`--with-mariadb-config`|10.0, 10.1, 10.2<br>5.6, 5.7 | Use the increment and offset options to customize the [auto-increment settings][Using AUTO_INCREMENT] for replication.<br><br>Use the `--with-entrypoint` and `--with-mariadb-config` options to automatically configure database directories in the Docker environment<br><br>*Example build commands:*<br>`ece-docker build:compose --db <mariadb-version>`<br>`ece-docker build:compose --db <mysql-version> --db-image`
46-
| [elasticsearch] | Elasticsearch | `--es`<br>`--es-env-var`<br>`--no-es` | 1.7, 2.4, 5.2, 6.5, 6.8, 7.5, 7.6 | Use the options to specify the Elasticsearch version, customize Elasticsearch configuration options, or to build a Docker environment without Elasticsearch.
46+
| [elasticsearch] | Elasticsearch | `--es`<br>`--es-env-var`<br>`--no-es` | 1.7, 2.4, 5.2, 6.5, 6.8, 7.5, 7.6, 7.7 | Use the options to specify the Elasticsearch version, customize Elasticsearch configuration options, or to build a Docker environment without Elasticsearch.
4747
| [FPM][fpm-container] | PHP FPM | `--php`<br>`--with-xdebug` | 7.0, 7.1, 7.2, 7.3, 7.4 | Used for all incoming requests. Optionally, add Xdebug configuration to debug PHP code in the Docker environment.
4848
| [node][node-container] | Node | `--node` | 6, 8, 10, 11 | Used gulp or other NPM based commands
4949
| [rabbitmq][rabbitmq-container]| RabbitMQ | `--rmq` | 3.5, 3.7, 3.8 |

0 commit comments

Comments
 (0)