[執筆:Adobe、シニアテクニカルアーキテクト、Tony Evers]{class="badge informative" title="寄稿:Tony Evers"} [PaaS のみ]{class="badge informative" title="Adobe Commerce on Cloud プロジェクト(Adobeが管理する PaaS インフラストラクチャ)およびオンプレミスプロジェクトにのみ適用されます。"}
Adobe Commerce パッチの大規模な配布のベストプラクティス
複数のAdobe Commerceのインストールを管理する場合、 パッチ適用 は複雑なプロセスになる場合があります。 パッチの一元化 は、企業におけるベストプラクティスです。 これにより、すべてのAdobe Commerce インストールに適切なパッチを適用できます。 ここでは、すべてのタイプのAdobe Commerce パッチ に対して一元的なパッチ配布を実現する方法について説明します。
影響を受ける製品とバージョン
- クラウドインフラストラクチャー上のAdobe Commerce
- Adobe Commerceオンプレミス
方法
パッチには様々な種類があり、適用する方法も多数あるので、最初に適用されるパッチを把握するにはどうすればよいでしょうか。 パッチの数が多いほど、同じファイルや同じコード行に適用される可能性が高くなります。 パッチは次の順序で適用されます。
-
セキュリティパッチ は、Adobe Commerce リリースの静的コードベースの一部です。
-
cweagans/composer-patches などの
composer installおよびcomposer updateプラグインを使用した Composer パッチ 。 -
Commerce用クラウドパッチ パッケージに含まれるすべての 必須パッチ 。
-
選択した 品質パッチ が [Quality Patches Tool] に含まれています。
-
カスタムパッチ およびAdobe Commerceは、パッチ名のアルファベット順に
/m2-hotfixesディレクトリ内のパッチをサポートします。note important IMPORTANT 適用するパッチが多いほど、コードがより複雑になります。 複雑なコードを使用すると、Adobe commerce を新しいバージョンにアップグレードすることが難しくなり、総所有コストが増加する場合があります。
Adobe Commerceの複数のインストールを管理する必要がある場合は、すべてのインスタンスに同じパッチセットをインストールするのは困難なことがあります。 インストールごとに、独自の Git リポジトリ、/m2-hotfixes ディレクトリ、composer.json ファイルが用意されています。 唯一の保証は、クラウドユーザー向けの セキュリティパッチ および 必要なパッチ がすべてメインのAdobe Commerce バージョンの一部としてインストールされることです。
現在のところ、この問題に対する一元的なソリューションはありませんが、Composer はギャップを埋める方法を提供しています。 cweagans/composer-patches パッケージを使用すると、 依存関係からパッチを適用 できます。 すべてのパッチをインストールする Composer パッケージを作成し、すべてのプロジェクトでそのパッケージを必要とすることができます。
セキュリティパッチ、必須パッチ、および Composer パッチ について説明しますが、品質パッチおよび /m2-hotfixes ディレクトリの内容についてはどうですか?
品質向上パッチおよびホットフィックスの適用
vendor/bin/magento-patches apply コマンドを使用すると、クラウドインフラストラクチャとオンプレミスの両方のインストールにクオリティパッチをインストールできます。 vendor/bin/magento-patches apply の操作後に composer install コマンドが実行されることを確認する必要があります。
.magento.env.yaml ファイルに品質向上パッチを一覧表示してインストールすることもできます。 ここで説明する例では、vendor/bin/magento-patches apply コマンドを使用する必要があります。カスタム Composer コンポーネント パッケージの composer.json ファイルに適用するパッチを指定し、composer install の操作後にコマンドを実行するプラグイン パッケージを作成できます。
まとめると、この一元的なパッチ適用の例では、次の 2 つのカスタム Composer パッケージを作成する必要があります。
-
コンポーネントパッケージ:
centralized-patcher- インストールする品質向上パッチおよび
m2-hotfixesのリストを定義します。 centralized-patcher-composer-pluginの操作後にvendor/bin/magento-patches applyコマンドを実行するcomposer installパッケージが必要です
- インストールする品質向上パッチおよび
-
プラグイン パッケージ:
centralized-patcher-composer-pluginCentralizedPatcherパッケージから品質向上パッチリストを読み取るcentralized-patcherPHP クラスを定義します。vendor/bin/magento-patches applyコマンドを実行して、composer install操作後に品質向上パッチのリストをインストールします
centralized-patcher
Composer コンポーネントパッケージ(centralized-patcher)を作成して、すべてのAdobe Commerce インストールにわたって、すべての品質向上のパッチおよび /m2-hotfixes ールを一元的に管理できます。
コンポーネントパッケージには次の条件があります。
- デプロイ時に、
/m2-hotfixesディレクトリの内容をすべてのインストールにコピーします。 - インストールする品質向上パッチのリストを定義します。
vendor/bin/magento-patchesコマンドを実行して、すべてのインストールで同じ品質パッチのリストをインストールします(centralized-patcher-composer-pluginプラグインパッケージを依存関係として使用)。
centralized-patcher コンポーネントパッケージを作成するには:
-
次の内容の
composer.jsonファイルを作成します。note note NOTE 次の例の require属性は、この例で後で作成する必要があるrequireplugin パッケージ への しい依存関係を示しています。code language-json { "name": "magento-services/centralized-patcher", "version": "0.0.1", "description": "Centralized patcher for patching multiple web stores from a central place", "type": "magento2-component", "license": [ "OSL-3.0", "AFL-3.0" ], "require": { "magento-services/centralized-patcher-composer-plugin": "~0.0.1" }, "require-dev": { "composer/composer": "^2.0" }, "extra": { "map": [ ], } -
パッケージ内に
/m2-hotfixesディレクトリを作成し、mapファイルのcomposer.json属性に追加します。map属性には、このパッケージからパッチを適用するターゲットプロジェクトのルートにコピーするファイルが含まれます。code language-json { ... "extra": { "map": [ [ "/m2-hotfixes", "/m2-hotfixes" ] ], }note note NOTE centralized-patcherパッケージは、/m2-hotfixesディレクトリの内容を、composer install上のターゲットプロジェクトの m2-hotfixes ディレクトリにコピーします。 クラウドのデプロイメントスクリプトはcomposer install後に m2-hotfix を適用するので、すべてのホットフィックスはデプロイメントメカニズムによってインストールされます。 -
インストールする品質向上パッチを
quality-patches属性で定義します。code language-json { ... "extra": { "map": [ [ "/m2-hotfixes", "/m2-hotfixes" ] ], "quality-patches": [ "MDVA-30106", "MDVA-12304" ] }
前述のコードサンプルの quality-patches 属性には、例として 完全なパッチリスト の 2 つのパッチが含まれています。 これらの品質向上パッチは、centralized-patcher コマンドを使用して、vendor/bin/magento-patches apply パッケージを必要とするすべてのプロジェクトにインストールされます。
テストを目的として、サンプルのパッチ(/m2-hotfixes/EXAMPLE-PATCH_2.4.6.patch)を作成できます。
m2-hotfixes ディレクトリに配置する必要があります。パッチファイル(/m2-hotfixes/EXAMPLE-PATCH_2.4.6.patch)の例は次のとおりです。
diff --git a/vendor/magento/framework/Mview/View/Subscription.php b/vendor/magento/framework/Mview/View/Subscription.php
index 03a3bf9..681e0b0 100644
--- a/vendor/magento/framework/Mview/View/Subscription.php
+++ b/vendor/magento/framework/Mview/View/Subscription.php
@@ -16,6 +16,7 @@ use Magento\Framework\Mview\ViewInterface;
/**
* Mview subscription.
+ * Test Patch File
*/
class Subscription implements SubscriptionInterface
{
centralized-patcher-composer-plugin
この例ではオンプレミス方式を使用して品質向上パッチをインストールするため、vendor/bin/magento-patches apply の操作後に composer install コマンドが実行されていることを確認する必要があります。 このプラグインは、composer install コマンドを実行する vendor/bin/magento-patches apply 操作の後にトリガーされます。
centralized-patcher-compose-plugin コンポーネントパッケージを作成するには:
-
次の内容の
composer.jsonファイルを作成します。code language-json { "name": "magento-services/centralized-patcher-composer-plugin", "version": "0.0.1", "description": "Centralized patcher composer plugin to apply quality patches from the centralized patcher", "type": "composer-plugin", "license": [ "OSL-3.0", "AFL-3.0" ], "require": { "symfony/process": "^4.1 || ^5.1", "magento/magento-cloud-patches": "~1.0.20", "magento/framework": "~103.0.5-p1", "composer-plugin-api": "^2.0" }, "require-dev": { "composer/composer": "^2.0" }, "suggest": { "magento-services/centralized-patcher": "~0.0.1" }, "autoload": { "psr-4": { "MagentoServices\\CentralizedPatcherComposerPlugin\\": "" } }, "extra": { "class": "MagentoServices\\CentralizedPatcherComposerPlugin\\Patcher" } } -
PHP ファイルを作成し、
CentralizedPatcherクラスを定義して、centralized-patcherコンポーネントパッケージから品質向上パッチリストを読み取り、composer installの操作のたびに直ちにインストールします。code language-php <?php declare(strict_types=1); namespace MagentoServices\CentralizedPatcherComposerPlugin; use Composer\Composer; use Composer\EventDispatcher\EventSubscriberInterface; use Composer\IO\IOInterface; use Composer\Plugin\PluginInterface; use Composer\Script\ScriptEvents; use Symfony\Component\Process\Exception\ProcessFailedException; use Symfony\Component\Process\Process; class Patcher implements PluginInterface, EventSubscriberInterface { /** * @var Composer $composer */ protected $composer; /** * @var IOInterface $io */ protected $io; /** * @param Composer $composer * @param IOInterface $io * @return void */ public function activate(Composer $composer, IOInterface $io) { $this->composer = $composer; $this->io = $io; } /** * @param Composer $composer * @param IOInterface $io * @return void */ public function deactivate(Composer $composer, IOInterface $io) { // Method must exist } /** * @param Composer $composer * @param IOInterface $io * @return void */ public function uninstall(Composer $composer, IOInterface $io) { // Method must exist } /** * @return string[] */ public static function getSubscribedEvents() { return [ ScriptEvents::POST_UPDATE_CMD => 'installPatches', ScriptEvents::POST_INSTALL_CMD => 'installPatches', ]; } /** * Apply patches from magento-services/centralized-patcher * * @param \Composer\Script\Event $event * @return void */ public function installPatches(\Composer\Script\Event $event) { $patches = []; $this->io->write('Applying centralized quality patches'); $packages = $this->composer->getLocker()->getLockData()['packages']; foreach ($packages as $package) { if ($package['name'] !== 'magento-services/centralized-patcher') { continue; } $patches = $package['extra']['quality-patches'] ?? []; } if (empty($patches)) { $this->io->error("No centralized quality patches to install"); exit(0); } $command = array_merge( ['php','./vendor/bin/magento-patches','apply','--no-interaction'], $patches ); $process = new Process($command); try { $this->io->debug($process->getCommandLine()); $process->mustRun(); $this->io->write( str_replace("\n\n", "\n", trim($process->getErrorOutput() ?: $process->getOutput(), "\n")) ); } catch (ProcessFailedException $e) { $process = $e->getProcess(); $error = sprintf( 'The command "%s" failed. %s', $process->getCommandLine(), trim($process->getErrorOutput() ?: $process->getOutput(), "\n") ); throw new \RuntimeException($error, $process->getExitCode()); } } }
プロジェクト固有のパッチの対処方法
すべてのプロジェクトでパッチの 95% のみが必要で、いくつかのパッチが特定のインスタンスにのみ適用されるというシナリオが考えられます。 パッチ適用を適用する通常の方法は、引き続き機能します。 プロジェクト固有のパッチを /m2-hotfixes ディレクトリに保持し、プロジェクトごとに品質パッチをインストールできます。
この方法を使用する場合は、コンポーネントパッケージによってプロジェクトにコピーされた ディレクトリ内のパッチを /m2-hotfixes コミットしない centralized-patcher でください。 /m2-hotfixes ファイルに .gitignore を追加することで、誤ったコミットを防ぐことができます。 .gitignore ファイルを更新した後は、/m2-hotfixes コマンドを使用してプロジェクト固有の git add –force を追加する必要があることに注意してください。
異なるバージョンのAdobe Commerceの実行
centralized-patcher コンポーネントパッケージに正しい依存関係を設定していることを確認します。 例えば、パッケージの特定のバージョンに対してAdobe Commerce 2.4.5-p2 が必要な場合、Adobe Commerce 2.4.5-p2 と互換性のあるパッチのみが提供されます。 このパッケージには、Adobe Commerce 2.4.4 と互換性のある別のバージョンが含まれている場合があります。
結果について
クラウドインフラストラクチャー上のAdobe Commerceの場合と同様に、この記事では、デプロイメントプロセスで新しいコードをサーバーにデプロイする際に composer install や composer update ではなく、git pull コマンドを使用することを前提としています。 一元化されたパッチインストールのフローは、次のようになります。
-
Composer のインストール
- -p1 または – p2 のセキュリティおよび機能パッチを含むAdobe Commerceをインストールします。
- 一元化された
/m2-hotfixesおよびサポートパッチと、プロジェクト固有の/m2-hotfixesおよびサポートパッチを組み合わせる cweagans/composer-patchesComposer パッケージとともにインストールされるパッチを適用します。
-
composer install後- Composer プラグインは、集中管理品質パッチをインストールします
-
デプロイメント
- 必要なパッチおよびプロジェクト固有の高品質のパッチは、
.magento.env.yamlファイルに基づいてインストールされます(クラウドインフラストラクチャプロジェクト上のAdobe Commerceのみ)。 /m2-hotfixesディレクトリにあるカスタムパッチおよびサポートパッチは、パッチ名のアルファベット順にインストールされます。
- 必要なパッチおよびプロジェクト固有の高品質のパッチは、
これにより、すべてのインストールに対するすべてのパッチを一元的に管理でき、Adobe Commerce ストアのセキュリティと安定性をより確実に保証できます。 次の方法を使用して、パッチステータスを確認します。