diff --git a/src/_data/var.yml b/src/_data/var.yml index c8502b9f145..83f9e7ce95f 100644 --- a/src/_data/var.yml +++ b/src/_data/var.yml @@ -21,24 +21,23 @@ mbi: Adobe Commerce Reporting # Cloud product name variables ece: Adobe Commerce on cloud infrastructure -ece-release-date: July 29, 2021 csuite: Cloud Suite for Commerce ct: ece-tools ct-repo: magento/ece-tools -ct-release: 2002.1.7 +ct-release: 2002.1.8 mcc-prod: Cloud Components of Commerce mcc-package: magento/magento-cloud-components -mcc-release: 1.0.8 +mcc-release: 1.0.9 mcd-prod: Cloud Docker for Commerce mcd-package: magento/magento-cloud-docker -mcd-release: 1.2.4 +mcd-release: 1.3.0 mcp-prod: Cloud Patches for Commerce mcp-package: magento/magento-cloud-patches -mcp-release: 1.0.12 +mcp-release: 1.0.13 # TIP: Use the following syntax to use a variable in the documentation source: {{site.data.var.xx}} where xx # is the variable value. diff --git a/src/_includes/cloud/backup-db.md b/src/_includes/cloud/backup-db.md index 9b9b91424d2..4684df2331a 100644 --- a/src/_includes/cloud/backup-db.md +++ b/src/_includes/cloud/backup-db.md @@ -25,7 +25,7 @@ To back up your Staging or Production environment database before deploying: 1. Use SSH to log in to the remote server. -1. Create a database dump. +1. Create a database dump. To choose a target directory for the DB dump, use the `--dump-directory` option. ```bash vendor/bin/ece-tools db-dump diff --git a/src/cloud/docker/docker-mode-developer.md b/src/cloud/docker/docker-mode-developer.md index ed6eca986f4..50fbb0a01d1 100644 --- a/src/cloud/docker/docker-mode-developer.md +++ b/src/cloud/docker/docker-mode-developer.md @@ -11,7 +11,7 @@ Developer mode supports an active development environment with full, writable fi ## Performance considerations -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]. +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]. {: .bs-callout-info } 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 **Prerequisites:** - Complete the [installation steps]. -- [Install file synchronization tools][Synchronizing data in Docker] if needed. +- [Install file synchronization tools][sync] if needed. {:.procedure} To launch the Docker environment in developer mode: @@ -35,7 +35,10 @@ To launch the Docker environment in developer mode: ./vendor/bin/ece-docker build:compose --mode="developer" ``` - If required, set the option for [synchronizing data in Docker]. For example: + {:.bs-callout-info} + The `--mode` option in this step determines the mode in a later `deploy` step. + + If required, set the option for [synchronizing data in Docker][sync]. For example: ```bash ./vendor/bin/ece-docker build:compose --mode="developer" --sync-engine="mutagen" @@ -107,10 +110,6 @@ To launch the Docker environment in developer mode: docker-compose run --rm deploy cloud-deploy ``` - ```bash - docker-compose run --rm deploy magento-command deploy:mode:set developer - ``` - - Run post-deploy hooks. ```bash @@ -153,12 +152,10 @@ To launch the Docker environment in developer mode: -[{{site.data.var.mcd-prod}} Docker image]: https://hub.docker.com/r/magento/magento-cloud-docker-php/tags [installation steps]: {{site.baseurl}}/cloud/docker/docker-installation.html -[latest release of the {{site.data.var.mcd-package}}]: https://github.com/magento/magento-cloud-docker/releases [magento-creds]: {{site.baseurl}}/cloud/setup/first-time-setup-import-prepare.html#auth-json [mutagen-install]: https://mutagen.io/documentation/introduction/installation/ [services]: {{site.baseurl}}/cloud/docker/docker-containers.html#service-containers [service configuration options]: {{site.baseurl}}/cloud/docker/docker-containers.html#service-configuration-options -[Synchronizing data in Docker]: {{site.baseurl}}/cloud/docker/docker-syncing-data.html +[sync]: {{site.baseurl}}/cloud/docker/docker-syncing-data.html [xdebug]: {{site.baseurl}}/cloud/docker/docker-development-debug.html#configure-xdebug] diff --git a/src/cloud/project/project-webint-snap.md b/src/cloud/project/project-webint-snap.md index 893e5afe448..931442478e2 100644 --- a/src/cloud/project/project-webint-snap.md +++ b/src/cloud/project/project-webint-snap.md @@ -10,11 +10,11 @@ You can back up and restore specific environments at any time using a snapshot. 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. {:.bs-callout-warning} -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). +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). -You have up to **7 days** to _restore_ a snapshot. +You have up to **seven days** to _restore_ a snapshot. -We provide two methods for creating and managing snapshots: +Adobe provides two methods for creating and managing snapshots: - Project Web Interface - Magento Cloud CLI @@ -116,10 +116,9 @@ To restore a snapshot using the Magento Cloud CLI: ## Dump your database {#db-dump} -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. +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. -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. -You can also backup only selected databases by appending the database names to the command, for example: +You can also back up only selected databases by appending the database names to the command, for example: ```bash php vendor/bin/ece-tools -- main sales @@ -128,43 +127,43 @@ php vendor/bin/ece-tools -- main sales For help, use the command: `php vendor/bin/ece-tools db-dump --help` {:.procedure} -To create a database dump: +To create a database dump in the Staging or Production environment: -1. [SSH into the environment]({{ site.baseurl }}/cloud/env/environments-ssh.html) that contains the database you want to copy: +1. [Use SSH to log in to the environment]({{ site.baseurl }}/cloud/env/environments-ssh.html) that contains the database to copy: - **Staging:** `ssh -A _stg@.ent.magento.cloud` - **Production:** `ssh -A @.ent.magento.cloud` - - To SSH into the `master` branch of your Integration environment: - - ```bash - magento-cloud environment:ssh - ``` - -1. Enter the following command: - - ```bash - php vendor/bin/ece-tools db-dump - ``` - - ```terminal - php vendor/bin/ece-tools db-dump - 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. - Your site will not receive any traffic until the operation completes. - Do you wish to proceed with this process? (y/N)? y - 2020-01-28 16:38:08] INFO: Starting backup. - [2020-01-28 16:38:08] NOTICE: Enabling Maintenance mode - [2020-01-28 16:38:10] INFO: Trying to kill running cron jobs and consumers processes - [2020-01-28 16:38:10] INFO: Running Magento cron and consumers processes were not found. - [2020-01-28 16:38:10] INFO: Waiting for lock on db dump. - [2020-01-28 16:38:10] INFO: Start creation DB dump for main database... - [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 - [2020-01-28 16:38:10] INFO: Backup completed. - [2020-01-28 16:38:11] NOTICE: Maintenance mode is disabled. - ``` - - {:.bs-callout-info} - -- 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. + + ```bash + magento-cloud environment:ssh + ``` + +1. Create a backup of the database. To choose a target directory for the DB dump, use the `--dump-directory` option. + + ```bash + php vendor/bin/ece-tools db-dump + ``` + + Sample response: + + ```terminal + 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. + Your site will not receive any traffic until the operation completes. + Do you wish to proceed with this process? (y/N)? y + 2020-01-28 16:38:08] INFO: Starting backup. + [2020-01-28 16:38:08] NOTICE: Enabling Maintenance mode + [2020-01-28 16:38:10] INFO: Trying to kill running cron jobs and consumers processes + [2020-01-28 16:38:10] INFO: Running Magento cron and consumers processes were not found. + [2020-01-28 16:38:10] INFO: Waiting for lock on db dump. + [2020-01-28 16:38:10] INFO: Start creation DB dump for main database... + [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 + [2020-01-28 16:38:10] INFO: Backup completed. + [2020-01-28 16:38:11] NOTICE: Maintenance mode is disabled. + ``` + +{:.bs-callout-info} + +- 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. - The `db-dump` command creates an archive in your remote project directory called `dump-.sql.gz`. - 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`). - 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 ## Rollbacks to remove code {#rollback-code} -We recommend creating a snapshot of the environment and a backup of the database prior to deployments. +Adobe recommends creating a snapshot of the environment and a backup of the database prior to deployments. -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. +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. 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). diff --git a/src/cloud/release-notes/cloud-tools.md b/src/cloud/release-notes/cloud-tools.md index 88987cffadb..69536362301 100644 --- a/src/cloud/release-notes/cloud-tools.md +++ b/src/cloud/release-notes/cloud-tools.md @@ -21,6 +21,7 @@ This release information details the latest improvements to the {{site.data.var. 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}}`. + [`{{site.data.var.ct}}` release notes]: {{site.baseurl}}/cloud/release-notes/ece-release-notes.html [`{{site.data.var.mcc-prod}}` release notes]: {{site.baseurl}}/cloud/release-notes/mcc-release-notes.html [`{{site.data.var.mcd-prod}}` release notes]: {{site.baseurl}}/cloud/release-notes/mcd-release-notes.html diff --git a/src/cloud/release-notes/ece-release-notes.md b/src/cloud/release-notes/ece-release-notes.md index 228f5cfea0f..c3bd31e69dd 100644 --- a/src/cloud/release-notes/ece-release-notes.md +++ b/src/cloud/release-notes/ece-release-notes.md @@ -7,40 +7,62 @@ functional_areas: - Configuration --- -The [{{site.data.var.ct}}](https://github.com/magento/ece-tools) package is a set of scripts and tools designed to manage and deploy Cloud projects. These release notes describe the latest improvements to this package, which is part of the [{{site.data.var.csuite}}]({{page.baseurl}}/cloud/release-notes/cloud-tools.html). The release notes include: +The [{{site.data.var.ct}}](https://github.com/magento/ece-tools) package is a set of scripts and tools designed to manage and deploy Cloud projects. These release notes describe the latest improvements to this package, which is part of the [{{site.data.var.csuite}}]({{page.baseurl}}/cloud/release-notes/cloud-tools.html). + +{:.bs-callout-info} +See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-parent.html) for information about updating to the latest release of the `{{site.data.var.ct}}` package. + +The `{{site.data.var.ct}}` package uses the following release versioning sequence: `200..` + +The release notes include: - {:.new}New features - {:.fix}Fixes and improvements -The `{{site.data.var.ct}}` package uses the following release versioning sequence: `200..`. + -{:.bs-callout-info} -See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-parent.html) for information about updating to the latest release of the `{{site.data.var.ct}}` package. +## v2002.1.8 + +Release date: October 25, 2021 + +- {:.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. See [Snapshots and backup management: Dump your database]({{ site.baseurl }}/cloud/project/project-webint-snap.html#db-dump) +- {:.fix}**Update Monolog**—Updated the minimum version required for the `monolog` package to `^2.3`. +- {:.fix}**Update Symfony**—Updated the Symfony dependencies to be compatible with {{site.data.var.ee}} 2.4.4. +- {:.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. ## v2002.1.7 -*Release date: {{ site.data.var.ece-release-date }}*
-**Configuration updates**– +Release date: July 29, 2021 -- {:.new}Added support for Composer 2.0. +**Configuration updates**— -- {:.fix} **Updated composer requirements for `symphony/console`**–Updated the {{ site.data.var.ct }} `composer.json` version requirements for the `symphony/console` package to fix an issue that caused the `di:compile` commands to fail with the following error: `Incompatible argument type: Required type: int. Actual type: string` +- {:.new}Added support for Composer 2.0. -- {:.fix}Updated the end-of-life software checks (`eol.yaml`) to include Elasticsearch 7.9.x. +- {:.fix}**Updated composer requirements for `symphony/console`**—Updated the {{ site.data.var.ct }} `composer.json` version requirements for the `symphony/console` package to fix an issue that caused the `di:compile` commands to fail with the following error: `Incompatible argument type: Required type: int. Actual type: string` + +- {:.fix}Updated the end-of-life software checks (`eol.yaml`) to include Elasticsearch 7.9.x. ## v2002.1.6 -*Release date: April 20, 2021*
-- {:.new} **Redis authentication credentials**—Added the ability to read Redis authorization credentials from the `relationships` property during the deploy phase. -- {:.new} **Elasticsearch authorization credentials**—Added the ability to read Elasticsearch authorization credentials from the `relationships` property during the deploy phase. -- {:.new} **Dedicated session storage service**—Added `redis-session` as a second option for session storage. You can use the `redis-session` service to store session information and use the `redis` service for cache to provide better performance. -- {:.new} **Deprecated SPLIT_DB messages**—Added validator warning and critical messages for the deprecated `SPLIT_DB` option for {{site.data.var.ee}} 2.4.2 and its removal in {{site.data.var.ee}} 2.5.0. -- {:.fix} **Elasticsearch version from relationships**—Fixed Service validator to retrieve the correct version of Elasticsearch from the `relationships` properties in Cloud Docker and integration environments. -- {:.fix} **Flexible Redis port validation**—Redis can now validate the port in a custom cache connection from the `server` URL. For example, you can add your port number to your server URL as follows: `server: 'tcp://rfs-store-simple-page-cache:26379'`. This helps prevent validation errors where the `port` option is either missing or incorrect. -- {:.fix} **Upgrading to {{site.data.var.ee}} 2.4.2**—Fixed the issue that required users to manually run `bin/magento setup:upgrade` to make their sites operational after upgrading to {{site.data.var.ee}} 2.4.2. +Release date: April 20, 2021 + +- {:.new}**Redis authentication credentials**—Added the ability to read Redis authorization credentials from the `relationships` property during the deploy phase. + +- {:.new}**Elasticsearch authorization credentials**—Added the ability to read Elasticsearch authorization credentials from the `relationships` property during the deploy phase. + +- {:.new}**Dedicated session storage service**—Added `redis-session` as a second option for session storage. You can use the `redis-session` service to store session information and use the `redis` service for cache to provide better performance. + +- {:.new}**Deprecated SPLIT_DB messages**—Added validator warning and critical messages for the deprecated `SPLIT_DB` option for {{site.data.var.ee}} 2.4.2 and its removal in {{site.data.var.ee}} 2.5.0. + +- {:.fix}**Elasticsearch version from relationships**—Fixed Service validator to retrieve the correct version of Elasticsearch from the `relationships` properties in Cloud Docker and integration environments. + +- {:.fix}**Flexible Redis port validation**—Redis can now validate the port in a custom cache connection from the `server` URL. For example, you can add your port number to your server URL as follows: `server: 'tcp://rfs-store-simple-page-cache:26379'`. This helps prevent validation errors where the `port` option is either missing or incorrect. + +- {:.fix}**Upgrading to {{site.data.var.ee}} 2.4.2**—Fixed the issue that required users to manually run `bin/magento setup:upgrade` to make their sites operational after upgrading to {{site.data.var.ee}} 2.4.2. ## v2002.1.5 -*Release date: Feb 1, 2021*
+ +Release date: February 1, 2021 - {:.new}**Remote storage**—Added the `REMOTE_STORAGE` environment variable to enable Cloud Projects for remote storage of media files using a storage service, such as AWS S3. This configuration option is part of the {{site.data.var.ct}} package, but is not supported on {{site.data.var.ece}}. @@ -63,14 +85,16 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare - {:.fix}**Cache:flush logging**—Improved log entries to indicate the start and finish of the `cache:flush` step. ## v2002.1.4 -*Release date: November 19, 2020*
+ +Release date: November 19, 2020 - {:.fix}Fixed an issue that caused deployment failure when the search engine specified in the `SEARCH_CONFIGURATION` environment variable is a value other than `elasticsearch`. ## v2002.1.3 -*Release date: November 9, 2020*
-**Infrastructure updates**– +Release date: November 9, 2020 + +**Infrastructure updates**— - {:.new}Added ece-tools support for the read-only `pub/static` directory when static content is set to deploy in the build stage. @@ -78,7 +102,7 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare - {:.fix}Updated the ece-tools `composer.json` to add a required dependency for the Quality Patches Tool. This fixes a circular dependency that existed between the ece-tools and magento-cloud-patches packages. -**Validation and log improvements**– +**Validation and log improvements**— - {:.new}Added search-engine validation to ensure that `elasticsearch` is set for {{site.data.var.ece }} 2.4 and later. If the validation fails, the deployment is stopped with a critical error message suggesting fixes for the issue. See [Critical Errors, Deploy stage]({{ site.baseurl }}/cloud/reference/ece-tools-error-reference.html#deploy-stage). @@ -92,18 +116,19 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare - {:.fix}Updated the `cloud.log` to include the concurrent requests limit for sending requests during cache warmup. This value is configured in the [WARM_UP_CONCURRENCY]({{ site.baseurl }}/cloud/env/variables-post-deploy.html#warm_up_concurrency) post-deploy variable. -**CLI command updates**– +**CLI command updates**— - {:.new}Added CLI commands (`cloud:config:create` and `cloud:config:update`) to create and update the `.magento.env.yaml` file with a configuration that can include one or more build, deploy, and post-deploy variables. See [Create configuration file from CLI]({{ site.baseurl }}/cloud/project/magento-env-yaml.html#create-configuration-file-from-cli). -**Environment variable updates**– +**Environment variable updates**— - {:.new}Added the [SKIP_COMPOSER_DUMP_AUTOLOAD]({{ site.baseurl }}/cloud/env/variables-build.html#skip_composer_dump_autoload) build variable. Setting the variable to `true` stops the application from running the `composer dump-autoload` command during a {{ site.data.var.mcd-prod }} installation. The variable is only relevant to {{ site.data.var.mcd-prod }} containers with writable file systems (created for testing and development using `./vendor/bin/ece-docker build:compose --with-test`). With such installations, skipping the `composer dump-autoload` command prevents errors when running other commands that try to access files from a deleted `generated` directory. ## v2002.1.2 -*Release date: August 5, 2020*
-**Validation and log improvements**– +Release date: August 5, 2020 + +**Validation and log improvements**— - {:.new}Added the `schema.error.yaml` file that includes all error and warning notifications that can occur during the build, deploy, and post-deploy process along with suggestions for resolving the errors. The information in this file is also available in the _Cloud Guide for Commerce_. See [Error message reference for ece-tools]({{ site.baseurl }}/cloud/reference/ece-tools-error-reference.html). @@ -111,20 +136,21 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare - {:.new}Added additional error checks to build, deploy, and post-deploy processing and improved existing checks: - - Error code 2026–Failed to restore some data generated during the build phase to the mounted directories + - Error code 2026—Failed to restore some data generated during the build phase to the mounted directories - - Error code 3004–Cannot create backup files + - Error code 3004—Cannot create backup files - - Error code 102–Added additional checks for issues that occur when the `env.php` file is not writable + - Error code 102—Added additional checks for issues that occur when the `env.php` file is not writable - {:.new}Added the **QUALITY_PATCHES** environment variable to specify one or more quality patches to apply during the deployment process. See [Build variables]({{ site.baseurl }}/cloud/env/variables-build.html#quality_patches). ## v2002.1.1 -*Release date: June 25, 2020*
-- {:.new}**Infrastructure updates**– +Release date: June 25, 2020 - - {:.new}**Logging improvements**–Improved log tracking capability by assigning exit codes to critical deploy errors and exposing the exit codes in error message notifications and log events. See [Error message reference for ece-tools]({{site.baseurl}}/cloud/reference/ece-tools-error-reference.html). +- {:.new}**Infrastructure updates**— + + - {:.new}**Logging improvements**—Improved log tracking capability by assigning exit codes to critical deploy errors and exposing the exit codes in error message notifications and log events. See [Error message reference for ece-tools]({{site.baseurl}}/cloud/reference/ece-tools-error-reference.html). - {:.new}Improved the process for database dumps (`vendor/bin/ece-tools db-dump`) and updated log messages to clarify that the database dump operation switches the application to maintenance mode, stops consumer queue processes, and disables cron jobs before the dump begins. @@ -134,17 +160,17 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare - {:.fix}Fixed an issue in the installation process that incorrectly returns the `Crypt key missing` error. The `crypt/key` value is generated automatically during the installation. -- {:.new}**Service updates**– +- {:.new}**Service updates**— - {:.new}Added support for PHP 7.4 and MariaDB 10.4. -- {:.new}**Environment variable updates**– +- {:.new}**Environment variable updates**— - {:.new}Added the **SCD_USE_BALER** variable to enable the Baler module for JavaScript bundling during the {{site.data.var.ece }} build process. See the variable description in the [build variables]({{site.variable}}/cloud/env/variables-build.html#scd_use_baler). - {:.new}Added the **REDIS_BACKEND** environment variable to configure the Redis backend model for Redis cache for {{site.data.var.ee}} 2.3.5 or later. See the variable description in the [deploy variables]({{site.baseurl}}/cloud/env/variables-deploy.html#redis_backend). -- {:.new}**CLI command updates**– +- {:.new}**CLI command updates**— - {:.new}Updated the following CLI commands with an option for more detailed logging: @@ -154,11 +180,11 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare The logging level for each call is determined by the configuration of the [`VERBOSE_COMMANDS`]({{site.baseurl}}/cloud/env/variables-build.html#verbose_commands) variable in the `.magento.env.yaml` file. -- {:.new}**Validation improvements**– +- {:.new}**Validation improvements**— - - {:.new}**Elasticsearch 7.x compatibility checks**–Updated Elasticsearch validation for Elasticsearch 7.x software compatibility checks. + - {:.new}**Elasticsearch 7.x compatibility checks**—Updated Elasticsearch validation for Elasticsearch 7.x software compatibility checks. - - {:.new}**Updated service version and EOL validation checks**–Updated validation to check installed service versions against {{site.data.var.ee}} 2.4. requirements. + - {:.new}**Updated service version and EOL validation checks**—Updated validation to check installed service versions against {{site.data.var.ee}} 2.4. requirements. - {:.fix}Fixed a validation issue so that the following post-deploy warning message displays only if the `post-deploy` hook configuration is missing from the `.magento.app.yaml` file: @@ -168,7 +194,7 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare {:.no-copy} - - {:.new}**Added validation for Zend Framework dependencies**–Added composer dependency validation for the Zend Framework which has migrated to the Laminas project. If the required dependencies are missing, the following error message displays during the build process. + - {:.new}**Added validation for Zend Framework dependencies**—Added composer dependency validation for the Zend Framework which has migrated to the Laminas project. If the required dependencies are missing, the following error message displays during the build process. ```text Required configuration is missing from the autoload section of the composer.json file. @@ -180,7 +206,7 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare See [Verify Zend Framework dependencies]({{site.baseurl}}/cloud/project/project-upgrade.html#verify-zend-framework-composer-dependencies). - - {:.new}**Added validation for `env.php` file and data**–Added checks for the `env.php` file and data during the install and upgrade process. + - {:.new}**Added validation for `env.php` file and data**—Added checks for the `env.php` file and data during the install and upgrade process. - If the `env.php` file is missing from the installation, and the `crypt/key` value is not specified in the `.magento.app.yaml` file, the deployment fails with the following notification: @@ -198,26 +224,27 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare {:.no-copy} ## v2002.1.0 -*Release date: February 6, 2020*
-- {:.new}**Infrastructure updates**– +Release date: February 6, 2020 + +- {:.new}**Infrastructure updates**— - - {:.new}**Added separate package for Magento Cloud Docker**–Decoupled the Docker package from the `{{site.data.var.ct}}` package to maintain code quality and provide independent releases. Updates and fixes related to `{{site.data.var.ct}}` are managed from the [magento-cloud-docker](https://github.com/magento/magento-cloud-docker) GitHub repository. + - {:.new}**Added separate package for Magento Cloud Docker**—Decoupled the Docker package from the `{{site.data.var.ct}}` package to maintain code quality and provide independent releases. Updates and fixes related to `{{site.data.var.ct}}` are managed from the [magento-cloud-docker](https://github.com/magento/magento-cloud-docker) GitHub repository. - - {:.new}**Updated patching capabilities**–Moved the patching functionality from the {{site.data.var.ct}} package to a separate [magento-cloud-patches](https://github.com/magento/magento-cloud-patches) package. During deployment, `{{site.data.var.ct}}` uses the new package to apply patches. See [Cloud patches release notes]({{site.baseurl}}/cloud/release-notes/mcp-release-notes.html). + - {:.new}**Updated patching capabilities**—Moved the patching functionality from the {{site.data.var.ct}} package to a separate [magento-cloud-patches](https://github.com/magento/magento-cloud-patches) package. During deployment, `{{site.data.var.ct}}` uses the new package to apply patches. See [Cloud patches release notes]({{site.baseurl}}/cloud/release-notes/mcp-release-notes.html). - - {:.new}**Updated Composer dependencies**–Updated the `composer.json` file for {{site.data.var.ece}} with a dependency for the `{{site.data.var.mcd-package}}` package. Now, `{{site.data.var.ct}}` includes dependencies for all packages in the [`{{site.data.var.csuite}}`]({{site.baseurl}}/cloud/release-notes/cloud-tools.html). These packages are installed and updated automatically when you install or update `{{site.data.var.ct}}`. + - {:.new}**Updated Composer dependencies**—Updated the `composer.json` file for {{site.data.var.ece}} with a dependency for the `{{site.data.var.mcd-package}}` package. Now, `{{site.data.var.ct}}` includes dependencies for all packages in the [`{{site.data.var.csuite}}`]({{site.baseurl}}/cloud/release-notes/cloud-tools.html). These packages are installed and updated automatically when you install or update `{{site.data.var.ct}}`. -- {:.new}**Support for scenario-based deployments**– +- {:.new}**Support for scenario-based deployments**— - {:.new}Now you can customize the build, deploy, and post-deploy processes using XML configuration files to override or customize the default configuration. - - {:.new}**Changed the `hooks` configuration in `.magento.app.yaml`**–We updated the `hooks` configuration format to support scenario-based deployments. The legacy format from earlier {{site.data.var.ct}} 2002.0.x release is still supported. However, you must update to the new format to use the scenario-based deployment feature. See [Scenario-based deployments]({{site.baseurl}}/cloud/deploy/scenario-based-deployment.html#add-scenarios-using-build-and-deploy-hooks). + - {:.new}**Changed the `hooks` configuration in `.magento.app.yaml`**—We updated the `hooks` configuration format to support scenario-based deployments. The legacy format from earlier {{site.data.var.ct}} 2002.0.x release is still supported. However, you must update to the new format to use the scenario-based deployment feature. See [Scenario-based deployments]({{site.baseurl}}/cloud/deploy/scenario-based-deployment.html#add-scenarios-using-build-and-deploy-hooks). {:.bs-callout-info} Before updating to {{site.data.var.ct}} version 2002.1.0, review the [backward incompatible changes]({{site.baseurl}}/cloud/release-notes/backward-incompatible-changes.html) to learn about changes that might require you to update {{site.data.var.ece}} project configuration or processes. -- {:.new}**Service updates**– +- {:.new}**Service updates**— - {:.new}Added support for PHP 7.3. @@ -230,7 +257,7 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare {:.bs-callout-info} See [Service versions]({{site.baseurl}}/cloud/project/services.html) for a list of services used in {{site.data.var.ece}} and their version compatibility with the Magento Cloud template. -- {:.new}**Environment variable updates**– +- {:.new}**Environment variable updates**— - {:.new}Extended the functionality of the `WARM_UP_PAGES` environment variable to support cache preloading for specific product pages. See the expanded definition in the [post-deploy variables]({{site.baseurl}}/cloud/env/variables-post-deploy.html#warm_up_pages) topic. @@ -240,20 +267,21 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare - {:.fix}Fixed an issue in the Elastic Suite configuration process so that the default configuration is overwritten as expected when you configure the `ELASTICSUITE_CONFIGURATION` deploy variable without the `_merge` option. -- {:.new}**CLI command updates**– +- {:.new}**CLI command updates**— - - {:.new}**New cron command**–You can now manually manage cron processing in your {{ site.data.var.ece }} environment using the `cron:disable` and `cron:enable` commands. Use the disable command to stop all active cron processes and disable all cron jobs. Use the enable command to re-enable cron jobs when you are ready. See [Disable cron jobs]({{site.baseurl}}/cloud/configure/setup-cron-jobs.html#disable-cron-jobs). + - {:.new}**New cron command**—You can now manually manage cron processing in your {{ site.data.var.ece }} environment using the `cron:disable` and `cron:enable` commands. Use the disable command to stop all active cron processes and disable all cron jobs. Use the enable command to re-enable cron jobs when you are ready. See [Disable cron jobs]({{site.baseurl}}/cloud/configure/setup-cron-jobs.html#disable-cron-jobs). - - {:.new}**Improved error reporting**–Added better logging for CLI command failures that occur during {{site.data.var.ct}} processing. + - {:.new}**Improved error reporting**—Added better logging for CLI command failures that occur during {{site.data.var.ct}} processing. - - {:.new}**Remove deprecated build commands**– Removed the following build commands: `m2-ece-build`, `m2-ece-deploy`, `m2-ece-scd-dump`, and renamed `ece-tools docker` commands to `ece-docker`. See [Backward incompatible changes]({{site.baseurl}}/cloud/release-notes/backward-incompatible-changes.html) + - {:.new}**Remove deprecated build commands**— Removed the following build commands: `m2-ece-build`, `m2-ece-deploy`, `m2-ece-scd-dump`, and renamed `ece-tools docker` commands to `ece-docker`. See [Backward incompatible changes]({{site.baseurl}}/cloud/release-notes/backward-incompatible-changes.html) - {:.new}Removed the deprecated `build_options.ini` file and added validation to fail the build if the file exists. Use the [.magento.env.yaml]({{site.baseurl}}/cloud/project/magento-env-yaml.html) file to configure build options. - {:.fix}Fixed an issue that caused the build process to fail when the `config.php` file is empty. ## 2002.0.23 -*Release date: February 27, 2020*
+ +Release date: February 27, 2020 - {:.fix}Fixed a compatibility issue with `{{site.data.var.ct}}` 2002.0.x releases that prevented on-demand static content generation from completing successfully in production mode. diff --git a/src/cloud/release-notes/mcc-release-notes.md b/src/cloud/release-notes/mcc-release-notes.md index 8b551b3eea2..d6f23cff940 100644 --- a/src/cloud/release-notes/mcc-release-notes.md +++ b/src/cloud/release-notes/mcc-release-notes.md @@ -9,60 +9,81 @@ functional_areas: The [Magento Cloud Components](https://github.com/magento/magento-cloud-components) package provides extended {{site.data.var.ee}} core functionality for sites deployed on Cloud infrastructure. This package is a dependency for the {{ site.data.var.ct }} package. These release notes describe the latest improvements to this package, which is a component of [{{ site.data.var.csuite }}]({{ page.baseurl }}/cloud/release-notes/cloud-tools.html). -The `{{site.data.var.mcc-package}}` package uses the following version sequence: `..`. +The `{{site.data.var.mcc-package}}` package uses the following version sequence: `..` + +The release notes include: + +- {:.new}New features +- {:.fix}Fixes and improvements + + + +## v1.0.9 + +Release date: October 25, 2021 + +- {:.fix}**Update Monolog**—Updated the minimum version required for the `monolog` package to `^2.3`. ## v1.0.8 -*Release date: {{ site.data.var.ece-release-date }}*
-- {:.fix}**Removed trailing slashes from auto-generated URLs**–Removed the trailing slashes from Category Page URLs generated during cache warm up. +Release date: July 29, 2021 + +- {:.fix}**Removed trailing slashes from auto-generated URLs**—Removed the trailing slashes from Category Page URLs generated during cache warm up. ## v1.0.7 -*Release date: September 9, 2020*
-- {:.new}**Logging improvements**–Reduce the size of the `cache.log` file to improve performance. +Release date: September 9, 2020 + +- {:.new}**Logging improvements**—Reduce the size of the `cache.log` file to improve performance. - {:.fix}Fixed a type error in the cache configuration values that caused the `php bin/magento cache:evict` CLI command to fail. ## v1.0.6 -*Release date: August 5, 2020*
- -- {:.new}**Improve Redis performance**–Added the `./bin/magento cache:evict` command to remove expired Redis keys, which reduces Redis memory usage to improve performance. +Release date: August 5, 2020 + +- {:.new}**Improve Redis performance**—Added the `./bin/magento cache:evict` command to remove expired Redis keys, which reduces Redis memory usage to improve performance. - {:.fix}Removed support for *New Relic Logs in Context* to fix a performance issue. ## v1.0.5 -*Release date: June 25, 2020*
+ +Release date: June 25, 2020 - {:.fix}Fixed an issue introduced in {{site.data.var.mcc-package}} version 1.0.4 that caused the flush cache operation to fail during the deploy phase, interrupting the deployment process. ## v1.0.4 -*Release date: June 25, 2020*
-- {:.new}**Implemented New Relic Logs in Context**–Application logs generated by {{site.data.var.ee}} now display in traces within New Relic to improve troubleshooting capabilities. +Release date: June 25, 2020 + +- {:.new}**Implemented New Relic Logs in Context**—Application logs generated by {{site.data.var.ee}} now display in traces within New Relic to improve troubleshooting capabilities. -- {:.new}**Improved logging**–Added logging to track cache invalidation and full reindex events. +- {:.new}**Improved logging**—Added logging to track cache invalidation and full reindex events. ## v1.0.3 -*Release date: February 27, 2020*
+ +Release date: February 27, 2020 - {:.fix}Fixed a compatibility issue to support `{{site.data.var.ct}}` 2002.0.x releases that use older PHP versions. ## v1.0.2 -*Release date: February 6, 2020*
+ +Release date: February 6, 2020 - {:.new}Extended the functionality of the `WARM_UP_PAGES` environment variable to support cache preloading for specific product pages. See the [post-deploy variables]({{site.baseurl}}/cloud/env/variables-post-deploy.html#warm_up_pages) topic for a detailed feature description. - {:.fix}Fixed an issue where an invalid store URL causes the post-deploy hook to fail when using the `WARM_UP_PAGES` functionality to populate the cache. This issue occurred only when URL rewrites were disabled. ## v1.0.1 -*Release date: July 23, 2019*
+ +Release date: July 23, 2019 - {:.fix}Fixed an issue affecting [**WARM_UP_PAGES**]({{ site.baseurl }}/cloud/env/variables-post-deploy.html#warm_up_pages) functionality that uses a default store URL. Now, if the `config:show:default-url` command cannot fetch a base URL, then the URL from the MAGENTO_CLOUD_ROUTES variable is used. ## v1.0.0 -*Release date: June 12, 2019*
+ +Release date: June 12, 2019 This is the first release of the [`magento/magento-cloud-components`](https://github.com/magento/magento-cloud-components) package, which is a new dependency for `{{ site.data.var.ct }}` package version 2002.0.20 and later. -- {:.new}Added the capability to use regex patterns to configure the **WARM_UP_PAGES** environment variable to cache single pages, multiple domains, and multiple pages. See [Post-deploy variables]({{ site.baseurl }}/cloud/env/variables-post-deploy.html#warm_up_pages). +- {:.new}Added the capability to use regex patterns to configure the **WARM_UP_PAGES** environment variable to cache single pages, multiple domains, and multiple pages. See [Post-deploy variables]({{ site.baseurl }}/cloud/env/variables-post-deploy.html#warm_up_pages). diff --git a/src/cloud/release-notes/mcd-release-notes.md b/src/cloud/release-notes/mcd-release-notes.md index dbdfcddbc39..00580f2b72b 100644 --- a/src/cloud/release-notes/mcd-release-notes.md +++ b/src/cloud/release-notes/mcd-release-notes.md @@ -9,32 +9,49 @@ functional_areas: The [`{{site.data.var.mcd-package}}`](https://github.com/magento/magento-cloud-docker) package provides functionality and Docker images to deploy {{ site.data.var.ee }} to a local Cloud environment. These release notes describe the latest improvements to this package, which is a component of [{{ site.data.var.csuite }}]({{ page.baseurl }}/cloud/release-notes/cloud-tools.html). -The `{{site.data.var.mcd-package}}` package uses the following version sequence: `..`. +The `{{site.data.var.mcd-package}}` package uses the following version sequence: `..` The release notes include: - {:.new}New features - {:.fix}Fixes and improvements + + +## v1.3.0 + +Release date: October 25, 2021 + +- {:.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). +- {:.fix}**Improvements for read-only filesystem**— + - Fix issue starting a PHP container for mail configuration. + - Can use environment variables in INI files. + - Ensure PHP entry points do not need write permission. +- {:.fix}**Update Node**—Update the bundled Node version; when installing Node in PHP-CLI images, it now uses the current LTS version. +- {:.fix}**Update Symfony**—Updated the Symfony config dependencies to be compatible with {{site.data.var.ee}} 2.4.4. + ## v1.2.4 -*Release date: {{ site.data.var.ece-release-date }}*
-- {:.new}**New `Zookeeper` container**–Added a [Zookeeper container]({{ site.baseurl}}/cloud/docker/docker-containers-service.html#zookeeper-container) to manage lock provider configuration for projects that are not deployed to {{ site.data.var.ee }} on Cloud infrastructure. +Release date: July 29, 2021 + +- {:.new}**New `Zookeeper` container**—Added a [Zookeeper container]({{ site.baseurl}}/cloud/docker/docker-containers-service.html#zookeeper-container) to manage lock provider configuration for projects that are not deployed to {{ site.data.var.ee }} on Cloud infrastructure. -- {:.new}**Added support for Composer 2.0.**–Added Composer version 2.0 to the Composer configuration file to support upgrades from Composer 1.0 which is approaching end-of-life. +- {:.new}**Added support for Composer 2.0.**—Added Composer version 2.0 to the Composer configuration file to support upgrades from Composer 1.0 which is approaching end-of-life. ## v1.2.3 -*Release date: June 14, 2021*
-- {:.new}**Added PHP 8.0**—Updated PHP to version 8.0, allowing you take advantage of all the new features and optimizations PHP 8.0 includes. -- {:.new}**Updated to Varnish 6.6 and Elasticsearch 7.11.2**—The following links provide release information on [Varnish Cache 6.6](https://varnish-cache.org/releases/rel6.6.0.html#rel6-6-0) and [Elasticsearch 7.11.2](https://www.elastic.co/guide/en/elasticsearch/reference/current/release-notes-7.11.2.html). -- {:.new}**Added `ioncube` extension for PHP 7.4 image**—The `ioncube` extension has been re-added to the PHP 7.4 image after having been initially excluded from the PHP 7.3 to PHP 7.4 upgrade. *[Submitted by mattskr](https://github.com/magento/magento-cloud-docker/pull/314).* -- {:.new}**Added a new file sync option: `manual-native`**—The `manual-native` file synchronization option provides manual control over synchronization, which provides the best performance for macOs and Windows environments. Read about using the `manual-native` option in the [Developer mode](https://devdocs.magento.com/cloud/docker/docker-mode-developer.html) and [Synchronizing data in a Docker developer environment](https://devdocs.magento.com/cloud/docker/docker-syncing-data.html#file-synchronization-options) topics. -- {:.new}**Removed volume deletions from `up` and `down` commands**—The `--volume` option was removed from the `bin/magento-docker up` and `bin/magento-docker down` commands, replaced by the new `bin/magento-docker init` command with a data loss warning. This change helps prevent the accidental data loss. *[Submitted by joeshelton-wagento](https://github.com/magento/magento-cloud-docker/pull/319).* -- {:.fix}**Updated `CN` value for the generated certificate**—Removed the hardcoded `CN` value from the Dockerfile. This value created a certificate error (`NET::ERR_CERT_INVALID`) that caused the `--host` option for the `ece-docker build:compose` command to be ignored. +Release date: June 14, 2021 + +- {:.new}**Added PHP 8.0**—Updated PHP to version 8.0, allowing you take advantage of all the new features and optimizations PHP 8.0 includes. +- {:.new}**Updated to Varnish 6.6 and Elasticsearch 7.11.2**—The following links provide release information on [Varnish Cache 6.6](https://varnish-cache.org/releases/rel6.6.0.html#rel6-6-0) and [Elasticsearch 7.11.2](https://www.elastic.co/guide/en/elasticsearch/reference/current/release-notes-7.11.2.html). +- {:.new}**Added `ioncube` extension for PHP 7.4 image**—The `ioncube` extension has been re-added to the PHP 7.4 image after having been initially excluded from the PHP 7.3 to PHP 7.4 upgrade. *[Submitted by mattskr](https://github.com/magento/magento-cloud-docker/pull/314).* +- {:.new}**Added a new file sync option: `manual-native`**—The `manual-native` file synchronization option provides manual control over synchronization, which provides the best performance for macOs and Windows environments. Read about using the `manual-native` option in the [Developer mode](https://devdocs.magento.com/cloud/docker/docker-mode-developer.html) and [Synchronizing data in a Docker developer environment](https://devdocs.magento.com/cloud/docker/docker-syncing-data.html#file-synchronization-options) topics. +- {:.new}**Removed volume deletions from `up` and `down` commands**—The `--volume` option was removed from the `bin/magento-docker up` and `bin/magento-docker down` commands, replaced by the new `bin/magento-docker init` command with a data loss warning. This change helps prevent the accidental data loss. *[Submitted by joeshelton-wagento](https://github.com/magento/magento-cloud-docker/pull/319).* +- {:.fix}**Updated `CN` value for the generated certificate**—Removed the hardcoded `CN` value from the Dockerfile. This value created a certificate error (`NET::ERR_CERT_INVALID`) that caused the `--host` option for the `ece-docker build:compose` command to be ignored. ## v1.2.2 -*Release date: April 20, 2021*
+ +Release date: April 20, 2021 - {:.new}**Updated `host.docker.internal` to be platform independent**—You can now create the same Docker Compose scripts for Ubuntu, Windows, and macOS. Using Xdebug on Ubuntu no longer requires a separate environment variable. *[Fix submitted by Igor Vitol](https://github.com/magento/magento-cloud-docker/pull/299).* - {:.new}**Updated init-docker.sh**—Added the `mounts` object to the `MAGENTO_CLOUD_APPLICATION` environment variable. *[Fix submitted by Chiranjeevi](https://github.com/magento/magento-cloud-docker/pull/299).* @@ -52,67 +69,69 @@ The release notes include: - {:.fix}**Fixed service version validation errors**—Added service versions for RabbitMQ, Elasticsearch, and other services to the `type` property in the `MAGENTO_CLOUD_RELATIONSHIP` variable. Adding these versions to the `relationships` variable fixed the validation errors that occurred during the deploy phase. ## v1.2.1 -*Release date: December 21, 2020*
-- {:.new}**NGINX command options**–Added build command options to change the number of NGINX `worker_processes` and NGINX `worker_connections` for TLS and Web services. The `worker_process` parameter retains the ability to set the value to `auto`. Examples: +Release date: December 21, 2020 + +- {:.new}**NGINX command options**—Added build command options to change the number of NGINX `worker_processes` and NGINX `worker_connections` for TLS and Web services. The `worker_process` parameter retains the ability to set the value to `auto`. Examples: ```terminal ./vendor/bin/ece-docker build:compose --nginx-worker-processes=2 ./vendor/bin/ece-docker build:compose --nginx-worker-connections=2048 ``` -- {:.new}**TLS command option**–Added build command option to create a configuration without the TLS service. Example: +- {:.new}**TLS command option**—Added build command option to create a configuration without the TLS service. Example: ```terminal ./vendor/bin/ece-docker build:compose --no-tls ``` -- {:.new}**NGINX memory consumption**–Reduced the memory consumed by the NGINX process for TLS and Web services. +- {:.new}**NGINX memory consumption**—Reduced the memory consumed by the NGINX process for TLS and Web services. -- {:.new}**Blackfire**–Disabled Blackfire PHP extension by default in the Cloud Docker image. +- {:.new}**Blackfire**—Disabled Blackfire PHP extension by default in the Cloud Docker image. -- {:.fix}**PHP-FPM container**–Fixed PHP-FPM container health check by changing the `WEB_PORT` from `80` to `8080`. +- {:.fix}**PHP-FPM container**—Fixed PHP-FPM container health check by changing the `WEB_PORT` from `80` to `8080`. -- {:.fix}**Invalid volume naming**–Fixed an error with invalid volume naming in developer mode. +- {:.fix}**Invalid volume naming**—Fixed an error with invalid volume naming in developer mode. - {:.fix}**NGINX upstream port**—Updated the Docker NGINX 1.19 image to use port 8080 to avoid an infinite loop. *[Fix submitted by Adarsh Manickam](https://github.com/magento/magento-cloud-docker/pull/296).* ## v1.2.0 -*Release date: November 9, 2020*
-- {:.new}**Container updates–** +Release date: November 9, 2020 - - {:.new}**PHP-FPM container**–Added support for the gnupg PHP extension. *[Fix submitted by G Arvind from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/210).* +- {:.new}**Container updates—** - - {:.fix}**Database container**–Fixed the database container health check by adding the required database password to the health check command. + - {:.new}**PHP-FPM container**—Added support for the gnupg PHP extension. *[Fix submitted by G Arvind from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/210).* + + - {:.fix}**Database container**—Fixed the database container health check by adding the required database password to the health check command. - {:.new}**Elasticsearch container** - Added support for Elasticsearch 7.9 for compatibility with upcoming {{site.data.var.ee}} releases. - - **Elasticsearch plugin configuration**–Added support to use the Elasticsearch plugin configuration information from the `services.yaml` file to generate the `docker-compose.yaml` file for a {{ site.data.var.mcd-prod }} environment. See [Elasticsearch plugins]({{ site.baseurl}}/cloud/docker/docker-containers-service.html#elasticsearch-plugins). + - **Elasticsearch plugin configuration**—Added support to use the Elasticsearch plugin configuration information from the `services.yaml` file to generate the `docker-compose.yaml` file for a {{ site.data.var.mcd-prod }} environment. See [Elasticsearch plugins]({{ site.baseurl}}/cloud/docker/docker-containers-service.html#elasticsearch-plugins). - - **Elasticsearch plugin support**–Added support for the following Elasticsearch plugins: `analysis-icu`, `analysis-phonetic`, `analysis-stempel`, and `analysis-nori`. The `analysis-icu` and `analysis-phonetic` plugins are installed by default. You can add or remove the `analysis-stempel` and `analysis-nori` plugins as needed. + - **Elasticsearch plugin support**—Added support for the following Elasticsearch plugins: `analysis-icu`, `analysis-phonetic`, `analysis-stempel`, and `analysis-nori`. The `analysis-icu` and `analysis-phonetic` plugins are installed by default. You can add or remove the `analysis-stempel` and `analysis-nori` plugins as needed. - - {:.new} **CLI container** + - {:.new}**CLI container** - - **Run commands inside Docker PHP containers**–Now you can use the Magento Cloud Docker CLI to run commands inside PHP containers in your Docker environment without having to install PHP on the host. For example, the following command builds the configuration: `./bin/magento-docker php 7.3 vendor/bin/ece-docker build:compose`. See [Magento Cloud Docker CLI]({{ site.baseurl }}/cloud/docker/docker-quick-reference.html#magento-cloud-docker-cli). *[Fix submitted by G Arvind from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/209).* + - **Run commands inside Docker PHP containers**—Now you can use the Magento Cloud Docker CLI to run commands inside PHP containers in your Docker environment without having to install PHP on the host. For example, the following command builds the configuration: `./bin/magento-docker php 7.3 vendor/bin/ece-docker build:compose`. See [Magento Cloud Docker CLI]({{ site.baseurl }}/cloud/docker/docker-quick-reference.html#magento-cloud-docker-cli). *[Fix submitted by G Arvind from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/209).* - Added the OpenSSH-client to PHP CLI containers. Now, you can use ssh-agent forwarding for Composer if the `composer.json` file contains private git repositories that require an ssh client to use Composer commands. - - {:.fix}**TLS container**–Now, the [TLS container]({{ site.baseurl}}/cloud/docker/docker-containers-service.html#tls-container) is based on the `https://hub.docker.com/r/magento/magento-cloud-docker-nginx` Docker image instead of the Centos image. This change fixes issues that caused errors when sending HTTPS requests between containers in the Cloud Docker environment. + - {:.fix}**TLS container**—Now, the [TLS container]({{ site.baseurl}}/cloud/docker/docker-containers-service.html#tls-container) is based on the `https://hub.docker.com/r/magento/magento-cloud-docker-nginx` Docker image instead of the Centos image. This change fixes issues that caused errors when sending HTTPS requests between containers in the Cloud Docker environment. - - {:.new}**Test container**–Added a test container for application testing, and added the `--with-test` option to the Docker `build:compose` command to create the container only when testing in the Docker environment. See [application testing](https://devdocs.magento.com/cloud/docker/docker-test-app-mftf.html). + - {:.new}**Test container**—Added a test container for application testing, and added the `--with-test` option to the Docker `build:compose` command to create the container only when testing in the Docker environment. See [application testing](https://devdocs.magento.com/cloud/docker/docker-test-app-mftf.html). - {:.new}**FPM-XDEBUG container** - - {:.new}**Configure Xdebug on Linux**–Added the `--set-docker-host` option to the `ece-docker build:compose` command to configure the `host.docker.internal` value in the Xdebug container. This option is required to use Xdebug on Linux systems. See [Configure Xdebug for Docker]({{ site.baseurl }}/cloud/docker/docker-development-debug.html). + - {:.new}**Configure Xdebug on Linux**—Added the `--set-docker-host` option to the `ece-docker build:compose` command to configure the `host.docker.internal` value in the Xdebug container. This option is required to use Xdebug on Linux systems. See [Configure Xdebug for Docker]({{ site.baseurl }}/cloud/docker/docker-development-debug.html). - {:.fix}Fixed the Xdebug variable configuration for the Docker ENTRYPOINT to resolve `uninitialized "with_xdebug" variable` errors in the logs. *[Fix submitted by Florent Olivaud](https://github.com/magento/magento-cloud-docker/pull/218)* - {:.new}**Docker configuration changes** - - **MailHog configuration**–Now you can use the following `ece-docker build:compose` command options to disable MailHog and specify ports: `--no-mailhog`, `--mailhog-http-port`, and `--mailhog-smtp-port`. See [Set up email]({{ site.baseurl }}/cloud/docker/docker-config.html#set-up-email). + - **MailHog configuration**—Now you can use the following `ece-docker build:compose` command options to disable MailHog and specify ports: `--no-mailhog`, `--mailhog-http-port`, and `--mailhog-smtp-port`. See [Set up email]({{ site.baseurl }}/cloud/docker/docker-config.html#set-up-email). - For {{site.data.var.mcd-prod}} 1.2.0 and later, Adobe now provides Docker images for each patch version, and the Docker configuration generator creates the Docker configuration with a specified patch version instead of using the latest. Previously, the Docker configuration generator built the configuration using the latest patch version which could break {{ site.data.var.mcd-prod}} environments built using an earlier version. @@ -127,14 +146,16 @@ The release notes include: - {:.fix}Updated the {{site.data.var.mcd-prod}} functional tests to support Composer 2.0. ## v1.1.2 -*Release date: September 9, 2020*
+ +Release date: September 9, 2020 - {:.new}Added support for Elasticsearch 7.7 ## v1.1.1 -*Release date: August 5, 2020*
-- {:.fix}**Updated email configuration**–Updated the default {{ site.var.ece.mcd-product }} configuration to support the MailHog service instead of using SendMail. See [Set up email]({{ site.baseurl }}/cloud/docker/docker-config.html#set-up-email). +Release date: August 5, 2020 + +- {:.fix}**Updated email configuration**—Updated the default {{ site.var.ece.mcd-product }} configuration to support the MailHog service instead of using SendMail. See [Set up email]({{ site.baseurl }}/cloud/docker/docker-config.html#set-up-email). - {:.fix}Restored the PS library to the Cloud Docker environment configuration to fix `ps: command not found` errors. @@ -154,13 +175,14 @@ The release notes include: ## v1.1.0 -*Release date: June 25, 2020*
-- {:.new}**Added support for the split database performance solution**–Now you can configure and deploy a store using the Split database performance solution in the Cloud Docker environment. +Release date: June 25, 2020 + +- {:.new}**Added support for the split database performance solution**—Now you can configure and deploy a store using the Split database performance solution in the Cloud Docker environment. -- {:.new}**Support for {{site.data.var.ee}} and {{site.data.var.ce}} deployment**–Now you can use {{site.data.var.mcd-prod}} to deploy a local development environment for projects that are not hosted on {{site.data.var.ece}}. +- {:.new}**Support for {{site.data.var.ee}} and {{site.data.var.ce}} deployment**—Now you can use {{site.data.var.mcd-prod}} to deploy a local development environment for projects that are not hosted on {{site.data.var.ece}}. -- {:.new}**Blackfire.io support**–Added support to use the [Blackfire.io extension]({{site.baseurl}}/cloud/docker/docker-config-blackfire-io.html) for automated performance testing. *[Fix submitted by Adarsh Manickam from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/202)* +- {:.new}**Blackfire.io support**—Added support to use the [Blackfire.io extension]({{site.baseurl}}/cloud/docker/docker-config-blackfire-io.html) for automated performance testing. *[Fix submitted by Adarsh Manickam from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/202)* - {:.new}**Container updates** @@ -236,81 +258,82 @@ The release notes include: - {:.fix}Removed `rsyslog` from the {{site.data.var.mcd-prod}} PHP containers to resolve compatibility issues that caused warning notifications during deployment. Magento Cloud Docker does not use the rsyslog utility. ## v1.0.0 -*Release date: Feb 5, 2020*
-- {:.new}**Created a separate package to deliver `{{site.data.var.mcd-prod}}`**–Moved the source code to deliver {{site.data.var.mcd-prod}} from the `{{site.data.var.ct}}` repository to the [new `magento-cloud-docker` repository](https://github.com/magento/magento-cloud-docker) to maintain code quality and provide independent releases. The new package is a dependency for {{site.data.var.ct}} v2002.1.0 and later. +Release date: Feb 5, 2020 + +- {:.new}**Created a separate package to deliver `{{site.data.var.mcd-prod}}`**—Moved the source code to deliver {{site.data.var.mcd-prod}} from the `{{site.data.var.ct}}` repository to the [new `magento-cloud-docker` repository](https://github.com/magento/magento-cloud-docker) to maintain code quality and provide independent releases. The new package is a dependency for {{site.data.var.ct}} v2002.1.0 and later. When you update {{site.data.var.ct}}, you also update the `{{site.data.var.mcd-package}}` package to version 1.0.0. If you used {{site.data.var.mcd-prod}} with an earlier `{{site.data.var.ct}}` release (2002.0.x), review the [backward incompatibilities]({{site.baseurl}}/cloud/release-notes/backward-incompatible-changes.html#magento-cloud-docker-changes) and update your project as scripts, commands, and processes as needed. -- {:.new}**Added versioning to the Docker images**–You must now update the `{{site.data.var.mcd-package}}` package to get the updated images. +- {:.new}**Added versioning to the Docker images**—You must now update the `{{site.data.var.mcd-package}}` package to get the updated images. -- {:.new}**Container updates**– +- {:.new}**Container updates**— - - {:.new}**PHP-FPM container**– + - {:.new}**PHP-FPM container**— - - {:.new}**Added Node.js support**–Updated the PHP-FPM image to support node, npm, and the grunt-cli capabilities inside the PHP container. + - {:.new}**Added Node.js support**—Updated the PHP-FPM image to support node, npm, and the grunt-cli capabilities inside the PHP container. - - {:.new}**Added support for [ionCube](https://www.ioncube.com/)**–Updated the default Docker configuration to support ionCube in the local Docker development environment. + - {:.new}**Added support for [ionCube](https://www.ioncube.com/)**—Updated the default Docker configuration to support ionCube in the local Docker development environment. - - {:.new}**Web container**– + - {:.new}**Web container**— - - {:.new}**Customize NGINX configuration**–Added the capability to mount a custom `nginx.conf` file to the {{site.data.var.mcd-prod}} environment. See [Web container]({{site.baseurl}}/cloud/docker/docker-containers-service.html#web-container). + - {:.new}**Customize NGINX configuration**—Added the capability to mount a custom `nginx.conf` file to the {{site.data.var.mcd-prod}} environment. See [Web container]({{site.baseurl}}/cloud/docker/docker-containers-service.html#web-container). - - {:.new}**Auto-generated NGINX certificates**–The Docker configuration file now includes the configuration to auto-generate NGINX certificates for the Web container. + - {:.new}**Auto-generated NGINX certificates**—The Docker configuration file now includes the configuration to auto-generate NGINX certificates for the Web container. - - {:.new}**New Selenium container**–Added a [Selenium container]({{site.baseurl}}/cloud/docker/docker-containers-service.html#selenium-container) to support {{site.data.var.ee}} application testing using the Magento Functional Testing Framework (MFTF). + - {:.new}**New Selenium container**—Added a [Selenium container]({{site.baseurl}}/cloud/docker/docker-containers-service.html#selenium-container) to support {{site.data.var.ee}} application testing using the Magento Functional Testing Framework (MFTF). - - {:.new}**RabbitMQ version support**–Updated the RabbitMQ container configuration to support RabbitMQ version 3.8. + - {:.new}**RabbitMQ version support**—Updated the RabbitMQ container configuration to support RabbitMQ version 3.8. - - {:.fix}**Persistent database container**–The `magento-db: /var/lib/mysql` database volume now persists after you stop and remove the Docker configuration and restores when you restart the Docker configuration. Now, you must manually delete the database volume. See [Database containers]. + - {:.fix}**Persistent database container**—The `magento-db: /var/lib/mysql` database volume now persists after you stop and remove the Docker configuration and restores when you restart the Docker configuration. Now, you must manually delete the database volume. See [Database containers]. - - {:.new}**TLS container**– + - {:.new}**TLS container**— - - {:.new}**Updated the container base image to use official image**–The [Cloud TLS container] image is now based on the official `debian:jessie` Docker image.– + - {:.new}**Updated the container base image to use official image**—The [Cloud TLS container] image is now based on the official `debian:jessie` Docker image.— - - {:.new}**Added support for the [Pound TLS Termination Proxy]**–The [Pound configuration file][`pound.cfg`] adds the following ENV variables to customize the Docker configuration for the TLS container: + - {:.new}**Added support for the [Pound TLS Termination Proxy]**—The [Pound configuration file][`pound.cfg`] adds the following ENV variables to customize the Docker configuration for the TLS container: - - **`TimeOut`**–Sets the Time to First Byte (TTFB) timeout value. The default value is 300 seconds. + - **`TimeOut`**—Sets the Time to First Byte (TTFB) timeout value. The default value is 300 seconds. - - **`RewriteLocation`**–Determines whether the Pound proxy rewrites the location to the request URL by default. Defaults to `0` to prevent the rewrite from breaking redirects to outside websites like an external SSO site. [Fix submitted by Sorin Sugar](https://github.com/magento/magento-cloud-docker/pull/37) + - **`RewriteLocation`**—Determines whether the Pound proxy rewrites the location to the request URL by default. Defaults to `0` to prevent the rewrite from breaking redirects to outside websites like an external SSO site. [Fix submitted by Sorin Sugar](https://github.com/magento/magento-cloud-docker/pull/37) - - {:.new} Increased the timeout value in the TLS container configuration from 15 to 300 seconds. [Fix submitted by Mathew Beane from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/78) + - {:.new}Increased the timeout value in the TLS container configuration from 15 to 300 seconds. [Fix submitted by Mathew Beane from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/78) - - {:.new}**Varnish container**– + - {:.new}**Varnish container**— - {:.new}**Updated the container base image to use official image**—The [Cloud Varnish container] is now based on the official `centos` Docker image. - {:.new}**Improved default timeout configuration**-Added `.first_byte_timeout` and `.between_bytes_timeout` configuration to the Varnish container. Both timeout values default to `300s` (5 minutes). [Fix submitted by Mathew Beane from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/78) - - {:.fix}**Skip Varnish during Xdebug sessions**–Updated the Varnish container configuration to return `pass` on requests received when Xdebug is enabled. In previous releases, you could not use Xdebug if the Docker environment included Varnish. [Fix submitted by Mathew Beane from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/111). + - {:.fix}**Skip Varnish during Xdebug sessions**—Updated the Varnish container configuration to return `pass` on requests received when Xdebug is enabled. In previous releases, you could not use Xdebug if the Docker environment included Varnish. [Fix submitted by Mathew Beane from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/111). -- {:.new}**Docker configuration changes**– +- {:.new}**Docker configuration changes**— - - {:.new}**Manage mounts and volumes for your project**–Added the ability to manage mounts and volumes when launching a Docker environment for local development. See [Sharing project data]. + - {:.new}**Manage mounts and volumes for your project**—Added the ability to manage mounts and volumes when launching a Docker environment for local development. See [Sharing project data]. - - {:.new}**Support for network bridge mode**–Added support for network bridge mode to enable connections between Docker containers over the local network. + - {:.new}**Support for network bridge mode**—Added support for network bridge mode to enable connections between Docker containers over the local network. - - {:.new}**Cron container disabled by default**–To improve performance, the Cron container is no longer configured by default when you build the Docker environment. You can use the `--with-cron` option on the Docker build command to add a Cron container to your environment. See [Managing cron jobs]({{site.baseurl}}/cloud/docker/docker-manage-cron-jobs.html). + - {:.new}**Cron container disabled by default**—To improve performance, the Cron container is no longer configured by default when you build the Docker environment. You can use the `--with-cron` option on the Docker build command to add a Cron container to your environment. See [Managing cron jobs]({{site.baseurl}}/cloud/docker/docker-manage-cron-jobs.html). - - {:.new}**Stop synchronizing large backup files**–Added DB dumps and archive files—ZIP, SQL, GZ, and BZ2—to the exclusion list in the `dist/docker-sync.yml` and `dist/mutagen.sh` files. Synchronizing large files (>1 GB) can cause a period of inactivity and backup files do not normally require synchronization since you can regenerate them. + - {:.new}**Stop synchronizing large backup files**—Added DB dumps and archive files—ZIP, SQL, GZ, and BZ2—to the exclusion list in the `dist/docker-sync.yml` and `dist/mutagen.sh` files. Synchronizing large files (>1 GB) can cause a period of inactivity and backup files do not normally require synchronization since you can regenerate them. -- {:.new}**Command changes**– +- {:.new}**Command changes**— - {:.fix}Renamed the `./bin/docker` file to `./bin/magento-docker` to fix an issue that caused some Docker environments to break because the `./bin/docker` file overwrites existing Docker binary files. This is a [backward incompatible change] that requires updates to your scripts and commands. - - {:.new}**Added a service configuration option to expose the database port to the host**–Use the `--expose-db-port=` option to expose the database port to the host when building the `docker-compose.yml` file: `bin/ece-docker build:compose --expose-db-port=` [Fix submitted by Adarsh Manickam from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/101). + - {:.new}**Added a service configuration option to expose the database port to the host**—Use the `--expose-db-port=` option to expose the database port to the host when building the `docker-compose.yml` file: `bin/ece-docker build:compose --expose-db-port=` [Fix submitted by Adarsh Manickam from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/101). - - {:.new}**New post-deploy command**–Previously, the post-deploy hooks defined in the `.magento.app.yaml` file ran automatically after you deployed {{site.data.var.ee}} to a Cloud Docker container using the `cloud-deploy` command. Now, you must issue a separate `cloud-post-deploy` command to run the post-deploy hooks after you deploy. See the updated launch instructions for [developer] and [production] mode. + - {:.new}**New post-deploy command**—Previously, the post-deploy hooks defined in the `.magento.app.yaml` file ran automatically after you deployed {{site.data.var.ee}} to a Cloud Docker container using the `cloud-deploy` command. Now, you must issue a separate `cloud-post-deploy` command to run the post-deploy hooks after you deploy. See the updated launch instructions for [developer] and [production] mode. - {:.new}Added the `--rm` option to `./bin/magento-docker` commands for the build and deploy containers. This removes the container after the task is complete. - - {:.new}**Updates to `build:compose` command**– + - {:.new}**Updates to `build:compose` command**— - {:.new}Added the `--sync-engine="native"` option to the `docker-build` command to disable file synchronization when you generate the Docker Compose configuration file in developer mode. Use this option when developing on Linux systems, which do not require file synchronization for local Docker development. See [Synchronizing data in the Docker environment]({{site.baseurl}}/cloud/docker/docker-syncing-data.html). - {:.new}Changed the default file synchronization setting from `docker-sync` to `native`. [Fix submitted by Mathew Beane from Zilker Technology](https://github.com/magento/magento-cloud-docker/pull/124). -- {:.new}**Validation improvements**– +- {:.new}**Validation improvements**— - {:.new}Added validation to the deployment process for local Docker development environments to verify that the Cloud environment configuration includes the encryption key required to decrypt the database. Now, you get an error message in the log if the environment configuration does not specify a value for the encryption key. diff --git a/src/cloud/release-notes/mcp-release-notes.md b/src/cloud/release-notes/mcp-release-notes.md index d245742b3b0..80cb1d70c44 100644 --- a/src/cloud/release-notes/mcp-release-notes.md +++ b/src/cloud/release-notes/mcp-release-notes.md @@ -11,90 +11,105 @@ The [Magento Cloud Patches](https://github.com/magento/magento-cloud-patches) pa The {{ site.data.var.mcp }} package is a dependency for the {{site.data.var.ct}} package and is installed and updated when you install or update the {{ site.data.var.ct }} package. You can also use and manage {{ site.data.var.mcp-prod }} as a stand-alone package to apply patches to a {{ site.data.var.ee }} project that is not on the Cloud platform. These release notes describe the latest improvements to this package. -The `{{site.data.var.mcp-package}}` package uses the following version sequence: `..`. - {:.bs-callout-tip} To ensure that your project has all required patches, update to the [latest version of {{ site.data.var.ct }}]({{site.baseurl}}/cloud/project/ece-tools-update.html). {:.bs-callout-info} See [Apply patches]({{site.baseurl}}/cloud/project/project-patch.html) for instructions on applying patches to your projects. +The `{{site.data.var.mcp-package}}` package uses the following version sequence: `..` + +## v1.0.13 + +Release date: October 25, 2021 + +- **Update Monolog**—Updated the minimum version required for the `monolog` package to `^2.3`. +- **Incompatible PHP Method**—Fixed incompatible PHP method for {{site.data.var.ee}} versions 2.4.3 and 2.3.7-p1. +- **PHP error**—Fixed a `PHP error 'Undefined variable: errorMessage' ...` error that occurred while trying to apply a patch. + ## v1.0.12 -*Release date: August 12, 2021*
+ +Release date: August 12, 2021 Critical patch for {{site.data.var.ee}} 2.4.3 and 2.3.7-p1: -- {:.fix}**Issue with API rate limiting**—This patch corrects a default rate limit that prevented Web APIs from processing requests with more than 20 items in an array. This patch raises the default value of the rate limit. See the {{site.data.var.ee}} [2.4.3 release notes]({{site.baseurl}}/guides/v2.4/release-notes/commerce-2-4-3.html#apply-mc-43048__set_rate_limits__243patch-to-address-issue-with-api-rate-limiting) and the [2.3.7 release notes]({{site.baseurl}}/guides/v2.3/release-notes/2-3-7-p1.html#apply-mc-43048__set_rate_limits__237-p1patch-to-address-issue-with-api-rate-limiting). +- **Issue with API rate limiting**—This patch corrects a default rate limit that prevented Web APIs from processing requests with more than 20 items in an array. This patch raises the default value of the rate limit. See the {{site.data.var.ee}} [2.4.3 release notes]({{site.baseurl}}/guides/v2.4/release-notes/commerce-2-4-3.html#apply-mc-43048__set_rate_limits__243patch-to-address-issue-with-api-rate-limiting) and the [2.3.7 release notes]({{site.baseurl}}/guides/v2.3/release-notes/2-3-7-p1.html#apply-mc-43048__set_rate_limits__237-p1patch-to-address-issue-with-api-rate-limiting). ## v1.0.11 -*Release date: {{ site.data.var.ece-release-date }}*
-- {:.fix} **Fixed an issue caused by applying the B2B Layered navigation patch**–For customers that have applied the B2B Layered navigation patch, this fix resolves an `Undefined offset` error that displays on the Search page after switching the Store view. +Release date: July 29, 2021 + +- **Fixed an issue caused by applying the B2B Layered navigation patch**—For customers that have applied the B2B Layered navigation patch, this fix resolves an `Undefined offset` error that displays on the Search page after switching the Store view. -- {:.fix} **Paypal Checkout patch**–Fixes a {{site.data.var.ee}} 2.3.7 issue with PayPal Express where the previously placed order price is displayed. +- **Paypal Checkout patch**—Fixes a {{site.data.var.ee}} 2.3.7 issue with PayPal Express where the previously placed order price is displayed. -- {:.fix} **Patch category support**–Added support for processing patch categories and origin sources assigned to Quality Patches. The categories allow customers to use filters and sorting to find patches more quickly when using the [Quality Patches Tool](https://github.com/magento/quality-patches) and the Site-wide Analysis Tool (SWAT). +- **Patch category support**—Added support for processing patch categories and origin sources assigned to Quality Patches. The categories allow customers to use filters and sorting to find patches more quickly when using the [Quality Patches Tool](https://github.com/magento/quality-patches) and the Site-wide Analysis Tool (SWAT). ## v1.0.10 -*Release date: May 10, 2021*
-- {:.fix} **Compatibility with {{site.data.var.ee}} 2.3.7**—Resolved composer dependencies conflict for installation on {{site.data.var.ee}} 2.3.7. -- {:.fix} **Fixed an issue caused by applying a bundled patch multiple times**—Applying a bundled patch (one that includes other deprecated patches) more than once could revert the included deprecated packages. All patches are now applied only once. Trying to apply the same package again shows a message that the patch has already been applied.. -- {:.fix} **B2B Layered navigation patch**—Fixed another issue that prevented layered navigation from showing all product options when the user enables the B2B Shared Catalog. +Release date: May 10, 2021 + +- **Compatibility with {{site.data.var.ee}} 2.3.7**—Resolved composer dependencies conflict for installation on {{site.data.var.ee}} 2.3.7. +- **Fixed an issue caused by applying a bundled patch multiple times**—Applying a bundled patch (one that includes other deprecated patches) more than once could revert the included deprecated packages. All patches are now applied only once. Trying to apply the same package again shows a message that the patch has already been applied. +- **B2B Layered navigation patch**—Fixed another issue that prevented layered navigation from showing all product options when the user enables the B2B Shared Catalog. ## v1.0.9 -*Release date: February 1, 2021*
-- {:.new} **B2B Layered navigation patch**—Fixed the issue that prevented layered navigation from showing all product options when the B2B Shared Catalog was enabled. -- {:.fix} **Compatibility with PHP 7.4**—Fixed a cloud-patches compatibility issue with PHP 7.4. -- {:.fix} **Deprecated patches become visible**—Fixed a cloud-patches issue in which deprecated patches become visible in the patches table after applying a replacement patch that contains the entire contents of the deprecated patch. This could happen if you applied a patch that combined several other patches. -- {:.fix} **Silent failures when applying patches**—Fixed a cloud-patches issue in which the `git apply` command silently failed to apply patches in some environments. +Release date: February 1, 2021 + +- **B2B Layered navigation patch**—Fixed the issue that prevented layered navigation from showing all product options when the B2B Shared Catalog was enabled. +- **Compatibility with PHP 7.4**—Fixed a cloud-patches compatibility issue with PHP 7.4. +- **Deprecated patches become visible**—Fixed a cloud-patches issue in which deprecated patches become visible in the patches table after applying a replacement patch that contains the entire contents of the deprecated patch. This could happen if you applied a patch that combined several other patches. +- **Silent failures when applying patches**—Fixed a cloud-patches issue in which the `git apply` command silently failed to apply patches in some environments. ## v1.0.8 -*Release date: October 14, 2020*
-- **Compatibility updates for {{site.data.var.mcp-package}}**–Updated the `symfony` and `semver` version constraints in the `composer.json` file for compatibility with {{site.data.var.ee}} 2.4.1 and later releases. +Release date: October 14, 2020 + +- **Compatibility updates for {{site.data.var.mcp-package}}**—Updated the `symfony` and `semver` version constraints in the `composer.json` file for compatibility with {{site.data.var.ee}} 2.4.1 and later releases. ## v1.0.7 -*Release date: October 14, 2020*
-- **Redis patches for {{site.data.var.ee}} 2.3.0 to 2.3.5, 2.4.0**–Updated the Redis patches to support adding products to a category when implementing a Level 2 cache. +Release date: October 14, 2020 -- **Braintree VBE patch**–Fixes an issue that generated an error when an Administrator tried to view a Braintree Settlement Report. +- **Redis patches for {{site.data.var.ee}} 2.3.0 to 2.3.5, 2.4.0**—Updated the Redis patches to support adding products to a category when implementing a Level 2 cache. + +- **Braintree VBE patch**—Fixes an issue that generated an error when an Administrator tried to view a Braintree Settlement Report. - Now, the `ece-patches apply` command uses the Unix `patch` command to apply patches if Git is not available on the host system. ## v1.0.6 -*Release date: {{ site.data.var.ece-release-date }}*
- +Release date: -- **Redis patches for {{site.data.var.ee}} 2.3.0 - 2.3.4**–Optimize communication and improve performance +- **Redis patches for {{site.data.var.ee}} 2.3.0 - 2.3.4**—Optimize communication and improve performance - Reduce size of network transfers between Redis and {{site.data.var.ee}} - Fix race conditions on Redis load and write operations - Rewrite base cache adapter to handle errors on save - Decrease Redis CPU consumption -- **Redis patches for {{site.data.var.ee}} 2.3.0 - 2.3.5**–Improve performance and fix errors +- **Redis patches for {{site.data.var.ee}} 2.3.0 - 2.3.5**—Improve performance and fix errors - Fix the Cache lock implementation to prevent infinite locks - Improve the current locking mechanism - Implement signed locks to prevent unlock from parallel requests - Fix the following error that occurs on Redis write operation: `OOM command not allowed when used memory > maxmemory` - Fix processing for clean cache by `cat_p` tag that runs during product updates -- {:.fix}Fixed an issue that caused an error when applying the required `amzn/amazon-pay-module` patch to {{ site.data.var.ece }} projects with {{site.data.var.ee}} v2.2.6 or 2.3.5, which do not include this module. Now, the patching process skips the `amzn/amazon-pay-module` patch if the module is not installed. +- Fixed an issue that caused an error when applying the required `amzn/amazon-pay-module` patch to {{ site.data.var.ece }} projects with {{site.data.var.ee}} v2.2.6 or 2.3.5, which do not include this module. Now, the patching process skips the `amzn/amazon-pay-module` patch if the module is not installed. ## v1.0.5 -*Release date: June 26, 2020*
-- **Redis performance improvements**–Adds Redis optimization features to {{site.data.var.ee}} versions 2.3.3 and 2.3.4. These fixes were included in the {{site.data.var.ee}} version 2.3.5 release. See [Performance boosts]({{site.baseurl}}/guides/v2.3/release-notes/release-notes-2-3-5-commerce.html#performance-boosts) in the _{{site.data.var.ee}} 2.3.5 Release Notes_. +Release date: June 26, 2020 + +- **Redis performance improvements**—Adds Redis optimization features to {{site.data.var.ee}} versions 2.3.3 and 2.3.4. These fixes were included in the {{site.data.var.ee}} version 2.3.5 release. See [Performance boosts]({{site.baseurl}}/guides/v2.3/release-notes/release-notes-2-3-5-commerce.html#performance-boosts) in the _{{site.data.var.ee}} 2.3.5 Release Notes_. -- **New Relic log enricher**–Adds the Monolog ProcessorInterface required to support improvements to New Relic logging capabilities introduced in {{site.data.var.mcc-prod}} version 1.0.4. This patch is required to deploy {{site.data.var.ee}} 2.1.x. If the patch is not applied, the build fails during the `di:compile` process. +- **New Relic log enricher**—Adds the Monolog ProcessorInterface required to support improvements to New Relic logging capabilities introduced in {{site.data.var.mcc-prod}} version 1.0.4. This patch is required to deploy {{site.data.var.ee}} 2.1.x. If the patch is not applied, the build fails during the `di:compile` process. ## v1.0.4 -*Release date: May 12, 2020*
+ +Release date: May 12, 2020 - **Amazon Pay checkout**—Fixes an issue with the Amazon Pay payment widget that prevented customers from changing the payment method on the _Review & Payments_ step during the checkout process. @@ -111,12 +126,14 @@ Critical patch for {{site.data.var.ee}} 2.4.3 and 2.3.7-p1: - Updated patches for compatibility with {{site.data.var.ce}}. ## v1.0.3 -*Release date: April 28, 2020*
+ +Release date: April 28, 2020 - Added fix for the "FPC is getting disabled during deployments" patch to support {{site.data.var.ee}} 2.3.5. ## v1.0.2 -*Release date: February 27, 2020*
+ +Release date: February 27, 2020 This release includes the following patches and critical fixes: @@ -128,44 +145,44 @@ This release includes the following patches and critical fixes: - **PayPal Express Checkout**—Published on February 12, 2020, this patch resolves an issue that affects orders placed with PayPal Express Checkout where the shipping address for the order specifies a country region that has been manually entered into the text field rather than selected from the drop-down menu on the Shipping page. See the complete patch description on the [patch download page](https://magento.com/tech-resources/download#download2353). -- **Application deployment fix**–Added a patch to fix an issue that disabled the full page cache during the deployment process. This patch applies to {{site.data.var.ee}} 2.3.2 and later releases. +- **Application deployment fix**—Added a patch to fix an issue that disabled the full page cache during the deployment process. This patch applies to {{site.data.var.ee}} 2.3.2 and later releases. - **Scope parameter for Async/Bulk API**—Updated this patch to fix a syntax error in the `composer.json` file. This patch applies to {{site.data.var.ce}} 2.3.1 and 2.3.2. See the complete patch description on the [patch download page](https://magento.com/tech-resources/download#download2312). ## v1.0.1 -*Release date: February 6, 2020*
+ +Release date: February 6, 2020 We have included all {{site.data.var.ce}} 2.x patches from the [software downloads page](https://magento.com/tech-resources/download) in the {{site.data.var.mcp-package}} v1.0.1 release. If you copied any patches into your project previously, remove them to avoid conflicts. This release includes the following patches and critical fixes: -- **Fix cron deadlocks and improve cron locking**– +- **Fix cron deadlocks and improve cron locking**— - Fixes an issue with some cron jobs not running due to an incorrect status value in the `cron_schedule` table. Now, we use the {{site.data.var.ee}} lock framework to check and update cron job status instead of using the `cron_schedule` table. Cron jobs that have ended with an error status are retried during the next cron run instead of waiting 24 hours. - Adds a _retry_ operation to avoid deadlock during updates to the data in the `cron_schedule` table. -- **Updated `{{site.data.var.mcp-package}}` to include all available patches for {{site.data.var.ce}} 2.x**–Updated the {{site.data.var.mcp-package}} package to include all {{site.data.var.ce}} 2.x patches available on the [software downloads page](https://magento.com/tech-resources/download). If you copied any {{site.data.var.ce}} patches into your {{site.data.var.ece}} project previously, remove them to avoid conflicts. +- **Updated `{{site.data.var.mcp-package}}` to include all available patches for {{site.data.var.ce}} 2.x**—Updated the {{site.data.var.mcp-package}} package to include all {{site.data.var.ce}} 2.x patches available on the [software downloads page](https://magento.com/tech-resources/download). If you copied any {{site.data.var.ce}} patches into your {{site.data.var.ece}} project previously, remove them to avoid conflicts. -- **Elasticsearch catalog pagination fix** –Replaced the Elasticsearch catalog pagination patch delivered in {{site.data.var.mcp-package}} v1.0 with a more effective fix. +- **Elasticsearch catalog pagination fix** —Replaced the Elasticsearch catalog pagination patch delivered in {{site.data.var.mcp-package}} v1.0 with a more effective fix. -- **Page Builder patches**–In {{site.data.var.mcp-prod}} 1.0.0, we bundled Page Builder patches to address a known Page Builder remote code execution (RCE) vulnerability, with the initial fix based on {{site.data.var.ee}} 2.3.3. We have updated these patches with a more stable implementation based on {{site.data.var.ee}} 2.3.4., which includes multiple optimizations for fixing the issue. +- **Page Builder patches**—In {{site.data.var.mcp-prod}} 1.0.0, we bundled Page Builder patches to address a known Page Builder remote code execution (RCE) vulnerability, with the initial fix based on {{site.data.var.ee}} 2.3.3. We have updated these patches with a more stable implementation based on {{site.data.var.ee}} 2.3.4., which includes multiple optimizations for fixing the issue. If you have the {{site.data.var.mcp-package}} 1.0.0 package, you are still protected from the Page Builder RCE vulnerability issues. If you update to 1.0.1 or later, you have a better implementation of the same fix. ## v1.0.0 -*Release date: November 14, 2019*
-This is the first release of the [`magento/magento-cloud-patches`](https://github.com/magento/magento-cloud-patches) package, which is a new dependency for the `{{ site.data.var.ct }}` package version 2002.0.22 or later releases. +Release date: November 14, 2019 - +This is the first release of the [`magento/magento-cloud-patches`](https://github.com/magento/magento-cloud-patches) package, which is a new dependency for the `{{ site.data.var.ct }}` package version 2002.0.22 or later releases. This release includes the following patches and critical fixes: -- **Page Builder security patches for 2.3.1.x and 2.3.2.x releases**–Fixes an issue in Page Builder preview that allows unauthenticated users to access some templating methods that can be used to trigger arbitrary code execution over the network (RCE) resulting in global information leaks. This issue can occur when using unsupported versions of Page Builder with {{ site.data.var.ee }} versions 2.3.1 and 2.3.2. +- **Page Builder security patches for 2.3.1.x and 2.3.2.x releases**—Fixes an issue in Page Builder preview that allows unauthenticated users to access some templating methods that can be used to trigger arbitrary code execution over the network (RCE) resulting in global information leaks. This issue can occur when using unsupported versions of Page Builder with {{ site.data.var.ee }} versions 2.3.1 and 2.3.2. -- **MSI patches**–Fixes issues that caused indexing errors and performance issues when using default inventory settings for managing stock. +- **MSI patches**—Fixes issues that caused indexing errors and performance issues when using default inventory settings for managing stock. - **Backward Compatibility of new Mail Interfaces**-Fixes a backward incompatibility issue caused by the `Magento\Framework\Mail\EmailMessageInterface` PHP interface introduced in {{ site.data.var.ee }} v2.3.3. In the scope of this patch, the new `EmailMessageInterface` inherits from the old `MessageInterface`, and {{ site.data.var.ee }} core modules are reverted to depend on `MessageInterface`. -- **Catalog pagination does not work on Elasticsearch 6.x**–Fixes a critical issue with search result pagination that affects customers using Elasticsearch 6.x as the catalog search engine. +- **Catalog pagination does not work on Elasticsearch 6.x**—Fixes a critical issue with search result pagination that affects customers using Elasticsearch 6.x as the catalog search engine.