Implementación de variables

Las siguientes variables deploy controlan acciones en la fase de implementación y pueden heredar y anular valores de las variables globales. Inserte estas variables en la fase deploy del archivo .magento.env.yaml:

stage:
  deploy:
    DEPLOY_VARIABLE_NAME: value

Para obtener más información sobre cómo personalizar el proceso de generación e implementación:

CACHE_CONFIGURATION

Configure la página Redis y el almacenamiento en caché predeterminado. Al establecer el parámetro cm_cache_backend_redis, debe especificar las opciones server, port y database.

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

De manera predeterminada, el proceso de implementación sobrescribe todos los valores del archivo env.php; sin embargo, puede optar por combinar uno o varios valores de una configuración de servicio sin sobrescribir todos los valores.

Establezca la opción _merge en una de las siguientes opciones:

El siguiente ejemplo combina nuevos valores en una configuración existente:

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

El siguiente ejemplo usa la característica de precarga de Redis tal como se define en la guía de configuración:

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 un modelo REDIS_BACKEND personalizado (no solo de la lista de permitidos), establezca la opción _custom_redis_backend en true para habilitar la validación correcta como en el siguiente ejemplo:

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

CLEAN_STATIC_FILES

Habilita o deshabilita la limpieza de archivos de contenido estático generados durante la fase de compilación o implementación. Se recomienda usar el valor predeterminado true en desarrollo.

Si modifica el contenido estático mediante un proceso independiente, establezca el valor en false.

stage:
  deploy:
    CLEAN_STATIC_FILES: false

Si no se limpian los archivos de vista estática antes de la implementación, pueden producirse problemas si se implementan actualizaciones en los archivos existentes sin quitar las versiones anteriores. Debido a las reglas static file fallback, las operaciones de reserva pueden mostrar el archivo incorrecto si el directorio contiene varias versiones del mismo archivo.

CRON_CONSUMERS_RUNNER

Utilice esta variable de entorno para confirmar que las colas de mensajes se están ejecutando después de una implementación.

Matriz de ejemplo que ejecuta consumers específico y multiple_processes para que se genere 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

Ejemplo de una matriz vacía que ejecuta todos los consumers:

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

De manera predeterminada, el proceso de implementación sobrescribe toda la configuración del archivo env.php. Consulte Administrar colas de mensajes en la Guía de configuración de Commerce para Adobe Commerce local.

CONSUMERS_WAIT_FOR_MAX_MESSAGES

Configure cómo consumers procesa los mensajes de la cola de mensajes eligiendo una de las siguientes opciones:

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

Cuando mueve la base de datos de un entorno a otro sin un proceso de instalación, necesita la información criptográfica correspondiente. Adobe Commerce usa el valor de clave de cifrado establecido en Cloud Console como el valor crypt/key del archivo env.php.

DATABASE_CONFIGURATION

Si ha definido una base de datos en la propiedad de relaciones del archivo .magento.app.yaml, puede personalizar las conexiones de base de datos para la implementación.

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_value'

De manera predeterminada, el proceso de implementación sobrescribe todos los valores del archivo env.php; sin embargo, puede optar por combinar uno o varios valores de una configuración de servicio sin sobrescribir todos los valores.

Establezca la opción _merge en una de las siguientes opciones:

El siguiente ejemplo combina nuevos valores en una configuración existente:

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

Además, puede configurar un prefijo de tabla.

El ejemplo siguiente utiliza el prefijo de tabla ece_ con la configuración de conexión predeterminada en lugar de utilizar la opción _merge:

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

Salida de ejemplo:

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

Conserva la configuración personalizada del servicio Elastic Suite entre implementaciones y la usa en la sección "system/default/mile_elasticsuite_core_base_settings" de la configuración principal de Elastic Suite. Si está instalado el paquete del compositor Elastic Suite, se configura automáticamente.

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

De manera predeterminada, el proceso de implementación sobrescribe todos los valores del archivo env.php; sin embargo, puede optar por combinar uno o varios valores de una configuración de servicio sin sobrescribir todos los valores.

Establezca la opción _merge en una de las siguientes opciones:

El siguiente ejemplo combina un nuevo valor con la configuración existente:

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

Limitaciones conocidas:

ENABLE_GOOGLE_ANALYTICS

Habilita y deshabilita los Google Analytics al implementarlos en entornos de ensayo e integración. De forma predeterminada, Google Analytics solo es true para el entorno Producción. Establezca este valor en true para habilitar los Google Analytics en los entornos de ensayo e integración.

Agregar la variable de entorno ENABLE_GOOGLE_ANALYTICS al escenario deploy en el archivo .magento.env.yaml:

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Al implementarse en entornos de ensayo y producción Pro o Starter, esta variable reemplaza las direcciones URL base de Adobe Commerce en la base de datos por las direcciones URL del proyecto especificadas por la variable MAGENTO_CLOUD_ROUTES. Use esta configuración para anular el comportamiento predeterminado de la variable de implementación UPDATE_URLS, que se omite al implementar en entornos de ensayo o producción.

stage:
  deploy:
    FORCE_UPDATE_URLS: true

LOCK_PROVIDER

El proveedor de bloqueo evita el inicio de trabajos cron y grupos cron duplicados. Usar el proveedor de bloqueos file en el entorno de producción. Los entornos iniciales y el entorno de integración Pro no usan la variable MAGENTO_CLOUD_LOCKS_DIR, por lo que ece-tools aplica el proveedor de bloqueo db automáticamente.

stage:
  deploy:
    LOCK_PROVIDER: "db"

Consulte Configurar el bloqueo en la Guía de instalación.

MYSQL_USE_SLAVE_CONNECTION

Adobe Commerce puede leer varias bases de datos de forma asincrónica. Configúrelo en true para que use automáticamente una conexión de solo lectura con la base de datos para recibir tráfico de solo lectura en un nodo que no sea maestro. Esta conexión mejora el rendimiento mediante el equilibrio de carga, ya que solo un nodo administra el tráfico de lectura-escritura. Establezca el valor en false para quitar cualquier matriz de conexión de solo lectura existente del archivo env.php.

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

Cuando la variable MYSQL_USE_SLAVE_CONNECTION se establece en true, el parámetro synchronous_replication se establece en true de forma predeterminada en el archivo env.php en los entornos de ensayo y producción de Pro. Cuando MYSQL_USE_SLAVE_CONNECTION está establecido en false, el parámetro synchronous_replication no está configurado.

QUEUE_CONFIGURATION

Utilice esta variable de entorno para conservar la configuración personalizada del servicio AMQP entre implementaciones. Por ejemplo, si prefiere usar un servicio de cola de mensajes existente en lugar de depender de la infraestructura de nube para crearlo, use la variable de entorno QUEUE_CONFIGURATION para conectarlo al sitio:

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

De manera predeterminada, el proceso de implementación sobrescribe todos los valores del archivo env.php; sin embargo, puede optar por combinar uno o varios valores de una configuración de servicio sin sobrescribir todos los valores.

Establezca la opción _merge en una de las siguientes opciones:

El siguiente ejemplo combina nuevos valores en una configuración 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 la configuración del modelo backend para la caché de Redis.

La versión 2.3.0 y posteriores de Adobe Commerce incluyen los siguientes modelos backend:

El ejemplo muestra cómo establecer REDIS_BACKEND

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

REDIS_USE_SLAVE_CONNECTION

Adobe Commerce puede leer varias instancias de Redis de forma asincrónica. Configúrelo en true para usar automáticamente una conexión de solo lectura con una instancia de Redis para recibir tráfico de solo lectura en un nodo que no sea maestro. Esta conexión mejora el rendimiento mediante el equilibrio de carga, ya que solo un nodo administra el tráfico de lectura-escritura. Establezca el valor en false para quitar cualquier matriz de conexión de solo lectura existente del archivo env.php.

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

Debe tener un servicio Redis configurado en el archivo .magento.app.yaml y en el archivo services.yaml.

ECE-Tools versión 2002.0.18 y posteriores usan más configuraciones de tolerancia a errores. Si Adobe Commerce no puede leer datos de la instancia de Redis esclavo, leerá datos de la instancia de Redis maestro.

La conexión de solo lectura no está disponible para su uso en el entorno de integración o si utiliza la variable CACHE_CONFIGURATION.

RESOURCE_CONFIGURATION

Asigna un nombre de recurso a una conexión de base de datos. Esta configuración corresponde a la sección resource del archivo env.php.

De manera predeterminada, el proceso de implementación sobrescribe todos los valores del archivo env.php; sin embargo, puede optar por combinar uno o varios valores de una configuración de servicio sin sobrescribir todos los valores.

Establezca la opción _merge en una de las siguientes opciones:

El siguiente ejemplo combina nuevos valores en una configuración existente:

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

SCD_COMPRESSION_LEVEL

Especifica el nivel de compresión gzip (0 a 9) que se usará para comprimir contenido estático; 0 deshabilita la compresión.

stage:
  deploy:
    SCD_COMPRESSION_LEVEL: 5

SCD_COMPRESSION_TIMEOUT

Cuando el tiempo necesario para comprimir los recursos estáticos supera el límite de tiempo de espera de compresión, interrumpe el proceso de implementación. Establezca el tiempo máximo de ejecución, en segundos, para el comando de compresión de contenido estático.

stage:
  deploy:
    SCD_COMPRESSION_TIMEOUT: 800

SCD_MATRIX

Puede configurar varias configuraciones regionales por tema. Esta personalización acelera el proceso de implementación al reducir el número de archivos de temas innecesarios. Por ejemplo, puede implementar el tema magento/backend en inglés y un tema personalizado en otros idiomas.

El siguiente ejemplo implementa el tema Magento/backend con tres configuraciones regionales:

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

Además, puede elegir no implementar un tema:

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

SCD_MAX_EXECUTION_TIME

Permite aumentar el tiempo de ejecución máximo esperado para la implementación de contenido estático.

De forma predeterminada, Adobe Commerce establece el tiempo de ejecución máximo esperado en 900 segundos, pero en algunos casos puede necesitar más tiempo para completar la implementación de contenido estático para un proyecto de Cloud.

stage:
  deploy:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

En la fase de implementación, establezca SCD_NO_PARENT: true de modo que la generación de contenido estático para los temas principales no se produzca durante la fase de implementación. Esta configuración minimiza el tiempo de implementación y evita el tiempo de inactividad del sitio que puede producirse si la compilación de contenido estático falla durante la implementación. Consulte Implementación de contenido estático.

stage:
  deploy:
    SCD_NO_PARENT: true

SCD_STRATEGY

Permite personalizar la estrategia de implementación para el contenido estático. Consulte Implementar archivos de vista estática.

Utilice estas opciones solamente si tiene más de una configuración regional:

stage:
  deploy:
    SCD_STRATEGY: "compact"

SCD_THREADS

Establece el número de subprocesos para la implementación de contenido estático. El valor predeterminado se establece en función del recuento de subprocesos de CPU detectado y no supera un valor de 4. El aumento del número de subprocesos acelera la implementación de contenido estático; reducir el número de subprocesos hace que se ralentice. Puede establecer el valor del subproceso, por ejemplo:

stage:
  deploy:
    SCD_THREADS: 2

Para reducir aún más el tiempo de implementación, use Administración de configuración con el comando scd-dump para mover la implementación estática a la fase de compilación.

SEARCH_CONFIGURATION

Utilice esta variable de entorno para conservar la configuración personalizada del servicio de búsqueda entre implementaciones. Por ejemplo:

Configuración del 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'

Configuración de OpenSearch (para Commerce 2.4.6 y 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'

De manera predeterminada, el proceso de implementación sobrescribe todos los valores del archivo env.php; sin embargo, puede optar por combinar uno o varios valores de una configuración de servicio sin sobrescribir todos los valores.

Establezca la opción _merge en una de las siguientes opciones:

El siguiente ejemplo combina un nuevo valor con la configuración existente:

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

SESSION_CONFIGURATION

Configure el almacenamiento de sesión de Redis. Requiere las opciones save, redis, host, port y database para la variable de almacenamiento de sesión. Por ejemplo:

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

De manera predeterminada, el proceso de implementación sobrescribe todos los valores del archivo env.php; sin embargo, puede optar por combinar uno o varios valores de una configuración de servicio sin sobrescribir todos los valores.

Establezca la opción _merge en una de las siguientes opciones:

El siguiente ejemplo combina un nuevo valor con la configuración existente:

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

SKIP_SCD

Se establece en true para omitir la implementación de contenido estático durante la fase de implementación.

En la fase de implementación, configure SKIP_SCD: true para que la generación de contenido estático no se produzca durante la fase de implementación. Esta configuración minimiza el tiempo de implementación y evita el tiempo de inactividad del sitio que puede producirse si la compilación de contenido estático falla durante la implementación. Consulte Implementación de contenido estático.

stage:
  deploy:
    SKIP_SCD: true

UPDATE_URLS

En la implementación, reemplace las direcciones URL base de Adobe Commerce en la base de datos por las direcciones URL del proyecto especificadas por la variable MAGENTO_CLOUD_ROUTES. Esta configuración es útil para el desarrollo local, donde las direcciones URL base están configuradas para el entorno local. Al implementar en un entorno de Cloud, las direcciones URL se actualizan para que pueda acceder a su tienda y al administrador mediante las direcciones URL del proyecto.

Si debe actualizar las direcciones URL al implementar en entornos de ensayo y producción Pro o Starter, utilice la variable FORCE_UPDATE_URLS.

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

Habilite o deshabilite el nivel de detalle de depuración de Symfony para los comandos CLI de bin/magento ejecutados durante la fase de implementación.

Elija el nivel de detalle proporcionado en los registros:

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"