Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
a115544
Added header for 2002.0.19 release notes
meker12 May 13, 2019
aced8c2
Add FORCE_UPDATE_URLS deploy variable doc (#4516)
meker12 May 14, 2019
0e94bfe
MAGECLOUD-2973 db table prefixes (#4511)
hguthrie May 15, 2019
678f470
MAGECLOUD-3569: Improve UX by adding scripts (#4565)
shiftedreality May 21, 2019
d003336
MAGECLOUD-3545 add release note for exclude list (#4542)
hguthrie May 21, 2019
0faa238
Merge branch 'master' into Cloud-2002.0.20
hguthrie May 28, 2019
97cf734
Merge branch 'master' into Cloud-2002.0.20
hguthrie Jun 10, 2019
efd823d
MAGECLOUD-3258 warm cache with multiple pages (#4720)
hguthrie Jun 12, 2019
0e0d588
MAGECLOUD-3258: warm cache with multiple pages (#4749)
oshmyheliuk Jun 13, 2019
3581274
MAGECLOUD-3813 ece-tools reference (#4787)
hguthrie Jun 20, 2019
6372e19
Add contributor credit to release notes (#4794)
hguthrie Jun 21, 2019
236e6be
MAGECLOUD-3357: [Cloud Docker] Changes in .magento.app.yaml should af…
Jun 21, 2019
c6277ba
Added TTFB_TESTED_PAGES env variable docs (#4817)
meker12 Jun 25, 2019
0039c4b
MAGECLOUD-3684 functional testing in Docker (#4828)
hguthrie Jun 25, 2019
6eb32d2
Merge branch 'master' into Cloud-2002.0.20
hguthrie Jun 25, 2019
dfe0554
Apply fixes to Docker Xdebug content
hguthrie Jun 25, 2019
f04a946
Add magento-cloud CLI template for command list
hguthrie Jun 25, 2019
26865ab
MAGECLOUD-3611 multi scd threads
hguthrie Jun 25, 2019
32cfa75
MAGECLOUD-3582 magento root path for docker
hguthrie Jun 25, 2019
265f63b
Release notes for 2.2 and 2.1 bugs
hguthrie Jun 25, 2019
9433ae7
yaml fixes
hguthrie Jun 26, 2019
38ab8d5
sodium update
hguthrie Jun 26, 2019
993862e
image updates and log levels
hguthrie Jun 26, 2019
ec5b8ce
MAGECLOUD-3357 php extension update
hguthrie Jun 27, 2019
6a8321a
Reformatted magento-cloud json
hguthrie Jun 27, 2019
107ad1e
forgot to add php link
hguthrie Jun 27, 2019
2fe6bad
clean template wording
hguthrie Jun 27, 2019
a85a737
indenting problem
hguthrie Jun 27, 2019
5c1949d
resort notes for emphasis
hguthrie Jun 27, 2019
99d87c3
remove variable not in use from sample
hguthrie Jun 27, 2019
f2c05eb
Update docker-development-debug.md
hguthrie Jun 27, 2019
9b1b477
Updates to release notes based on technical feedback
hguthrie Jun 27, 2019
4be03cf
Update guides/v2.1/cloud/env/variables-deploy.md
hguthrie Jun 27, 2019
62b42d7
Apply suggestions from code review
hguthrie Jun 27, 2019
aa85069
fix post-deploy
hguthrie Jun 27, 2019
f1ddcc3
remove CLI reference
hguthrie Jun 27, 2019
e9ff478
Merge branch 'master' into Cloud-2002.0.20
hguthrie Jun 27, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions _data/toc/cloud-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ pages:
- label: Magento Cloud CLI
url: /cloud/reference/cli-ref-topic.html

- label: ece-tools package
url: /cloud/reference/ece-tools-reference.html

- label: Git
url: /cloud/reference/git-integration.html

Expand Down Expand Up @@ -105,6 +108,9 @@ pages:
- label: Connect to the database
url: /cloud/docker/docker-database.html

- label: Functional testing in Docker
url: /cloud/docker/docker-development-testing.html

- label: Docker quick reference
url: /cloud/docker/docker-quick-reference.html

Expand Down
2 changes: 1 addition & 1 deletion _includes/cloud/note-ece-tools-release-info.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
{: .bs-callout .bs-callout-info}
{: .bs-callout-info}
For current {{ site.data.var.ece }} release information, see [Release notes for ece-tools]({{ page.baseurl }}/cloud/release-notes/cloud-tools.html).
4 changes: 3 additions & 1 deletion guides/v2.1/cloud/bk-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Amazon Web Services (AWS) powers the underlying Infrastructure as a Service (Iaa

## {{site.data.var.ct}} package

The `{{site.data.var.ct}}` package is a scalable deployment tool that simplifies the Cloud upgrade process. In 2018, we deprecated the `magento-cloud-configuration` and `ece-patches` packages in favor of providing a single package. We encourage all customers to [upgrade to use `{{site.data.var.ct}}`]({{page.baseurl}}/cloud/project/ece-tools-upgrade-project.html) as soon as possible to benefit from the package features, such as commands to create a backup of the database, apply custom patches, and verify environment configuration.
The [`{{site.data.var.ct}}` package][ece] is a scalable deployment tool that simplifies the Cloud upgrade process. In 2018, we deprecated the `magento-cloud-configuration` and `ece-patches` packages in favor of providing a single package. We encourage all customers to [upgrade to use `{{site.data.var.ct}}`]({{page.baseurl}}/cloud/project/ece-tools-upgrade-project.html) as soon as possible to benefit from the package features, such as commands to create a backup of the database, apply custom patches, and verify environment configuration.

<!-- Link definitions -->

Expand All @@ -31,3 +31,5 @@ The `{{site.data.var.ct}}` package is a scalable deployment tool that simplifies

[Cloud Stack]: {{site.baseurl}}/common/images/cloud/CloudStack.png
{: width="804px" height="721px"}

[ece]: {{page.baseurl}}/cloud/reference/ece-tools-reference.html
88 changes: 50 additions & 38 deletions guides/v2.1/cloud/docker/docker-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,38 +52,44 @@ For example, the following command starts the Docker configuration generator for
./vendor/bin/ece-tools docker:build --mode="developer" --php 7.2
```

### Prerequisites
## Prerequisites

You must have the following software installed on your local workstation:
1. You must have the following software installed on your local workstation:

- PHP version 7.1 or later
- [php@7.1](https://formulae.brew.sh/formula/php@7.1)
- [php@7.2](https://formulae.brew.sh/formula/php@7.2)
- [Composer](https://getcomposer.org)
- [Docker](https://www.docker.com/get-started)
- [docker-sync](https://docker-sync.readthedocs.io/en/latest/getting-started/installation.html)—file synchronization is required for developer mode
- PHP version 7.1 or later
- [php@7.1](https://formulae.brew.sh/formula/php@7.1)
- [php@7.2](https://formulae.brew.sh/formula/php@7.2)
- [Composer](https://getcomposer.org)
- [Docker](https://www.docker.com/get-started)
- File synchronization required for developer mode—use one of the following:
- [docker-sync](https://docker-sync.readthedocs.io/en/latest/getting-started/installation.html)
- [mutagen](https://mutagen.io/documentation/installation/#installation)

Before you begin, you must add the following hostname to your `/etc/hosts` file:
1. Update the hosts file.

```
127.0.0.1 magento2.docker
```
Before you begin, you must add the following hostname to your `/etc/hosts` file:

Alternatively, you can run the following command to add it to the file:
```
127.0.0.1 magento2.docker
```

```bash
echo "127.0.0.1 magento2.docker" | sudo tee -a /etc/hosts
```
Alternatively, you can run the following command to add it to the file:

### Stopping default Apache instance on Mac OS
```bash
echo "127.0.0.1 magento2.docker" | sudo tee -a /etc/hosts
```

Because Mac OS provides built-in Apache service, and may occupy port `80`, you must stop the service with the following command:
1. Stop the default Apache instance on Mac OS.

```bash
sudo apachectl stop
```
Because Mac OS provides built-in Apache service, and may occupy port `80`, you must stop the service with the following command:

```bash
sudo apachectl stop
```

#### To launch Docker:
1. Optionally, [enable Xdebug]({{page.baseurl}}/cloud/docker/docker-development-debug.html#enable-xdebug).

## Launch the Docker environment

1. Download a Magento application template from the [Magento Cloud repository](https://github.com/magento/magento-cloud). Be careful to select the branch that corresponds with the Magento version.

Expand All @@ -110,7 +116,7 @@ Continue launching your Docker environment in the default _production_ mode.
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
cp docker/config.php.dist docker/config.php
cp .docker/config.php.dist .docker/config.php
```

Convert custom PHP configuration files to Docker ENV files.
Expand All @@ -121,12 +127,12 @@ Continue launching your Docker environment in the default _production_ mode.

This generates the following Docker ENV files:

* `docker/config.env`
* `.docker/config.env`

{: .bs-callout .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 [enable and configure Xdebug]({{ page.baseurl }}/cloud/docker/docker-development-debug.html).
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.

Expand All @@ -138,15 +144,15 @@ Continue launching your Docker environment in the default _production_ mode.

- Build Magento in the Docker container:

```bash
docker-compose run build cloud-build
```
```bash
docker-compose run build cloud-build
```

- Deploy Magento in the Docker container:

```bash
docker-compose run deploy cloud-deploy
```
```bash
docker-compose run deploy cloud-deploy
```

{: .bs-callout .bs-callout-info}
For `{{site.data.var.ct}}` v2002.0.12, install Magento with the `docker-compose run cli magento-installer` command.
Expand Down Expand Up @@ -184,7 +190,7 @@ The `{{site.data.var.ct}}` version 2002.0.18 and later supports developer mode.
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
cp docker/config.php.dist docker/config.php
cp .docker/config.php.dist .docker/config.php
```

Convert custom PHP configuration files to Docker ENV files.
Expand All @@ -195,16 +201,24 @@ The `{{site.data.var.ct}}` version 2002.0.18 and later supports developer mode.

This generates the following Docker ENV files:

* `docker/config.env`
* `.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.

For the `docker-sync` tool:

```bash
docker-sync start
```

For the `mutagen` tool:

```bash
bash ./mutagen.sh
```

1. Build files to containers and run in the background.

```bash
Expand Down Expand Up @@ -272,11 +286,11 @@ docker-sync stop

## Advanced usage

### Extending docker-compose.yml configuration
### Extend the Docker configuration

You can use Docker's built-in [extension mechanism](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files).
You can use the built-in extension mechanism of Docker to [specify multiple compose files](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files). The following example replaces the default value of the `ENABLE_SENDMAIL` environment variable.

1. Create a `docker-compose-dev.yml` file inside your project's root directory and add the following content:
1. Create a `docker-compose-dev.yml` file inside your project root directory and add the following content:

```yaml
version: '2'
Expand All @@ -286,8 +300,6 @@ You can use Docker's built-in [extension mechanism](https://docs.docker.com/comp
- ENABLE_SENDMAIL=true
```

This replaces the default value of the `ENABLE_SENDMAIL` environment variable.

1. Pass both configuration files while executing your commands. For example:

```bash
Expand Down
6 changes: 3 additions & 3 deletions guides/v2.1/cloud/docker/docker-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ functional_areas:
- Configuration
---

There are two ways to connect to the database. Before you begin, you can find the database credentials in the `database` section of the `docker/config.php` file. The examples use the following default credentials:
There are two ways to connect to the database. Before you begin, you can find the database credentials in the `database` section of the `.docker/config.php` file. The examples use the following default credentials:

> Filename: `docker/config.php`
> Filename: `.docker/config.php`

```php?start_inline=1
return [
Expand Down Expand Up @@ -85,4 +85,4 @@ return [
| 10.0.38-MariaDB-1~xenial |
+--------------------------+
```
{: .no-copy}
{: .no-copy}
52 changes: 33 additions & 19 deletions guides/v2.1/cloud/docker/docker-development-debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,29 +18,43 @@ If you use Microsoft Windows, take the following steps before continuing:

## Enable Xdebug

To enable Xdebug, you must configure your `docker-compose.yaml` file at the time you configure your local workstation to [Launch Docker]({{ page.baseurl }}/cloud/docker/docker-config.html).
To enable Xdebug for your project, add `xdebug` to the `runtime:extensions` section of the `.magento.app.yaml` file.

```yaml
generic:
image: alpine
environment:
- PHP_MEMORY_LIMIT=2048M
- DEBUG=false
- ENABLE_SENDMAIL=false
- UPLOAD_MAX_FILESIZE=64M
- MAGENTO_ROOT=/app
- PHP_ENABLE_XDEBUG=false
- PHP_IDE_CONFIG=serverName=magento_cloud_docker
- XDEBUG_CONFIG=remote_host=host.docker.internal
env_file:
- ./docker/config.env
runtime:
extensions:
- redis
- xsl
- json
- blackfire
- newrelic
- xdebug
```

You can change any Xdebug configuration using the`XDEBUG_CONFIG` option. For example, to change the `xdebug.remote_port` option:
## Configure Xdebug

```yaml
XDEBUG_CONFIG='remote_host=host.docker.internal remote_port=9002'
```
1. Rebuild the `docker-compose.yml` file by continuing to configure your local workstation to [launch the Docker environment]({{ page.baseurl }}/cloud/docker/docker-config.html). The following is an excerpt from the `docker-compose.yml` file that shows Docker global variables.

```yaml
generic:
image: alpine
environment:
- PHP_MEMORY_LIMIT=2048M
- UPLOAD_MAX_FILESIZE=64M
- MAGENTO_ROOT=/app
- 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}

1. Change any Xdebug configuration using the`XDEBUG_CONFIG` option. For example, to change the `xdebug.remote_port` option:

```yaml
XDEBUG_CONFIG='remote_host=host.docker.internal remote_port=9002'
```

#### To configure PhpStorm to work with Xdebug:

Expand Down Expand Up @@ -68,7 +82,7 @@ XDEBUG_CONFIG='remote_host=host.docker.internal remote_port=9002'

1. Click **Apply**.

## Using Xdebug
## Use Xdebug

The following steps describe debugging web requests and CLI commands.

Expand Down
Loading