Implantar variáveis

As variáveis implantar a seguir controlam ações na fase de implantação e podem herdar e substituir valores das Variáveis globais. Insira estas variáveis no estágio deploy do arquivo .magento.env.yaml:

stage:
  deploy:
    DEPLOY_VARIABLE_NAME: value

Para obter mais informações sobre como personalizar o processo de criação e implantação:

CACHE_CONFIGURATION

Configurar página Redis e cache padrão. Ao definir o parâmetro cm_cache_backend_redis, especifique as opções server, port e database.

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

Por padrão, o processo de implantação substitui todas as configurações no arquivo env.php; no entanto, você pode optar por mesclar um ou mais valores para uma configuração de serviço sem substituir todos os valores.

Defina a opção _merge como uma das opções a seguir:

O exemplo a seguir mescla novos valores com uma configuração existente:

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

O exemplo a seguir usa o recurso de pré-carregamento Redis conforme definido no Guia de configuração:

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'

Para usar um modelo REDIS_BACKEND personalizado (não apenas da lista de permissões), defina a opção _custom_redis_backend como true para habilitar a validação correta, como no exemplo a seguir:

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

CLEAN_STATIC_FILES

Habilita ou desabilita a limpeza de arquivos de conteúdo estático gerados durante a fase de compilação ou implantação. Use o valor padrão true em desenvolvimento como uma prática recomendada.

Se você modificar o conteúdo estático por meio de um processo separado, defina o valor como false.

stage:
  deploy:
    CLEAN_STATIC_FILES: false

Falha ao limpar arquivos de exibição estáticos antes da implantação pode causar problemas se você implantar atualizações em arquivos existentes sem remover as versões anteriores. Devido às regras de fallback de arquivo estático, as operações de fallback poderão exibir o arquivo errado se o diretório contiver várias versões do mesmo arquivo.

CRON_CONSUMERS_RUNNER

Use essa variável de ambiente para confirmar se as filas de mensagens estão em execução após uma implantação.

Exemplo de matriz que executa o consumers específico e o multiple_processes para gerar para cada consumidor:

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

Exemplo de uma matriz vazia que executa todos os consumers:

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

Por padrão, o processo de implantação substitui todas as configurações no arquivo env.php. Consulte Gerenciar filas de mensagens no Guia de Configuração do Commerce para Adobe Commerce local.

CONSUMERS_WAIT_FOR_MAX_MESSAGES

Configure como consumers processa mensagens da fila de mensagens escolhendo uma das seguintes opções:

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

Ao mover o banco de dados de um ambiente para outro sem um processo de instalação, você precisará das informações criptográficas correspondentes. O Adobe Commerce usa o valor da chave de criptografia definido em Cloud Console como o valor crypt/key no arquivo env.php.

DATABASE_CONFIGURATION

Se você definiu um banco de dados na propriedade de relações do arquivo .magento.app.yaml, poderá personalizar suas conexões de banco de dados para implantação.

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_value'

Por padrão, o processo de implantação substitui todas as configurações no arquivo env.php; no entanto, você pode optar por mesclar um ou mais valores para uma configuração de serviço sem substituir todos os valores.

Defina a opção _merge como uma das opções a seguir:

O exemplo a seguir mescla novos valores com uma configuração existente:

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

Além disso, é possível configurar um prefixo de tabela.

O exemplo a seguir usa o prefixo de tabela ece_ com configurações de conexão padrão em vez de usar a opção _merge:

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

Saída de exemplo:

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

Mantém as configurações personalizadas do serviço Elastic Suite entre as implantações e as usa na seção 'system/default/sorriso_elasticsuite_core_base_settings' da configuração principal do Elastic Suite. Se o pacote do compositor Elastic Suite estiver instalado, ele será configurado automaticamente.

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

Por padrão, o processo de implantação substitui todas as configurações no arquivo env.php; no entanto, você pode optar por mesclar um ou mais valores para uma configuração de serviço sem substituir todos os valores.

Defina a opção _merge como uma das opções a seguir:

O exemplo a seguir mescla um novo valor com a configuração existente:

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

Limitações conhecidas:

ENABLE_GOOGLE_ANALYTICS

Ativa e desativa Google Analytics ao implantar em ambientes de Preparo e Integração. Por padrão, Google Analytics é verdadeiro somente para o ambiente de Produção. Defina esse valor como true para habilitar Google Analytics nos ambientes de Preparo e Integração.

Adicione a variável de ambiente ENABLE_GOOGLE_ANALYTICS ao estágio deploy no arquivo .magento.env.yaml:

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Na implantação em ambientes Pro ou Starter de Preparo e Produção, essa variável substitui as URLs de base do Adobe Commerce no banco de dados pelas URLs de projeto especificadas pela variável MAGENTO_CLOUD_ROUTES. Use esta configuração para substituir o comportamento padrão da variável de implantação UPDATE_URLS, que é ignorada ao implantar em ambientes de Preparo ou Produção.

stage:
  deploy:
    FORCE_UPDATE_URLS: true

LOCK_PROVIDER

O provedor de bloqueio impede a inicialização de trabalhos cron duplicados e grupos cron. Use o provedor de bloqueio file no ambiente de Produção. Os ambientes iniciais e o ambiente de integração Pro não usam a variável MAGENTO_CLOUD_LOCKS_DIR, portanto, o ece-tools aplica o provedor de bloqueio db automaticamente.

stage:
  deploy:
    LOCK_PROVIDER: "db"

Consulte Configurar o bloqueio no Guia de instalação.

MYSQL_USE_SLAVE_CONNECTION

O Adobe Commerce pode ler vários bancos de dados de forma assíncrona. Defina como true para usar automaticamente uma conexão somente leitura com o banco de dados para receber tráfego somente leitura em um nó não mestre. Essa conexão melhora o desempenho por meio do balanceamento de carga, pois somente um nó lida com o tráfego de leitura-gravação. Defina como false para remover qualquer matriz de conexão somente leitura existente do arquivo env.php.

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

Quando a variável MYSQL_USE_SLAVE_CONNECTION está definida como true, o parâmetro synchronous_replication é definido como true por padrão no arquivo env.php nos ambientes de Preparo e Produção Profissionais. Quando o MYSQL_USE_SLAVE_CONNECTION está definido como false, o parâmetro synchronous_replication não está configurado.

QUEUE_CONFIGURATION

Use essa variável de ambiente para manter configurações de serviço AMQP personalizadas entre implantações. Por exemplo, se você preferir usar um serviço de fila de mensagens existente, em vez de depender da infraestrutura de nuvem para criá-lo para você, use a variável de ambiente QUEUE_CONFIGURATION para conectá-lo ao seu site:

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

Por padrão, o processo de implantação substitui todas as configurações no arquivo env.php; no entanto, você pode optar por mesclar um ou mais valores para uma configuração de serviço sem substituir todos os valores.

Defina a opção _merge como uma das opções a seguir:

O exemplo a seguir mescla novos valores com uma configuração existente:

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

Especifica a configuração do modelo de back-end para o cache Redis.

O Adobe Commerce versão 2.3.0 e posterior inclui os seguintes modelos de back-end:

O exemplo de como definir REDIS_BACKEND

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

REDIS_USE_SLAVE_CONNECTION

O Adobe Commerce pode ler várias instâncias de Redis de forma assíncrona. Defina como true para usar automaticamente uma conexão somente leitura com uma instância Redis para receber tráfego somente leitura em um nó não mestre. Essa conexão melhora o desempenho por meio do balanceamento de carga, pois somente um nó lida com o tráfego de leitura-gravação. Defina como false para remover qualquer matriz de conexão somente leitura existente do arquivo env.php.

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

Você deve ter um serviço Redis configurado no arquivo .magento.app.yaml e no arquivo services.yaml.

ECE-Tools versão 2002.0.18 e posterior usa mais configurações tolerantes a falhas. Se o Adobe Commerce não puder ler dados da instância slave do Redis, ele lerá os dados da instância master do Redis.

A conexão somente leitura não está disponível para uso no ambiente de integração ou se você usar a variável CACHE_CONFIGURATION.

RESOURCE_CONFIGURATION

Mapeia um nome de recurso para uma conexão de banco de dados. Esta configuração corresponde à seção resource do arquivo env.php.

Por padrão, o processo de implantação substitui todas as configurações no arquivo env.php; no entanto, você pode optar por mesclar um ou mais valores para uma configuração de serviço sem substituir todos os valores.

Defina a opção _merge como uma das opções a seguir:

O exemplo a seguir mescla novos valores com uma configuração existente:

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

SCD_COMPRESSION_LEVEL

Especifica qual nível de compactação gzip (0 a 9) usar ao compactar conteúdo estático; 0 desabilita a compactação.

stage:
  deploy:
    SCD_COMPRESSION_LEVEL: 5

SCD_COMPRESSION_TIMEOUT

Quando o tempo necessário para compactar os ativos estáticos excede o tempo limite de compactação, ele interrompe o processo de implantação. Defina o tempo máximo de execução, em segundos, para o comando static content compression.

stage:
  deploy:
    SCD_COMPRESSION_TIMEOUT: 800

SCD_MATRIX

Você pode configurar vários locais por tema. Essa personalização acelera o processo de implantação, reduzindo o número de arquivos de tema desnecessários. Por exemplo, você pode implantar o tema magento/backend em inglês e um tema personalizado em outros idiomas.

O exemplo a seguir implanta o tema Magento/backend com três localidades:

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

Além disso, você pode optar por não implantar um tema:

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

SCD_MAX_EXECUTION_TIME

Permite aumentar o tempo de execução máximo esperado para implantação de conteúdo estático.

Por padrão, o Adobe Commerce define a execução máxima esperada para 900 segundos, mas em alguns cenários, pode ser necessário mais tempo para concluir a implantação do conteúdo estático para um projeto na nuvem.

stage:
  deploy:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

Na fase de implantação, defina SCD_NO_PARENT: true para que a geração de conteúdo estático para temas principais não ocorra durante a fase de implantação. Essa configuração minimiza o tempo de implantação e evita o tempo de inatividade do site que pode ocorrer se a compilação de conteúdo estático falhar durante a implantação. Consulte Implantação de conteúdo estático.

stage:
  deploy:
    SCD_NO_PARENT: true

SCD_STRATEGY

Permite personalizar a estratégia de implantação para conteúdo estático. Consulte Implantar arquivos de exibição estáticos.

Use estas opções somente se você tiver mais de uma localidade:

stage:
  deploy:
    SCD_STRATEGY: "compact"

SCD_THREADS

Define o número de threads para implantação de conteúdo estático. O valor padrão é definido com base na contagem de threads da CPU detectada e não excede um valor 4. Aumentar o número de threads acelera a implantação de conteúdo estático; diminuir o número de threads o torna mais lento. Você pode definir o valor da thread, por exemplo:

stage:
  deploy:
    SCD_THREADS: 2

Para reduzir ainda mais o tempo de implantação, use o Gerenciamento de Configuração com o comando scd-dump para mover a implantação estática para a fase de compilação.

SEARCH_CONFIGURATION

Use essa variável de ambiente para manter configurações personalizadas do serviço de pesquisa entre implantações. Por exemplo:

Configuração de 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'

Configuração do OpenSearch (para Commerce 2.4.6 e posterior):

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

Por padrão, o processo de implantação substitui todas as configurações no arquivo env.php; no entanto, você pode optar por mesclar um ou mais valores para uma configuração de serviço sem substituir todos os valores.

Defina a opção _merge como uma das opções a seguir:

O exemplo a seguir mescla um novo valor com a configuração existente:

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

SESSION_CONFIGURATION

Configurar o armazenamento de sessão Redis. Requer as opções save, redis, host, port e database para a variável de armazenamento de sessão. Por exemplo:

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

Por padrão, o processo de implantação substitui todas as configurações no arquivo env.php; no entanto, você pode optar por mesclar um ou mais valores para uma configuração de serviço sem substituir todos os valores.

Defina a opção _merge como uma das opções a seguir:

O exemplo a seguir mescla um novo valor com a configuração existente:

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

SKIP_SCD

Defina como true para ignorar a implantação de conteúdo estático durante a fase de implantação.

Na fase de implantação, defina SKIP_SCD: true para que a compilação de conteúdo estático não ocorra durante a fase de implantação. Essa configuração minimiza o tempo de implantação e evita o tempo de inatividade do site que pode ocorrer se a compilação de conteúdo estático falhar durante a implantação. Consulte Implantação de conteúdo estático.

stage:
  deploy:
    SKIP_SCD: true

UPDATE_URLS

Na implantação, substitua as URLs de base do Adobe Commerce no banco de dados pelas URLs de projeto especificadas pela variável MAGENTO_CLOUD_ROUTES. Essa configuração é útil para desenvolvimento local, em que os URLs básicos são configurados para o ambiente local. Quando você implanta em um ambiente de nuvem, os URLs são atualizados para que você possa acessar sua vitrine e o administrador usando os URLs do projeto.

Se você precisar atualizar URLs ao implantar em ambientes Pro ou Starter de Preparo e Produção, use a variável FORCE_UPDATE_URLS.

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

Habilite ou desabilite o nível de detalhamento de depuração Symfony para comandos CLI bin/magento executados durante a fase de implantação.

Escolha o nível de detalhes fornecido nos logs:

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"