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

Commit 722df7b

Browse files
authored
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.
1 parent c9fd0dc commit 722df7b

File tree

9 files changed

+30
-18
lines changed

9 files changed

+30
-18
lines changed

src/_data/main-nav.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
url: /cloud/docker/docker-development.html
3030
versionless: true
3131

32-
- label: Launch Docker
32+
- label: Configure and launch Docker
3333
url: /cloud/docker/docker-config.html
3434
versionless: true
3535

src/_data/toc/cloud-guide.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,18 +144,20 @@ pages:
144144
- label: Manage cron jobs
145145
url: /cloud/docker/docker-manage-cron-jobs.html
146146
versionless: true
147+
148+
- label: Extend Docker
149+
url: /cloud/docker/docker-extend.html
150+
versionless: true
147151

152+
- label: Launch Docker
153+
children:
148154
- label: Developer mode
149155
url: /cloud/docker/docker-mode-developer.html
150156
versionless: true
151157

152158
- label: Production mode
153159
url: /cloud/docker/docker-mode-production.html
154160
versionless: true
155-
156-
- label: Extend Docker
157-
url: /cloud/docker/docker-extend.html
158-
versionless: true
159161

160162
- label: Functional Testing
161163
children:
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
{:.bs-callout-info}
2+
See [Configure Docker]({{site.baseurl}}/cloud/docker/docker-config.html) for additional information about Docker prerequisites and using the Magento Cloud Docker environment.

src/cloud/docker/docker-config.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,12 @@ The `ece-docker build:compose` command overwrites the existing `docker-compose.y
5151

5252
1. Optionally, [enable Xdebug].
5353

54-
## Launch modes
54+
## Set the launch mode
5555

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:
5757

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].
6260

6361
For example, the following command starts the Docker configuration generator for the developer mode:
6462

@@ -68,6 +66,9 @@ For example, the following command starts the Docker configuration generator for
6866

6967
To skip the interactive mode, use the `-n, --no-interaction` option.
7068

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+
7172
## Stop and start containers
7273

7374
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:
8990
{: .bs-callout-warning}
9091
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].
9192

92-
## Running Composer with Docker
93+
## Run Composer with Docker
9394

9495
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.
9596

@@ -101,7 +102,7 @@ docker run -it -v $(pwd):/app/ -v ~/.composer/:/root/.composer/ magento/magento
101102

102103
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.
103104

104-
## Sendmail service
105+
## Set up email
105106

106107
Send emails from your Docker environment by adding the following configuration to the `docker-compose.yml` configuration file:
107108

src/cloud/docker/docker-development.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ functional_areas:
99

1010
{{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.
1111

12+
{%include cloud/note-docker-config-reference-link.md%}
13+
1214
## Host Operating Systems
1315

1416
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.

src/cloud/docker/docker-mode-production.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ functional_areas:
99

1010
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.
1111

12+
{%include cloud/note-docker-config-reference-link.md%}
13+
1214
{:.procedure}
1315
To launch the Docker environment in developer mode:
1416

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ functional_areas:
66
- Docker
77
---
88

9+
{%include cloud/note-docker-config-reference-link.md%}
10+
911
## docker-compose
1012

1113
Action | Command
@@ -39,8 +41,8 @@ docker-compose -f docker-compose.yml -f docker-compose-custom.yml [-f more-custo
3941

4042
| Option | Key | Available values
4143
| ------------ | ---------------- | ------------------
42-
| [Mode]({{site.baseurl}}/cloud/docker/docker-config.html#launch-modes) | `--mode`, `-m` | production, developer
43-
| [File synchronization engine]({{site.baseurl}}/cloud/docker/docker-config.html#launch-modes) | `--sync-engine` | native (default), docker-sync, mutagen
44+
| [Mode]({{site.baseurl}}/cloud/docker/docker-config.html#set-the-launch-mode) | `--mode`, `-m` | production, developer
45+
| [File synchronization engine]({{site.baseurl}}/cloud/docker/docker-syncing-data.html) | `--sync-engine` | native (default), docker-sync, mutagen
4446

4547
{:.bs-callout-info}
4648
See [Service versions] for a list of the options to configure the software service version when building your {{site.data.var.mcd-prod}} environment.
@@ -80,3 +82,4 @@ Destroy containers | `down`
8082
Destroy, re-create, and start containers | `up`
8183

8284
[Service versions]: {{site.baseurl}}/cloud/docker/docker-containers.html#service-containers
85+
[Configure Docker]: {{site.baseurl}}/cloud/docker/docker-config.html

src/cloud/reference/ece-tools-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Ideal state is configured
127127
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].
128128

129129
<!-- link definitions -->
130-
[mode]: {{site.baseurl}}/cloud/docker/docker-config.html#launch-modes
130+
[mode]: {{site.baseurl}}/cloud/docker/docker-config.html#set-the-launch-mode
131131
[hooks]: {{site.baseurl}}/cloud/project/project-conf-files_magento-app.html#hooks
132132
[cloudvar]: {{site.baseurl}}/cloud/env/variables-cloud.html
133133
[wizard]: {{site.baseurl}}/cloud/deploy/smart-wizards.html

src/cloud/release-notes/cloud-release-archive.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ The `{{site.data.var.ct}}` 2002.0.22 release changes the structure of the `{{sit
139139

140140
- {:.new}<!-- MAGECLOUD-3345 -->**New Docker Image**—Added a Node.js image to support Gulp and other capabilities, such as Jasmine JS Unit Testing.
141141

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.
143143

144144
- {:.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.
145145

@@ -198,7 +198,7 @@ The `{{site.data.var.ct}}` version 2002.0.17 includes an important security patc
198198

199199
- <!-- MAGECLOUD-3025 -->Now, the default service configuration generated in the Docker environment is the same as the default configuration in the Cloud template.
200200

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).
202202

203203
- <!-- MAGECLOUD-2891 -->Added the ability to [configure Xdebug]({{ site.baseurl }}/cloud/docker/docker-development-debug.html) to debug in the Cloud Docker environment.
204204

0 commit comments

Comments
 (0)