Docker development quick reference

See Configure Docker for additional information about Docker prerequisites and using the Magento Cloud Docker environment.

Docker Compose

The --rm option automatically removes containers when they stop. This setting overrides any restart policy specified in the service configuration and prevents orphaned containers from consuming excess disk space. See docker-compose run in the Docker command-line reference.

Override configuration

Because the ece-docker build:compose command overwrites the base configuration, we recommend saving your customizations in an override configuration file. You can use this method to merge multiple custom configurations. See Docker Docs: Multiple Compose files.

The docker-compose up command considers the base docker-compose.yml configuration by default. If the docker-compose.override.yml file is present, then the override configuration merges with the base configuration.

Use the -f argument to specify an alternate configuration file. The following example uses the default configuration and merges each custom configuration sequentially:

1
docker-compose -f docker-compose.yml -f docker-compose-custom.yml [-f more-custom-docker-compose.yml] up

Docker Compose configuration generator

You use the following commands to generate the Docker configuration files and build your environment.

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

1
./vendor/bin/ece-docker build:compose --mode="developer" --php 7.2

Use the following command to list the Magento Cloud Docker ece-docker commands:

1
php ./vendor/bin/ece-docker list

The ece-docker build:compose command runs in interactive mode and verifies the configured service versions. To skip interactive mode, use the -n, --no-interaction option.

Additional build options

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.

Magento Cloud Docker CLI

The bin/magento-docker commands simplify running docker-compose tasks. For example, instead of running a separate docker-compose command for the build, deploy, and post-deploy steps, you can redeploy Magento in a Docker environment using the following command:

1
./bin/magento-docker ece-redeploy

The following example shows the ./bin/magento-docker command and output when connecting to the bash shell:

1
./bin/magento-docker bash

1
2
3
4
5
Starting project_redis_1 ... done
Starting project_db_1    ... done
Starting project_elasticsearch_1 ... done
[ ok ] Starting enhanced syslogd: rsyslogd.
root@deploy:/app#