Distribuire le variabili

Le seguenti variabili deploy controllano le azioni nella fase di distribuzione e possono ereditare ed eseguire l'override dei valori dalle variabili globali. Inserisci queste variabili nella fase deploy del file .magento.env.yaml:

stage:
  deploy:
    DEPLOY_VARIABLE_NAME: value

Per ulteriori informazioni sulla personalizzazione del processo di compilazione e distribuzione:

CACHE_CONFIGURATION

Configura la pagina Redis e il caching predefinito. Quando si imposta il parametro cm_cache_backend_redis, è necessario specificare le opzioni server, port e database.

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

Per impostazione predefinita, il processo di distribuzione sovrascrive tutte le impostazioni nel file env.php. Tuttavia, è possibile scegliere di unire uno o più valori per una configurazione del servizio senza sovrascrivere tutti i valori.

Impostare l'opzione _merge su una delle opzioni seguenti:

Nell'esempio seguente i nuovi valori vengono uniti a una configurazione esistente:

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

Nell'esempio seguente viene utilizzata la funzionalità di precaricamento Redis definita nella Guida alla configurazione:

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'

Per utilizzare un modello REDIS_BACKEND personalizzato (non solo dall'elenco Consentiti), impostare l'opzione _custom_redis_backend su true per abilitare la convalida corretta come nell'esempio seguente:

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

CLEAN_STATIC_FILES

Abilita o disabilita la pulizia di file di contenuto statico generati durante la fase di compilazione o distribuzione. Utilizza il valore predefinito true nello sviluppo come best practice.

Se modifichi il contenuto statico tramite un processo separato, imposta il valore su false.

stage:
  deploy:
    CLEAN_STATIC_FILES: false

La mancata pulizia dei file di visualizzazione statica prima della distribuzione può causare problemi se si distribuiscono aggiornamenti ai file esistenti senza rimuovere le versioni precedenti. A causa di regole di fallback del file statico, le operazioni di fallback possono visualizzare il file errato se la directory contiene più versioni dello stesso file.

CRON_CONSUMERS_RUNNER

Utilizzare questa variabile di ambiente per verificare che le code di messaggi siano in esecuzione dopo una distribuzione.

Array di esempio che esegue consumers e multiple_processes specifici da generare per ogni consumatore:

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

Esempio di un array vuoto che esegue tutti consumers:

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

Per impostazione predefinita, il processo di distribuzione sovrascrive tutte le impostazioni nel file env.php. Consulta Gestione delle code di messaggi nella Guida alla configurazione di Commerce per Adobe Commerce locale.

CONSUMERS_WAIT_FOR_MAX_MESSAGES

Configurare il modo in cui consumers elabora i messaggi dalla coda di messaggi scegliendo una delle opzioni seguenti:

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

Quando si sposta il database da un ambiente a un altro senza un processo di installazione, è necessario disporre delle informazioni di crittografia corrispondenti. Adobe Commerce utilizza il valore della chiave di crittografia impostato in Cloud Console come valore crypt/key nel file env.php.

DATABASE_CONFIGURATION

Se hai definito un database nella proprietà relations del file .magento.app.yaml, puoi personalizzare le connessioni al database per la distribuzione.

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_value'

Per impostazione predefinita, il processo di distribuzione sovrascrive tutte le impostazioni nel file env.php. Tuttavia, è possibile scegliere di unire uno o più valori per una configurazione del servizio senza sovrascrivere tutti i valori.

Impostare l'opzione _merge su una delle opzioni seguenti:

Nell'esempio seguente i nuovi valori vengono uniti a una configurazione esistente:

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

È inoltre possibile configurare un prefisso di tabella.

Nell'esempio seguente viene utilizzato il prefisso della tabella ece_ con le impostazioni di connessione predefinite anziché l'opzione _merge:

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

Output di esempio:

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

Mantiene le impostazioni personalizzate del servizio Elastic Suite tra le distribuzioni e le utilizza nella sezione 'system/default/smile_elasticsuite_core_base_settings' della configurazione principale di Elastic Suite. Se il pacchetto del compositore Elastic Suite è installato, viene configurato automaticamente.

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

Per impostazione predefinita, il processo di distribuzione sovrascrive tutte le impostazioni nel file env.php. Tuttavia, è possibile scegliere di unire uno o più valori per una configurazione del servizio senza sovrascrivere tutti i valori.

Impostare l'opzione _merge su una delle opzioni seguenti:

L’esempio che segue unisce un nuovo valore alla configurazione esistente:

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

Limitazioni note:

ENABLE_GOOGLE_ANALYTICS

Abilita e disabilita le Google Analytics durante la distribuzione in ambienti di staging e integrazione. Per impostazione predefinita, Google Analytics è true solo per l’ambiente di produzione. Imposta questo valore su true per abilitare le Google Analytics negli ambienti di staging e integrazione.

Aggiungere la variabile di ambiente ENABLE_GOOGLE_ANALYTICS alla fase deploy nel file .magento.env.yaml:

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Durante la distribuzione negli ambienti Pro o Starter di staging e produzione, questa variabile sostituisce gli URL di base di Adobe Commerce nel database con gli URL del progetto specificati dalla variabile MAGENTO_CLOUD_ROUTES. Utilizzare questa impostazione per ignorare il comportamento predefinito della variabile di distribuzione UPDATE_URLS, che viene ignorata durante la distribuzione in ambienti di staging o produzione.

stage:
  deploy:
    FORCE_UPDATE_URLS: true

LOCK_PROVIDER

Il provider di blocchi impedisce l'avvio di processi cron e gruppi cron duplicati. Utilizza il provider di blocchi file nell'ambiente di produzione. Gli ambienti Starter e l'ambiente di integrazione Pro non utilizzano la variabile MAGENTO_CLOUD_LOCKS_DIR, pertanto ece-tools applica automaticamente il provider di blocchi db.

stage:
  deploy:
    LOCK_PROVIDER: "db"

Vedere Configurare il blocco nella Guida all'installazione.

MYSQL_USE_SLAVE_CONNECTION

Adobe Commerce può leggere più database in modo asincrono. Impostare su true per utilizzare automaticamente una connessione di sola lettura al database per ricevere traffico di sola lettura su un nodo non principale. Questa connessione migliora le prestazioni tramite il bilanciamento del carico, perché solo un nodo gestisce il traffico di lettura-scrittura. Impostare su false per rimuovere qualsiasi array di connessione di sola lettura esistente dal file env.php.

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

Quando la variabile MYSQL_USE_SLAVE_CONNECTION è impostata su true, il parametro synchronous_replication è impostato su true per impostazione predefinita nel file env.php negli ambienti di staging e produzione Pro. Quando MYSQL_USE_SLAVE_CONNECTION è impostato su false, il parametro synchronous_replication non è configurato.

QUEUE_CONFIGURATION

Utilizza questa variabile di ambiente per mantenere le impostazioni del servizio AMQP personalizzate tra le distribuzioni. Ad esempio, se preferisci utilizzare un servizio di coda messaggi esistente invece di affidarti all'infrastruttura cloud per crearlo, utilizza la variabile di ambiente QUEUE_CONFIGURATION per connetterlo al sito:

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

Per impostazione predefinita, il processo di distribuzione sovrascrive tutte le impostazioni nel file env.php. Tuttavia, è possibile scegliere di unire uno o più valori per una configurazione del servizio senza sovrascrivere tutti i valori.

Impostare l'opzione _merge su una delle opzioni seguenti:

Nell'esempio seguente i nuovi valori vengono uniti a una configurazione esistente:

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

Specifica la configurazione del modello back-end per la cache Redis.

Adobe Commerce versione 2.3.0 e successive include i seguenti modelli di back-end:

Esempio di impostazione di REDIS_BACKEND

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

REDIS_USE_SLAVE_CONNECTION

Adobe Commerce può leggere più istanze Redis in modo asincrono. Imposta su true per utilizzare automaticamente una connessione di sola lettura a un'istanza Redis per ricevere traffico di sola lettura su un nodo non principale. Questa connessione migliora le prestazioni tramite il bilanciamento del carico, perché solo un nodo gestisce il traffico di lettura-scrittura. Impostare su false per rimuovere qualsiasi array di connessione di sola lettura esistente dal file env.php.

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

È necessario configurare un servizio Redis nel file .magento.app.yaml e nel file services.yaml.

ECE-Tools versione 2002.0.18 e successive utilizza impostazioni più a tolleranza di errore. Se Adobe Commerce non riesce a leggere i dati dall'istanza Redis slave, legge i dati dall'istanza Redis master.

La connessione di sola lettura non è disponibile per l'utilizzo nell'ambiente di integrazione o se si utilizza la variabile CACHE_CONFIGURATION.

RESOURCE_CONFIGURATION

Associa un nome di risorsa a una connessione al database. Questa configurazione corrisponde alla sezione resource del file env.php.

Per impostazione predefinita, il processo di distribuzione sovrascrive tutte le impostazioni nel file env.php. Tuttavia, è possibile scegliere di unire uno o più valori per una configurazione del servizio senza sovrascrivere tutti i valori.

Impostare l'opzione _merge su una delle opzioni seguenti:

Nell'esempio seguente i nuovi valori vengono uniti a una configurazione esistente:

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

SCD_COMPRESSION_LEVEL

Specifica il livello di compressione gzip (da 0 a 9) da utilizzare durante la compressione del contenuto statico; 0 disabilita la compressione.

stage:
  deploy:
    SCD_COMPRESSION_LEVEL: 5

SCD_COMPRESSION_TIMEOUT

Quando il tempo necessario per comprimere le risorse statiche supera il limite di timeout di compressione, il processo di distribuzione viene interrotto. Imposta il tempo massimo di esecuzione, in secondi, per il comando di compressione del contenuto statico.

stage:
  deploy:
    SCD_COMPRESSION_TIMEOUT: 800

SCD_MATRIX

È possibile configurare più impostazioni internazionali per tema. Questa personalizzazione velocizza il processo di distribuzione riducendo il numero di file dei temi non necessari. Ad esempio, puoi distribuire il tema magento/backend in inglese e un tema personalizzato in altre lingue.

L'esempio seguente distribuisce il tema Magento/backend con tre impostazioni internazionali:

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

Inoltre, puoi scegliere di non distribuire un tema:

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

SCD_MAX_EXECUTION_TIME

Consente di aumentare il tempo massimo di esecuzione previsto per la distribuzione del contenuto statico.

Per impostazione predefinita, Adobe Commerce imposta l’esecuzione massima prevista su 900 secondi, ma in alcuni scenari potrebbe essere necessario più tempo per completare la distribuzione di contenuto statico per un progetto Cloud.

stage:
  deploy:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

Nella fase di distribuzione, impostare SCD_NO_PARENT: true in modo che la generazione di contenuto statico per i temi principali non venga eseguita durante la fase di distribuzione. Questa impostazione consente di ridurre al minimo i tempi di distribuzione e di evitare i tempi di inattività del sito che possono verificarsi se la generazione di contenuto statico non riesce durante la distribuzione. Vedi Distribuzione di contenuto statico.

stage:
  deploy:
    SCD_NO_PARENT: true

SCD_STRATEGY

Consente di personalizzare la strategia di distribuzione per il contenuto statico. Vedere Distribuire i file di visualizzazione statici.

Utilizza queste opzioni only se hai più di una lingua:

stage:
  deploy:
    SCD_STRATEGY: "compact"

SCD_THREADS

Imposta il numero di thread per la distribuzione del contenuto statico. Il valore predefinito è impostato in base al numero di thread della CPU rilevati e non supera il valore 4. L'aumento del numero di thread velocizza la distribuzione dei contenuti statici; la riduzione del numero di thread ne rallenta la distribuzione. Puoi impostare il valore del thread, ad esempio:

stage:
  deploy:
    SCD_THREADS: 2

Per ridurre ulteriormente i tempi di distribuzione, utilizzare Gestione configurazione con il comando scd-dump per spostare la distribuzione statica nella fase di compilazione.

SEARCH_CONFIGURATION

Utilizza questa variabile di ambiente per mantenere le impostazioni del servizio di ricerca personalizzate tra le distribuzioni. Ad esempio:

Elasticsearch di configurazione:

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

Configurazione di OpenSearch (per Commerce 2.4.6 e versioni successive):

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

Per impostazione predefinita, il processo di distribuzione sovrascrive tutte le impostazioni nel file env.php. Tuttavia, è possibile scegliere di unire uno o più valori per una configurazione del servizio senza sovrascrivere tutti i valori.

Impostare l'opzione _merge su una delle opzioni seguenti:

L’esempio che segue unisce un nuovo valore alla configurazione esistente:

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

SESSION_CONFIGURATION

Configurare l’archiviazione della sessione Redis. Richiede le opzioni save, redis, host, port e database per la variabile di archiviazione della sessione. Ad esempio:

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

Per impostazione predefinita, il processo di distribuzione sovrascrive tutte le impostazioni nel file env.php. Tuttavia, è possibile scegliere di unire uno o più valori per una configurazione del servizio senza sovrascrivere tutti i valori.

Impostare l'opzione _merge su una delle opzioni seguenti:

L’esempio che segue unisce un nuovo valore alla configurazione esistente:

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

SKIP_SCD

Imposta su true per saltare la distribuzione del contenuto statico durante la fase di distribuzione.

Nella fase di distribuzione, impostare SKIP_SCD: true in modo che la compilazione del contenuto statico non avvenga durante la fase di distribuzione. Questa impostazione consente di ridurre al minimo i tempi di distribuzione e di evitare i tempi di inattività del sito che possono verificarsi se la generazione di contenuto statico non riesce durante la distribuzione. Vedi Distribuzione di contenuto statico.

stage:
  deploy:
    SKIP_SCD: true

UPDATE_URLS

Durante la distribuzione, sostituire gli URL di base di Adobe Commerce nel database con gli URL del progetto specificati dalla variabile MAGENTO_CLOUD_ROUTES. Questa configurazione è utile per lo sviluppo locale, dove gli URL di base sono impostati per l’ambiente locale. Quando distribuisci in un ambiente Cloud, gli URL vengono aggiornati in modo da poter accedere alla vetrina e all’amministratore tramite gli URL del progetto.

Se è necessario aggiornare gli URL durante la distribuzione in ambienti di staging e produzione Pro o Starter, utilizzare la variabile FORCE_UPDATE_URLS.

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

Attiva o disattiva il livello di dettaglio di debug Symfony per i comandi CLI bin/magento eseguiti durante la fase di distribuzione.

Scegli il livello di dettaglio fornito nei registri:

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"