変数のデプロイ

次の デプロイ 変数は、デプロイフェーズでのアクションを制御し、 グローバル変数の値を継承および上書きできます。 .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 ファイルの relationships プロパティでデータベースを定義した場合は、データベース接続を配置用にカスタマイズできます。

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 composer パッケージがインストールされている場合は、自動的に設定されます。

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

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

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

次の例では、新しい値を既存の設定に結合します。

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

既知の制限事項:

ENABLE_GOOGLE_ANALYTICS

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

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

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

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

stage:
  deploy:
    FORCE_UPDATE_URLS: true

LOCK_PROVIDER

ロックプロバイダーは、重複した cron ジョブや cron グループの起動を防ぎます。 実稼動環境で file lock プロバイダーを使用します。 スターターMAGENTOと Pro 統合環境は、Environment_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 サービス設定をデプロイメント間で保持します。 例えば、クラウドインフラストラクチャを利用して作成するのではなく、既存のメッセージキューサービスを使用する場合は、QUEUE_CONFIGURATION の環境変数を使用してサービスをサイトに接続します。

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

デフォルトでは、デプロイメントプロセスは 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 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

また、テーマをデプロイ ない ように選択することもできます。

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 または Starter のステージング環境および実稼動環境にデプロイするときに URL を更新する必要がある場合は、FORCE_UPDATE_URLS 変数を使用します。

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

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

ログに表示される詳細レベルを選択します。

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"