ECE-Tools release notes
The 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 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:
v2002.2.1 latest
Release date: February 6, 2024
v2002.2.0
Release date: October 7, 2024
v2002.1.19
Release date: May 21, 2024
v2002.1.18
Release date: April 8, 2024
v2002.1.17
Release date: January 16, 2024
v2002.1.16
Release date: October 16, 2023
v2002.1.15
Release date: July 31, 2023
v2002.1.14
Release date: March 10, 2023
-
-
-
db-dump
operation to stop prematurely.
v2002.1.13
Release date: October 27, 2022
-
-
-
id_salt
value incache
configuration in theapp/etc/env.php
file.
v2002.1.12
Release date: September 13, 2022
-
synchronous_replication
—ECE-Tools setssynchronous_replication=>true
in theapp/etc/env.php
file whenMYSQL_USE_SLAVE_CONNECTION
is enabled. This configuration affects only Commerce 2.4.6+. See theMYSQL_USE_SLAVE_CONNECTION
variable description in the Deploy variables. -
opensearch
engine for the next Adobe Commerce release 2.4.6. See Set up OpenSearch service.
v2002.1.11
Release date: August 4, 2022
v2002.1.10
Release date: March 31, 2022
v2002.1.9
Release date: March 10, 2022
-
-
-
-
multiple_processes
option so that you can specify the number of processes to spawn for each consumer. See theCRON_CONSUMERS_RUNNER
variable description in the Deploy variables. -
-
-
env.php
file byece-tools
for validators.
v2002.1.8
Release date: October 25, 2021
-
--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 Backup management: Dump your database -
monolog
package to^2.3
. -
-
CRITICAL: [9] Required configuration is missed in autoload section of composer.json file.
error.
v2002.1.7
Release date: July 29, 2021
Configuration updates—
-
-
symphony/console
—Updated the ECE-Toolscomposer.json
version requirements for thesymphony/console
package to fix an issue that caused thedi:compile
commands to fail with the following error:Incompatible argument type: Required type: int. Actual type: string
-
eol.yaml
) to include Elasticsearch 7.9.x.
v2002.1.6
Release date: April 20, 2021
-
relationships
property during the deploy phase. -
relationships
property during the deploy phase. -
redis-session
as a second option for session storage. You can use theredis-session
service to store session information and use theredis
service for cache to provide better performance. -
SPLIT_DB
option for Adobe Commerce 2.4.2 and its removal in Adobe Commerce 2.5.0. -
relationships
properties in Cloud Docker and integration environments. -
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 theport
option is either missing or incorrect. -
bin/magento setup:upgrade
to make their sites operational after upgrading to Adobe Commerce 2.4.2.
v2002.1.5
Release date: February 1, 2021
-
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 ECE-Tools package, but is not supported on Adobe Commerce on cloud infrastructure. -
cloud:config:validate
command—Added commandphp vendor/bin/ece-tools cloud:config:validate
to validate the.magento.env.yaml
configuration before pushing changes to the remote Cloud environment. -
opcache.enable_cli
PHP 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. -
-
SCD_NO_PARENT
environment variable (for Adobe Commerce >=2.4.2) to manage the generation of static content for parent themes. -
php vendor/bin/ece-tools
commands would not work if the size of thecloud.log
file exceeded the PHP memory_limit. Instead of reading the entirecloud.log
file into memory, we now only read a smaller subset of data from the log file. -
.magento.env.yaml
configuration issue in which custom database connections defined forDATABASE_CONFIGURATION
were not used. The connection settings were not being added toapp/etc/env.php
. -
cloud.error.log
was empty. -
-
cache:flush
step.
v2002.1.4
Release date: November 19, 2020
-
SEARCH_CONFIGURATION
environment variable is a value other thanelasticsearch
.
v2002.1.3
Release date: November 9, 2020
Infrastructure updates—
-
pub/static
directory when static content is set to deploy in the build stage. -
-
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—
-
elasticsearch
is set for Adobe 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. -
-
-
2026
and2027
for invalidMAGE_MODE
environment variable setting. The only valid value isproduction
. Before this fix,MAGE_MODE
could be set todeveloper
without deployment errors, only to cause errors later when trying to write to read-only files. See Warning Errors. -
cloud.log
. -
cloud.log
to 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—
-
cloud:config:create
andcloud: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.
Environment variable updates—
-
true
stops the application from running thecomposer dump-autoload
command 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-autoload
command prevents errors when running other commands that try to access files from a deletedgenerated
directory.
v2002.1.2
Release date: August 5, 2020
Validation and log improvements—
-
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. -
/var/log/cloud.error.log
) entries to JSON format to make the log easier to parse programmatically. -
-
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—Added additional checks for issues that occur when the
env.php
file is not writable
-
-
v2002.1.1
Release date: June 25, 2020
-
-
-
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. -
ece-tools
uses the URL for the route with theprimary:true
attribute set in the project route configuration. See Deploy variables. -
generate.xml
build scenario workflow for applying patches. Patches must be applied earlier to update Adobe Commerce to fix any issues that might cause thedi:compile
andmodule:refresh
steps to fail. -
Crypt key missing
error. Thecrypt/key
value is generated automatically during the installation.
-
-
-
-
-
-
-
app:config:dump
app:config:import
module:enable
The logging level for each call is determined by the configuration of the
VERBOSE_COMMANDS
variable in the.magento.env.yaml
file.
-
-
-
-
-
post-deploy
hook configuration is missing from the.magento.app.yaml
file:code language-text Your application does not have the "post_deploy" hook enabled.
-
code language-text Required configuration is missing from the autoload section of the composer.json file. Add ("Laminas\Mvc\Controller\Zend\": "setupsrc/ Zend/Mvc/Controller/") to the `autoload -> psr-4` section. Then, re-run the "composer update" command locally, and commit the updated composer.json and composer.lock files.
-
env.php
file and data—Added checks for theenv.php
file and data during the install and upgrade process.-
If the
env.php
file is missing from the installation, and thecrypt/key
value is not specified in the.magento.app.yaml
file, the deployment fails with the following notification:code language-text The crypt/key key value does not exist in the ./app/etc/env.php file or the CRYPT_KEY cloud environment variable``Missing crypt key for upgrading Magento`.
-
If the installation does not include the
env.php
file, or the configuration contains only one cache type, thecron:enable
command runs during the upgrade process to restore the file with allcache_types
. The following notification is added to the log:code language-text Magento state indicated as installed but configuration file app/etc/env.php was empty or did not exist. Required data will be restored from environment configurations and from the .magento.env.yaml file.
-
-
v2002.1.0
Release date: February 6, 2020