Merge branch 'master' into sync-develop

Author: jeff-matthews

common/images/ext-best-practices/import-validation.png

@@ -54,10 +54,9 @@ For example, the following command starts the Docker configuration generator for
 ## Prerequisites
 
 1.  You must have the following software installed on your local workstation:
-
     -  PHP version 7.1 or later
-        -  [[email protected]](https://formulae.brew.sh/formula/[email protected])
-        -  [[email protected]](https://formulae.brew.sh/formula/[email protected])
+       -  [[email protected]](https://formulae.brew.sh/formula/[email protected])
+       -  [[email protected]](https://formulae.brew.sh/formula/[email protected])
     -  [Composer](https://getcomposer.org)
     -  [Docker](https://www.docker.com/get-started)
     -  File synchronization required for developer mode—use one of the following:
@@ -121,19 +120,6 @@ Continue launching your Docker environment in the default _production_ mode.
     cp .docker/config.php.dist .docker/config.php
     ```
 
-    Convert custom PHP configuration files to Docker ENV files.
-
-    ```bash
-    ./vendor/bin/ece-tools docker:config:convert
-    ```
-
-    This generates the following Docker ENV files:
-
-    * `.docker/config.env`
-
-    {: .bs-callout-info }
-    The `{{site.data.var.ct}}` version 2002.0.12 package does not support the `docker:config:convert` command.
-
 1.  _Optional_: Configure the Docker global variables in the `docker-compose.yml` file. For example, you can [configure Xdebug]({{ page.baseurl }}/cloud/docker/docker-development-debug.html#configure-xdebug).
 
 1.  Build files to containers and run in the background.
@@ -170,7 +156,8 @@ Continue launching your Docker environment in the default _production_ mode.
     ```bash
     docker-compose run deploy magento-command cache:clean
     ```
-1. _Optional_: Restart services if the static content does not synchronize with all images after generation on build phase.
+
+1.  _Optional_: Restart services if the static content does not synchronize with all images after generation on build phase.
 
     ```bash
     docker-compose restart
@@ -185,52 +172,61 @@ Continue launching your Docker environment in the _developer_ mode. The develope
 {: .bs-callout-info }
 The `{{site.data.var.ct}}` version 2002.0.18 and later supports developer mode.
 
-1.  Install the `docker-sync` tool using the [Installation instructions](https://docker-sync.readthedocs.io/en/latest/getting-started/installation.html). If you have it installed, continue to the next step.
+1.  Install the `docker-sync` tool using the [Installation instructions](https://docker-sync.readthedocs.io/en/latest/getting-started/installation.html).
+    Optionally, you can install the `mutagen.io` tool using the [Installation instructions](https://mutagen.io/documentation/installation/).
+    If you have it installed, continue to the next step.
 
 1.  In your local environment, start the Docker configuration generator. You can use the service keys, such as `--php`, to [specify a version](#service-versions).
 
     ```bash
     ./vendor/bin/ece-tools docker:build --mode="developer"
     ```
 
-1.  _Optional_: If you have a custom PHP configuration file, copy the default configuration DIST file to your custom configuration file and make any necessary changes.
+    By default, the docker-compose configuration uses 'docker-sync' for file synchronization.
+    To use 'mutagen.io' for file synchronization, you must run the command with the `--sync-engine=mutagen` option.
+
+    For example:
 
     ```bash
-    cp .docker/config.php.dist .docker/config.php
+    ./vendor/bin/ece-tools docker:build --mode="developer" --sync-engine=mutagen
     ```
 
-    Convert custom PHP configuration files to Docker ENV files.
+1.  _Optional_: If you have a custom PHP configuration file, copy the default configuration DIST file to your custom configuration file and make any necessary changes.
 
     ```bash
-    ./vendor/bin/ece-tools docker:config:convert
+    cp .docker/config.php.dist .docker/config.php
     ```
 
-    This generates the following Docker ENV files:
-
-    * `.docker/config.env`
-
 1.  _Optional_: Configure the Docker global variables in the `docker-compose.yml` file. For example, you can [enable and configure Xdebug]({{ page.baseurl }}/cloud/docker/docker-development-debug.html).
 
-1.  Start the file synchronization (use one of the following).
+1.  Start the file synchronization.
 
     For the `docker-sync` tool:
 
     ```bash
     docker-sync start
     ```
 
-    For the `mutagen` tool:
+    If it is the first installation you should wait a few minutes for synchronization files
 
-    ```bash
-    bash ./mutagen.sh
-    ```
+    {: .bs-callout-info}
+    If you use `mutagen.io` for file synchronization, skip this step. You start `mutagen.io` _after_ deploying the docker containers.
 
 1.  Build files to containers and run in the background.
 
     ```bash
     docker-compose up -d
     ```
 
+1.  Start the file synchronization with `mutagen.io`.
+
+    ```bash
+    bash ./mutagen.sh
+    ```
+
+    {: .bs-callout-info}
+    If you use `docker-sync` for file synchronization, skip this step.
+
 1. Install Magento in your Docker environment.
 
     - Deploy Magento in the Docker container:

common/images/ui_comps/listing_button.png

@@ -45,8 +45,6 @@ runtime:
         - PHP_IDE_CONFIG=serverName=magento_cloud_docker
         - XDEBUG_CONFIG=remote_host=host.docker.internal
         - 'PHP_EXTENSIONS=bcmath bz2 calendar exif gd gettext intl mysqli pcntl pdo_mysql soap sockets sysvmsg sysvsem sysvshm opcache zip redis xsl xdebug'
-      env_file:
-        - ./.docker/config.env
     ```
     {:.no-copy}
 
@@ -60,19 +58,19 @@ runtime:
 
 1.  In your PhpStorm project, open the settings panel.
 
-    -  _Mac OS X_—Select **File** > **Preferences**.
-    -  _Windows/Linux_—Select **File** > **Settings**.
+    - _Mac OS X_—Select **File** > **Preferences**.
+    - _Windows/Linux_—Select **File** > **Settings**.
 
 1.  In the _Settings_ panel, expand and locate the **Languages & Frameworks** > **PHP** > **Servers** section.
 
 1.  Click the **+** to add a server configuration. The project name is in grey at the top.
 
 1.  Configure the following settings for the new server configuration:
 
-    -  **Name**—Enter the name used for the `serverName` in `PHP_IDE_CONFIG` option from `docker-compose.yml` file.
-    -  **Host**—Enter `localhost`.
-    -  **Port**—Enter `80`.
-    -  **Debugger**—Select `Xdebug`.
+    - **Name**—Enter the name used for the `serverName` in `PHP_IDE_CONFIG` option from `docker-compose.yml` file.
+    - **Host**—Enter `localhost`.
+    - **Port**—Enter `80`.
+    - **Debugger**—Select `Xdebug`.
 
 1.  Select **Use path mappings**. In the _File/Directory_ pane, the root of the project for the `serverName` displays.
 

guides/v2.2/cloud/docker/docker-config.md

@@ -58,8 +58,8 @@ stage:
 
 Enables or disables cleaning [static content files]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-static-view.html#config-cli-static-overview) generated during the build or deploy phase. We recommend the default value _true_ in development.
 
--   **`true`**—Removes all existing static content before deploying the updated static content.
--   **`false`**—The deployment only overwrites existing static content files if the generated content contains a newer version.
+-  **`true`**—Removes all existing static content before deploying the updated static content.
+-  **`false`**—The deployment only overwrites existing static content files if the generated content contains a newer version.
 
 If you make modifications to static content through a separate process, set the value to _false_.
 
@@ -79,9 +79,9 @@ deploy updates to existing files without removing the previous versions. Because
 
 Use this environment variable to confirm message queues are running after a deployment.
 
--   `cron_run`—A boolean value that enables or disables the `consumers_runner` cron job (default = `false`).
--   `max_messages`—A number specifying the maximum number of messages each consumer must process before terminating (default = `1000`). Although we do not recommend it, you can use `0` to prevent the consumer from terminating.
--   `consumers`—An array of strings specifying which consumer(s) to run. An empty array runs _all_ consumers.
+-  `cron_run`—A boolean value that enables or disables the `consumers_runner` cron job (default = `false`).
+-  `max_messages`—A number specifying the maximum number of messages each consumer must process before terminating (default = `1000`). Although we do not recommend it, you can use `0` to prevent the consumer from terminating.
+-  `consumers`—An array of strings specifying which consumer(s) to run. An empty array runs _all_ consumers.
 
 ```yaml
 stage:
@@ -101,6 +101,27 @@ By default, the deployment process overwrites all settings in the `env.php` file
 ```bash
 ./bin/magento queue:consumers:list
 ```
+
+### `CONSUMERS_WAIT_FOR_MAX_MESSAGES`
+
+-  **Default**—`false`
+-  **Version**—Magento 2.2.0 and later
+
+Configure how consumers process messages from the message queue by choosing one of the following options:
+
+- `false`—Consumers process available messages in the queue, close the TCP connection, and terminate. Consumers do not wait for additional messages to enter the queue, even if the number of processed messages is less than the `max_messages` value specified in the `CRON_CONSUMERS_RUNNER` deploy variable.
+
+- `true`—Consumers continue to process messages from the message queue until reaching the maximum number of messages (`max_messages`) specified in the `CRON_CONSUMERS_RUNNER` deploy variable before closing the TCP connection and terminating the consumer process. If the queue empties before reaching `max_messages`, the consumer waits for more messages to arrive.
+
+{: .bs-callout .bs-callout-warning}
+If you use workers to run consumers instead of using a cron job, set this variable to true.
+
+```yaml
+stage:
+  deploy:
+    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false
+```
+
 ### `CRYPT_KEY`
 
 -  **Default**—_Not set_
@@ -171,7 +192,7 @@ MariaDB [main]> SHOW TABLES;
 | ece_cache                           |
 | ece_cache_tag                       |
 | ece_captcha_log                     |
-.....
+...
 ```
 {: .no-copy}
 
@@ -209,8 +230,8 @@ stage:
 
 **Known limitations**—
 
--   Changing the search engine to any type other than `elasticsuite` causes a deploy failure accompanied by an appropriate validation error
--   Removing the ElasticSearch service causes a deploy failure accompanied by an appropriate validation error
+-  Changing the search engine to any type other than `elasticsuite` causes a deploy failure accompanied by an appropriate validation error
+-  Removing the ElasticSearch service causes a deploy failure accompanied by an appropriate validation error
 
 {:.bs-callout .bs-callout-info}
 Magento does not support the ElasticSuite third-party plugin.
@@ -222,8 +243,8 @@ Magento does not support the ElasticSuite third-party plugin.
 
 Enables and disables Google Analytics when deploying to Staging and Integration environments. By default, Google Analytics is true only for the Production environment. Set this value to `true` to enable Google Analytics in the Staging and Integration environments.
 
--   **`true`**—Enables Google Analytics on Staging and Integration environments.
--   **`false`**—Disables Google Analytics on Staging and Integration environments.
+-  **`true`**—Enables Google Analytics on Staging and Integration environments.
+-  **`false`**—Disables Google Analytics on Staging and Integration environments.
 
 Add the `ENABLE_GOOGLE_ANALYTICS` environment variable to the `deploy` stage in the `.magento.env.yaml` file:
 
@@ -249,6 +270,21 @@ stage:
     FORCE_UPDATE_URLS: true
 ```
 
+### `LOCK_PROVIDER`
+
+-  **Default**—`file`
+-  **Version**—Magento 2.2.5 and later
+
+The lock provider prevents the launch of duplicate cron jobs and cron groups. You must use the `file` lock provider in the Production environment. Starter environments and the Pro Integration environment do not use the [MAGENTO_CLOUD_LOCKS_DIR]({{page.baseurl}}/cloud/env/variables-cloud.html) variable, so `{{site.data.var.ct}}` applies the `db` lock provider automatically.
+
+```yaml
+stage:
+  deploy:
+    LOCK_PROVIDER: "db"
+```
+
+See [Configure the lock]({{page.baseurl}}/install-gde/install/cli/install-cli-subcommands-lock.html) in the _Install guide_.
+
 ### `MYSQL_USE_SLAVE_CONNECTION`
 
 -  **Default**—`false`
@@ -422,6 +458,7 @@ stage:
 Allows you to increase the maximum expected execution time for static content deployment.
 
 By default, Magento Commerce sets the maximum expected execution to 400 seconds, but in some scenarios you might need more time to complete the static content deployment for a Cloud project.
+
 ```yaml
 stage:
   deploy:

guides/v2.2/cloud/docker/docker-development-debug.md

@@ -146,3 +146,18 @@ The current default storage amount per project is 5GB, or 5120MB. You can distri
     ```
 
 1. Confirm the `service` and `type` from the response. The response provides connection information, such as the IP address and port number.
+
+## Service versions
+
+The following table lists the services used in {{site.data.var.ece}} and their version compatibility with the [Magento Cloud template](https://github.com/magento/magento-cloud).
+
+Service   |  Magento 2.3  | Magento 2.2
+--------- | ------------- | ------------
+`elasticsearch` | Magento 2.3.1 and later—1.7, 2.4, 5.2, 6.5<br>Magento 2.3.0—1.7, 2.4, 5.2 | Magento versions 2.2.8 and later—1.7, 2.4, 5.2, 6.5<br>Magento 2.2.0 to 2.2.7—1.7, 2.4, 5.2
+`mariadb` | 10.0 to 10.2  | 10.0 to 10.2
+`nginx`   | 1.9           | 1.9
+`node`    | 6, 8, 10, 11  | 6, 8, 10, 11
+`php`     | Magento 2.3.3 and later—7.1, 7.2, 7.3<br>Magento 2.3.0 to 2.3.2—7.1, 7.2 | Magento 2.2.10 and later—7.1, 7.2<br>Magento 2.2.5 to 2.2.9—7.0, 7.1<br>Magento 2.2.4 and earlier—7.0.2, 7.0.4, ~7.0.6, 7.1
+`rabbitmq`| 3.5, 3.7      | 3.5
+`redis`   | 3.2, 4.0, 5.0 | 3.2, 4.0, 5.0
+`varnish` | Magento 2.3.3 and later—4.0, 5.0, 6.2<br>Magento 2.3.0 to 2.3.2—4.0, 5.0 | 4.0, 5.0