[PaaS のみ]{class="badge informative" title="Adobe Commerce on Cloud プロジェクト（Adobeが管理する PaaS インフラストラクチャ）およびオンプレミスプロジェクトにのみ適用されます。"}

変数のデプロイ

次の​ デプロイ ​変数は、デプロイフェーズのアクションを制御し、​ グローバル変数から値を継承して上書きできます。 これらの変数を.magento.env.yaml ファイルのdeploy ステージに挿入します。

stage:
  deploy:
    DEPLOY_VARIABLE_NAME: value

ビルドおよびデプロイプロセスのカスタマイズについて詳しくは、次を参照してください。

CACHE_CONFIGURATION

Redis ページとデフォルトのキャッシュを設定します。 cm_cache_backend_redis パラメーターを設定する場合は、server、portおよびdatabaseのオプションを指定する必要があります。

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

デフォルトでは、デプロイメントプロセスはenv.php ファイル内のすべての設定を上書きしますが、すべての値を上書きすることなく、サービス設定の1つ以上の値を結合することを選択できます。

_merge オプションを次のいずれかに設定します。

次の例では、新しい値を既存の設定にマージします。

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

次の例では、設定ガイド​で定義されているRedis プリロード機能を使用しています。

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'

カスタム REDIS_BACKEND モデルを（許可リストからだけでなく）使用するには、_custom_redis_backend オプションをtrueに設定して、次の例のように正しい検証を有効にします。

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

CLEAN_STATIC_FILES

ビルドまたはデプロイのフェーズで生成された静的コンテンツファイル ​のクリーニングを有効または無効にします。 開発時のデフォルト値​ true ​をベストプラクティスとして使用します。

別のプロセスで静的コンテンツを変更する場合は、値を​ false ​に設定します。

stage:
  deploy:
    CLEAN_STATIC_FILES: false

デプロイ前に静的ビューファイルをクリーンアップしないと、以前のバージョンを削除せずに既存のファイルにアップデートをデプロイすると問題が発生する可能性があります。 静的ファイルのフォールバック ​ ルールにより、ディレクトリに同じファイルの複数のバージョンが含まれている場合、フォールバック操作で間違ったファイルが表示される可能性があります。

CRON_CONSUMERS_RUNNER

この環境変数を使用して、デプロイメント後にメッセージキューが実行されていることを確認します。

各コンシューマーに対して生成する特定のconsumersとmultiple_processesを実行する配列の例：

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

すべてのconsumersを実行する空の配列の例：

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

デフォルトでは、デプロイメントプロセスはenv.php ファイルのすべての設定を上書きします。 オンプレミス Adobe Commerceについては、Commerce設定ガイド​の「​ メッセージキューの管理」を参照してください。

CONSUMERS_WAIT_FOR_MAX_MESSAGES

次のいずれかのオプションを選択して、consumersがメッセージキューからのメッセージを処理する方法を設定します。

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

インストールプロセスなしでデータベースを環境から別の環境に移動する場合は、対応する暗号化情報が必要です。 Adobe Commerceは、Cloud Consoleで設定された暗号化キーの値をenv.php ファイルのcrypt/key値として使用します。

DATABASE_CONFIGURATION

.magento.app.yaml ファイルの関係プロパティ ​でデータベースを定義した場合、デプロイメント用にデータベース接続をカスタマイズできます。

stage:
  deploy:
    DATABASE_CONFIGURATION:
      some_config: 'some_value'

デフォルトでは、デプロイメントプロセスはenv.php ファイル内のすべての設定を上書きしますが、すべての値を上書きすることなく、サービス設定の1つ以上の値を結合することを選択できます。

_merge オプションを次のいずれかに設定します。

次の例では、新しい値を既存の設定にマージします。

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

また、テーブルの接頭辞を設定することもできます。

次の例では、_merge オプションではなく、デフォルトの接続設定でece_ テーブルのプレフィックスを使用しています。

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

出力サンプル：

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

デプロイメント間でカスタマイズされたElastic Suite サービス設定を保持し、メインのElastic Suite設定の「system/default/smile_elasticsuite_core_base_settings」セクションで使用します。 Elastic Suite コンポーザーパッケージがインストールされている場合は、自動的に設定されます。

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: 1
               number_of_replicas: 2

デフォルトでは、デプロイメントプロセスはenv.php ファイル内のすべての設定を上書きしますが、すべての値を上書きすることなく、サービス設定の1つ以上の値を結合することを選択できます。

_merge オプションを次のいずれかに設定します。

次の例では、新しい値を既存の設定にマージします。

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

既知の制限事項:

ENABLE_GOOGLE_ANALYTICS

ステージング環境と統合環境にデプロイする際に、Google Analyticsを有効または無効にします。 デフォルトでは、Google Analyticsは実稼動環境に対してのみtrueです。 ステージング環境と統合環境でGoogle Analyticsを有効にするには、この値をtrueに設定します。

ENABLE_GOOGLE_ANALYTICS環境変数を.magento.env.yaml ファイルのdeploy ステージに追加します。

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Proまたはスターターステージングおよび実稼動環境へのデプロイメント時に、この変数は、データベース内のAdobe Commerce ベース URLを、MAGENTO_CLOUD_ROUTES変数で指定されたプロジェクト URLに置き換えます。 この設定を使用して、UPDATE_URLS デプロイ変数のデフォルトの動作を上書きします。この変数は、ステージング環境または実稼動環境にデプロイする際に無視されます。

stage:
  deploy:
    FORCE_UPDATE_URLS: true

LOCK_PROVIDER

ロックプロバイダーは、重複したcron ジョブとcron グループの起動を防ぎます。 実稼動環境でfile ロックプロバイダーを使用します。 スターター環境とPro統合環境ではMAGENTO_CLOUD_LOCKS_DIR変数が使用されないため、ece-toolsはdb ロックプロバイダーを自動的に適用します。

stage:
  deploy:
    LOCK_PROVIDER: "db"

インストールガイド​の「​ ロックの設定」を参照してください。

MYSQL_USE_SLAVE_CONNECTION

Adobe Commerceは、複数のデータベースを非同期で読み取ることができます。 データベースへの​ 読み取り専用 ​接続を自動的に使用して、非マスターノードで読み取り専用トラフィックを受信するには、trueに設定します。 1つのノードのみが読み取りと書き込みのトラフィックを処理するため、負荷分散によってパフォーマンスが向上します。 env.php ファイルから既存の読み取り専用の接続配列を削除するには、falseに設定します。

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

MYSQL_USE_SLAVE_CONNECTION変数がtrueに設定されている場合、Pro ステージング環境および実稼動環境のenv.php ファイルでは、synchronous_replication パラメーターがデフォルトでtrueに設定されます。 MYSQL_USE_SLAVE_CONNECTIONがfalseに設定されている場合、synchronous_replication パラメーターは設定されていません。

QUEUE_CONFIGURATION

この環境変数を使用して、デプロイメント間でカスタマイズされたキューサービス設定を保持します。 この変数は、AMQP （RabbitMQの場合）とSTOMP （ActiveMQ Artemisの場合）の両方のプロトコルをサポートします。 例えば、クラウドインフラストラクチャに依存せずに既存のメッセージキューサービスを使用して作成する場合は、QUEUE_CONFIGURATION環境変数を使用してサイトに接続します。

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

STOMP プロトコルを使用するActiveMQ Artemisの場合：

stage:
  deploy:
    QUEUE_CONFIGURATION:
      stomp:
        host: activemq.host
        port: 61616
        user: username
        password: password

デフォルトでは、デプロイメントプロセスはenv.php ファイル内のすべての設定を上書きしますが、すべての値を上書きすることなく、サービス設定の1つ以上の値を結合することを選択できます。

_merge オプションを次のいずれかに設定します。

次の例では、新しい値を既存の設定にマージします。

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

Redis キャッシュのバックエンドモデル設定を指定します。

Adobe Commerce バージョン 2.3.0以降には、次のバックエンドモデルが含まれています。

REDIS_BACKENDの設定方法の例

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

REDIS_USE_SLAVE_CONNECTION

Adobe Commerceは、複数のRedis インスタンスを非同期で読み取ることができます。 Redis インスタンスへの​ 読み取り専用 ​接続を自動的に使用して、非マスターノードで読み取り専用トラフィックを受信するには、trueに設定します。 1つのノードのみが読み取りと書き込みのトラフィックを処理するため、負荷分散によってパフォーマンスが向上します。 env.php ファイルから既存の読み取り専用の接続配列を削除するには、falseに設定します。

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

.magento.app.yaml ファイルとservices.yaml ファイルでRedis サービスを設定する必要があります。

ECE-Tools バージョン 2002.0.18以降では、より多くのフォールトトレラント設定が使用されます。 Adobe CommerceがRedis スレーブ インスタンスからデータを読み取れない場合は、Redis マスター インスタンスからデータを読み取ります。

読み取り専用の接続は、統合環境で使用できないか、CACHE_CONFIGURATION変数を使用している場合に使用できます。

VALKEY_BACKEND

VALKEY_BACKENDは、Valkey キャッシュのバックエンド モデル設定を指定します。

Adobe Commerce バージョン 2.8.0以降には、次のバックエンドモデルが含まれています。

次の例は、VALKEY_BACKENDを設定する方法を示しています。

stage:
  deploy:
  VALKEY_USE_SLAVE_CONNECTION: true
  VALKEY_BACKEND: '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'

VALKEY_USE_SLAVE_CONNECTION

Adobe Commerceは、複数のRedis インスタンスを非同期で読み取ることができます。VALKEY_USE_SLAVE_CONNECTION Redis インスタンスへの​ 読み取り専用 ​接続を自動的に使用して、非マスターノードで読み取り専用トラフィックを受信するには、trueに設定します。 1つのノードのみが読み取りと書き込みのトラフィックを処理するため、負荷分散によってパフォーマンスが向上します。 VALKEY_USE_SLAVE_CONNECTIONをfalseに設定して、既存の読み取り専用の接続配列をenv.php ファイルから削除します。

stage:
  deploy:
    VALKEY_USE_SLAVE_CONNECTION: true

.magento.app.yaml ファイルとservices.yaml ファイルでRedis サービスを設定する必要があります。

ECE-Tools バージョン 2002.0.18以降では、より多くのフォールトトレラント設定が使用されます。 Adobe CommerceがValkey slave インスタンスからデータを読み取れない場合、Redis master インスタンスからデータを読み取ります。

読み取り専用の接続は、統合環境で使用できないか、CACHE_CONFIGURATION変数を使用している場合に使用できます。

RESOURCE_CONFIGURATION

リソース名をデータベース接続にマッピングします。 この設定は、env.php ファイルのresource セクションに対応しています。

デフォルトでは、デプロイメントプロセスはenv.php ファイル内のすべての設定を上書きしますが、すべての値を上書きすることなく、サービス設定の1つ以上の値を結合することを選択できます。

_merge オプションを次のいずれかに設定します。

次の例では、新しい値を既存の設定にマージします。

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

SCD_COMPRESSION_LEVEL

静的コンテンツを圧縮する際に使用するgzip圧縮レベル （0 ～ 9）を指定します。0は圧縮を無効にします。

stage:
  deploy:
    SCD_COMPRESSION_LEVEL: 5

SCD_COMPRESSION_TIMEOUT

静的アセットの圧縮にかかる時間が圧縮タイムアウトの制限を超えると、デプロイメントプロセスが中断されます。 静的コンテンツ圧縮コマンドの最大実行時間を秒単位で設定します。

stage:
  deploy:
    SCD_COMPRESSION_TIMEOUT: 800

SCD_MATRIX

テーマごとに複数のロケールを設定できます。 このカスタマイズにより、不要なテーマファイルの数を減らすことで、デプロイメントプロセスが高速化されます。 例えば、magento/backend テーマを英語でデプロイし、カスタムテーマを他の言語でデプロイできます。

次の例では、3つのロケールを持つMagento/backend テーマをデプロイします。

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

また、テーマを​not デプロイするように選択できます。

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

SCD_MAX_EXECUTION_TIME

静的コンテンツのデプロイメントで想定される最大実行時間を増やすことができます。

デフォルトでは、Adobe Commerceは想定される最大実行時間を900秒に設定しますが、一部のシナリオでは、Cloud プロジェクトの静的コンテンツのデプロイメントを完了するのに多くの時間が必要になる場合があります。

stage:
  deploy:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

展開フェーズで、親テーマの静的コンテンツの生成が展開フェーズ中に発生しないようにSCD_NO_PARENT: trueを設定します。 この設定により、デプロイメント時間が最小限に抑えられ、デプロイメント中に静的コンテンツのビルドに失敗した場合に発生する可能性のあるサイトのダウンタイムが回避されます。 静的コンテンツ展開を参照してください。

stage:
  deploy:
    SCD_NO_PARENT: true

SCD_STRATEGY

静的コンテンツの​ デプロイメント戦略をカスタマイズできます。 静的ビューファイルのデプロイ ​を参照してください。

複数のロケールがある場合は、次のオプション のみ​を使用します。

stage:
  deploy:
    SCD_STRATEGY: "compact"

SCD_THREADS

静的コンテンツのデプロイメント用のスレッド数を設定します。 デフォルト値は、検出されたCPU スレッド数に基づいて設定され、値4を超えることはありません。 スレッド数を増やすと、静的コンテンツのデプロイメントが高速化されます。スレッド数を減らすと、速度が低下します。 スレッドの値を設定できます。例：

stage:
  deploy:
    SCD_THREADS: 2

デプロイメントの時間をさらに短縮するには、scd-dump コマンドで構成管理を使用して、静的デプロイメントをビルド フェーズに移動します。

SEARCH_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'

OpenSearch設定（Commerce 2.4.6以降）:

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

デフォルトでは、デプロイメントプロセスはenv.php ファイル内のすべての設定を上書きしますが、すべての値を上書きすることなく、サービス設定の1つ以上の値を結合することを選択できます。

_merge オプションを次のいずれかに設定します。

次の例では、新しい値を既存の設定にマージします。

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

SESSION_CONFIGURATION

Redis セッションストレージを設定します。 セッションストレージ変数には、save、redis、host、portおよびdatabaseのオプションが必要です。 例：

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

デフォルトでは、デプロイメントプロセスはenv.php ファイル内のすべての設定を上書きしますが、すべての値を上書きすることなく、サービス設定の1つ以上の値を結合することを選択できます。

_merge オプションを次のいずれかに設定します。

次の例では、新しい値を既存の設定にマージします。

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

SKIP_SCD

デプロイメントフェーズ中に静的コンテンツのデプロイメントをスキップするには、trueに設定します。

デプロイフェーズで、デプロイフェーズ中に静的コンテンツのビルドが発生しないようにSKIP_SCD: trueを設定します。 この設定により、デプロイメント時間が最小限に抑えられ、デプロイメント中に静的コンテンツのビルドに失敗した場合に発生する可能性のあるサイトのダウンタイムが回避されます。 静的コンテンツ展開を参照してください。

stage:
  deploy:
    SKIP_SCD: true

UPDATE_URLS

デプロイメント時に、データベース内のAdobe Commerce ベース URLを、MAGENTO_CLOUD_ROUTES変数で指定されたプロジェクト URLに置き換えます。 この設定は、ベース URLがローカル環境に設定されているローカル開発に役立ちます。 クラウド環境にデプロイすると、URLが更新され、プロジェクト URLを使用してストアフロントと管理者にアクセスできるようになります。

Proまたはスターターステージングおよび実稼動環境にデプロイする際にURLを更新する必要がある場合は、FORCE_UPDATE_URLS変数を使用します。

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

デプロイメントフェーズ中に実行されるbin/magento CLI コマンドのSymfony デバッグの冗長性レベルを有効または無効にします。

ログに記載されている詳細レベルを選択します。

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"