ÃÛ¶¹ÊÓƵ

ECE-Tools Package

The ECE-Tools package is a set of scripts and tools designed to manage and deploy the Commerce application. The ece-tools package simplifies many processes, such as managing cron jobs, verifying project configuration, and applying ÃÛ¶¹ÊÓƵ patches and hot fixes. You can view and contribute to the .

NOTE
If you use a version of ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure that does not contain the ece-tools package, then you must perform a one-time upgrade to your cloud project to remove deprecated packages. If you currently use the ece-tools package and you need to update it, see Update the ECE-Tools package.

The ece-tools package is compatible with ÃÛ¶¹ÊÓƵ Commerce—starting with version 2.1.4—and contains scripts and ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure commands designed to help manage your code and automatically build and deploy your projects.

The following lists the available ece-tools commands:

php ./vendor/bin/ece-tools list

Build and deploy

The ece-tools package contains commands to perform operations for the build, deploy, and post-deploy stages of launching your ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure application. For example, the php ./vendor/bin/ece-tools build command begins the application build process.

By default, these ece-tools commands are in the hooks property of the .magento.app.yaml configuration file.

Docker configuration generator

The ece-tools package includes a dependency for the package, which provides functionality and configuration files for Docker images to launch a Docker development environment for ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure. You can also run Cloud Docker for Commerce as a stand-alone package. See Docker development.

Services, routes, and variables

You can use the ece-tools package to display detailed information about the Base64-encoded Cloud variables used in any Cloud environment. The following command shows all services, routes, and variables.

php ./vendor/bin/ece-tools env:config:show

To display a specific set of information, use the following format:

php ./vendor/bin/ece-tools env:config:show <option>
  • services—Displays the relationship data from the MAGENTO_CLOUD_RELATIONSHIPS environment variable, defined in the services.yaml file.
  • routes—Displays the configured routes for the project using the MAGENTO_CLOUD_ROUTES environment variable.
  • variables—Displays the configured variables for the project using the MAGENTO_CLOUD_VARIABLES environment variable.

Sample output for the services option:

Magento Cloud Services:
+-----------------------------------+----------------------------------+
| Service Configuration             | Value                            |
+-----------------------------------+----------------------------------+
| database:                                                            |
+-----------------------------------+----------------------------------+
| host                              | 127.0.0.1                        |
| password                          | <password>                       |
| port                              | 3306                             |
+-----------------------------------+----------------------------------+
| opensearch:                                                          |
+-----------------------------------+----------------------------------+
| host                              | 127.0.0.1                        |
| port                              | 9200                             |
...

Verify environment configuration

There is a set of verification commands available to help evaluate the configuration of your project. See Smart wizards in the Optimize deployment section for a detailed description of each wizard command. The wizard:ideal-state command runs automatically during the build phase. To verify the ideal state of your project:

php ./vendor/bin/ece-tools wizard:ideal-state
NOTE
You must run the wizard:ideal-state command in the remote Cloud environment. The command always returns the The configured state is not ideal error when run in the local development environment.

Sample output:

Ideal state is configured

See Release notes for ece-tools.

ÃÛ¶¹ÊÓƵ patches and custom patches

The ece-tools package includes a dependency for the package, which delivers ÃÛ¶¹ÊÓƵ patches and hot fixes that improve the integration of all ÃÛ¶¹ÊÓƵ Commerce versions with Cloud environments and supports quick delivery of critical fixes. The `` also delivers custom patches that you add to your ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure project. See Apply patches.

recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26