CI/CD パイプラインの設定

メモ

AEM as a Cloud Servic で CI/CD パイプライン用に Cloud Manager を設定する方法については、こちらを参照してください。

以下のページでは、パイプライン​の設定方法について説明します。パイプラインの動作の仕組みについて詳しくは、CI/CD パイプラインの概要を参照してください。

フローについて

Cloud Manager UI の​パイプライン設定​タイルからパイプラインを設定することができます。

パイプラインの設定はデプロイメントマネージャーが担当します。その際は、まず Git リポジトリー​からブランチを選択します。パイプライン設定は以下で構成されます。

  • パイプラインを開始するトリガーの定義
  • 実稼動デプロイメントを制御するパラメーターの定義
  • パフォーマンステストパラメーターの設定

ビデオチュートリアル

Cloud Manager でのパイプラインの設定

CI/CD 実稼動パイプラインの設定は、パイプラインを開始するトリガー、実稼動環境のデプロイメントを制御するパラメーター、およびテストパラメーターのパフォーマンスを定義します。

パイプラインの設定

注意

パイプラインは、Git リポジトリーが少なくとも 1 つのブランチを持ち、プログラム設定が完了するまで、設定できません。

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

メモ

初期設定後にパイプライン設定を変更できます。

パイプラインカードからの新しい実稼動パイプラインの追加

Cloud Manager UI を使用してプログラムをセットアップし、環境が少なくとも 1 つできたら、いつでも実稼動パイプラインを追加できます。

実稼動パイプラインの動作と環境を設定するには、次の手順に従います。

  1. プログラムの概要​ページから​パイプライン​カードに移動します。

  2. +追加」をクリックし、「実稼動パイプラインを追加」を選択します。

  3. 実稼動パイプラインを追加​ダイアログボックスが表示されます。

    1. パイプライン名」を入力します。「リポジトリー」と「Git ブランチ」を選択できます。

    2. デプロイメントオプション」の「デプロイメントトリガー」と「重要な指標のエラー動作」をセットアップできます。

      パイプラインを開始するデプロイメントトリガーとして、次のいずれかを割り当てることができます。

      • 手動 - UI を使用して、パイプラインを手動で開始します。
      • Git の変更時 - 設定された Git ブランチにコミットが追加されるたびに CI/CD パイプラインを開始します。このオプションを選択しても、常にパイプラインを手動で開始できます。

      パイプラインのセットアップまたは編集中に、デプロイメントマネージャーは、品質ゲートのいずれかで重要なエラーが検出された場合のパイプラインの動作を定義できます。

      これは、より自動化されたプロセスを求めるお客様に役に立ちます。使用できるオプションは以下のとおりです。

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

      • ステージデプロイメント後に承認​機能は、実稼動環境のデプロイメント前の承認と同様に機能しますが、ステージデプロイメントステップの直後(テストの実行前)に行われます。一方、実稼動環境のデプロイメント前の承認は、すべてのテストが完了した後に行われます。

      • ロードバランサーの変更をスキップ - 変更をスキップします。

    4. ステージの「Dispatcher 設定」を選択します。「パス」を入力し、「タイプ」からアクションを選択して、「+ パスを追加」をクリックします。1 環境につき最大 100 個のパスを指定できます。

    5. 実稼動の「デプロイメントオプション」を選択します。ここで、実稼動デプロイメントを制御するパラメーターを定義します。

      次の 3 つのオプションが使用可能です。

      • GoLive の承認を使用 - Cloud Manager UI を使用して、ビジネスオーナー、プロジェクトマネージャー、デプロイメントマネージャーのいずれかがデプロイメントを手動で承認する必要があります。

      • スケジュール設定 - このオプションを使用すると、ユーザーはスケジュールされた実稼動デプロイメントを有効にできます。

        メモ

        スケジュール設定」オプションが選択されている場合は、パイプラインでステージングデプロイメント(および、「GoLive の承認を使用」が有効な場合はその承認)の​​に実稼動デプロイメントをスケジュールして、スケジュールが設定されるのを待つことができます。ユーザーは、実稼動デプロイメントをすぐに実行することもできます。

        デプロイメントのスケジュールを設定する、または実稼動デプロイメントをすぐに実行する場合は、コードのデプロイを参照してください。

        • CSE Oversight を使用 - CSE が実際にデプロイメントを開始します。CSE Oversight が有効になっている場合は、パイプラインの設定または編集中に、デプロイメントマネージャーは次のオプションを選択できます。

          • 任意の CSE:対応可能な任意の CSE に問い合わせます。
          • 担当の CSE:顧客に割り当てられている特定の CSE(CSE が不在の場合はバックアップ)に問い合わせます。
    6. 実稼動の「Dispatcher 設定」をセットアップします。「パス」を入力し、「タイプ」からアクションを選択して、「+ パスを追加」をクリックします。1 環境につき最大 100 個のパスを指定できます。

      デプロイメントマネージャーは、パイプラインの設定または編集中に、AEM Dispatcher キャッシュからパブリッシュインスタンス向けに​無効化​または​フラッシュ​する一連のコンテンツパスを設定できます。

      ステージングデプロイメントと実稼動デプロイメントに別々に一連のパスを設定できます。設定した場合、これらのキャッシュアクションは、コンテンツパッケージがデプロイされた直後にデプロイメントパイプラインステップの一部として実行されます。これらの設定では、標準の AEM Dispatcher 動作を使用します。無効化は、コンテンツがオーサーからパブリッシュにアクティブ化された場合と同様に、キャッシュを無効化します。フラッシュはキャッシュを削除します。

      一般に、無効化アクションを使用する方が望ましいですが、フラッシュが必要な場合もあります(特に、AEM HTML クライアントライブラリを使用する場合など)。

      メモ

      Dispatcher のキャッシュについて詳しくは、Dispatcher の概要を参照してください。

  4. すべてのオプションを選択したら、「続行」をクリックします。

  5. ステージテスト​ステップのオプションを選択します。ライセンスを取得している製品に応じて、AEM Sites および AEM Assets のパフォーマンステストを設定できます。詳しくは、パフォーマンステストを参照してください。

    1. サイトコンテンツ配信 / 負荷分散​のオプションを選択します。詳しくは、「パフォーマンステスト」の AEM Sites の節を参照してください。

    2. アセットパフォーマンステスト配布​のオプションを選択します。詳しくは、「パフォーマンステスト」の AEM Assets の節を参照してください。

  6. 保存」をクリックして、実稼動パイプラインの追加を完了します。

実稼動パイプラインの編集

プログラムの概要​ページでパイプライン設定を編集できます。

設定済みのパイプラインを編集するには、次の手順に従います。

  1. プログラムの概要​ページから​パイプライン​カードに移動します。

  2. パイプライン​カードの「」をクリックし、「編集」をクリックします(下図を参照)。

  3. 実稼動パイプラインを編集​ダイアログボックスが表示されます。

    1. 設定」タブでは、「パイプライン名」、「リポジトリー」、「Git ブランチ」、「デプロイメントトリガー」、「重要な指標のエラー動作」、「デプロイメントオプション」および「Dispatcher 設定」を更新できます。

      メモ

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

    2. ステージテスト」タブでは、サイトコンテンツ配信 / 負荷分散​と​アセットパフォーマンステスト配布​のオプションを再選択できます。

  4. パイプラインの編集が完了したら、「更新」をクリックします。

実稼動パイプラインに対するその他のアクション

実稼動パイプラインの実行

パイプラインカードから実稼動パイプラインを実行できます。

  1. プログラムの概要​ページから​パイプライン​カードに移動します。

  2. パイプライン​カードの「」をクリックし、「実行」をクリックします(下図を参照)。

実稼動パイプラインの削除

パイプラインカードから実稼動パイプラインを削除できます。

  1. プログラムの概要​ページから​パイプライン​カードに移動します。

  2. パイプライン​カードの「」をクリックし、「削除」をクリックします(下図を参照)。

    メモ

    デプロイメントマネージャーの役割を持つユーザーが、パイプラインカードの「削除」オプションを使用して、セルフサービス方式で実稼動パイプラインを削除できるようになりました。

実稼動以外のコード品質専用パイプライン

ステージングおよび実稼動環境にデプロイするメインパイプラインに加えて、顧客は、実稼動以外のパイプライン​と呼ばれる追加のパイプラインを設定できます。このパイプラインでは、常にビルドステップとコード品質ステップを実行します。また、オプションで Adobe Managed Services 環境にデプロイすることもできます。

ビデオチュートリアル

Cloud Manager の実稼動以外のコード品質専用パイプライン

CI/CD 実稼動以外のパイプラインは、コード品質パイプラインとデプロイパイプラインの 2 つのカテゴリに分類されます。コード品質は、Git ブランチのすべてのコードをパイプライン化し、Cloud Manager のコード品質スキャンに対して構築および評価されます。

実稼動以外のパイプラインの追加

ホーム画面には、このパイプラインが新しいカードに一覧表示されます。

  1. Cloud Manager のホーム画面から​パイプライン​カードにアクセスします。「+追加」をクリックし、「実稼動以外のパイプラインを追加」を選択します。

  2. 実稼動以外のパイプラインを追加​ダイアログボックスが表示されます。作成するパイプラインのタイプとして、「コード品質パイプライン」か「デプロイメントパイプライン」のいずれかを選択します。

    また、「デプロイメントオプション」の「デプロイメントトリガー」と「重要な指標のエラー動作」もセットアップできます。「続行」をクリックします。

  3. 新しく作成した実稼動以外のパイプラインが​パイプライン​カードに表示されます。

    このパイプラインはホーム画面の同カードに表示され、次の 3 つのアクションを備えています。

    • 追加 - 新しいパイプラインを追加できます。
    • リポジトリー情報へアクセス - Cloud Manager Git リポジトリーへのアクセスに必要な情報をユーザーが取得できるようにします.
    • 詳細 - CI/CD パイプラインのドキュメントリソースの概要に移動します。

実稼動以外のパイプラインの編集

プログラムの概要​ページの​パイプライン​カードでパイプライン設定を編集できます。

設定済みの実稼動以外のパイプラインを編集するには、次の手順に従います。

  1. プログラムの概要​ページから​パイプライン​カードに移動します。

  2. 実稼動以外のパイプラインを選択し、「」をクリックします。「編集」をクリックします(下図を参照)。

  3. 実稼動以外のパイプラインを編集​ダイアログボックスが表示されます。このダイアログボックスでは、「パイプライン名」、「リポジトリー」、「Git ブランチ」、「デプロイメントトリガー」および「重要な指標のエラー動作」を更新できます。

    メモ

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

    パイプラインを開始するデプロイメントトリガーとして、次のいずれかを割り当てることができます。

    • 手動 - UI を使用して、パイプラインを手動で開始します。
    • Git の変更時 - 設定された Git ブランチにコミットが追加されるたびに CI/CD パイプラインを開始します。このオプションを選択しても、常にパイプラインを手動で開始できます。

    パイプラインのセットアップまたは編集中に、デプロイメントマネージャーは、品質ゲートのいずれかで重要なエラーが検出された場合のパイプラインの動作を定義できます。これは、より自動化されたプロセスを求めるお客様に役に立ちます。使用できるオプションは以下のとおりです。

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

実稼動以外のパイプラインに対するその他のアクション

実稼動以外のパイプラインの実行

パイプラインカードから実稼動以外のパイプラインを実行できます。

  1. プログラムの概要​ページから​パイプライン​カードに移動します。

  2. パイプライン​カードの「」をクリックし、「実行」をクリックします(下図を参照)。

実稼動以外のパイプラインの削除

パイプラインカードから実稼動以外のパイプラインを削除できます。

  1. プログラムの概要​ページから​パイプライン​カードに移動します。

  2. パイプライン​カードの「」をクリックし、「削除」をクリックします(下図を参照)。

次の手順

パイプラインを設定したら、コードをデプロイする必要があります。

詳しくは、コードのデプロイを参照してください。

このページ