変数のデプロイ

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

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 ベストプラクティスとして開発する。

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

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 ファイル。 参照： メッセージキューの管理 が含まれる Commerce設定ガイド オンプレミスのAdobe Commerceの場合。

CONSUMERS_WAIT_FOR_MAX_MESSAGES

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

stage:
  deploy:
    CONSUMERS_WAIT_FOR_MAX_MESSAGES: false

CRYPT_KEY

インストール処理を行わずに、ある環境から別の環境にデータベースを移動する場合は、対応する暗号化情報が必要です。 Adobe Commerceは、 Cloud Console as the crypt/key の値 env.php ファイル。

DATABASE_CONFIGURATION

でデータベースを定義した場合 relationships プロパティ の .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

また、テーブルプレフィックスを設定することもできます。

次の例では、 ece_ を使用する代わりに、デフォルトの接続設定を使用してテーブルのプレフィックスを指定する _merge オプション：

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 デプロイメント間のサービス設定で、メインのの「system/default/smile_elasticsuite_core_base_settings」セクションでそれを使用します Elastic Suite 設定。 次の場合 Elastic Suite composer パッケージがインストールされ、自動的に設定されます。

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

デフォルトでは、デプロイメントプロセスはのすべての設定を 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 環境変数をに設定 deploy のステージ .magento.env.yaml ファイル：

stage:
  deploy:
    ENABLE_GOOGLE_ANALYTICS: true

FORCE_UPDATE_URLS

Pro または Starter のステージング環境および実稼動環境にデプロイメントすると、この変数は、データベース内のAdobe Commerceのベース URL を、で指定されたプロジェクト URL に置き換えます。 MAGENTO_CLOUD_ROUTES 変数。 この設定を使用して、 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 つだけなので、ロード・バランシングによってパフォーマンスが向上します。 をに設定 false 既存の読み取り専用接続配列を env.php ファイル。

stage:
  deploy:
    MYSQL_USE_SLAVE_CONNECTION: true

いつ MYSQL_USE_SLAVE_CONNECTION 変数はに設定されています。 true, synchronous_replication パラメーターはに設定されています。 true デフォルトでは、 env.php ステージング環境および実稼動環境でのファイル。 いつ 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 インスタンスを非同期で読み取ることができます。 をに設定 true を自動的に使用するには 読み取り専用 非マスターノードで読み取り専用トラフィックを受信する Redis インスタンスへの接続。 この接続では、読み取り/書き込みトラフィックを処理するノードが 1 つだけなので、ロード・バランシングによってパフォーマンスが向上します。 をに設定 false 既存の読み取り専用接続配列を env.php ファイル。

stage:
  deploy:
    REDIS_USE_SLAVE_CONNECTION: true

で Redis サービスが設定されている必要があります。 .magento.app.yaml ファイルおよびを services.yaml ファイル。

ECE-Tools バージョン 2002.0.18 後で、よりフォールトトレラントな設定を使用します。 Adobe Commerceが Redis からデータを読み取れない場合 奴隷 その後、Redis からデータを読み取ります。 master インスタンス。

読み取り専用接続は、統合環境では使用できません。また、 CACHE_CONFIGURATION 変数.

RESOURCE_CONFIGURATION

リソース名をデータベース接続にマップします。 この設定は、 resource の節 env.php ファイル。

デフォルトでは、デプロイメントプロセスはのすべての設定を 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/バックエンド 英語のテーマおよび他の言語のカスタムテーマ。

次の例では、 Magento/backend 3 つのロケールを持つテーマ：

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

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

stage:
  deploy:
    UPDATE_URLS: false

VERBOSE_COMMANDS

を有効または無効にする 交感 デバッグの詳細レベル： bin/magento デプロイメント段階で実行される CLI コマンド。

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

stage:
  deploy:
    VERBOSE_COMMANDS: "-vv"