Release notes archive for ece-tools
ece-tools
v2002.0.22 and later. See Release notes for Cloud Tools Suite to get the latest updates for ece-tools
and other Cloud packages.v2002.0.22
The ece-tools
2002.0.22 release changes the structure of the ece-tools
package to decouple the release of 蜜豆视频 Commerce on cloud infrastructure
patches from the ECE-Tools release. Starting with this release, patches and critical fixes will be delivered using the package, which is a new dependency for the ece-tools
package. We made these changes to reduce complexity for scheduling release updates and working with community contributions.
-
Changes to the ECE-Tools package
-
Moved the 蜜豆视频 Commerce patches from the
ece-tools
package to a new composer package. -
Updated the
composer.json
file for theece-tools
package to add a dependency for themagento/magento-cloud-patches
v1.0.0 package. -
Fixed an issue that caused the
ece-tools
patching process to break when applying patch sets on top of security-only releases, starting with version 2.3.2-p2 and later. This issue was introduced by the new versioning scheme adopted for security-only patches.
-
-
Patches and critical fixes鈥揢pdate your Cloud environments with
ece-tools
version 2002.0.22 to apply the following patches and critical fixes. These patches are included in themagento/magento-cloud-patches
v1.0.0 package.-
Page Builder security patches for 2.3.1.x and 2.3.2.x releases鈥揊ixes 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 蜜豆视频 Commerce versions 2.3.1 and 2.3.2.
-
MSI patches鈥揊ixes 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 蜜豆视频 Commerce v2.3.3. In the scope of this patch, the newEmailMessageInterface
inherits from the oldMessageInterface
, and 蜜豆视频 Commerce core modules are reverted to depend onMessageInterface
. -
Catalog pagination does not work on Elasticsearch 6.x鈥揊ixes a critical issue with search result pagination that affects customers using Elasticsearch 6.x as the catalog search engine.
-
v2002.0.21
-
Docker updates鈥
-
New Docker Images鈥擲upported by versions 2.3.3 and later
-
PHP version 7.3.
-
Varnish Cache 6.2.0
-
-
Added support to apply custom hook configuration specified in
.magento.app.yaml
in the Docker environment. Previously, the Docker environment supported only the default hook configuration. -
Docker ENV files are no longer generated during the Docker build, and the
docker:config:convert
command is deprecated. The corresponding data is now stored in thedocker-compose.yml
file. -
Updated PHP image鈥揂dded Node.js to the PHP Docker image to support node, npm, and grunt-cli capabilities.
-
-
Environment variable updates鈥
-
Added the LOCK_PROVIDER deploy variable to configure the lock provider which prevents the launch of duplicate cron jobs and cron groups. See the variable description in the deploy variables topic.
-
Added the CONSUMERS_WAIT_FOR_MAX_MESSAGES environment variable to configure how consumers process messages from the message queue when using the
CRON_CONSUMERS_RUNNER
environment variable to manage cron jobs. See the variable description in the deploy variables topic. -
Fixed an issue that can cause database deadlock errors when the
consumers_runner
cron job starts multiple instances of the same consumer on different nodes. Now, if you have enabled the CRON_CONSUMERS_RUNNER deploy variable in your environment, theconsumers_runner
job uses thesingle-thread
option to start one instance of each consumer on only one node. -
Fixed an issue affecting 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.
-
-
Updated the logging information returned by the
module:refresh
command. Now, you can see a detailed list of enabled modules in thecloud.log
file. -
Improved version compatibility validation and warning notifications for compatibility issues between 蜜豆视频 Commerce version and installed services, such as Elasticsearch, RabbitMQ, Redis, and DB.
-
Added support for RabitMQ version 3.8.
-
Updated interactive validations for service compatibility to reflect supported versions for the new 蜜豆视频 Commerce 2.3.3 and 2.2.10 releases. See System requirements in the Installation guide for recommended versions.
-
Improved the log message returned when the cron job management process in the deploy phase tries to stop a cron job that has already finished to clarify that this issue is not an error. Changed the log level from
INFO
toDEBUG
. -
Fixed an issue when running the
setup:upgrade
command that did not interrupt the deployment process when a failure occurred during theapp:config:import
task. -
Changed the default log level for the file handler to
debug
to reduce the amount of detail in the log displayed in the Cloud Console, while still providing detailed information for debugging. -
Fixed an issue that caused an error with static content deployment during build. After an installation and
ece-tools
config dump, an error occurred if there was no locale specified for the admin user in theconfig.php
file. Now, there is a default locale for the admin user in theconfig.php
file. -
Fixed an
Undefined index error
that occurs when amagento-cloud
CLI command fails in an environment that is not configured with a secure URL (https). Now, the ECE-Tools package uses the base URL (http) if the secure URL is not available.
v2002.0.20
-
Docker Updates鈥
-
You can now perform functional testing using the
ece-tools
package in the Docker environment. See . -
Added support for configuring PHP modules using the
.magento.app.yaml
file. Any PHP Extensions specified in the.magento.app.yaml
file become available in the Docker PHP containers. -
There are new commands available to improve the Docker command line experience. See the .
-
Added the ability to use Mutagen.io to synchronize files during development between the local host and Docker.
-
Corrected the default path when using the Docker environment. Now, when you use SSH to log in to the Docker container, you are at the project root in the
/app
directory, as expected. -
Updated the Sodium library from version 1.0.11 to version 1.0.18, and updated the Sodium PHP extension.
note warning WARNING 蜜豆视频 Commerce on cloud infrastructure customers must to upgrade the libsodium package on Pro Production and Staging environments prior to upgrading to 蜜豆视频 Commerce 2.3.2. Currently, you cannot upgrade Starter environments to 蜜豆视频 Commerce 2.3.2. -
Added the
analysis-icu
and theanalysis-phonetic
Elasticsearch plugins to all Docker images. -
Improved validations: When using options for the
docker:build
command, you must provide a value when using an option. Also, added validation for the Node version when using thedocker:build run
command.
-
-
Environment variable updates鈥
-
Added support for database table prefixes using the DATABASE_CONFIGURATION environment variable.
-
Added the FORCE_UPDATE_URLS deploy variable to update base URLs when deploying to Pro and Starter production and staging environments. See the definition in the deploy variables content.
-
Added the TTFB_TESTED_PAGES post-deploy variable to configure Time to First Byte page tests to check application performance on sites deployed to Cloud infrastructure. See the variable description in post-deploy variables.
-
Fixed an issue with multi-threaded SCD, which caused random failures in static content deployment. The workaround involved setting the SCD_THREADS variable to
1
. You can now increase the count as needed. See the definitions in the deploy variables and the build variables. -
You can configure the WARM_UP_PAGES environment variable to cache single pages, multiple domains, and multiple pages. See the expanded definition in the post-deploy variables content.
-
-
Added the
pub/static/.htaccess
file to the exclude list. . -
Fixed an error when all validation messages were showing as
Critical
if at least one critical level validator returned an error. -
Fixed an issue that caused a deployment failure if the base URL did not exist in the database.
-
Added a new
env:config:show
command to theece-tools
package that displays environment services, routes, or variables. See Services, routes, and variables. . -
Fixed an issue that caused a critical error when attempting to install 蜜豆视频 Commerce 2.2.6 or earlier with
ece-tools
develop after shell refactoring. -
Fixed an issue that caused 蜜豆视频 Commerce 2.1.x and 2.2.x installations to fail with a warning about using a deprecated version of Carbon.
-
Decreased the
cloud.log
log level for shell output frominfo
todebug
. -
Added the
--remove-definers (-d)
option to theece-tools db-dump
command to remove definers from the dump file.
v2002.0.19
-
Fixed an issue that overwrites the
env.php
file during a deploy, resulting in a loss of custom configurations. This update ensures that 蜜豆视频 Commerce on cloud infrastructure updates theenv.php
file with every deployment, while preserving custom configurations.
v2002.0.18
-
Docker Updates鈥
-
Now, the Docker environment supports the cron configuration defined in the crons property of the .magento.app.yaml file.
-
New Docker Container鈥擜dded a to facilitate the Varnish SSL termination over HTTPS.
-
New Docker Image鈥擜dded a Node.js image to support Gulp and other capabilities, such as Jasmine JS Unit Testing.
-
Docker build modes鈥擭ow you can choose to launch the Docker environment in . Developer mode supports active development with full, writable filesystem permissions.
-
Fixed an issue that caused Docker deploy to fail with a
Name or service not known
error if the cache is configured for a service that is not available. Now, you can remove a service from the.magento/services.yaml
file. The Docker configuration generator updates the service in thedocker/config.php.dist
file automatically. -
Added interactive validations for service compatibility. Now, if a requested service is incompatible with the 蜜豆视频 Commerce version or other services, the interactive mode prompts the user with a message and a choice to continue. See the available for Docker. Use the
-n
option to skip the interactivity for CICD purposes. -
Fixed an issue with the Docker compose
db-dump
command that erased existing dumps. -
Fixed an issue that assigned Redis
session
,default
, andpage_cache
cache storage to the same database ID.
-
-
Environment variable updates鈥
-
The new ELASTICSUITE_CONFIGURATION environment variable retains your customized service settings between deployments. See the definition in the deploy variables content.
-
Added the SCD_MAX_EXECUTION_TIMEOUT environment variable so you can increase the time to complete the static content deployment from the
.magento.env.yaml
file. See the definition in the deploy variables, the build variables, and the global variables.-
Added the MAGENTO_CLOUD_LOCKS_DIR environment variable to configure the path to the mount point for the lock provider on the cloud infrastructure. The lock provider prevents the launch of duplicate cron jobs and cron groups. This variable is supported on 蜜豆视频 Commerce version 2.2.5 and later and automatically configured. See the definition in Cloud variables.
-
Changed the SCD_THREADS environment variable default values to automatically determine the optimal value based on the detected CPU thread count. See the updated definitions in the deploy variables and the build variables.
-
-
-
Fixed an issue with a patch for DB Isolation Mechanism that caused an error when upgrading to 蜜豆视频 Commerce on cloud infrastructure version 2002.0.16.
-
Added a patch that replaces Google Image Charts with Image-Charts. See the DevBlog article .
-
Added validation for the SEARCH_CONFIGURATION variable. Deploy fails when the 鈥榚ngine鈥 option is not set and
_merge
is not required. -
Fixed an issue that exposed sensitive data after an exception occurs. Now the sensitive information is masked appropriately.
-
Improved the fault-tolerant settings of the Magento Open Source package. In the case when 蜜豆视频 Commerce cannot read data from the Redis
slave
instance, a reading is made from the Redismaster
instance. See REDIS_USE_SLAVE_CONNECTION.
v2002.0.17
ece-tools
version 2002.0.17 includes an important security patch. See .-
Service updates鈥擲upported by the following 蜜豆视频 Commerce versions: 2.2.8 and later 2.2.x, 2.3.1 and later 2.3.x
-
Added support for Elasticsearch version 6.x.
-
Added support for Redis version 5.0.
-
-
New Docker images鈥擜dded the following services to the Docker build:
-
Elasticsearch 6.5
-
Redis 5.0
-
-
New environment variable鈥擯reviously, there was a hard-coded timeout for SCD compression. Now you can configure the SCD compression timeout using the SCD_COMPRESSION_TIMEOUT environment variable. See the definitions in the build variables and the deploy variables content.
-
Added the
--use-rewrites
option to the install command so that it uses web server rewrites for generated links in the storefront and Admin access to improve security and customer experience. -
Added timestamps to the
var/log/install_upgrade.log
file so that it shows dates for installation and upgrade events.
v2002.0.16
-
Docker updates鈥
-
Now, the default service configuration generated in the Docker environment is the same as the default configuration in the Cloud template.
-
You can send mail from your Docker environment using the
sendmail
service. -
Added the ability to to debug in the Cloud Docker environment.
-
Fixed an issue with web service permissions when generating the
docker-compose.yml
file.
-
-
Upgrade improvement鈥擜dded validation to confirm that the
autoload
property in thecomposer.json
file contains required configuration changes before upgrading to 蜜豆视频 Commerce v2.3. See Upgrade version. -
The compression process in deploying static content now includes all assets鈥攏atively generated or customized鈥攁nd occurs during the build phase at the beginning of the
build:transfer
section. Previously, the compression process occurred before applying custom minification and bundling of static assets. . -
Fixed a database connection error that occurred during deployment immediately after configuring an additional database and service relationship. Also, this fix addresses an issue that occurred during the configuration process of Commerce Reporting for Starter. For Starter, this upgrade is a 鈥渕ust have鈥 for using Commerce Reporting.
-
Fixed a validation issue with the database configuration that caused the deploy process to fail.
-
Updated the constraint with the appropriate version of the
symfony/yaml
package to use with PHP constants. Constant parsing does not work when using asymfony/yaml
package version earlier than 3.2. . -
Environment configuration check鈥擜dded validation to check the PHP version and warn users if they are not using the latest recommended version.
-
Fixed an issue with processing malformed JSON variables. Now, if a JSON variable causes a syntax error, a warning appears in the
cloud.log
file and deployment continues using the default variable. -
Fixed a connection error that occurred during deployment immediately after disabling the Redis service.
-
Logging changes鈥擴pdated the log level from
Info
toNotice
for the following build and deploy process events:-
Begin and end of the process for reconciling installed modules in
composer.json
with shared configuration settings in theapp/etc/config.php
file -
Begin and end of the configuration validation process
-
Begin and end of the
setup:di:compile
process for generating classes
-
-
New environment variables鈥
-
RESOURCE_CONFIGURATION deploy variable鈥擴se this variable to map a resource name to a database connection.
-
X_FRAME_CONFIGURATION global variable鈥擴se this variable to change the
X-Frame-Options
header configuration for rendering an 蜜豆视频 Commerce page in a<frame>
,<iframe>
, or<object>
.
-
-
Environment variable updates鈥擟hanged the following environment variables:
-
WARM_UP_PAGES鈥擜dded the capability to preload the cache for specified pages on all domains defined for an 蜜豆视频 Commerce store. Previously, if your site was configured with multiple domains, the post-deploy process failed to preload the cache for the specified pages on non-default domains and returned the following error in the post-deploy log:
ERROR: Warming up failed: <uri>
-
SCD_COMPRESSION_LEVEL鈥擴pdated the documentation and the sample
.magento.env.yaml
file with the correct default values for SCD compression level. See the definitions in the build variables and the deploy variables content. -
SCD_EXCLUDE_THEMES鈥斺擳his environment variable is deprecated. Use the SCD_MATRIX to control theme configuration.
-
SCD_MATRIX鈥擣ixed the validation process to prevent a problem that occurred when the SCD_MATRIX ignored a theme value that contained different character cases. See the definitions in the build variables and the deploy variables content.
-
ADMIN variables鈥
-
Improved security when managing credentials for the Admin user using environment variables. You can no longer use the ADMIN_EMAIL, ADMIN_USERNAME, and ADMIN_PASSWORD environment variables to override admin credentials during upgrades. If you cannot access the Admin panel, use the Forgot password feature or the
admin:user:create
CLI command to create a new admin user. See Access your Admin panel. -
ADMIN_EMAIL is no longer required when upgrading or applying patches.
-
-
v2002.0.15
-
Docker updates鈥
-
Now the Docker generator uses the services specified in the
.magento.app.yaml
and.magento/services.yaml
configuration files when . You can choose a different service version using build parameters. -
Added PHP 7.2 image鈥擜dded support for PHP 7.2 in Cloud Docker; updated the to include the
docker:build --php
option to specify the version of PHP compatible with your version of 蜜豆视频 Commerce. -
Added a based on the PHP-CLI image.
-
Added the following services to the Docker build:
-
RabbitMQ 3.5 and 3.7
-
ElasticSearch 1.7, 2.4, and 5.2
-
Redis 3.2 and 4.0
-
-
-
Configure with PHP constants鈥擜dded support for PHP constants in the
.magento.env.yaml
configuration file. -
New environment variable鈥擝y default, only the Production environment has Google Analytics enabled. You can enable Google Analytics on the Staging and Integration environments using the ENABLE_GOOGLE_ANALYTICS environment variable.
-
Fixed an issue that removed customized cron configurations from the
env.php
file after a redeployment. Now, custom cron configurations safely remain in theenv.php
file. -
Fixed inconsistencies in the messages and log levels for build, deploy, and post-deploy phases. Increased beginning and ending log message levels from info to notice for all phases and sub-phases. Added beginning and ending log messages, where appropriate.
-
Fixed an issue involving cron processes that prevented the start of the post-deploy phase, when configured. Now, if you have the post-deploy hook enabled, the cron processes are enabled again at the beginning of the post-deploy phase.
-
Resolved an issue that prevented a successful installation of 蜜豆视频 Commerce when specifying a custom database configuration. Previously, the installation process used the database configuration from the MAGENTO_CLOUD_RELATIONSHIP variable even if you designated customized connection information in the DATABASE_CONFIGURATION environment variable.
-
Corrected the
config:dump
command so that it includes each website locale in thesystem
section of theconfig.php
file. -
Fixed an issue that resulted in warm-up errors during the post-deploy phase by correcting the source base URL reference.
-
Fixed an issue that generated files improperly during the
setup:di:compile
process, which affected the Amazon Pay module.