You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: src/_includes/cloud/error-codes.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
<!-Note: The error code tables in this file are auto-generated from source code. To request changes to error code descriptions or suggestions, submit a GitHub issue to the magento/ece-tools repository.->
1
+
<!--Note: This topic is auto-generated from the https://github.com/magento/ece-tools/blob/e3b13ca023afe324cd93d0caa2fd62d5683b60b9/config/schema.error.yaml source code. To request changes to error code descriptions or suggestions, submit a GitHub issue to the magento/ece-tools repository.-->
2
2
3
3
## Critical Errors
4
4
@@ -71,9 +71,10 @@ Critical errors indicate a problem with the Magento Commerce Cloud project confi
| 130 | install-update: cache_type | Command failed: `php ./bin/magento cache:enable`| Command `php ./bin/magento cache:enable` runs only when Magento was installed but `./app/etc/env.php` file was absent or empty at the beginning of the deployment. Check the `cloud.log` for more information. Add `VERBOSE_COMMANDS: '-vvv'` into `.magento.env.yaml` for more detailed command output. |
73
73
| 131 | install-update | The `crypt/key` key value does not exist in the `./app/etc/env.php` file or the `CRYPT_KEY` cloud environment variable | This error occurs if the `./app/etc/env.php` file is not present when Magento deployment begins, or if the `crypt/key` value is undefined. If you migrated the database from another environment, retrieve the crypt key value from that environment. Then, add the value to the [CRYPT_KEY](https://devdocs.magento.com/cloud/env/variables-deploy.html#crypt_key) cloud environment variable in your current environment. See [Add the Magento encryption key](https://devdocs.magento.com/cloud/setup/first-time-setup-import-import.html#encryption-key). If you accidentally removed the `./app/etc/env.php` file, use the following command to restore it from the backup files created from a previous deployment: `./vendor/bin/ece-tools backup:restore` CLI command ." |
74
-
| 132 || Can not connect to the Elasticsearch service | Check that credentials for elasticsearch are correct and service is running |
74
+
| 132 || Can not connect to the Elasticsearch service | Check for valid Elasticsearch credentials and verify that the service is running |
75
75
| 133 | validate-config | Remove Magento Braintree module configuration which is no longer supported in Magento 2.4 and later versions. | Support for the Braintree module is no longer included with Magento 2.4.0 and later. Remove the CONFIG__STORES__DEFAULT__PAYMENT__BRAINTREE__CHANNEL variable from the variables section of the .magento.app.yaml file. For Braintree support, use an official Braintree Payments extension from the Magento Marketplace instead. |
76
76
| 134 | validate-config | Magento 2.4.0 requires Elasticsearch service to be installed | Install Elasticsearch service |
77
+
| 135 | validate-config | The search engine must be set to Elasticsearch for Magento >= 2.4.0 | Check the SEARCH_CONFIGURATION variable for the `engine` option. If it is configured, remove the option, or set the value to "elasticsearch". |
Copy file name to clipboardExpand all lines: src/cloud/env/variables-build.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -184,6 +184,21 @@ stage:
184
184
{:.bs-callout-info}
185
185
Because Baler is currently in alpha release, we do not recommend using it in Production environments.
186
186
187
+
### `SKIP_COMPOSER_DUMP_AUTOLOAD`
188
+
189
+
- **Default**— _Not set_
190
+
- **Version**—Magento 2.1.4 and later
191
+
192
+
Set to `true` to skip the `composer dump-autoload` command during a {{ site.data.var.mcd-prod }} installation. This variable is only relevant for {{ site.data.var.mcd-prod }} containers with writable file systems. In such cases, skipping the command prevents errors from other commands trying to access code from the deleted `generated` directory.
193
+
194
+
When Magento runs `composer dump-autoload`, it creates autoload files with links to generated classes in the `generated` folder. In production environments with read-only files systems, this is not a problem. However, for {{ site.data.var.mcd-prod }} installations with writable file systems (created only for testing and development using `./vendor/bin/ece-docker build:compose --with-test`), you can run the `bin/magento -n setup:upgrade` command without the `--keep-generated` option, which deletes the `generated` directory. If the directory is deleted, the `composer dump-autoload` command fails because the autoload contains links to files in the deleted directory.
Copy file name to clipboardExpand all lines: src/cloud/project/magento-env-yaml.md
+45Lines changed: 45 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,3 +67,48 @@ When a failure occurs because of an unexpected value in the `.magento.env.yaml`
67
67
```
68
68
69
69
Make any corrections, commit, and push the changes. If you do not receive an error message, then the changes to your configuration file pass the validation.
70
+
71
+
## Create configuration file from CLI
72
+
73
+
You can generate a `.magento.env.yaml` configuration file for a Cloud environment using the following `ece-tools` CLI commands.
74
+
75
+
```bash
76
+
php ./vendor/bin/ece-tools cloud:config:create # Creates a new configuration file
77
+
```
78
+
79
+
```bash
80
+
php ./vendor/bin/ece-tools cloud:config:update # Updates values in the configuration file
81
+
```
82
+
83
+
Both commands require a single argument, a JSON-formatted array that specifies a value for at least one build, deploy, or post-deploy variable. For example, the following command sets values for the `SCD_THREADS` and `CLEAN_STATIC_FILES` variables.
This command creates a new .magento.env.yaml file with the following settings:
90
+
91
+
```yaml
92
+
stage:
93
+
build:
94
+
SCD_THREADS: 5
95
+
deploy:
96
+
CLEAN_STATIC_FILES: false
97
+
```
98
+
99
+
You can use the `cloud:config:update` command to update the new file. For example, the following command changes the `SCD_THREADS` value and adds the `SCD_COMPRESSION_TIMEOUT` configuration:
Copy file name to clipboardExpand all lines: src/cloud/reference/ece-tools-reference.md
+27-21Lines changed: 27 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,39 +19,45 @@ php ./vendor/bin/ece-tools list
19
19
20
20
```terminal
21
21
Available commands:
22
-
build Builds application
23
-
db-dump Creates backup of database
24
-
deploy Deploys application
25
-
help Displays help for a command
26
-
list Lists commands
27
-
patch Applies custom patches
22
+
build Builds application.
23
+
db-dump Creates database backups.
24
+
deploy Deploys application.
25
+
help Displays help for a command.
26
+
list Lists commands.
27
+
patch Applies custom patches.
28
28
post-deploy Performs after deploy operations.
29
-
run Execute scenario(s)
29
+
run Execute scenario(s).
30
30
backup
31
-
backup:list Shows the list of backup files
31
+
backup:list Shows the list of backup files.
32
32
backup:restore Restore important configuration files. Run backup:list to show the list of backup files
33
-
build
34
-
build:generate Generates all necessary files for build stage
35
-
build:transfer Transfer generated files into init directory
33
+
build.
34
+
build:generate Generates all necessary files for build stage.
35
+
build:transfer Transfers generated files into init directory.
36
+
cloud
37
+
cloud:config:create Creates a `.magento.env.yaml` file with the specified build, deploy, and post-deploy variable configuration. Overwrites any existing `.magento,.env.yaml` file.
38
+
cloud:config:update Updates the existing `.magento.env.yaml` file with the specified configuration. Creates `.magento.env.yaml` file if it does not exist.
36
39
config
37
40
config:dump [dump] Dump configuration for static content deployment.
38
41
cron
39
-
cron:disable Disable all Magento cron processes and kills currently running
40
-
cron:enable Enable Magento cron processes
41
-
cron:kill Kill all Magento cron processes
42
+
cron:disable Disable all Magento cron processes and kills currently running.
43
+
cron:enable Enable Magento cron processes.
44
+
cron:kill Kill all Magento cron processes.
42
45
cron:unlock Unlock cron jobs that stuck in "running" state.
43
46
dev
44
47
dev:git:update-composer Updates composer for deployment from git.
Copy file name to clipboardExpand all lines: src/cloud/release-notes/ece-release-notes.md
+34-3Lines changed: 34 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,10 +17,41 @@ The `{{site.data.var.ct}}` package uses the following release versioning sequenc
17
17
{:.bs-callout-info}
18
18
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.
- {:.new}Added ece-tools support for the read-only `pub/static` directory when static content is set to deploy in the build stage.<!--MC-37699-->
26
+
27
+
- {:.new}Added support for Elasticsearch 7.9 and Redis 6 for compatibility with upcoming Magento releases.<!--MCLOUD-7191-->
28
+
29
+
- {:.fix}Updated the ece-tools `composer.json` to add a required dependency for the Magento Quality Patches package. This fixes a circular dependency that existed between the ece-tools and magento-cloud-patches packages.<!--MCLOUD-6910-->
30
+
31
+
**Validation and log improvements**–
32
+
33
+
- {:.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).<!--MCLOUD-6937-->
34
+
35
+
- {:.new}Added Elasticsearch validation to check the compatibility between the Elasticsearch service version and the Magento version.<!--MCLOUD-7193-->
36
+
37
+
- {:.new}Updated the Elasticsearch compatibility error message to show the versions of Elasticsearch that are compatible with the Magento 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 Magento. See [Warning Errors, Deploy stage]({{ site.baseurl }}/cloud/reference/ece-tools-error-reference.html#deploy-stage-1).<!--MCLOUD-6698-->
38
+
39
+
- {:.new}Added warning errors `2026` and `2027` for invalid `MAGE_MODE` environment variable setting. The only valid value is `production`. Before this fix, `MAGE_MODE` could be set to `developer` without deployment errors, only to cause errors later when trying to write to read-only files. See [Warning Errors]({{ site.baseurl }}/cloud/reference/ece-tools-error-reference.html#warning-errors).<!--MCLOUD-6708-->
40
+
41
+
- {:.fix}Fixed validation for Redis, RabbitMQ and MySQL services to ensure these versions are compatible with the Magento version. Valid versions of these services are now written to the `cloud.log`.<!--MCLOUD-7098-->
42
+
43
+
- {:.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.<!--MCLOUD-5563-->
44
+
45
+
**CLI command updates**–
46
+
47
+
- {:.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).<!--MCLOUD-7072-->
48
+
49
+
**Environment variable updates**–
50
+
51
+
- {:.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 Magento 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.<!--MCLOUD-6939-->
52
+
53
+
## v2002.1.2
54
+
*Release date: August 5, 2020*<br/>
24
55
25
56
**Validation and log improvements**–
26
57
@@ -87,7 +118,7 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare
87
118
{:.no-copy}
88
119
<!--MCLOUD-4077-->
89
120
90
-
- {:.new}**Added validation for Zend Framework dependencies**–Added compoer 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.
121
+
- {:.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.
91
122
92
123
```text
93
124
Required configuration is missing from the autoload section of the composer.json file.
0 commit comments