You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Updated Cloud Guide navigation for accessible Docker launch instructions (#6620)
* Updated Cloud Guide navigation to make launch instructions more
accessible:
- Added the Docker Development > Launch Docker navigation heading
- Changes the top-level navigation title from "Launch Docker" to
"Configure and launch Docker"
- Updated the Launch developer and Launch production topics to include
links to the Docker configuration topics
- Changed title of "Launch modes" subsection to add what launch modes
are for
* Updated the `Backward incompatible changes` topic in the _
Cloud Guide_ to include new requirement to specify `--with-cron` option
to build a Magento Cloud Docker environment that includes a Cron
container.
See [Configure Docker]({{site.baseurl}}/cloud/docker/docker-config.html) for additional information about Docker prerequisites and using the Magento Cloud Docker environment.
Copy file name to clipboardExpand all lines: src/cloud/docker/docker-config.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,14 +51,12 @@ The `ece-docker build:compose` command overwrites the existing `docker-compose.y
51
51
52
52
1. Optionally, [enable Xdebug].
53
53
54
-
## Launch modes
54
+
## Set the launch mode
55
55
56
-
_Mode_ is an additional configuration option for the Docker configuration generator (the `ece-docker build:compose` command). This mode option does not affect the Magento mode. It determines the {{site.data.var.ece}} file system installation and read-only or read-write behavior.
56
+
You can launch a Docker environment in production or developer mode by setting the `mode` option on the `ece-docker build:compose` command:
57
57
58
-
You can launch your Docker environment in one of the following modes:
59
-
60
-
-[**production**][prod-mode]—Production mode is the default configuration setting for launching the Docker environment with read-only filesystem permissions. This option builds the Docker environment in production mode and verifies configured service versions.
61
-
-[**developer**][dev-mode]—Developer mode supports an active development environment with full, writable filesystem permissions. This option builds the Docker environment in developer mode and verifies configured service versions. System performance is slower in developer mode because of additional file synchronization operations.
58
+
-**Production mode**—The `--mode="production"` setting supports an active production environment with read-only filesystem permissions. This is the default configuration setting for launching a Docker environment. Selecting this option builds the Docker environment in production mode and verifies configured service versions. See [Production mode launch instructions][prod-mode].
59
+
-**Developer mode**—The `--mode="developer"` setting supports an active development environment with full, writable filesystem permissions. Selecting this option builds the Docker environment in developer mode and verifies configured service versions. System performance is slower in developer mode because of additional file synchronization operations. See [Developer mode launch instructions][dev-mode].
62
60
63
61
For example, the following command starts the Docker configuration generator for the developer mode:
64
62
@@ -68,6 +66,9 @@ For example, the following command starts the Docker configuration generator for
68
66
69
67
To skip the interactive mode, use the `-n, --no-interaction` option.
70
68
69
+
{:.bs-callout-info}
70
+
The mode option for the `ece-docker build:compose` command does not affect the Magento mode. It determines the {{site.data.var.ece}} file system installation and read-only or read-write behavior.
71
+
71
72
## Stop and start containers
72
73
73
74
You can stop containers and restore them afterwards using the following methods.
@@ -89,7 +90,7 @@ Use the following command to stop and remove the Docker configuration:
89
90
{: .bs-callout-warning}
90
91
This command removes all components of your local Docker instance including containers, networks, volumes, and images except for the persistent database and the `magento-sync` volume. See [Rebuild a clean environment][refresh].
91
92
92
-
## Running Composer with Docker
93
+
## Run Composer with Docker
93
94
94
95
You can run composer using the `docker` command before you create the container instance. This technique is useful to create an application instance during the CI/CD build process, or even during first time Magento set up.
This command passes in the current working directory as `/app/`, includes composer from `~/.composer/`, and runs the `composer install` command in the container. After this set up, the command fixes the permissions on the files that have been added or changed.
103
104
104
-
## Sendmail service
105
+
## Set up email
105
106
106
107
Send emails from your Docker environment by adding the following configuration to the `docker-compose.yml` configuration file:
Copy file name to clipboardExpand all lines: src/cloud/docker/docker-development.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,8 @@ functional_areas:
9
9
10
10
{{site.data.var.ece}} provides a Docker environment option for those who use their local environment for development, test, or automation tasks. The {{site.data.var.ece}} Docker environment requires three, essential components: a {{site.data.var.ee}} v2 template, Docker Compose, and the {{site.data.var.ece}} `{{site.data.var.ct}}` package.
The Cloud Docker environment supports Linux, macOS, and Windows operating systems. The containers should run on any Docker host, but some of the set up scripts require you to install PHP and Composer.
Copy file name to clipboardExpand all lines: src/cloud/docker/docker-mode-production.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,8 @@ functional_areas:
9
9
10
10
Production mode is the default configuration setting for launching the Docker environment with read-only filesystem permissions. This option builds the Docker environment in production mode and verifies configured service versions.
Copy file name to clipboardExpand all lines: src/cloud/reference/ece-tools-reference.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,7 +127,7 @@ Ideal state is configured
127
127
The `{{site.data.var.ct}}` package includes a dependency for the [magento/magento-cloud-patches] package, which delivers Magento patches and hot fixes that improve the integration of all {{site.data.var.ee}} versions with Cloud environments and supports quick delivery of critical fixes. The `{{site.data.var.mcp}}` also delivers custom patches that you add to your {{site.data.var.ece}} project. See [Apply patches].
Copy file name to clipboardExpand all lines: src/cloud/release-notes/cloud-release-archive.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -139,7 +139,7 @@ The `{{site.data.var.ct}}` 2002.0.22 release changes the structure of the `{{sit
139
139
140
140
- {:.new}<!-- MAGECLOUD-3345 -->**New Docker Image**—Added a Node.js image to support Gulp and other capabilities, such as Jasmine JS Unit Testing.
141
141
142
-
- {:.new}<!-- MAGECLOUD-3152/3511 -->**Docker build modes**—Now you can choose to launch the Docker environment in [Production mode or Developer mode]({{ site.baseurl }}/cloud/docker/docker-config.html#launch-modes). Developer mode supports active development with full, writable filesystem permissions.
142
+
- {:.new}<!-- MAGECLOUD-3152/3511 -->**Docker build modes**—Now you can choose to launch the Docker environment in [Production mode or Developer mode]({{ site.baseurl }}/cloud/docker/docker-config.html#set-the-launch-mode). Developer mode supports active development with full, writable filesystem permissions.
143
143
144
144
- {:.fix}<!-- MAGECLOUD-3369 -->Fixed an issue that caused Docker deploy to fail with a `Name or service not known` error if the cache is configured for a service that is not available. Now, you can remove a service from the [`.magento/services.yaml` file]({{ site.baseurl }}/cloud/project/project-conf-files_services.html). The Docker configuration generator updates the service in the `docker/config.php.dist` file automatically.
145
145
@@ -198,7 +198,7 @@ The `{{site.data.var.ct}}` version 2002.0.17 includes an important security patc
198
198
199
199
-<!-- MAGECLOUD-3025 -->Now, the default service configuration generated in the Docker environment is the same as the default configuration in the Cloud template.
200
200
201
-
-<!-- MAGECLOUD-2907 -->You can send mail from your Docker environment using the [`sendmail` service]({{ site.baseurl }}/cloud/docker/docker-config.html#sendmail-service).
201
+
-<!-- MAGECLOUD-2907 -->You can send mail from your Docker environment using the [`sendmail` service]({{ site.baseurl }}/cloud/docker/docker-config.html#set-up-email).
202
202
203
203
-<!-- MAGECLOUD-2891 -->Added the ability to [configure Xdebug]({{ site.baseurl }}/cloud/docker/docker-development-debug.html) to debug in the Cloud Docker environment.
0 commit comments