Distribuera variabler

Följande distribuera-variabelkontrollåtgärder i distributionsfasen och kan ärva och åsidosätta värden från de globala variablerna. Infoga de här variablerna i deploy-steget i filen .magento.env.yaml:

stage:
  deploy:
    DEPLOY_VARIABLE_NAME: value

Mer information om hur du anpassar bygg- och distributionsprocessen:

CACHE_CONFIGURATION

Konfigurera Redis-sida och standardcachning. När du anger parametern cm_cache_backend_redis måste du ange alternativen server, port och database.

stage:
  deploy:
    CACHE_CONFIGURATION:
      frontend:
        default:
          backend: file
        page_cache:
          backend: file

Som standard skriver distributionsprocessen över alla inställningar i filen env.php, men du kan välja att sammanfoga ett eller flera värden för en tjänstkonfiguration utan att skriva över alla värden.

Ställ in alternativet _merge på något av följande:

I följande exempel sammanfogas nya värden med en befintlig konfiguration:

stage:
  deploy:
    CACHE_CONFIGURATION:
      _merge: true
      frontend:
        default:
          backend_options:
            database: 10
        page_cache:
          backend_options:
            database: 11

I följande exempel används Redis-förinläsningsfunktionen enligt definitionen i Konfigurationsguiden:

stage:
  deploy:
    CACHE_CONFIGURATION:
      _merge: true
      frontend:
        default:
          id_prefix: '061_'
          backend_options:
            preload_keys:
              - '061_EAV_ENTITY_TYPES:hash'
              - '061_GLOBAL_PLUGIN_LIST:hash'
              - '061_DB_IS_UP_TO_DATE:hash'
              - '061_SYSTEM_DEFAULT:hash'

Om du vill använda en anpassad REDIS_BACKEND-modell (inte bara från tillåtelselista) anger du alternativet _custom_redis_backend till true för att aktivera korrekt validering som i följande exempel:

stage:
  deploy:
    CACHE_CONFIGURATION:
      frontend:
        default:
          _custom_redis_backend: true
          backend: '\CustomRedisModel'

CLEAN_STATIC_FILES

Aktiverar eller inaktiverar rensning av statiska innehållsfiler som genereras under bygg- eller distributionsfasen. Använd standardvärdet true i utvecklingen som en bra rutin.

Om du ändrar statiskt innehåll genom en separat process ska värdet anges till false.

stage:
  deploy:
    CLEAN_STATIC_FILES: false

Om du inte rensar statiska vyfiler innan du distribuerar dem kan det orsaka problem om du distribuerar uppdateringar till befintliga filer utan att ta bort tidigare versioner. På grund av statiska återgångsregler kan återgångsåtgärder visa fel fil om katalogen innehåller flera versioner av samma fil.

CRON_CONSUMERS_RUNNER

Använd den här miljövariabeln för att bekräfta att meddelandeköer körs efter en distribution.

Exempelmatris som kör specifika consumers och multiple_processes som ska anges för varje konsument:

stage:
  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      max_messages: 1000
      consumers:
        - example_consumer_1
        - example_consumer_2
-     multiple_processes:
        example_consumer_1: 4
        example_consumer_2: 3

Exempel på en tom array som kör alla consumers:

stage:
  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      max_messages: 1000
      consumers: []

Som standard skriver distributionsprocessen över alla inställningar i filen env.php. Se Hantera meddelandeköer i Commerce Configuration Guide för lokal Adobe Commerce.

CONSUMERS_WAIT_FOR_MAX_MESSAGES

Konfigurera hur consumers ska bearbeta meddelanden från meddelandekön genom att välja något av följande alternativ:

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

När du flyttar databasen från en miljö till en annan utan någon installationsprocess behöver du motsvarande kryptografisk information. Adobe Commerce använder det krypteringsnyckelvärde som angetts i Cloud Console som crypt/key-värde i filen env.php.

DATABASE_CONFIGURATION

Om du har definierat en databas i relationsegenskapen för filen .magento.app.yaml kan du anpassa databasanslutningarna för distribution.

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_value'

Som standard skriver distributionsprocessen över alla inställningar i filen env.php, men du kan välja att sammanfoga ett eller flera värden för en tjänstkonfiguration utan att skriva över alla värden.

Ställ in alternativet _merge på något av följande:

I följande exempel sammanfogas nya värden med en befintlig konfiguration:

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_new_value'
      _merge: true

Du kan också konfigurera ett tabellprefix.

I följande exempel används tabellprefixet ece_ med standardanslutningsinställningar i stället för alternativet _merge:

stage:
  deploy:
    DATABASE_CONFIGURATION:
      connection:
        default:
          username: user
          host: host
          dbname: magento
          password: password
      table_prefix: 'ece_'

Exempel:

MariaDB [main]> SHOW TABLES;
+-------------------------------------+
| Tables_in_main                      |
+-------------------------------------+
| ece_admin_passwords                 |
| ece_admin_system_messages           |
| ece_admin_user                      |
| ece_admin_user_session              |
| ece_adminnotification_inbox         |
| ece_amazon_customer                 |
| ece_authorization_rule              |
| ece_cache                           |
| ece_cache_tag                       |
| ece_captcha_log                     |
...

ELASTICSUITE_CONFIGURATION

Bevarar anpassade Elastic Suite-tjänstinställningar mellan distributioner och använder dem i avsnittet system/default/leasticsuite_core_base_settings i huvudkonfigurationen för Elastic Suite. Om Elastic Suite-dispositionspaketet är installerat konfigureras det automatiskt.

stage:
  deploy:
    ELASTICSUITE_CONFIGURATION:
      es_client:
        servers: 'remote-host:9200'
      indices_settings:
        number_of_shards: 1
        number_of_replicas: 0

Som standard skriver distributionsprocessen över alla inställningar i filen env.php, men du kan välja att sammanfoga ett eller flera värden för en tjänstkonfiguration utan att skriva över alla värden.

Ställ in alternativet _merge på något av följande:

I följande exempel sammanfogas ett nytt värde med den befintliga konfigurationen:

stage:
  deploy:
    ELASTICSUITE_CONFIGURATION:
      indices_settings:
        number_of_shards: 3
        number_of_replicas: 2
      _merge: true

Kända begränsningar:

ENABLE_GOOGLE_ANALYTICS

Aktiverar och inaktiverar Google Analytics vid distribuering till miljöer för förproduktion och integrering. Som standard gäller Google Analytics endast för produktionsmiljön. Ange det här värdet till true om du vill aktivera Google Analytics i mellanlagrings- och integreringsmiljöerna.

Lägg till miljövariabeln ENABLE_GOOGLE_ANALYTICS på scenen deploy i filen .magento.env.yaml:

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Vid distribution till Pro- eller Starter Staging- och Production-miljöer ersätter den här variabeln Adobe Commerce base URL:er i databasen med de projekt-URL:er som anges av variabeln MAGENTO_CLOUD_ROUTES. Använd den här inställningen för att åsidosätta standardbeteendet för distributionsvariabeln UPDATE_URLS som ignoreras vid distribution till mellanlagrings- eller produktionsmiljöer.

stage:
  deploy:
    FORCE_UPDATE_URLS: true

LOCK_PROVIDER

Lås-providern förhindrar att duplicerade cron-jobb och cron-grupper startas. Använd låsprovidern file i produktionsmiljön. Startmiljöer och Pro-integreringsmiljön använder inte variabeln MAGENTO_CLOUD_LOCKS_DIR, så ece-tools använder db-låsprovidern automatiskt.

stage:
  deploy:
    LOCK_PROVIDER: "db"

Se Konfigurera låset i installationsguiden.

MYSQL_USE_SLAVE_CONNECTION

Adobe Commerce kan läsa flera databaser asynkront. Ange som true om du automatiskt vill använda en skrivskyddad-anslutning till databasen för att ta emot skrivskyddad trafik på en icke-huvudnod. Den här anslutningen förbättrar prestanda genom belastningsutjämning, eftersom bara en nod hanterar läs- och skrivtrafik. Ange som false om du vill ta bort alla befintliga skrivskyddade anslutningsmatriser från filen env.php.

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

När variabeln MYSQL_USE_SLAVE_CONNECTION är inställd på true är parametern synchronous_replication som standard inställd på true i filen env.php i Pro Staging- och Production-miljöer. När MYSQL_USE_SLAVE_CONNECTION är inställd på false är parametern synchronous_replication inte konfigurerad.

QUEUE_CONFIGURATION

Använd den här systemvariabeln för att behålla anpassade AMQP-tjänstinställningar mellan distributioner. Om du till exempel föredrar att använda en befintlig meddelandekötjänst i stället för att förlita dig på molninfrastrukturen för att skapa den åt dig, använder du miljövariabeln QUEUE_CONFIGURATION för att ansluta den till din plats:

stage:
  deploy:
    QUEUE_CONFIGURATION:
      amqp:
        host: test.host
        port: 1234
      amqp2:
        host: test.host2
        port: 12345
      mq:
        host: mq.host
        port: 1234

Som standard skriver distributionsprocessen över alla inställningar i filen env.php, men du kan välja att sammanfoga ett eller flera värden för en tjänstkonfiguration utan att skriva över alla värden.

Ställ in alternativet _merge på något av följande:

I följande exempel sammanfogas nya värden med en befintlig konfiguration:

stage:
  deploy:
    QUEUE_CONFIGURATION:
      _merge: true
      amqp:
        host: changed1.host
        port: 5672
      amqp2:
        host: changed2.host2
        port: 12345
      mq:
        host: changedmq.host
        port: 1234

REDIS_BACKEND

Anger serverdelsmodellens konfiguration för Redis-cachen.

Adobe Commerce version 2.3.0 och senare innehåller följande backend-modeller:

Exemplet som anger REDIS_BACKEND

stage:
  deploy:
    REDIS_BACKEND: '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'

REDIS_USE_SLAVE_CONNECTION

Adobe Commerce kan läsa flera Redis-instanser asynkront. Ange som true om du automatiskt vill använda en skrivskyddad-anslutning till en Redis-instans för att ta emot skrivskyddad trafik på en icke-huvudnod. Den här anslutningen förbättrar prestanda genom belastningsutjämning, eftersom bara en nod hanterar läs- och skrivtrafik. Ange som false om du vill ta bort alla befintliga skrivskyddade anslutningsmatriser från filen env.php.

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

Du måste ha en Redis-tjänst konfigurerad i filen .magento.app.yaml och i filen services.yaml.

ECE-Tools version 2002.0.18 och senare använder mer feltoleranta inställningar. Om Adobe Commerce inte kan läsa data från instansen Redis slave läser den data från instansen Redis master.

Den skrivskyddade anslutningen är inte tillgänglig för användning i integreringsmiljön eller om du använder variabeln CACHE_CONFIGURATION.

RESOURCE_CONFIGURATION

Kopplar ett resursnamn till en databasanslutning. Den här konfigurationen motsvarar avsnittet resource i filen env.php.

Som standard skriver distributionsprocessen över alla inställningar i filen env.php, men du kan välja att sammanfoga ett eller flera värden för en tjänstkonfiguration utan att skriva över alla värden.

Ställ in alternativet _merge på något av följande:

I följande exempel sammanfogas nya värden med en befintlig konfiguration:

stage:
  deploy:
    RESOURCE_CONFIGURATION:
      _merge: true
      default_setup:
        connection: default

SCD_COMPRESSION_LEVEL

Anger vilken gzip-komprimeringsnivå (0 till 9) som ska användas vid komprimering av statiskt innehåll. 0 inaktiverar komprimering.

stage:
  deploy:
    SCD_COMPRESSION_LEVEL: 5

SCD_COMPRESSION_TIMEOUT

När den tid det tar att komprimera de statiska resurserna överskrider tidsgränsen för komprimering avbryts distributionsprocessen. Ange den maximala körningstiden i sekunder för det statiska kommandot för innehållskomprimering.

stage:
  deploy:
    SCD_COMPRESSION_TIMEOUT: 800

SCD_MATRIX

Du kan konfigurera flera språkinställningar per tema. Den här anpassningen snabbar upp distributionsprocessen genom att minska antalet onödiga temafiler. Du kan till exempel distribuera temat magento/backend på engelska och ett anpassat tema på andra språk.

I följande exempel distribueras temat Magento/backend med tre språkområden:

stage:
  deploy:
    SCD_MATRIX:
      "magento/backend":
        language:
          - en_US
          - fr_FR
          - af_ZA

Du kan även välja att inte ska distribuera ett tema:

stage:
  deploy:
    SCD_MATRIX:
      "magento/backend": [ ]

SCD_MAX_EXECUTION_TIME

Gör att du kan öka den maximala förväntade körningstiden för statisk innehållsdistribution.

Som standard sätter Adobe Commerce den maximala förväntade körningen till 900 sekunder, men i vissa fall behöver du mer tid för att slutföra distributionen av statiskt innehåll för ett Cloud-projekt.

stage:
  deploy:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

Ange SCD_NO_PARENT: true på distributionsfasen så att genereringen av statiskt innehåll för överordnade teman inte inträffar under distributionsfasen. Den här inställningen minimerar driftsättningstiden och förhindrar driftstopp som kan inträffa om det statiska innehållet inte kan byggas under distributionen. Se Distribution av statiskt innehåll.

stage:
  deploy:
    SCD_NO_PARENT: true

SCD_STRATEGY

Gör att du kan anpassa distributionsstrategin för statiskt innehåll. Se Distribuera statiska vyfiler.

Använd dessa alternativ endast om du har fler än en språkinställning:

stage:
  deploy:
    SCD_STRATEGY: "compact"

SCD_THREADS

Anger antalet trådar för distribution av statiskt innehåll. Standardvärdet baseras på antalet CPU-tråd som identifierats och överstiger inte värdet 4. Om du ökar antalet trådar går det snabbare att distribuera statiskt innehåll, och om du minskar antalet trådar blir det långsammare. Du kan ange ett trådvärde, till exempel:

stage:
  deploy:
    SCD_THREADS: 2

Om du vill minska distributionstiden ytterligare använder du Configuration Management med kommandot scd-dump för att flytta statisk distribution till byggfasen.

SEARCH_CONFIGURATION

Använd den här systemvariabeln för att behålla anpassade inställningar för söktjänsten mellan distributioner. Exempel:

Elasticsearch-konfiguration:

stage:
  deploy:
    SEARCH_CONFIGURATION:
      engine: elasticsearch
      elasticsearch_server_hostname: http://elasticsearch.internal
      elasticsearch_server_port: '9200'
      elasticsearch_index_prefix: magento2
      elasticsearch_server_timeout: '15'

OpenSearch-konfiguration (för Commerce 2.4.6 och senare):

stage:
  deploy:
    SEARCH_CONFIGURATION:
      engine: opensearch
      opensearch_server_hostname: 'http://opensearch.internal'
      opensearch_server_port: '9200'
      opensearch_index_prefix: 'magento2'
      opensearch_server_timeout: '15'

Som standard skriver distributionsprocessen över alla inställningar i filen env.php, men du kan välja att sammanfoga ett eller flera värden för en tjänstkonfiguration utan att skriva över alla värden.

Ställ in alternativet _merge på något av följande:

I följande exempel sammanfogas ett nytt värde med den befintliga konfigurationen:

stage:
  deploy:
    SEARCH_CONFIGURATION:
      engine: elasticsearch
      elasticsearch_server_port: '9200'
      _merge: true

SESSION_CONFIGURATION

Konfigurera Redis-sessionslagring. Kräver alternativen save, redis, host, port och database för sessionslagringsvariabeln. Exempel:

stage:
  deploy:
    SESSION_CONFIGURATION:
      redis:
        bot_first_lifetime: 100
        bot_lifetime: 10001
        database: 0
        disable_locking: 1
        host: redis.internal
        max_concurrency: 10
        max_lifetime: 10001
        min_lifetime: 100
        port: 6379
      save: redis

Som standard skriver distributionsprocessen över alla inställningar i filen env.php, men du kan välja att sammanfoga ett eller flera värden för en tjänstkonfiguration utan att skriva över alla värden.

Ställ in alternativet _merge på något av följande:

I följande exempel sammanfogas ett nytt värde med den befintliga konfigurationen:

stage:
  deploy:
    SESSION_CONFIGURATION:
      _merge: true
      redis:
        max_concurrency: 10

SKIP_SCD

Ange true om du vill hoppa över statisk innehållsdistribution under distributionsfasen.

Ange SKIP_SCD: true på distributionsfasen så att det statiska innehållet inte byggs under distributionsfasen. Den här inställningen minimerar driftsättningstiden och förhindrar driftstopp som kan inträffa om det statiska innehållet inte kan byggas under distributionen. Se Distribution av statiskt innehåll.

stage:
  deploy:
    SKIP_SCD: true

UPDATE_URLS

Ersätt Adobe Commerce bas-URL:er i databasen med de projekt-URL:er som anges av variabeln MAGENTO_CLOUD_ROUTES vid distributionen. Den här konfigurationen är användbar för lokal utveckling, där bas-URL:er har konfigurerats för din lokala miljö. När du distribuerar till en molnmiljö uppdateras URL:erna så att du kan komma åt din butik och administratör via projektets URL:er.

Om du måste uppdatera URL:er när du distribuerar till Pro- eller Starter Staging- och Production-miljöer använder du variabeln FORCE_UPDATE_URLS.

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

Aktivera eller inaktivera Symfony-felsökningsnivån för bin/magento CLI-kommandon som utförs under distributionsfasen.

Välj detaljnivå i loggarna:

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"