シナリオベースのデプロイメント

最終更新日： 2025年1月31日

作成対象：

  • 管理者
  • 開発者

ece-tools 2002.1.0 以降では、シナリオベースのデプロイメント機能を使用して、デフォルトのデプロイメント動作をカスタマイズできます。
この機能は、設定で シナリオ と 手順 を使用します。

  • シナリオ設定 – 各デプロイメントフックは シナリオ です。これは、デプロイメントタスクを完了するためのシーケンスと設定パラメーターを記述する XML 設定ファイルです。 シナリオは、.magento.app.yaml ファイルの hooks セクションで設定します。

  • ステップ設定 – 各シナリオでは、デプロイメントタスクの完了に必要な操作をプログラムで説明する一連の ステップ を使用します。 この手順は XML ベースのシナリオ設定ファイルで設定します。

クラウドインフラストラクチャー上のAdobe Commerceでは、ece-tools パッケージに一連の デフォルトのシナリオと デフォルトの手順が用意されています。 デフォルトの設定をオーバーライドまたはカスタマイズするカスタム XML 設定ファイルを作成することで、デプロイメントの動作をカスタマイズできます。 シナリオと手順を使用して、カスタムモジュールからコードを実行することもできます。

ビルドフックとデプロイフックを使用したシナリオの追加

Adobe Commerceを構築およびデプロイするためのシナリオを .magento.app.yaml ファイルの hooks セクションに追加します。 各フックは、各フェーズで実行するシナリオを指定します。 次の例に、デフォルトのシナリオ設定を示します。

magento.app.yaml フック

hooks:
    build: |
        set -e
        php ./vendor/bin/ece-tools run scenario/build/generate.xml
        php ./vendor/bin/ece-tools run scenario/build/transfer.xml
    deploy: |
        php ./vendor/bin/ece-tools run scenario/deploy.xml
    post_deploy: |
        php ./vendor/bin/ece-tools run scenario/post-deploy.xml
NOTE
ece-tools 2002.1.x のリリースでは、新しい フック設定形式が追加されました。 ece-tools 2002.0.x リリースのレガシー形式は、引き続きサポートされます。 ただし、シナリオベースのデプロイメント機能を使用するには、新しい形式に更新する必要があります。

シナリオ手順のレビュー

フック設定では、各シナリオは、ビルド、デプロイまたはデプロイ後のタスクを実行する手順を含む XML ファイルです。 例えば、scenario/transfer ファイルには、compress-static-content、clear-init-directory、backup-data の 3 つのステップが含まれています

scenario/transfer.xml

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
    <step name="compress-static-content" type="Magento\MagentoCloud\Step\Build\CompressStaticContent" priority="100"/>
    <step name="clear-init-directory" type="Magento\MagentoCloud\Step\Build\ClearInitDirectory" priority="200"/>
    <step name="backup-data" type="Magento\MagentoCloud\Step\Build\BackupData" priority="300">
        <arguments>
            <argument name="logger" xsi:type="object">Psr\Log\LoggerInterface</argument>
            <argument name="steps" xsi:type="array">
                <item name="static-content" xsi:type="object" priority="100">Magento\MagentoCloud\Step\Build\BackupData\StaticContent</item>
                <item name="writable-dirs" xsi:type="object"  priority="200">Magento\MagentoCloud\Step\Build\BackupData\WritableDirectories</item>
            </argument>
        </arguments>
    </step>
</scenario>

デフォルトシナリオの拡張

次の例では、フック設定にデプロイ設定ファイルを追加することで、デフォルトのデプロイシナリオを拡張しています。

hooks:
  deploy: |
    php ./vendor/bin/ece-tools run scenario/deploy.xml vendor/<vendor-name>/<module-name>/deploy.xml vendor/<vendor-name>/<module-name>/deploy2.xml

デプロイメント時に、カスタムシナリオは次のルールに基づいてデフォルトのシナリオと結合されます。

  • シナリオの優先順位は、フック定義内のシーケンスに基づいて設定され、リストされた最後のシナリオが最も優先順位が高くなります。

    この例では、シナリオの優先度は次のとおりです。

    1. vendor/vendor-name/module-name/deploy2.xml
    2. vendor/vendor-name/module-name/deploy.xml
    3. scenario/deploy.xml （デフォルトまたはベースラインシナリオ）

  • 最も優先度が高いシナリオのステップは、他のシナリオの同じ名前のステップを上書きします。 新しい手順が設定に追加されます。 例えば（C → B → A）のように、各シナリオが右から左に優先順位付けされる 2 つ以上のシナリオにも同じルールが適用されます。

デフォルトの手順を削除

ステップをデフォルトのシナリオから削除するには、skip パラメーターを使用します。

例えば、デフォルトのデプロイシナリオの enable-maintenance-mode と set-production-mode の手順をスキップするには、次の設定を含む設定ファイルを作成します。

vendor/vendor-name/module-name/deploy-custom-mode-config.xml

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
    <step name="enable-maintenance-mode" skip="true" />
    <step name="set-production-mode"  skip="true" />
</scenario>

カスタム設定ファイルを使用するには、デフォルトの .magento.app.yaml ファイルを更新します。

カスタム .magento.app.yaml プロイメントシナリオを使用したデプロイ

hooks:
    build: |
        set -e
        php ./vendor/bin/ece-tools run scenario/build/generate.xml
        php ./vendor/bin/ece-tools run scenario/build/transfer.xml
    deploy: |
        php ./vendor/bin/ece-tools run scenario/deploy.xml vendor/vendor-name/module-name/deploy-custom-mode-config.xml
    post_deploy: |
        php ./vendor/bin/ece-tools run scenario/post-deploy.xml

デフォルトの手順を置換

カスタムシナリオは、デフォルトの手順を置き換えて、カスタムの実装を提供できます。 それには、デフォルトのステップ名をカスタムステップの名前として使用します。

例えば、 デフォルトのデプロイシナリオでは、enable-maintenance-mode の手順でデフォルトの EnableMaintenanceMode PHP スクリプトが実行されます。

<step name="enable-maintenance-mode" type="Magento\MagentoCloud\Step\EnableMaintenanceMode" priority="300"/>

この手順を上書きするには、カスタムシナリオ設定ファイルを作成して、enable-maintenance-mode の手順の実行時に別のスクリプトを実行します。

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
<scenario>
    <step name="enable-maintenance-mode" type="VendorName\VendorModule\Step\CustomEnableMaintenanceMode" priority="300"/>
</scenario>

ステップの優先度の変更

カスタムシナリオで、デフォルトのステップの優先度を変更できます。 次の手順では、enable-maintenance-mode の手順の優先度を 300 から 10 に変更して、デプロイシナリオの前半で手順が実行されるようにします。

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
<scenario>
    <step name="enable-maintenance-mode" type="Magento\MagentoCloud\Step\EnableMaintenanceMode" priority="10"/>
</scenario>

この例では、デフォルトのデプロイシナリオの他のすべてのステップよりも優先度が低いので、enable-maintenance-mode のステップがシナリオの最初に移動します。

例：デプロイシナリオの拡張

次の例では、次の変更を加えて デフォルトのデプロイシナリオをカスタマイズしています。

  • remove-deploy-failed-flag 手順をカスタム手順に置き換えます
  • デプロイ前手順の clean-redis-cache サブステップをスキップします
  • unlock-cron-jobs の手順をスキップします
  • validate-config の手順をスキップして重要なバリデーターを無効にします
  • 新しいプレデプロイ手順を追加します

vendor/vendor-name/module-name/deploy-extended.xml

<?xml version="1.0"?>
<scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
    <!-- Replace "remove-deploy-failed-flag" step with custom step -->
    <step name="remove-deploy-failed-flag" type="Vendor\ModuleName\Step\Deploy\RemoveDeployFailedFlag" priority="100"/>

    <!-- Skip "clean-redis-cache" sub-step in pre-deploy step -->
    <step name="pre-deploy" type="Magento\MagentoCloud\Step\Deploy\PreDeploy" priority="200">
        <arguments>
            <argument name="logger" xsi:type="object">Psr\Log\LoggerInterface</argument>
            <argument name="steps" xsi:type="array">
                <item name="clean-redis-cache" xsi:type="object" skip="true"/>
            </argument>
        </arguments>
    </step>

    <!-- Skip step "unlock-cron-jobs" -->
    <step name="unlock-cron-jobs" skip="true"/>

    <!-- Skip critical validators -->
    <step name="validate-config" type="Magento\MagentoCloud\Step\ValidateConfiguration" priority="300">
        <arguments>
            <argument name="logger" xsi:type="object">Psr\Log\LoggerInterface</argument>
            <argument name="validators" xsi:type="array">
                <item name="critical" xsi:type="array">
                    <item name="database-configuration" xsi:type="object" skip="true"/>
                    <item name="search-configuration" xsi:type="object" skip="true"/>
                </item>
            </argument>
        </arguments>
    </step>

    <!-- Add new step into the beginning of the deploy scenario -->
    <step name="new-pre-deploy-step" type="Vendor\ModuleName\Step\Deploy\PreDeploy" priority="10"/>
</scenario>

プロジェクトでこのスクリプトを使用するには、クラウドインフラストラクチャプロジェクト上のAdobe Commerceの .magento.app.yaml ファイルに次の設定を追加します。

hooks:
    build: |
        set -e
        php ./vendor/bin/ece-tools run scenario/build/generate.xml
        php ./vendor/bin/ece-tools run scenario/build/transfer.xml
    deploy: |
        php ./vendor/bin/ece-tools run scenario/deploy.xml vendor/vendor-name/module-name/deploy-extended.xml
    post_deploy: |
        php ./vendor/bin/ece-tools run scenario/post-deploy.xml
TIP
ece-tools GitHub リポジトリで デフォルトのシナリオと デフォルトのステップ設定を確認して、プロジェクトのビルド、デプロイ、デプロイ後のタスクに合わせてカスタマイズするシナリオと手順を決定できます。