Déployer les variables

Les variables deploy suivantes contrôlent les actions lors de la phase de déploiement et peuvent hériter des valeurs de Variables globales et les remplacer. Insérez ces variables dans l’étape deploy du fichier .magento.env.yaml :

stage:
  deploy:
    DEPLOY_VARIABLE_NAME: value

Pour plus d’informations sur la personnalisation du processus de création et de déploiement :

CACHE_CONFIGURATION

Configurez la page Redis et la mise en cache par défaut. Lors de la définition du paramètre cm_cache_backend_redis , vous devez spécifier les options server, port et database.

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

Par défaut, le processus de déploiement remplace tous les paramètres du fichier env.php. Vous pouvez toutefois choisir de fusionner une ou plusieurs valeurs pour une configuration de service sans remplacer toutes les valeurs.

Définissez l’option _merge sur l’une des options suivantes :

L’exemple suivant fusionne de nouvelles valeurs dans une configuration existante :

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

L’exemple suivant utilise la fonction de préchargement Redis telle que définie dans le Guide de configuration :

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'

Pour utiliser un modèle REDIS_BACKEND personnalisé (et pas seulement à partir de la liste autorisée de données), définissez l’option _custom_redis_backend sur true afin d’activer la validation correcte, comme dans l’exemple suivant :

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

CLEAN_STATIC_FILES

Active ou désactive le nettoyage fichiers de contenu statique généré pendant la phase de build ou de déploiement. Utilisez la valeur par défaut true en développement comme bonne pratique.

Si vous modifiez du contenu statique par le biais d’un processus distinct, définissez la valeur sur false.

stage:
  deploy:
    CLEAN_STATIC_FILES: false

Si vous ne nettoyez pas les fichiers d'affichage statique avant de les déployer, vous risquez de rencontrer des problèmes si vous déployez des mises à jour sur des fichiers existants sans supprimer les versions précédentes. En raison des règles static file fallback, les opérations de secours peuvent afficher le mauvais fichier si le répertoire contient plusieurs versions du même fichier.

CRON_CONSUMERS_RUNNER

Utilisez cette variable d’environnement pour confirmer que les files d’attente de messages sont en cours d’exécution après un déploiement.

Exemple de tableau qui exécute des consumers spécifiques et le multiple_processes à générer pour chaque client :

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

Exemple de tableau vide qui exécute toutes les consumers :

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

Par défaut, le processus de déploiement remplace tous les paramètres du fichier env.php. Voir Gérer les files d’attente de messages dans le Guide de configuration de Commerce pour Adobe Commerce On-Premise.

CONSUMERS_WAIT_FOR_MAX_MESSAGES

Configurez le traitement consumers messages de la file d'attente des messages en choisissant l'une des options suivantes :

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

Lorsque vous déplacez la base de données d’un environnement à un autre sans processus d’installation, vous avez besoin des informations cryptographiques correspondantes. Adobe Commerce utilise la valeur de la clé de chiffrement définie dans le Cloud Console comme valeur crypt/key dans le fichier env.php.

DATABASE_CONFIGURATION

Si vous avez défini une base de données dans la propriété relations du fichier .magento.app.yaml, vous pouvez personnaliser vos connexions à la base de données pour le déploiement.

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_value'

Par défaut, le processus de déploiement remplace tous les paramètres du fichier env.php. Vous pouvez toutefois choisir de fusionner une ou plusieurs valeurs pour une configuration de service sans remplacer toutes les valeurs.

Définissez l’option _merge sur l’une des options suivantes :

L’exemple suivant fusionne de nouvelles valeurs dans une configuration existante :

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

Vous pouvez également configurer un préfixe de tableau.

L’exemple suivant utilise le préfixe de tableau ece_ avec les paramètres de connexion par défaut au lieu d’utiliser l’option _merge :

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

Exemple de sortie :

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

Conserve les paramètres de service Elastic Suite personnalisés entre les déploiements et les utilise dans la section « system/default/smile_elasticsuite_core_base_settings » de la configuration Elastic Suite principale. Si le package du compositeur de Elastic Suite est installé, il est configuré automatiquement.

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

           indices_settings:
               number_of_shards: 3
               number_of_replicas: 2

Par défaut, le processus de déploiement remplace tous les paramètres du fichier env.php. Vous pouvez toutefois choisir de fusionner une ou plusieurs valeurs pour une configuration de service sans remplacer toutes les valeurs.

Définissez l’option _merge sur l’une des options suivantes :

L’exemple suivant fusionne une nouvelle valeur avec la configuration existante :

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

Limites connues :

ENABLE_GOOGLE_ANALYTICS

Active et désactive les Google Analytics lors du déploiement dans les environnements d’évaluation et d’intégration. Par défaut, le mot de Google Analytics est uniquement valable pour l’environnement de production. Définissez cette valeur sur true pour activer les Google Analytics dans les environnements d’évaluation et d’intégration.

Ajoutez la variable d’environnement ENABLE_GOOGLE_ANALYTICS à l’étape deploy dans le fichier .magento.env.yaml :

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Lors du déploiement dans des environnements d’évaluation et de production Pro ou Starter, cette variable remplace les URL de base d’Adobe Commerce dans la base de données par les URL de projet spécifiées par la variable MAGENTO_CLOUD_ROUTES . Utilisez ce paramètre pour remplacer le comportement par défaut de la variable de déploiement UPDATE_URLS, qui est ignorée lors du déploiement dans les environnements d’évaluation ou de production.

stage:
  deploy:
    FORCE_UPDATE_URLS: true

LOCK_PROVIDER

Le fournisseur de verrous empêche le lancement de tâches et de groupes cron en double. Utilisez le fournisseur de verrou file dans l’environnement de production. Les environnements de démarrage et l'environnement d'intégration Pro n'utilisent pas la variable MAGENTO_CLOUD_LOCKS_DIR. Par conséquent, ece-tools applique automatiquement le fournisseur de verrous db.

stage:
  deploy:
    LOCK_PROVIDER: "db"

Voir Configuration du verrou dans le Guide d’installation.

MYSQL_USE_SLAVE_CONNECTION

Adobe Commerce peut lire plusieurs bases de données de manière asynchrone. Définissez cette valeur sur true pour utiliser automatiquement une connexion lecture seule à la base de données afin de recevoir le trafic en lecture seule sur un nœud non principal. Cette connexion améliore les performances grâce à l’équilibrage de charge, car un seul nœud gère le trafic en lecture-écriture. Définissez sur false pour supprimer tout tableau de connexion en lecture seule existant du fichier env.php.

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

Lorsque la variable MYSQL_USE_SLAVE_CONNECTION est définie sur true, le paramètre synchronous_replication est défini sur true par défaut dans le fichier env.php dans les environnements d’évaluation et de production Pro. Lorsque la MYSQL_USE_SLAVE_CONNECTION est définie sur false, le paramètre synchronous_replication n’est pas configuré.

QUEUE_CONFIGURATION

Utilisez cette variable d’environnement pour conserver les paramètres de service AMAP personnalisés entre les déploiements. Par exemple, si vous préférez utiliser un service de file d’attente de messages existant au lieu de vous fier à l’infrastructure cloud pour le créer, utilisez la variable d’environnement QUEUE_CONFIGURATION pour le connecter à votre site :

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

Par défaut, le processus de déploiement remplace tous les paramètres du fichier env.php. Vous pouvez toutefois choisir de fusionner une ou plusieurs valeurs pour une configuration de service sans remplacer toutes les valeurs.

Définissez l’option _merge sur l’une des options suivantes :

L’exemple suivant fusionne de nouvelles valeurs dans une configuration existante :

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

Spécifie la configuration du modèle principal pour le cache Redis.

Les versions 2.3.0 et ultérieures d’Adobe Commerce incluent les modèles principaux suivants :

Exemple de définition de REDIS_BACKEND

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

REDIS_USE_SLAVE_CONNECTION

Adobe Commerce peut lire plusieurs instances Redis de manière asynchrone. Définissez cette variable sur true pour utiliser automatiquement une connexion lecture seule à une instance Redis afin de recevoir le trafic en lecture seule sur un nœud non maître. Cette connexion améliore les performances grâce à l’équilibrage de charge, car un seul nœud gère le trafic en lecture-écriture. Définissez sur false pour supprimer tout tableau de connexion en lecture seule existant du fichier env.php.

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

Un service Redis doit être configuré dans le fichier .magento.app.yaml et dans le fichier services.yaml.

ECE-Tools version 2002.0.18 et versions ultérieures utilisent des réglages plus tolérants aux pannes. Si Adobe Commerce ne peut pas lire les données de l’instance Redis esclave, il lit les données de l’instance Redis maître.

La connexion en lecture seule n’est pas disponible pour être utilisée dans l’environnement d’intégration ou si vous utilisez la variable CACHE_CONFIGURATION.

RESOURCE_CONFIGURATION

Mappe un nom de ressource à une connexion à la base de données. Cette configuration correspond à la section resource du fichier env.php.

Par défaut, le processus de déploiement remplace tous les paramètres du fichier env.php. Vous pouvez toutefois choisir de fusionner une ou plusieurs valeurs pour une configuration de service sans remplacer toutes les valeurs.

Définissez l’option _merge sur l’une des options suivantes :

L’exemple suivant fusionne de nouvelles valeurs dans une configuration existante :

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

SCD_COMPRESSION_LEVEL

Indique le niveau de compression gzip (0 à 9) à utiliser lors de la compression du contenu statique ; 0 désactive la compression.

stage:
  deploy:
    SCD_COMPRESSION_LEVEL: 5

SCD_COMPRESSION_TIMEOUT

Lorsque le temps nécessaire à la compression des ressources statiques dépasse le délai d’expiration de la compression, le processus de déploiement est interrompu. Définissez la durée d’exécution maximale, en secondes, de la commande de compression de contenu statique.

stage:
  deploy:
    SCD_COMPRESSION_TIMEOUT: 800

SCD_MATRIX

Vous pouvez configurer plusieurs paramètres régionaux par thème. Cette personnalisation accélère le processus de déploiement en réduisant le nombre de fichiers de thème inutiles. Par exemple, vous pouvez déployer le thème magento/backend en anglais et un thème personnalisé dans d’autres langues.

L’exemple suivant déploie le thème Magento/backend avec trois paramètres régionaux :

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

Vous pouvez également choisir de ne pas déployer thème :

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

SCD_MAX_EXECUTION_TIME

Permet d’augmenter le temps d’exécution maximal attendu pour le déploiement de contenu statique.

Par défaut, Adobe Commerce définit l’exécution maximale prévue sur 900 secondes, mais dans certains scénarios, vous aurez peut-être besoin de plus de temps pour terminer le déploiement du contenu statique pour un projet cloud.

stage:
  deploy:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

Lors de la phase de déploiement, définissez SCD_NO_PARENT: true afin que la génération de contenu statique pour les thèmes parents ne se produise pas pendant la phase de déploiement. Ce paramètre réduit le temps de déploiement et évite les temps d’arrêt du site qui peuvent se produire si la création de contenu statique échoue pendant le déploiement. Voir Déploiement de contenu statique.

stage:
  deploy:
    SCD_NO_PARENT: true

SCD_STRATEGY

Permet de personnaliser la stratégie de déploiement pour le contenu statique. Voir Déploiement de fichiers de vue statiques.

Utilisez ces options uniquement si vous disposez de plusieurs paramètres régionaux :

stage:
  deploy:
    SCD_STRATEGY: "compact"

SCD_THREADS

Définit le nombre de threads pour le déploiement de contenu statique. La valeur par défaut est définie en fonction du nombre de threads CPU détectés et ne dépasse pas une valeur de 4. L’augmentation du nombre de threads accélère le déploiement de contenu statique ; la diminution du nombre de threads le ralentit. Vous pouvez définir la valeur du thread, par exemple :

stage:
  deploy:
    SCD_THREADS: 2

Pour réduire davantage le temps de déploiement, utilisez Gestion de la configuration avec la commande scd-dump pour déplacer le déploiement statique vers la phase de création.

SEARCH_CONFIGURATION

Utilisez cette variable d’environnement pour conserver les paramètres de service de recherche personnalisés entre les déploiements. Par exemple :

Configuration Elasticsearch :

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

Configuration d’OpenSearch (pour Commerce 2.4.6 et versions ultérieures) :

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

Par défaut, le processus de déploiement remplace tous les paramètres du fichier env.php. Vous pouvez toutefois choisir de fusionner une ou plusieurs valeurs pour une configuration de service sans remplacer toutes les valeurs.

Définissez l’option _merge sur l’une des options suivantes :

L’exemple suivant fusionne une nouvelle valeur avec la configuration existante :

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

SESSION_CONFIGURATION

Configurez le stockage de session Redis. Nécessite les options save, redis, host, port et database pour la variable de stockage de session. Par exemple :

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

Par défaut, le processus de déploiement remplace tous les paramètres du fichier env.php. Vous pouvez toutefois choisir de fusionner une ou plusieurs valeurs pour une configuration de service sans remplacer toutes les valeurs.

Définissez l’option _merge sur l’une des options suivantes :

L’exemple suivant fusionne une nouvelle valeur avec la configuration existante :

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

SKIP_SCD

Définissez sur true pour ignorer le déploiement du contenu statique pendant la phase de déploiement.

Lors de la phase de déploiement, définissez SKIP_SCD: true afin que la création de contenu statique ne se produise pas pendant la phase de déploiement. Ce paramètre réduit le temps de déploiement et évite les temps d’arrêt du site qui peuvent se produire si la création de contenu statique échoue pendant le déploiement. Voir Déploiement de contenu statique.

stage:
  deploy:
    SKIP_SCD: true

UPDATE_URLS

Lors du déploiement, remplacez les URL de base d’Adobe Commerce dans la base de données par les URL de projet spécifiées par la variable MAGENTO_CLOUD_ROUTES . Cette configuration est utile pour le développement local, où les URL de base sont configurées pour votre environnement local. Lorsque vous effectuez un déploiement dans un environnement cloud, les URL sont mises à jour afin que vous puissiez accéder à votre storefront et à votre administrateur à l’aide des URL du projet.

Si vous devez mettre à jour des URL lors d’un déploiement dans des environnements d’évaluation et de production Pro ou Starter, utilisez la variable FORCE_UPDATE_URLS .

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

Activez ou désactivez le niveau de détail de débogage Symfony pour bin/magento commandes d’interface de ligne de commande exécutées lors de la phase de déploiement.

Choisissez le niveau de détail fourni dans les logs :

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"