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

Commit dbc2cb3

Browse files
meker12maeker12
andauthored
Update Docker command help (#8197)
* Updated Docker Quick reference - Addedd new options to the magento-docker CLI - Added listing that shows all available options for ece-docker build:compose command - Added intro to Docker Compose section * Update src/cloud/docker/docker-quick-reference.md Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>
1 parent a95939d commit dbc2cb3

File tree

2 files changed

+77
-11
lines changed

2 files changed

+77
-11
lines changed

src/_includes/cloud/cloud-docker-config-generator-cmds.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@ You use the following commands to generate the Docker configuration files and bu
22

33
Action | Command
44
:----- | :------
5-
Builds the Docker environment in [production mode][mode] by default and verifies configured service versions. | `ece-docker build:compose`
6-
Builds the docker environment in [developer mode][mode]. | `ece-docker build:compose --mode="developer"`
7-
Builds the docker environment in [production mode][mode]. |`ece-docker build:compose --mode="production"`
8-
Convert PHP configuration files to Docker ENV files. | `ece-docker image:generate:php`
5+
Builds the Docker environment in [production mode][mode] by default and verifies configured service versions. | `./vendor/bin/ece-docker build:compose`
6+
Builds the docker environment in [developer mode][mode]. | `./vendor/bin/ece-docker build:compose --mode="developer"`
7+
Builds the docker environment in [production mode][mode]. |`.vendor/bin/ece-docker build:compose --mode="production"`
8+
Convert PHP configuration files to Docker ENV files. | `.vendor/bin/ece-docker image:generate:php`
9+
Builds a custom `docker-compose.yaml` file | `./vendor/bin/ece-docker build:custom:compose`
910

1011
For example, the following command starts the Docker configuration generator in developer mode and specifies PHP version 7.2:
1112

src/cloud/docker/docker-quick-reference.md

Lines changed: 72 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ functional_areas:
1010

1111
## Docker Compose
1212

13+
Docker Compose is a tool for defining and running multi-container Docker applications. The following table lists the Docker Compose commands for building, deploying, and operating {{site.data.var.mcd-prod}}. You can also use [Magento Cloud Docker CLI](#magento-cloud-docker-cli) commands to complete Docker Compose tasks.
14+
1315
Action | Command
1416
:----- | :------
1517
Build and start Docker environment | `docker-compose up -d`
@@ -46,15 +48,68 @@ docker-compose -f docker-compose.yml -f docker-compose-custom.yml [-f more-custo
4648

4749
### Additional build options
4850

49-
| Option | Key | Available values
50-
| ------------ | ---------------- | ------------------
51-
| [Mode][] | `--mode`, `-m` | production, developer
52-
| [File synchronization engine][] | `--sync-engine` | native (default), docker-sync, mutagen
53-
| Specify a custom URL for Magento | `--host`<br>`--port`
54-
| Specify custom HTTP and SMTP ports for MailHog | `--mailhog-http-port`<br>`--mailhog-smtp-port`
51+
View the available options for the `ece-docker build:compose` command:
52+
53+
```bash
54+
php ./vendor/bin/ece-docker build:compose -h
55+
```
56+
57+
```terminal
58+
Description:
59+
Build docker configuration
60+
61+
Usage:
62+
build:compose [options]
63+
64+
Options:
65+
--php=PHP PHP version
66+
--nginx=NGINX Nginx version
67+
--db=DB DB version
68+
--db-image=DB-IMAGE DB image
69+
--expose-db-port=EXPOSE-DB-PORT Expose DB port
70+
--expose-db-quote-port=EXPOSE-DB-QUOTE-PORT Expose port for DB sales
71+
--expose-db-sales-port=EXPOSE-DB-SALES-PORT Expose port for DB quote
72+
--with-entrypoint Add DB entrypoint volume
73+
--with-mariadb-conf Add MariaDb config volume
74+
--redis=REDIS Redis version
75+
--es=ES Elasticsearch version
76+
--rmq=RMQ RabbitMQ version
77+
--node=NODE Node.js version
78+
--selenium-version=SELENIUM-VERSION Selenium version
79+
--selenium-image=SELENIUM-IMAGE Selenium image
80+
--no-es Disable Elasticsearch
81+
--no-mailhog Disable MailHog
82+
--mailhog-http-port Custom HTTP port for MailHog
83+
--mailhog-smtp-port Custom SMTP port for MailHog
84+
--set-docker-host Sets host.docker.internal for fpm_xdebug container to
85+
resolve debug issue for LINUX system
86+
-m, --mode=MODE Mode of environment (developer, production)
87+
--sync-engine=SYNC-ENGINE File sync engine. Works only with developer mode. Available: (docker-sync, mutagen, native)
88+
--with-cron Add cron container
89+
--no-varnish Remove Varnish container
90+
--with-selenium Add Selenium latest version
91+
--with-test Add container for running tests
92+
--no-tmp-mounts Remove /tmp mounted volume
93+
--with-xdebug Enables XDebug
94+
--env-vars[=ENV-VARS] Cloud environment variables
95+
--installation-type[=INSTALLATION-TYPE] Sets magento installation type [default: "composer"]
96+
--host[=HOST] Host name
97+
--port[=PORT] Port
98+
--tls-port TLS port
99+
--es-env-var=ES-ENV-VAR Environment variable for elasticsearch service (multiple values allowed)
100+
--db-increment-increment=DB-INCREMENT-INCREMENT "auto_increment_increment" database variable
101+
--db-increment-offset=DB-INCREMENT-OFFSET "auto_increment_offset" database variable
102+
-h, --help Display this help message
103+
-q, --quiet Do not output any message
104+
-V, --version Display this application version
105+
--ansi Force ANSI output
106+
--no-ansi Disable ANSI output
107+
-n, --no-interaction Do not ask any interactive question
108+
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
109+
```
55110

56111
{:.bs-callout-info}
57-
See [Service versions] for a list of service configuration options you can add to the `ece-docker build:compose` command to customize the Cloud Docker environment configuration.
112+
See [Service versions] for additional information about the service configuration options for the `ece-docker build:compose` command.
58113

59114
## Magento Cloud Docker CLI
60115

@@ -92,6 +147,16 @@ Start containers | `./bin/magento-docker start`
92147
Restart containers | `./bin/magento-docker restart`
93148
Destroy containers | `./bin/magento-docker down`
94149
Destroy, re-create, and start containers | `./bin/magento-docker up`
150+
Clears Redis cache | `./bin/magento-docker flush-redis`
151+
Clears Varnish cache | `./bin/magento-docker flush-varnish`
152+
Access database | `./bin/magento-docker ece-db`
153+
Run a command in a PHP container<br>Supports the following values for the PHP version: 7.1, 7.2, 7.3, 7.4| `./bin/magento-docker php <version>`
154+
155+
Use the following command to view the magento-docker CLI command help:
156+
157+
```bash
158+
./bin/magento-docker -h
159+
```
95160

96161
<!--Link definitions-->
97162

0 commit comments

Comments
 (0)