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

技術情報

このトピックでは、Commerce 2.2以降でのパイプラインのデプロイメントに関する技術的な実装の詳細について説明します。 改善点は、次の領域に分けることができます。

このトピックでは、パイプラインのデプロイメントに関する推奨ワークフローについても説明し、その仕組みを理解するのに役立つ例をいくつか紹介します。

開始する前に、開発、ビルド、実稼動システムの前提条件を確認してください

設定管理

開発および実稼動システムの設定を同期および維持できるようにするには、次の上書きスキームを使用します。

構成変数値の決定方法

図が示すように、設定値は次の順序で使用されます。

  1. 環境変数が存在する場合は、他のすべての値を上書きします。
  2. 共有設定ファイル env.phpおよびconfig.phpから。 env.phpの値がconfig.phpの値を上書きします。
  3. データベースに保存されている値から。
  4. これらのソースに値が存在しない場合は、デフォルト値またはNULLが使用されます。

共有設定の管理

共有設定はapp/etc/config.phpに保存されます。これはソース管理に保存する必要があります。

開発環境(またはAdobe Commerce on cloud infrastructure integration)システムの管理者で共有設定を設定し、magento app:config:dump コマンド ​を使用して設定をconfig.phpに書き込みます。

システム固有の設定の管理

システム固有の設定はapp/etc/env.phpに保存されます。これは​ not ​がソース管理に含まれている必要があります。

開発環境(またはAdobe Commerce on cloud infrastructure integration)システムの管理者でシステム固有の設定を行い、magento app:config:dump コマンド ​を使用して設定をenv.phpに書き込みます。

このコマンドは、機密設定もenv.phpに書き込みます。

機密性の高い設定の管理

機密性の高い設定もapp/etc/env.phpに保存されます。

機密性の高い設定は、次のいずれかの方法で管理できます。

管理者にロックされた設定設定

config.phpまたはenv.phpの構成設定はすべて管理者でロックされています。つまり、これらの設定は管理者で変更できません。
magento config:setまたはmagento config:set --lock コマンドを使用して、config.phpまたはenv.php ファイルの設定を変更します。

Commerce管理者

管理者は、実稼動モードで次の動作を示します。

  • 管理者でキャッシュタイプを有効または無効にすることはできません

  • 開発者の設定は利用できません(ストア >設定> 設定 >詳細> 開発者)。次を含む:

    • CSS、JavaScript、HTMLの最小化

    • CSSとJavaScriptの統合

    • サーバーサイドまたはクライアントサイドのLESS コンパイル

    • インライン翻訳

    • 前述したように、config.phpまたはenv.phpの構成設定はロックされており、管理者で編集することはできません。

    • 管理者ロケールは、デプロイされたテーマで使用される言語にのみ変更できます

      次の図は、管理者の​アカウント設定 > インターフェイス ロケール リストの例を示しています。デプロイされたロケールは2つしかありません。

      管理者ロケールは、デプロイされたロケールにのみ変更できます

  • 管理者を使用して、任意のスコープのロケール設定を変更することはできません。

    実稼動モードに切り替える前に、これらの変更を行うことをお勧めします。

    環境変数またはconfig:set CLI コマンドとパス general/locale/codeを使用して、ロケールを設定できます。

cronのインストールと削除

バージョン 2.2では、初めてmagento cron:install コマンド ​を提供することで、cron ジョブの設定を支援します。 このコマンドは、コマンドを実行するユーザーとしてcrontabを設定します。

また、magento cron:remove コマンドを使用してcrontabを削除することもできます。

推奨されるパイプライン展開ワークフロー

次の図は、パイプラインのデプロイメントを使用して設定を管理する方法を示しています。

推奨されるパイプライン展開ワークフロー

開発システム

開発システムで、管理者で構成を変更し、共有構成app/etc/config.phpとシステム固有の構成app/etc/env.phpを生成します。 Commerce コードと共有設定をソースコントロールにチェックし、ビルドサーバーにプッシュします。

また、開発システムに拡張機能をインストールし、Commerce コードをカスタマイズする必要があります。

開発システムの場合:

  1. 管理者で設定を設定します。

  2. 構成をファイルシステムに書き込むには、magento app:config:dump コマンドを使用します。

    • app/etc/config.phpは共有設定で、を除くすべての設定​が含まれます。機密性の高い設定とシステム固有の設定が含まれます。 このファイルはソース管理にする必要があります。
    • app/etc/env.phpはシステム固有の設定です。この設定には、特定のシステムに固有の設定(ホスト名やポート番号など)が含まれます。 このファイルは​ not ​がソース管理に含まれている必要があります。
  3. 変更したコードと共有設定をソースコントロールに追加します。

  4. 開発中に生成されたphp コードと静的アセットファイルを削除するには、次のコマンドを実行します。

    code language-shell
    rm -r var/view_preprocessed/*
    rm -r pub/static/*/*
    rm -r generated/*/*
    

アセットをクリアするコマンドを実行した後、Commerceは作業ファイルを生成します。

WARNING
上記のアプローチに注意してください。 generatedまたはpub フォルダー内の.htaccess ファイルを削除すると、問題が発生する可能性があります。

システムを構築

ビルドシステムは、コードをコンパイルし、Commerceに登録されたテーマの静的ビューファイルを生成します。 Commerce データベースへの接続は必要ありません。必要なのはCommerce コードベースのみです。

ビルドシステム上で次の操作を行います。

  1. ソースコントロールから共有設定ファイルを取得します。
  2. コードをコンパイルするには、magento setup:di:compile コマンドを使用します。
  3. 静的ファイル ビューファイルを更新するには、magento setup:static-content:deploy -f コマンドを使用します。
  4. ソースコントロールの更新を確認します。
INFO
静的ビューファイルの​ デプロイメント戦略を参照してください。

制作システム

実稼動システム(つまりライブストア)では、生成されたアセットとコードの更新をソースコントロールから取得し、コマンドラインまたは環境変数を使用してシステム固有の機密性の高い設定設定を設定します。

実稼動システム上:

  1. メンテナンスモードを開始します。
  2. ソースコードと設定の更新をソースコントロールから取得します。
  3. Adobe Commerceを使用している場合は、キューワーカーを停止します。
  4. 実稼動システムに設定変更を読み込むには、magento app:config:import コマンドを使用します。
  5. データベース スキーマを変更したコンポーネントをインストールした場合は、magento setup:upgrade --keep-generatedを実行してデータベース スキーマとデータを更新し、生成された静的ファイルを保持します。
  6. システム固有の設定を設定するには、magento config:set コマンドまたは環境変数を使用します。
  7. 機密性の高い設定を設定するには、magento config:sensitive:set コマンドまたは環境変数を使用します。
  8. キャッシュをクリーニング(フラッシュ​とも呼ばれます)します。
  9. メンテナンスモードを終了します。

設定管理コマンド

設定の管理に役立つ次のコマンドが用意されています。

  • magento app:config:dump様が管理者設定をconfig.phpおよびenv.php様に書き込みます(機密性の高い設定を除く)

  • magento config:setを使用して、実稼動システム上のシステム固有の設定の値を設定します。

    オプションの--lock オプションを使用して、管理者のオプションをロックします(つまり、設定を編集不可にします)。 設定が既にロックされている場合は、--lock オプションを使用して設定を変更します。

  • magento config:sensitive:setを使用して、実稼動システムの機密設定の値を設定します。

  • magento app:config:importを使用して、config.phpおよびenv.phpから実稼動システムに構成変更をインポートします。

設定管理の例

この節では、設定の管理例を示します。これにより、config.phpenv.phpに対する変更がどのように行われるかを確認できます。

既定のロケールを変更

このセクションでは、管理者(ストア/設定/構成/一般/一般/ロケールオプション)を使用してデフォルトの重み単位を変更した場合に、config.phpに加えられた変更を示します。

管理者に変更を加えた後、bin/magento app:config:dumpを実行して値をconfig.phpに書き込みます。 config.phpの次のスニペットが示すように、値はlocaleの下のgeneral配列に書き込まれます。

'general' =>
    array (
        'locale' =>
        array (
            'code' => 'en_US',
            'timezone' => 'America/Chicago',
            'weight_unit' => 'kgs'
        )
    )

複数の設定設定を変更する

この節では、次の設定変更について説明します。

  • Web サイト、ストア、およびストアビューの追加(ストア/設定> すべてのストア
  • デフォルトのメールドメインの変更(Stores >設定> Configuration >顧客> Customer Configuration
  • PayPal API ユーザー名とAPI パスワードの設定(Stores >設定> Configuration >販売> 支払い方法 > PayPal > 必要なPayPal設定

管理者に変更を加えた後、開発システムでbin/magento app:config:dumpを実行します。 今回は、すべての変更がconfig.phpに書き込まれるわけではありません。実際には、次のスニペットに示すように、web サイト、ストア、ストアビューのみが、そのファイルに書き込まれます。

config.php

config.phpの内容:

  • web サイト、ストア、ストアビューに対する変更。
  • システム固有でない検索エンジンの設定
  • 機密性のないPayPal設定
  • config.phpから省略された機密設定を知らせるコメント

websites配列:

      'new' =>
      array (
        'website_id' => '2',
        'code' => 'new',
        'name' => 'New website',
        'sort_order' => '0',
        'default_group_id' => '2',
        'is_default' => '0',
      ),

groups配列:

      2 =>
      array (
        'group_id' => '2',
        'website_id' => '2',
        'code' => 'newstore',
        'name' => 'New store',
        'root_category_id' => '2',
        'default_store_id' => '2',
      ),

stores配列:

     'newview' =>
      array (
        'store_id' => '2',
        'code' => 'newview',
        'website_id' => '2',
        'group_id' => '2',
        'name' => 'New store view',
        'sort_order' => '0',
        'is_active' => '1',
      ),

payment配列:

      'payment' =>
      array (
        'paypal_express' =>
        array (
          'active' => '0',
          'in_context' => '0',
          'title' => 'PayPal Express Checkout',
          'sort_order' => NULL,
          'payment_action' => 'Authorization',
          'visible_on_product' => '1',
          'visible_on_cart' => '1',
          'allowspecific' => '0',
          'verify_peer' => '1',
          'line_items_enabled' => '1',
          'transfer_shipping_options' => '0',
          'solution_type' => 'Mark',
          'require_billing_address' => '0',
          'allow_ba_signup' => 'never',
          'skip_order_review_step' => '1',
        ),

env.php

既定の電子メール ドメイン システム固有の構成設定はapp/etc/env.phpに書き込まれます。

bin/magento app:config:dump コマンドでは機密性の高い設定が書き込まれないため、PayPal設定はどちらのファイルにも書き込まれません。 実稼動システムのPayPal設定は、次のコマンドを使用して設定する必要があります。

bin/magento config:sensitive:set paypal/wpp/api_username <username>
bin/magento config:sensitive:set paypal/wpp/api_password <password>
recommendation-more-help
386822bd-e32c-40a8-81c2-ed90ad1e198c