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.
Copy file name to clipboardExpand all lines: src/cloud/docker/docker-mode-developer.md
+7-10Lines changed: 7 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Developer mode supports an active development environment with full, writable fi
11
11
12
12
## Performance considerations
13
13
14
-
On macOS and Windows systems, performance is slower in developer mode because of additional file synchronization operations. However, you can improve performance by using either the `manual-native` or the `mutagen` file synchronization option when you generate the `docker-compose.yml` file. See [Synchronizing data in Docker].
14
+
On macOS and Windows systems, performance is slower in developer mode because of additional file synchronization operations. However, you can improve performance by using either the `manual-native` or the `mutagen` file synchronization option when you generate the `docker-compose.yml` file. See [Synchronizing data in Docker][sync].
15
15
16
16
{: .bs-callout-info }
17
17
The `{{site.data.var.ct}}` version 2002.0.18 and later supports developer mode.
@@ -24,7 +24,7 @@ Large files (>1 GB) can cause a period of inactivity. DB dumps and archive files
24
24
**Prerequisites:**
25
25
26
26
- Complete the [installation steps].
27
-
-[Install file synchronization tools][Synchronizing data in Docker] if needed.
27
+
-[Install file synchronization tools][sync] if needed.
28
28
29
29
{:.procedure}
30
30
To launch the Docker environment in developer mode:
@@ -35,7 +35,10 @@ To launch the Docker environment in developer mode:
Copy file name to clipboardExpand all lines: src/cloud/project/project-webint-snap.md
+40-41Lines changed: 40 additions & 41 deletions
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ You can back up and restore specific environments at any time using a snapshot.
10
10
A _snapshot_ is a complete backup of an environment that includes all persistent data from all running services (for example, your MySQL database, Redis, and so on) and any files stored on the mounted volumes. Because an environment deploys as a read-only file system, restoring a snapshot is very fast.
11
11
12
12
{:.bs-callout-warning}
13
-
If you want to rollback to previous code or remove added extensions in an environment, restoring a snapshot is not the recommended method. See [Rollbacks to remove code](#rollback-code). If you need to restore an unstable environment that does not have a snapshot, see [Restore an environment]({{ site.baseurl }}/cloud/env/restore-environment.html).
13
+
If you want to rollback to previous code or remove added extensions in an environment, restoring a snapshot is not the recommended method. See [Rollbacks to remove code](#rollback-code). If you must restore an unstable environment that does not have a snapshot, see [Restore an environment]({{ site.baseurl }}/cloud/env/restore-environment.html).
14
14
15
-
You have up to **7 days** to _restore_ a snapshot.
15
+
You have up to **seven days** to _restore_ a snapshot.
16
16
17
-
We provide two methods for creating and managing snapshots:
17
+
Adobe provides two methods for creating and managing snapshots:
18
18
19
19
- Project Web Interface
20
20
- Magento Cloud CLI
@@ -116,10 +116,9 @@ To restore a snapshot using the Magento Cloud CLI:
116
116
117
117
## Dump your database {#db-dump}
118
118
119
-
You can create a copy of your database using the [`magento/ece-tools`]({{ site.baseurl }}/cloud/reference/cloud-composer.html#cloud-composer-cloudmeta) `db-dump`command.
119
+
You can create a copy of your database using the `{{site.data.var.ct}} db-dump` command. By default, this command creates backups in the `/app/var/dump-main` directory for all database connections that are specified in the environment configuration. For example, if you configured your project to use split databases, the `db-dump`operation creates backups for each of the configured databases.
120
120
121
-
By default, this command creates backups for all database connections that are specified in the environment configuration. For example, if you configured your project to use split databases, the `db-dump` operation creates backups for each of the configured databases.
122
-
You can also backup only selected databases by appending the database names to the command, for example:
121
+
You can also back up only selected databases by appending the database names to the command, for example:
123
122
124
123
```bash
125
124
php vendor/bin/ece-tools -- main sales
@@ -128,43 +127,43 @@ php vendor/bin/ece-tools -- main sales
128
127
For help, use the command: `php vendor/bin/ece-tools db-dump --help`
129
128
130
129
{:.procedure}
131
-
To create a database dump:
130
+
To create a database dump in the Staging or Production environment:
132
131
133
-
1.[SSH into the environment]({{ site.baseurl }}/cloud/env/environments-ssh.html) that contains the database you want to copy:
132
+
1.[Use SSH to log in to the environment]({{ site.baseurl }}/cloud/env/environments-ssh.html) that contains the database to copy:
134
133
135
134
-**Staging:**`ssh -A <project ID>_stg@<project ID>.ent.magento.cloud`
136
135
-**Production:**`ssh -A <project ID>@<project ID>.ent.magento.cloud`
137
-
- To SSH into the `master` branch of your Integration environment:
138
-
139
-
```bash
140
-
magento-cloud environment:ssh
141
-
```
142
-
143
-
1. Enter the following command:
144
-
145
-
```bash
146
-
php vendor/bin/ece-tools db-dump
147
-
```
148
-
149
-
```terminal
150
-
php vendor/bin/ece-tools db-dump
151
-
The db-dump operation switches the site to maintenance mode, stops all active cron jobs and consumer queue processes, and disables cron jobs before starting the dump process.
152
-
Your site will not receive any traffic until the operation completes.
153
-
Do you wish to proceed with this process? (y/N)? y
[2020-01-28 16:38:10] INFO: Trying to kill running cron jobs and consumers processes
157
-
[2020-01-28 16:38:10] INFO: Running Magento cron and consumers processes were not found.
158
-
[2020-01-28 16:38:10] INFO: Waiting for lock on db dump.
159
-
[2020-01-28 16:38:10] INFO: Start creation DB dump for main database...
160
-
[2020-01-28 16:38:10] INFO: Finished DB dump for main database, it can be found here: /tmp/qxmtlseakof6y/dump-main-1580229490.sql.gz
161
-
[2020-01-28 16:38:10] INFO: Backup completed.
162
-
[2020-01-28 16:38:11] NOTICE: Maintenance mode is disabled.
163
-
```
164
-
165
-
{:.bs-callout-info}
166
-
167
-
- For Production environments, we recommend completing database dump operations during off-peak hours to minimize service disruptions that occur when the site is in maintenance mode.
136
+
137
+
```bash
138
+
magento-cloud environment:ssh
139
+
```
140
+
141
+
1. Create a backup of the database. To choose a target directory for the DB dump, use the `--dump-directory` option.
142
+
143
+
```bash
144
+
php vendor/bin/ece-tools db-dump
145
+
```
146
+
147
+
Sample response:
148
+
149
+
```terminal
150
+
The db-dump operation switches the site to maintenance mode, stops all active cron jobs and consumer queue processes, and disables cron jobs before starting the dump process.
151
+
Your site will not receive any traffic until the operation completes.
152
+
Do you wish to proceed with this process? (y/N)? y
[2020-01-28 16:38:10] INFO: Trying to kill running cron jobs and consumers processes
156
+
[2020-01-28 16:38:10] INFO: Running Magento cron and consumers processes were not found.
157
+
[2020-01-28 16:38:10] INFO: Waiting for lock on db dump.
158
+
[2020-01-28 16:38:10] INFO: Start creation DB dump for main database...
159
+
[2020-01-28 16:38:10] INFO: Finished DB dump for main database, it can be found here: /tmp/qxmtlseakof6y/dump-main-1580229490.sql.gz
160
+
[2020-01-28 16:38:10] INFO: Backup completed.
161
+
[2020-01-28 16:38:11] NOTICE: Maintenance mode is disabled.
162
+
```
163
+
164
+
{:.bs-callout-info}
165
+
166
+
- For Production environments, Adobe recommends completing database dump operations during off-peak hours to minimize service disruptions that occur when the site is in maintenance mode.
168
167
- The `db-dump` command creates an archive in your remote project directory called `dump-<timestamp>.sql.gz`.
169
168
- If an error occurs during the dump operation, the command deletes the dump file to conserve disk space. Review the logs for details (`var/log/cloud.log`).
170
169
- For Pro Production environments, this command dumps only from one of three high-availability nodes, so production data written to a different node during the dump might not be copied. The command generates a `var/dbdump.lock` file to prevent the command from running on more than one node.
@@ -174,8 +173,8 @@ If you want to push this data into an environment, see [Migrate data and static
174
173
175
174
## Rollbacks to remove code {#rollback-code}
176
175
177
-
We recommend creating a snapshot of the environment and a backup of the database prior to deployments.
176
+
Adobe recommends creating a snapshot of the environment and a backup of the database prior to deployments.
178
177
179
-
If you need to restore a snapshot specifically to remove new code and added extensions, the process can be complicated depending on the amount of changes and when you rollback. Some rollbacks might require database changes.
178
+
If you must restore a snapshot specifically to remove new code and added extensions, the process can be complicated depending on the number of changes and when you roll back. Some rollbacks might require database changes.
180
179
181
180
Specifically for code, you should investigate reverting code changes from your branch before redeploying. If not, every deploy pushes the master branch (code and extensions) to the target environment again. See the [Deployment Process]({{ site.baseurl }}/cloud/reference/discover-deploy.html).
Copy file name to clipboardExpand all lines: src/cloud/release-notes/cloud-tools.md
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,7 @@ This release information details the latest improvements to the {{site.data.var.
21
21
When you update to `{{site.data.var.ct}}` 2002.1.0 or later, you automatically update to the latest versions of the other packages, which are dependencies for `{{site.data.var.ct}}`.
0 commit comments