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

Commit 678f470

Browse files
shiftedrealityhguthrie
authored andcommitted
MAGECLOUD-3569: Improve UX by adding scripts (#4565)
1 parent 0e94bfe commit 678f470

File tree

5 files changed

+25
-11
lines changed

5 files changed

+25
-11
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Continue launching your Docker environment in the default _production_ mode.
9696
1. _Optional_: Copy the raw configuration files.
9797

9898
```bash
99-
cp docker/config.php.dist docker/config.php
99+
cp .docker/config.php.dist .docker/config.php
100100
```
101101

102102
1. _Optional_: Convert the PHP configuration files to Docker ENV files.
@@ -107,7 +107,7 @@ Continue launching your Docker environment in the default _production_ mode.
107107

108108
This command generates the following Docker ENV files:
109109

110-
* `docker/config.env`
110+
* `.docker/config.env`
111111

112112
{: .bs-callout .bs-callout-info}
113113
The `{{site.data.var.ct}}` version 2002.0.12 package does not support the `docker:config:convert` command.
@@ -170,7 +170,7 @@ The `{{site.data.var.ct}}` version 2002.0.18 and later supports developer mode.
170170
1. _Optional_: Copy the raw configuration files.
171171

172172
```bash
173-
cp docker/config.php.dist docker/config.php
173+
cp .docker/config.php.dist .docker/config.php
174174
```
175175

176176
1. _Optional_: Convert the PHP configuration files to Docker ENV files.
@@ -181,7 +181,7 @@ The `{{site.data.var.ct}}` version 2002.0.18 and later supports developer mode.
181181

182182
This command generates the following Docker ENV files:
183183

184-
* `docker/config.env`
184+
* `.docker/config.env`
185185

186186
1. _Optional_: Configure the Docker global variables in the `docker-compose.yaml` file. For example, you can [enable and configure Xdebug]({{ page.baseurl }}/cloud/docker/docker-development-debug.html).
187187

guides/v2.1/cloud/docker/docker-database.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ functional_areas:
77
- Configuration
88
---
99

10-
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:
10+
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:
1111

12-
> Filename: `docker/config.php`
12+
> Filename: `.docker/config.php`
1313
1414
```php?start_inline=1
1515
return [
@@ -85,4 +85,4 @@ return [
8585
| 10.0.38-MariaDB-1~xenial |
8686
+--------------------------+
8787
```
88-
{: .no-copy}
88+
{: .no-copy}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ generic:
3333
- PHP_IDE_CONFIG=serverName=magento_cloud_docker
3434
- XDEBUG_CONFIG=remote_host=host.docker.internal
3535
env_file:
36-
- ./docker/config.env
36+
- ./.docker/config.env
3737
```
3838
3939
You can change any Xdebug configuration using the`XDEBUG_CONFIG` option. For example, to change the `xdebug.remote_port` option:

guides/v2.1/cloud/docker/docker-development.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ The database container is based on the `mariadb:10` image.
7676

7777
#### To import a database dump:
7878

79-
Place the SQL file into the `docker/mysql/docker-entrypoint-initdb.d` folder.
79+
Place the SQL file into the `.docker/mysql/docker-entrypoint-initdb.d` folder.
8080

8181
The `{{site.data.var.ct}}` package imports and processes the SQL file the next time you build and start the Docker environment using the `docker-compose up` command.
8282

83-
Although it is a more complex approach, you can use GZIP by _sharing_ the `.sql.gz` file using the `docker/mnt` directory and importing it inside the Docker container.
83+
Although it is a more complex approach, you can use GZIP by _sharing_ the `.sql.gz` file using the `.docker/mnt` directory and importing it inside the Docker container.
8484

8585
## Varnish container
8686

@@ -90,7 +90,7 @@ The TLS termination proxy container, based on the [magento/magento-cloud-docker
9090

9191
## Sharing data between host machine and container
9292

93-
You can share files easily between your machine and a Docker container by placing the files in the `docker/mnt` directory. You can find the files in the `/mnt` directory the next time you build and start the Docker environment using the `docker-compose up` command.
93+
You can share files easily between your machine and a Docker container by placing the files in the `.docker/mnt` directory. You can find the files in the `/mnt` directory the next time you build and start the Docker environment using the `docker-compose up` command.
9494

9595
## Sendmail service
9696

guides/v2.1/cloud/docker/docker-quick-reference.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,17 @@ php ./vendor/bin/ece-tools list | grep docker
5050
| ------------ | ---------------- | ------------------
5151
| Mode | `--mode`, `-m` | production, developer
5252

53+
## bin/docker
54+
55+
Action | Command
56+
:----- | :------
57+
Pull latest images | pull
58+
Destroy, re-create and start containers | up
59+
Destroy containers | down
60+
Build application | build
61+
Deploy application | up
62+
Re-build and re-deploy application | redeploy
63+
Connect to bash | bash
64+
Stop containers | stop
65+
Start containers | start
66+
Restart containers | restart

0 commit comments

Comments
 (0)