実稼動パイプラインの設定

実稼動パイプラインを設定し、コードをビルドして実稼働環境にデプロイする方法について説明します。実稼動パイプラインは最初にコードをステージング環境にデプロイし、承認があると同じコードを実稼動環境にデプロイします。

実稼働パイプラインを設定するには、ユーザーに​デプロイメントマネージャー​の役割が必要です。

コードのデプロイを開始する前に、Cloud Manager からパイプライン設定を指定する必要があります。

新しい実稼動パイプラインの追加

Cloud Manager UI を使用してプログラムをセットアップし、1 つ以上の環境を用意したら、次の手順に従って実稼動パイプラインを追加する準備が整います。

1. my.cloudmanager.adobe.com で Cloud Manager にログインし、適切な組織とプログラムを選択します。

2. プログラムの概要​ページから​パイプライン​カードに移動し、「追加」をクリックして「実稼動パイプラインを追加」を選択します。

   

3. 実稼動パイプラインを追加​ダイアログボックスが表示されます。パイプラインを識別するための「パイプライン名」のほか、以下のオプションを指定します。「続行」をクリックします。

   デプロイメントトリガー - パイプラインを開始するデプロイメントトリガーを定義する際には、次のオプションがあります。

   • 手動 - このオプションを使用して、パイプラインを手動で開始します。
   • Git の変更時 - このオプションは、設定された Git ブランチにコミットが追加されるたびに CI／CD パイプラインを開始します。このオプションを使用すると、必要に応じてパイプラインを手動で開始できます。

   重要な指標のエラー動作 - パイプラインの設定または編集中に、デプロイメントマネージャー​には、品質ゲートのいずれかで重要なエラーが発生した場合のパイプラインの動作を定義するオプションがあります。使用できるオプションは以下のとおりです。

   • 毎回確認する - デフォルトの設定。重要なエラーが検出されたときに手動で介入する必要があります。
   • 直ちに失敗 - 重要なエラーが検出されると、パイプラインはキャンセルされます。このオプションでは、基本的に、各エラーをユーザーが手動で拒否する状況をエミュレートします。
   • 直ちに続行 - 重要なエラーが検出されても、パイプラインは自動的に続行されます。このオプションでは、基本的に、各エラーをユーザーが手動で承認する状況をエミュレートします。

   

4. 「ソースコード」タブで、パイプラインのコードの取得先とタイプを定義する必要があります。

   • フロントエンドコード
   • フルスタックコード
   • Web 階層設定

実稼動パイプラインを作成する手順は、「ソースコード」で選択したオプションによって異なります。上記のリンクをたどると、このドキュメントの次の節にジャンプしてパイプラインの設定を完了できます。

フロントエンドコード

フロントエンドコードパイプラインは、1 つ以上のクライアントサイド UI アプリケーションを含んだフロントエンドコードビルドをデプロイします。このタイプのパイプラインについて詳しくは、CI／CD パイプラインのドキュメントを参照してください。

フロントエンドコード実稼動パイプラインの設定を完了するには、次の手順に従います。

1. 「ソースコード」タブで、次のオプションを定義する必要があります。

   • リポジトリー - このオプションは、パイプラインがコードを取得する Git リポジトリーを定義します。
   ヒント

   Cloud Manager でリポジトリーを追加および管理する方法については、リポジトリーの追加と管理のドキュメントを参照してください。

   • Git ブランチ - このオプションでは、選択したパイプラインのどのブランチからコードを取得するかを定義します。
     • ブランチ名の最初の数文字を入力すると、このフィールドのオートコンプリート機能により、一致するブランチが検索され、選択の助けになります。
   • コードの場所 - このオプションは、パイプラインがコードを取得する必要がある、選択したリポジトリーのブランチ内のパスを定義します。
   • 実稼動へのデプロイ前に一時停止 - このオプションを使用すると、実稼動環境にデプロイする前にパイプラインを一時停止できます。

   

2. 「保存」をクリックしてパイプラインを保存します。

パイプラインが保存され、プログラムの概要​ページの​パイプライン​カードでパイプラインを管理できるようになりました。

フルスタックコード

フルスタックコードパイプラインは、1 つ以上の AEM サーバーアプリケーションを含んだバックエンドおよびフロンエンドコードビルドと HTTPD／Dispatcher 設定を同時にデプロイします。このタイプのパイプラインについて詳しくは、CI／CD パイプラインのドキュメントを参照してください。

フルスタックコード実稼動パイプラインの設定を完了するには、次の手順に従います。

1. 「ソースコード」タブで、次のオプションを定義する必要があります。

   • リポジトリー - このオプションは、パイプラインがコードを取得する Git リポジトリーを定義します。
   ヒント

   Cloud Manager でリポジトリーを追加および管理する方法については、リポジトリーの追加と管理のドキュメントを参照してください。

   • Git ブランチ - このオプションでは、選択したパイプラインのどのブランチからコードを取得するかを定義します。
     • ブランチ名の最初の数文字を入力すると、このフィールドのオートコンプリート機能により、一致するブランチが検索され、選択の助けになります。
   • コードの場所 - このオプションは、パイプラインがコードを取得する必要がある、選択したリポジトリーのブランチ内のパスを定義します。
   • 実稼動へのデプロイ前に一時停止 - このオプションを使用すると、実稼動環境にデプロイする前にパイプラインを一時停止できます。
   • スケジュール設定 - このオプションを使用すると、ユーザーはスケジュールされた実稼動デプロイメントを有効にできます。

   

2. 「続行」をクリックして「エクスペリエンス監査」タブに進みます。ここでは、エクスペリエンス監査に常に含めるパスを定義できます。

   

3. エクスペリエンス監査に含めるパスを指定します。

   • ページパスは / で始める必要があります。
   • 例えば、エクスペリエンス監査に https://wknd.site/us/en/about-us.html を含める場合は、/us/en/about-us.html というパスを入力します。

   

4. 「ページを追加」をクリックすると、パスが使用中の環境のアドレスで自動的に補完され、パスのテーブルに追加されます。

   

5. 上記の 2 つの手順を繰り返して、必要なパスを追加します。

   • 最大 25 個のパスを追加できます。
   • パスを定義しない場合は、デフォルトでサイトのホームページがエクスペリエンス監査に含められます。

6. 「保存」をクリックして、パイプラインを保存します。

エクスペリエンス監査の対象として設定されたパスはサービスに送信され、パイプラインの実行時にパフォーマンス、アクセシビリティ、SEO（検索エンジン最適化）、ベストプラクティス、PWA（プログレッシブ ｗeb アプリ）の各テストに従って評価されます。詳しくは、「エクスペリエンス監査結果について」を参照してください。

パイプラインが保存され、プログラムの概要​ページの​パイプライン​カードでパイプラインを管理できるようになりました。

Web 階層設定

Web 階層設定パイプラインは HTTPD／Dispatcher 設定をデプロイします。このタイプのパイプラインについて詳しくは、CI／CD パイプラインのドキュメントを参照してください。

フルスタックコード実稼動パイプラインの設定を完了するには、次の手順に従います。

1. 「ソースコード」タブで、次のオプションを定義する必要があります。

   • リポジトリー - このオプションは、パイプラインがコードを取得する Git リポジトリーを定義します。
   ヒント

   Cloud Manager でリポジトリーを追加および管理する方法については、リポジトリーの追加と管理のドキュメントを参照してください。

   • Git ブランチ - このオプションでは、選択したパイプラインのどのブランチからコードを取得するかを定義します。
     • ブランチ名の最初の数文字を入力すると、このフィールドのオートコンプリート機能により、一致するブランチが検索され、選択の助けになります。
   • コードの場所 - このオプションは、パイプラインがコードを取得する必要がある、選択したリポジトリーのブランチ内のパスを定義します。
     • Web 階層設定パイプラインの場合、これは通常、conf.d、conf.dispatcher.d および opt-in ディレクトリを含んだパスになります。
     • 例えば、プロジェクト構造が AEM プロジェクトアーキタイプから生成された場合、パスは /dispatcher/src になります。
   • 実稼動へのデプロイ前に一時停止 - このオプションを使用すると、実稼動環境にデプロイする前にパイプラインを一時停止できます。
   • スケジュール設定 - このオプションを使用すると、ユーザーはスケジュールされた実稼動デプロイメントを有効にできます。

   

2. 「保存」をクリックしてパイプラインを保存します。

パイプラインが保存され、プログラムの概要​ページの​パイプライン​カードでパイプラインを管理できるようになりました。

フロントエンドパイプラインを使用したサイトの開発

フロントエンドパイプラインを使用すると、フロントエンド開発者の作業の独立性が高まるほか、開発プロセスを速めることができます。

このプロセスの可能性を最大限に引き出すために知っておくべきいくつかの考慮事項と、このプロセスがどのように機能するかについては、フロントエンドパイプラインを使用したサイトの開発のドキュメントを参照してください。

Dispatcher パッケージのスキップ

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>

Business.Adobe.com リソース