実稼動パイプラインの追加 configure-production-pipeline
本番パイプラインを設定し、コードをビルドして本番環境にデプロイする方法について説明します。本番パイプラインは、最初にコードをステージング環境にデプロイします。承認時に、同じコードが本番環境にデプロイされます。
本番パイプラインを設定するには、ユーザーに デプロイメントマネージャー の役割が必要です。
- プログラムが作成されます。
- Git リポジトリには 1 つ以上の分岐があります。
- 本番環境とステージング環境が作成されます。
コードのデプロイを開始する前に、Cloud Manager からパイプライン設定を行う必要があります。
新しい実稼動パイプラインの追加 adding-production-pipeline
Cloud Manager UI を使用してプログラムをセットアップし、1 つ以上の環境を用意したら、次の手順に従って実稼動パイプラインを追加する準備が整います。
-
experience.adobe.com でCloud Managerにログインします。
-
「クイックアクセス」セクションで、「Experience Manager」をクリックします。
-
左側のパネルで、「Cloud Manager」をクリックします。
-
必要な組織を選択します。
-
マイプログラム コンソールで、プログラムをクリックします。
-
マイプログラム コンソールで、プログラムを選択します。
-
プログラムの概要 ページから パイプライン カードに移動し、「追加」をクリックして「実稼動パイプラインを追加」を選択します。
-
実稼動パイプラインを追加 ダイアログボックスが表示されます。パイプラインを識別するための「パイプライン名」のほか、以下のオプションを指定します。「続行」をクリックします。
デプロイメントトリガー - パイプラインを開始するデプロイメントトリガーを定義する際には、次のオプションがあります。
- 手動 - パイプラインを手動で開始します。
- Git の変更時 - 設定された Git 分岐にコミットが追加されるたびに CI/CD パイプラインを開始します。このオプションを使用すると、必要に応じてパイプラインを手動で開始できます。
重要な指標のエラー動作 - パイプラインの設定または編集中に、デプロイメントマネージャー には、品質ゲートのいずれかで重要なエラーが発生した場合のパイプラインの動作を定義するオプションがあります。使用できるオプションは以下のとおりです。
- 毎回確認する - デフォルトの設定。重要なエラーが検出された場合は手動で介入する必要があります。
- 直ちに失敗 - 重要なエラーが検出されると、パイプラインがキャンセルされます。このプロセスでは、基本的に、ユーザーが各エラーを手動で拒否する状況をエミュレートします。
- 直ちに続行 - 重要なエラーが検出されても、パイプラインが自動的に続行されます。このプロセスでは、基本的に、ユーザーが各エラーを手動で承認する状況をエミュレートします。
-
「ソースコード」タブでは、パイプラインで処理するコードのタイプを選択します。
このタイプのパイプラインについて詳しくは、CI/CD パイプラインを参照してください。
実稼動パイプラインを作成する手順は、選択したソースコードのタイプによって異なります。上記のリンクをたどって、このドキュメントの次の節に移動し、パイプラインの設定を完了します。
フルスタックコードパイプラインの設定 full-stack-code
フルスタックコードパイプラインは、1 つ以上の AEM サーバーアプリケーションを含んだバックエンドおよびフロンエンドコードビルドと HTTPD/Dispatcher 設定を同時にデプロイします。
フルスタックコードパイプラインを設定するには:
-
「ソースコード」タブで、次のオプションを定義します。
- リポジトリ - パイプラインがコードを取得する Git リポジトリを定義します。
note tip TIP Cloud Manager でリポジトリを追加および管理する方法については、リポジトリの追加と管理を参照してください。 - Git 分岐 - 選択したパイプラインがどの分岐からコードを取得するかを定義します。
分岐名の最初の数文字を入力すると、このフィールドのオートコンプリート機能により、一致する分岐が検索され、選択しやすくなります。 - Web 階層設定を無視 - オンにすると、パイプラインは web 階層設定をデプロイしなくなります。
- 実稼動へのデプロイ前に一時停止 - 実稼動環境にデプロイする前にパイプラインを一時停止します。
- スケジュール設定 - ユーザーはスケジュールされた実稼動デプロイメントを有効にできます。
-
「続行」をクリックして「エクスペリエンス監査」タブに進みます。ここでは、エクスペリエンス監査に常に含めるパスを定義できます。
-
エクスペリエンス監査に含めるパスを指定します。
- 詳しくは、エクスペリエンス監査テストを参照してください。
-
「保存」をクリックしてパイプラインを保存します。
パイプラインの実行時に、エクスペリエンス監査の対象として設定したパスが送信され、パフォーマンス、アクセシビリティ、SEO、ベストプラクティス、PWA テストに基づいて評価されます。詳しくは、エクスペリエンス監査結果についてを参照してください。
パイプラインが保存され、プログラムの概要 ページの パイプライン カードでパイプラインを管理できるようになりました。
ターゲットデプロイメントパイプラインの設定 targeted-deployment
ターゲットデプロイメントは、AEM アプリケーションの選択した部分のコードのみをデプロイします。このようなデプロイメントでは、次のいずれかのタイプのコードを 含める よう選択できます。
-
設定 - AEM 環境の様々な機能の設定を行います。
- ログ転送、パージ関連のメンテナンスタスク、様々な CDN 設定など、サポートされる設定のリストと、それらが適切にデプロイされるようにリポジトリで管理するには、 設定パイプラインの使用 を参照してください。
- ターゲットデプロイメントパイプラインを実行すると、パイプラインで定義されている環境、リポジトリ、ブランチに設定が保存された場合、その設定がデプロイされます。
- 設定パイプラインは、常に 1 つの環境に 1 つしか存在できません。
-
Edge Delivery Services設定パイプラインを設定 - Edge Delivery設定パイプラインには、開発環境、ステージング環境および実稼動環境は個別には存在しません。 AEM as a Cloud Serviceでは、変更は開発層、ステージ層、実稼動層を通じて進みます。 これに対し、Edge Delivery設定パイプラインは、Cloud Managerに登録されたすべてのEdge Delivery Sites ドメインに設定を直接適用します。 詳しくは、Edge Delivery パイプラインの追加 を参照してください。
-
フロントエンドコード - AEM アプリケーションのフロントエンド用に JavaScript と CSS を設定します。
- フロントエンドパイプラインを使用すると、フロントエンド開発者の作業の独立性が高まるほか、開発プロセスを速めることができます。
- このプロセスの可能性を最大限に引き出すために知っておくべきいくつかの考慮事項と、このプロセスがどのように機能するかについては、フロントエンドパイプラインを使用したサイトの開発のドキュメントを参照してください。
-
Web 階層の設定 - Web ページをクライアントに保存、処理、配信するための Dispatcher プロパティを設定します。
- 詳しくは、CI/CD パイプラインのドキュメントを参照してください。
- 選択した環境に web 階層コードパイプラインが存在する場合、この選択は無効になります。
- 既存のフルスタックパイプラインがある環境に対して web 階層設定パイプラインを作成すると、フルスタックパイプライン内の web 階層設定は無視されます。この変更は、その環境の web 階層設定にのみ影響します。
ターゲットデプロイメントパイプラインを設定するには:
- 必要なデプロイメントのタイプを選択します。
-
適格なデプロイメント環境 を定義します。
- パイプラインがデプロイメントパイプラインの場合、デプロイ先の環境を選択する必要があります。
-
ソースコード の下で次のオプションを定義します。
- リポジトリ - このオプションは、パイプラインがコードを取得する Git リポジトリを定義します。
note tip TIP Cloud Manager でリポジトリを追加および管理する方法については、リポジトリの追加と管理を参照してください。 - Git ブランチ - このオプションは、選択したパイプラインのどのブランチからコードを取得するかを定義します。
- ブランチ名の最初の数文字と、このフィールドのオートコンプリート機能を入力します。これにより、選択可能な一致するブランチが検索されます。
- コードの場所 - このオプションは、パイプラインがコードを取得する必要がある、選択したリポジトリーのブランチ内のパスを定義します。
- 実稼動へのデプロイ前に一時停止 - このオプションを使用すると、実稼動環境にデプロイする前にパイプラインを一時停止できます。
- スケジュール設定 - ユーザーはスケジュールされた実稼動デプロイメントを有効にできます。Web 階層ターゲットのデプロイメントでのみ使用できます。
-
「保存」をクリックします。
パイプラインが保存され、プログラムの概要 ページの パイプライン カードでパイプラインを管理できるようになりました。
Dispatcher パッケージのスキップ skip-dispatcher-packages
ビルドストレージに公開せずにパイプラインで Dispatcher パッケージを作成するには、公開オプションを無効にします。これにより、パイプラインの実行時間を短縮できる場合があります。
Dispatcher パッケージの公開を無効にする次の設定を、プロジェクトの pom.xml
ファイルを使用して追加する必要があります。環境変数は、Cloud Manager ビルドコンテナで設定して、Dispatcher パッケージを無視するタイミングを決定するフラグとして機能します。
<profile>
<id>only-include-dispatcher-when-it-isnt-ignored</id>
<activation>
<property>
<name>env.IGNORE_DISPATCHER_PACKAGES</name>
<value>!true</value>
</property>
</activation>
<modules>
<module>dispatcher</module>
</modules>
</profile>