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

Commit 6011d72

Browse files
hguthriehguthrie
committed
Release notes
1 parent 39cdb7a commit 6011d72

File tree

6 files changed

+69
-46
lines changed

6 files changed

+69
-46
lines changed

‎src/_includes/cloud/backup-db.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To back up your Staging or Production environment database before deploying:
2525

2626
1. Use SSH to log in to the remote server.
2727

28-
1. Create a database dump.
28+
1. Create a database dump. To choose a target directory for the DB dump, use the `--dump-directory` option.
2929

3030
```bash
3131
vendor/bin/ece-tools db-dump

‎src/cloud/project/project-webint-snap.md

Lines changed: 40 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ You can back up and restore specific environments at any time using a snapshot.
1010
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.
1111

1212
{:.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).
1414

15-
You have up to **7 days** to _restore_ a snapshot.
15+
You have up to **seven days** to _restore_ a snapshot.
1616

17-
We provide two methods for creating and managing snapshots:
17+
Adobe provides two methods for creating and managing snapshots:
1818

1919
- Project Web Interface
2020
- Magento Cloud CLI
@@ -116,10 +116,9 @@ To restore a snapshot using the Magento Cloud CLI:
116116

117117
## Dump your database {#db-dump}
118118

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

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

124123
```bash
125124
php vendor/bin/ece-tools -- main sales
@@ -128,43 +127,43 @@ php vendor/bin/ece-tools -- main sales
128127
For help, use the command: `php vendor/bin/ece-tools db-dump --help`
129128

130129
{:.procedure}
131-
To create a database dump:
130+
To create a database dump in the Staging or Production environment:
132131

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

135134
- **Staging:** `ssh -A <project ID>_stg@<project ID>.ent.magento.cloud`
136135
- **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
154-
2020-01-28 16:38:08] INFO: Starting backup.
155-
[2020-01-28 16:38:08] NOTICE: Enabling Maintenance mode
156-
[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
153+
2020-01-28 16:38:08] INFO: Starting backup.
154+
[2020-01-28 16:38:08] NOTICE: Enabling Maintenance mode
155+
[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.
168167
- The `db-dump` command creates an archive in your remote project directory called `dump-<timestamp>.sql.gz`.
169168
- 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`).
170169
- 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
174173

175174
## Rollbacks to remove code {#rollback-code}
176175

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

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

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

‎src/cloud/release-notes/ece-release-notes.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,12 @@ The release notes include:
2323

2424
## v2002.1.8
2525

26-
Release date: October xx, 2021
26+
Release date: October 25, 2021
27+
28+
- {:.new}**Alternative dump location**—Added the `--dump-directory` option so that you can choose a target directory for a DB dump. Now `/app/var/dump-main` is the default target directory for a DB dump.<!-- MCLOUD-8063 -->
29+
- {:.fix}**Update Monolog**—Updated the minimum version required for the `monolog` package to `^2.3`.<!-- ACMP-1263 -->
30+
- {:.fix}**Update Symfony**—Updated the Symfony dependencies to be compatible with {{site.data.var.ee}} 2.4.4.<!-- ACMP-1533 -->
31+
- {:.fix}**Feature/resolve autoload**—Fixed an issue when deploying to an integration environment and seeing the `CRITICAL: [9] Required configuration is missed in autoload section of composer.json file.` error.<!-- https://github.com/magento/ece-tools/pull/799 -->
2732

2833
## v2002.1.7
2934

‎src/cloud/release-notes/mcc-release-notes.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ The release notes include:
2020

2121
## v1.0.9
2222

23-
Release date: October xx, 2021
23+
Release date: October 25, 2021
24+
25+
- {:.fix}**Update Monolog**—Updated the minimum version required for the `monolog` package to `^2.3`.<!-- ACMP-1263 -->
2426

2527
## v1.0.8
2628

‎src/cloud/release-notes/mcd-release-notes.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,20 @@ The release notes include:
2020

2121
## v1.3.0
2222

23-
Release date: October xx, 2021
23+
Release date: October 25, 2021
24+
25+
- {:.fix}**Improve Developer mode workflow**—Previously, you needed to specify the mode in the build and deploy steps. Now, the `--mode` option in the `build` step determines the mode in the later `deploy` step. Setting the mode after the deployment is no longer required. See [Developer mode](({{ site.baseurl}}/cloud/docker/docker-mode-developer.html).<!-- ACMP-1086 -->
26+
- {:.fix}**Improvements for RO filesystem**—<!-- ACMP-1106 -->
27+
- Fix issue starting a PHP container for mail configuration.
28+
- Can use environment variables in INI files.
29+
- Ensure PHP entry points do not need write permission.
30+
- {:.fix}**Update Node**—Update the bundled Node version; when installing Node in PHP-CLI images, it now uses the current LTS version.<!-- ACMP-1539 -->
31+
- {:.fix}**Update Symfony**—Updated the Symfony config dependencies to be compatible with {{site.data.var.ee}} 2.4.4.<!-- ACMP-1533 -->
32+
33+
*ini files are using environment variables to no require writable FS
34+
PHP-FPM files are using environment variables to no require writable FS
35+
PHP container is configured to read php.ini in the root directory with lower priority than the system in files
36+
ARG added to replace container-specific services like crontab and Compsoer version
2437

2538
## v1.2.4
2639

‎src/cloud/release-notes/mcp-release-notes.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,11 @@ The `{{site.data.var.mcp-package}}` package uses the following version sequence:
2323

2424
## v1.0.13
2525

26-
Release date: October xx, 2021
26+
Release date: October 25, 2021
27+
28+
- **Update Monolog**—Updated the minimum version required for the `monolog` package to `^2.3`.<!-- ACMP-1263 -->
29+
- **Incompatible PHP Method**—Fixed incompatible PHP method for {{site.data.var.ee}} versions 2.4.3 and 2.3.7-p1.<!-- AC-384 -->
30+
- **PHP error**—Fixed a `PHP error 'Undefined variable: errorMessage' ...` error that occurred while trying to apply a patch.<!-- ACP2E-138 -->
2731

2832
## v1.0.12
2933

0 commit comments

Comments
 (0)