MCLOUD-7072: Add CLI command for generating .magento.env.yaml

[oshmyheliuk]

Purpose of this pull request

This pull request (PR) will add information about new ece-tools commands.

Affected DevDocs pages

• https://devdocs.magento.com/cloud/project/magento-env-yaml.html
• https://devdocs.magento.com/cloud/reference/ece-tools-reference.html

whatsnew
Added documentation for the following ece-tools CLI commands to create and update the .magento.env.yaml file with a specified configuration that can include one or more build, deploy, and post-deploy variables: cloud:config:create and cloud:config:update. See Create configuration file from CLI.

[BarnyShergold]

Everything is basically fine but please remove the full stops from -
config:dump [dump] Dump configuration for static content deployment.
cron:unlock Unlock cron jobs that stuck in "running" state.
dev:git:update-composer Updates composer for deployment from git.

Appreciate that these are not yours but it would mean the whole section would be consistent.

[oshmyheliuk]

@BarnyShergold Done, Thank you!

[BarnyShergold]

Awesome :)

[meker12]

Providing the following suggestion inline in this code comment because the Suggestion feature doesn't work properly when the suggestion includes closing code block (``` )

Consider replacing lines 80 - 113 with the following text:

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.

php vendor/bin/ece-tools cloud:config:create '{"stage":{"build":{"SCD_THREADS":5}, "deploy":{"CLEAN_STATIC_FILES":false}}}'

This command creates a new .magento.env.yaml file with the following settings:

stage:
  build:
    SCD_THREADS: 5
  deploy:
    CLEAN_STATIC_FILES: false

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:

php vendor/bin/ece-tools cloud:config:update '{"stage":{"build":{"SCD_THREADS":3, "SCD_COMPRESSION_TIMEOUT":1000}}}'

The updated file contains the following configuration:

stage:
  build:
    SCD_THREADS: 3
    SCD_COMPRESSION_TIMEOUT: 1000
  deploy:
    CLEAN_STATIC_FILES: false

[oshmyheliuk]

Updated

[ghost]

Hi @oshmyheliuk, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.