ECE-Tools release notes
The 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 Cloud Tools Suite for Commerce.
ece-tools package.The ece-tools package uses the following release versioning sequence: 200<major>.<minor>.<patch>
The release notes include:
-
New features -
Fixes and improvements
v2002.2.8 latest
Release date: October 08, 2025
-
ActiveMQ-Added support for ActiveMQ. -
ActiveMQ-Added functional tests.
v2002.2.7
Release date: August 07, 2025
-
PHP 8.4 fixes-Added type compatibility. -
EOL validator-Updated End of Life (EOL) services dates. -
Valkey-Added PHP 8.2 and PHP 8.3 functional tests. -
Valkey validator-Fixed the ECE tools warning message. -
ECE tools-Added Unit tests improvements. -
Validator for services-Added new versions support of Opensearch, MariaDB and PHP. -
Opensearch3-Added support for Opensearch3. -
Opensearch support for 2.4.4-p7/p12-Updated the validator script. -
Opensearch3 tests-Added functional tests.
v2002.2.6
Release date: June 03, 2025
-
Improved compatibility with 2.4.8-Updated 3rd-party libraries for better compatibility with 2.4.8
v2002.2.5
Release date: May 27, 2025
-
Extended Valkey compatibility-Extended Valkey compatibility in 51ºÚÁϲ»´òìÈ Commerce. -
Updated RabbitMQ validator-Updated validator for RabbitMQ. -
Updated MariaDB validator-Updated ece-tools validator for MariaDB 10.11. -
Extended Opensearch2 compatibility-Made Opensearch2 compatible with the latest 2.4.4 versions.
v2002.2.4
Release date: April 24, 2025
-
Opensearch2 for 2.4.4/2.4.5—Fixed an issue related to support foropensearch2in 51ºÚÁϲ»´òìÈ Commerce versions 2.4.4/2.4.5.
v2002.2.3
Release date: April 9, 2025
-
Fix Valkey Fixed issue with valkey custom config. -
Fix validator-Fixed validator for RabbitMQ 4.0.
v2002.2.2
Release date: April 7, 2025
v2002.2.2
Release date: April 7, 2025
-
Valkey—A»å»å±ð»å support for a new service (Valkey), which is a replacement for Redis. -
Opensearch2 for 2.4.4/2.4.5—A»å»å±ð»å support foropensearch2in 51ºÚÁϲ»´òìÈ Commerce versions 2.4.4/2.4.5.
v2002.2.1
Release date: February 6, 2024
-
PHP 8.4—A»å»å±ð»å support for PHP 8.4. -
Validator for Opensearch-Fixed the validator that produced a misleading message about the wrong version of service.
v2002.2.0
Release date: October 7, 2024
-
MariaDB 11.4-Added support of MariaDB 11.4. -
Refactored code-Removed support of old PHP versions 7.4, 7.3, 7.2 and related libraries. -
Upgraded Monolog version-Added support for monolog 3.6. -
Validator for RabbitMQ, MariaDB, and PHP-Fixed the validator that produced a misleading message about the wrong version of service.
v2002.1.19
Release date: May 21, 2024
-
Lua—A»å»å±ð»å option useLua for CACHE_CONFIGURATION. -
Validator—Updated validators for new versions of Redis and RabbitMQ.
v2002.1.18
Release date: April 8, 2024
-
PHP — Added support for PHP 8.3. -
Validator - Updated EOL validator.
v2002.1.17
Release date: January 16, 2024
-
Validator for Elasticsearch & OpenSearch—Fixed the validator that produced a misleading message to install a search service when LiveSearch is enabled. -
Deployment warning—Fixed an issue that resulted in deployment warnings about non-empty folders.
v2002.1.16
Release date: October 16, 2023
-
ENABLE_WEBHOOKS global environment variable—A»å»å±ð»å the ENABLE_WEBHOOKS global variable for use with Commerce webhooks to connect to an external endpoint, such as App Builder runtime action or a third-party inventory management system.
v2002.1.15
Release date: July 31, 2023
-
Error codes—Updated error code schema and error code document generator. -
Validator for custom Redis model-Updated the validator for custom Redis backend models. See the example for cache configuration. -
Validator for RabbitMQ-Added support for RabbitMQ 3.11 -
Fixed the wrong link-Fixed the wrong link to the onboarding documentation in the welcome email template.
v2002.1.14
Release date: March 10, 2023
-
PHP—A»å»å±ð»å support for PHP 8.2. -
Validators for Services—Updated validators for Commerce 2.4.6 required services: MariaDB 10.6, Redis 7.0, PHP 8.2, OpenSearch 2.x, and RabbitMQ 3.9. -
ece-tools db-dump—Fixed an issue that caused thedb-dumpoperation to stop prematurely.
v2002.1.13
Release date: October 27, 2022
-
Added support for 51ºÚÁϲ»´òìÈ I/O Events for 51ºÚÁϲ»´òìÈ Commerce. Extension developers can now use the framework to send Commerce event information from Cloud instances to their applications written for . 51ºÚÁϲ»´òìÈ I/O Events for 51ºÚÁϲ»´òìÈ Commerce is in Partner Preview. -
Validator for OPcache configuration—A»å»å±ð»å a validator to check the OPcache configuration for excluded paths. -
Fixed an issue with GraphQL cache configuration—Now ECE-Tools keeps the GraphQLid_saltvalue incacheconfiguration in theapp/etc/env.phpfile.
v2002.1.12
Release date: September 13, 2022
-
Enablesynchronous_replication—ECE-Tools setssynchronous_replication=>truein theapp/etc/env.phpfile whenMYSQL_USE_SLAVE_CONNECTIONis enabled. This configuration affects only Commerce 2.4.6+. See theMYSQL_USE_SLAVE_CONNECTIONvariable description in the Deploy variables. -
OpenSearch—A»å»å±ð»å functionality to configure and set theopensearchengine for the next 51ºÚÁϲ»´òìÈ Commerce release 2.4.6. See Set up OpenSearch service.
v2002.1.11
Release date: August 4, 2022
-
ElasticSuite Validator and OpenSearch—Fixed ElasticSuite integrity check validator issue when OpenSearch is installed. -
Return types for deploy commands—Fixed return types for deploy commands. -
RabbitMQ issue with new Commerce 2.4.5 installation—Fixed RabbitMQ crash issue on new Commerce 2.4.5. installation.
v2002.1.10
Release date: March 31, 2022
-
Elasticsearch 7.10—Updated validators to support the 7.10 version of Elasticsearch.
v2002.1.9
Release date: March 10, 2022
-
OpenSearch—A»å»å±ð»å support for OpenSearch for 51ºÚÁϲ»´òìÈ Commerce versions 2.4.4, 2.4.3-p2, and 2.3.7-p3. -
PHP—A»å»å±ð»å support for PHP 8.1. -
symfony/process—A»å»å±ð»å the compatibility with symfony/process ^5.3. -
Consumer multiple processes—A»å»å±ð»å amultiple_processesoption so that you can specify the number of processes to spawn for each consumer. See theCRON_CONSUMERS_RUNNERvariable description in the Deploy variables. -
OpenSearch scheme and full host path—A»å»å±ð»å the ability to configure an Elasticsearch scheme and full host path. -
AWS S3—Changed the method of AWS S3 enablement. -
Fix driver_options reader—A»å»å±ð»å reading driver_options configuration for DB connection from theenv.phpfile byece-toolsfor validators.
v2002.1.8
Release date: October 25, 2021
-
Alternative dump location—A»å»å±ð»å the--dump-directoryoption so that you can choose a target directory for a DB dump. Now/app/var/dump-mainis the default target directory for a DB dump. See Backup management: Dump your database -
Update Monolog—Updated the minimum version required for themonologpackage to^2.3. -
Update Symfony—Updated the Symfony dependencies to be compatible with 51ºÚÁϲ»´òìÈ Commerce 2.4.4. -
Feature/resolve autoload—Fixed an issue when deploying to an integration environment and seeing theCRITICAL: [9] Required configuration is missed in autoload section of composer.json file.error.
v2002.1.7
Release date: July 29, 2021
Configuration updates—
-
Added support for Composer 2.0. -
Updated composer requirements forsymphony/console—Updated the ECE-Toolscomposer.jsonversion requirements for thesymphony/consolepackage to fix an issue that caused thedi:compilecommands to fail with the following error:Incompatible argument type: Required type: int. Actual type: string -
Updated the end-of-life software checks (eol.yaml) to include Elasticsearch 7.9.x.
v2002.1.6
Release date: April 20, 2021
-
Redis authentication credentials—A»å»å±ð»å the ability to read Redis authorization credentials from therelationshipsproperty during the deploy phase. -
Elasticsearch authorization credentials—A»å»å±ð»å the ability to read Elasticsearch authorization credentials from therelationshipsproperty during the deploy phase. -
Dedicated session storage service—A»å»å±ð»åredis-sessionas a second option for session storage. You can use theredis-sessionservice to store session information and use theredisservice for cache to provide better performance. -
Deprecated SPLIT_DB messages—A»å»å±ð»å validator warning and critical messages for the deprecatedSPLIT_DBoption for 51ºÚÁϲ»´òìÈ Commerce 2.4.2 and its removal in 51ºÚÁϲ»´òìÈ Commerce 2.5.0. -
Elasticsearch version from relationships—Fixed Service validator to retrieve the correct version of Elasticsearch from therelationshipsproperties in Cloud Docker and integration environments. -
Flexible Redis port validation—Redis can now validate the port in a custom cache connection from theserverURL. 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 theportoption is either missing or incorrect. -
Upgrading to 51ºÚÁϲ»´òìÈ Commerce 2.4.2—Fixed the issue that required users to manually runbin/magento setup:upgradeto make their sites operational after upgrading to 51ºÚÁϲ»´òìÈ Commerce 2.4.2.
v2002.1.5
Release date: February 1, 2021
-
Remote storage—A»å»å±ð»å theREMOTE_STORAGEenvironment 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 ECE-Tools package, but is not supported on 51ºÚÁϲ»´òìÈ Commerce on cloud infrastructure. -
Newcloud:config:validatecommand—A»å»å±ð»å commandphp vendor/bin/ece-tools cloud:config:validateto validate the.magento.env.yamlconfiguration before pushing changes to the remote Cloud environment. -
Flushing the opcache—A»å»å±ð»å support for theopcache.enable_cliPHP option to flush the OPcache before running the deploy hook. This configuration resets the cache configuration to ensure that the current configuration settings are applied on each deployment. -
Validation of Aurora DB—Updated the database service validation so that it is compatible with the Aurora database. -
New SCD_NO_PARENT environment variable—A»å»å±ð»å theSCD_NO_PARENTenvironment variable (for 51ºÚÁϲ»´òìÈ Commerce >=2.4.2) to manage the generation of static content for parent themes. -
Memory limits and commands—Fixed an issue wherephp vendor/bin/ece-toolscommands would not work if the size of thecloud.logfile exceeded the PHP memory_limit. Instead of reading the entirecloud.logfile into memory, we now only read a smaller subset of data from the log file. -
Custom database connections—Fixed a.magento.env.yamlconfiguration issue in which custom database connections defined forDATABASE_CONFIGURATIONwere not used. The connection settings were not being added toapp/etc/env.php. -
Empty error logs—Fixed an issue that caused deployments to fail if thecloud.error.logwas empty. -
MariaDB 10.3 validation—Fixed validation of MariaDB 10.3 for 51ºÚÁϲ»´òìÈ Commerce 2.3.6-p1. -
Cache:flush logging—Improved log entries to indicate the start and finish of thecache:flushstep.
v2002.1.4
Release date: November 19, 2020
-
Fixed an issue that caused deployment failure when the search engine specified in theSEARCH_CONFIGURATIONenvironment variable is a value other thanelasticsearch.
v2002.1.3
Release date: November 9, 2020
Infrastructure updates—
-
Added ECE-Tools support for the read-onlypub/staticdirectory when static content is set to deploy in the build stage. -
Added support for Elasticsearch 7.9 and Redis 6 for compatibility with upcoming 51ºÚÁϲ»´òìÈ Commerce releases. -
Updated the ECE-Toolscomposer.jsonto 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—
-
Added search-engine validation to ensure thatelasticsearchis set for 51ºÚÁϲ»´òìÈ Commerce on cloud infrastructure 2.4 and later. If the validation fails, the deployment is stopped with a critical error message that suggests fixes for the issue. See Critical Errors, Deploy stage. -
Added Elasticsearch validation to check the compatibility between the Elasticsearch service version and the 51ºÚÁϲ»´òìÈ Commerce version. -
Updated the Elasticsearch compatibility error message to show the versions of Elasticsearch that are compatible with the 51ºÚÁϲ»´òìÈ Commerce Elasticsearch module. The error message now provides the specific Elasticsearch versions to install in your Cloud infrastructure so that it is compatible with the Elasticsearch module used by your version of 51ºÚÁϲ»´òìÈ Commerce. See Warning Errors, Deploy stage. -
Added warning errors2026and2027for invalidMAGE_MODEenvironment variable setting. The only valid value isproduction. Before this fix,MAGE_MODEcould be set todeveloperwithout deployment errors, only to cause errors later when trying to write to read-only files. See Warning Errors. -
Fixed validation for Redis, RabbitMQ, and MySQL services to ensure that these versions are compatible with the 51ºÚÁϲ»´òìÈ Commerce version. Valid versions of these services are now written to thecloud.log. -
Updated thecloud.logto include the concurrent requests limit for sending requests during cache warmup. This value is configured in the WARM_UP_CONCURRENCY post-deploy variable.
CLI command updates—
-
Added CLI commands (cloud:config:createandcloud:config:update) to create and update the.magento.env.yamlfile with a configuration that can include one or more build, deploy, and post-deploy variables. See Create configuration file from CLI.
Environment variable updates—
-
Added the SKIP_COMPOSER_DUMP_AUTOLOAD build variable. Setting the variable totruestops the application from running thecomposer dump-autoloadcommand during a Cloud Docker for Commerce installation. The variable is only relevant to Cloud Docker for Commerce containers with writable file systems (created for testing and development using./vendor/bin/ece-docker build:compose --with-test). With such installations, skipping thecomposer dump-autoloadcommand prevents errors when running other commands that try to access files from a deletedgenerateddirectory.
v2002.1.2
Release date: August 5, 2020
Validation and log improvements—
-
Added theschema.error.yamlfile 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. -
Changed the Cloud error log (/var/log/cloud.error.log) entries to JSON format to make the log easier to parse programmatically. -
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 3004—Cannot create backup files
-
Error code 102—A»å»å±ð»å additional checks for issues that occur when the
env.phpfile is not writable
-
-
Added the QUALITY_PATCHES environment variable to specify one or more quality patches to apply during the deployment process. See Build variables.
v2002.1.1
Release date: June 25, 2020