Konfigurera miljövariabler för distribution

Filen .magento.env.yaml använder miljövariabler för att centralisera hanteringen av bygg- och distributionsåtgärder i alla dina miljöer, inklusive Pro Staging och Production. Om du vill konfigurera unika åtgärder i varje miljö måste du ändra den här filen i varje miljö.

Filstruktur

Filen .magento.env.yaml innehåller två avsnitt: stage och log. Avsnittet stage kontrollerar åtgärder som utförs under faserna i Cloud-distributionsprocessen.

Miljövariabler

Paketet ece-tools ställer in värden i filen env.php baserat på värden från Cloud-variabler, variabler som angetts i Cloud Console och konfigurationsfilen .magento.env.yaml. Miljövariablerna i filen .magento.env.yaml anpassar molnmiljön genom att åsidosätta din befintliga Commerce-konfiguration. Om standardvärdet är Not Set utför ece-tools-paketet NO-åtgärden och använder standardvärdet Commerce eller värdet från MAGENTO_CLOUD_RELATIONSHIPS-konfigurationen. Om standardvärdet anges används ece-tools-paketet för att ange standardvärdet.

Följande avsnitt innehåller detaljerade definitioner, till exempel om ett standardvärde har angetts eller inte, av alla variabler som du kan använda i filen .magento.env.yaml:

Skapa konfigurationsfil från CLI

Du kan generera en .magento.env.yaml-konfigurationsfil för en molnmiljö med följande ece-tools-kommandon.

Skapar en konfigurationsfil

php ./vendor/bin/ece-tools cloud:config:create `<configuration-json>`

Uppdatera värden i konfigurationsfilen

php ./vendor/bin/ece-tools cloud:config:update `<configuration-json>`

Båda kommandona kräver ett enda argument: en JSON-formaterad array som anger ett värde för minst en variabel för build, deploy eller post-deploy. Följande kommando anger till exempel värden för variablerna SCD_THREADS och CLEAN_STATIC_FILES:

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

Och skapar en .magento.env.yaml-fil med följande inställningar:

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

Du kan använda kommandot cloud:config:update för att uppdatera den nya filen. Följande kommando ändrar till exempel värdet SCD_THREADS och lägger till konfigurationen SCD_COMPRESSION_TIMEOUT:

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

Den uppdaterade filen innehåller följande konfiguration:

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

Verifiera konfigurationsfil

Använd följande ece-tools-kommando för att validera konfigurationsfilen .magento.env.yaml innan du skickar ändringar till fjärrmolnmiljön.

php ./vendor/bin/ece-tools cloud:config:validate

Följande exempelsvar innehåller en lista med objekt som ska korrigeras:

Environment configuration is not valid. Correct the following items in your .magento.env.yaml file:
The SCD_THREADS variable contains an invalid value of type string. Use the following type: integer.
The SCD_STRATEGY variable contains an invalid value fast. Use one of the available value options: compact, quick, standard.
The NOT_EXIST_OPTION variable is not allowed in configuration.

PHP-konstanter

Du kan använda PHP-konstanter i .magento.env.yaml-fildefinitioner i stället för hårdkodade värden. I följande exempel definieras driver_options med en PHP-konstant:

stage:
  deploy:
    DATABASE_CONFIGURATION:
      connection:
        default:
          driver_options:
            !php/const:\PDO::MYSQL_ATTR_LOCAL_INFILE : 1
        indexer:
          driver_options:
            !php/const:\PDO::MYSQL_ATTR_LOCAL_INFILE : 1
      _merge: true

Felhantering

När ett fel inträffar på grund av ett oväntat värde i konfigurationsfilen .magento.env.yaml får du ett felmeddelande. I följande felmeddelande visas en lista med föreslagna ändringar av varje objekt med ett oväntat värde, som ibland innehåller giltiga alternativ:

- Environment configuration is not valid. Please correct .magento.env.yaml file with next suggestions:
  Item CRON_CONSUMERS_RUNNER is not supposed to be in stage build. Please move it to one of possible stages: global, deploy
  Item SKIP_SCD has unexpected type string. Please use one of next types: boolean
  Item VERBOSE_COMMANDS has unexpected type boolean. Please use one of next types: string
  Item SKIP_HTML_MINIFICATION has unexpected type string. Please use one of next types: boolean
  Item CRON_CONSUMERS_RUNNER has unexpected type boolean. Please use one of next types: array
  Item VAR_WARM_UP_PAGES is not allowed in configuration.
  Item WARM_UP_PAGES has unexpected type string. Please use one of next types: array

Gör eventuella korrigeringar, implementera och skicka ändringarna vidare. Om du inte får något felmeddelande godkänns valideringen av ändringarna i konfigurationsfilen.

Optimering av konfigurationshantering

Om du har aktiverat Configuration Management efter att ha dumpat konfigurationerna, bör du flytta SCD_*-variablerna från distributionen till byggfasen. Se Statiska strategier för innehållsdistribution.

Före konfigurationshantering:

  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      consumers: []
    SCD_STRATEGY: compact
    SCD_MATRIX:
      ...
    REDIS_USE_SLAVE_CONNECTION: 1

När du har aktiverat Configuration Management flyttar du SCD_*-variablerna till byggfasen:

  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      consumers: []
    REDIS_USE_SLAVE_CONNECTION: 1
  build:
    SCD_STRATEGY: compact
    SCD_MATRIX:
      ...