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

最終更新日: 2023-11-17

実稼動環境にデプロイする前にコードの品質をテストするための実稼動以外のパイプラインを設定する方法を説明します。

ユーザーが デプロイメントマネージャー 実稼動以外のパイプラインを設定するためのロール。

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

ステージング環境と実稼動環境にデプロイする実稼動パイプラインに加えて、実稼動以外のパイプラインも設定して、コードを検証できます。

実稼動以外のパイプラインには次の 2 種類があります。

  • コード品質パイプライン - これらの実行コード品質スキャンは、Git 分岐のコードに対して実行され、ビルドステップとコード品質ステップを実行します。
  • デプロイメントパイプライン - コード品質パイプラインなどのビルドステップとコード品質ステップを実行する以外に、これらのパイプラインはコードを実稼動以外の環境にデプロイします。
メモ

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

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

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

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

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

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

  3. 実稼動以外のパイプラインを追加​ダイアログの「設定」タブで、追加する実稼動以外のパイプラインのタイプを選択します。

    • コード品質パイプライン - コードを構築し、単体テストを実行し、コード品質を評価してもデプロイしないパイプラインを作成します。
    • デプロイメントパイプライン - コードを構築し、単体テストを実行し、コード品質を評価し、環境にデプロイするパイプラインを作成します。

    実稼動以外のパイプラインを追加ダイアログ

  4. 実稼動以外のパイプライン名​を指定して、次の追加情報と共にパイプラインを特定します。

    • デプロイメントトリガー - 次のオプションで、パイプラインを開始するデプロイメントトリガーの時期を定義できます。

      • 手動 - このオプションを使用して、パイプラインを手動で開始します。
      • Git の変更時 - このオプションは、設定された Git ブランチにコミットが追加されるたびに CI/CD パイプラインを開始します。このオプションを使用すると、必要に応じてパイプラインを手動で開始できます。
  5. デプロイメントパイプライン​を作成する場合、重要な指標のエラー動作​も定義する必要があります。

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

  7. 実稼動以外のパイプラインを追加​ダイアログの「ソースコード」タブで、パイプラインが処理するコードのタイプを選択する必要があります。

詳しくは、 CI/CD パイプライン を参照してください。

実稼動以外のパイプラインの作成を完了する手順は、選択したソースコードのタイプによって異なります。 上記のリンクをたどって、このドキュメントの次の節に移動し、パイプラインの設定を完了します。

フルスタックコード

フルスタックコードパイプラインは、1 つ以上の AEM サーバーアプリケーションを含んだバックエンドおよびフロンエンドコードビルドと HTTPD/Dispatcher 設定を同時にデプロイします。

メモ

選択した環境にフルスタックコードパイプラインが存在する場合、この選択は無効になります。

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

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

    • 適格なデプロイメント環境 - パイプラインがデプロイメントパイプラインの場合、デプロイ先の環境を選択する必要があります。
    • リポジトリ - このオプションは、パイプラインがコードを取得する Git リポジトリを定義します。
    ヒント

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

    • Git ブランチ - このオプションは、選択したパイプラインのどのブランチからコードを取得するかを定義します。

      • ブランチ名の最初の数文字と、このフィールドのオートコンプリート機能を入力します。これにより、選択できる一致するブランチを検索できます。
    • web 階層設定を無視 - オンにすると、パイプラインは web 階層設定をデプロイしなくなります。

    • パイプライン - パイプラインがデプロイメントパイプラインの場合、テストフェーズを実行するように選択できます。このフェーズで有効にするオプションを選択します。どのオプションも選択していない場合、テストフェーズはパイプラインの実行中に表示されません。

    フルスタックパイプライン

  2. 保存」をクリックします。

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

ターゲットのデプロイメント

ターゲットのデプロイメントは、AEMアプリケーションの選択した部分のコードのみをデプロイします。 このようなデプロイメントでは、次の操作を選択できます。 次を含む 次のいずれかのタイプのコード。

  • Config - AEM環境、メンテナンスタスク、CDN ルールなどの設定をおこないます。
  • フロントエンドコード - AEMアプリケーションのフロントエンド用に JavaScript と CSS を設定します。
    • フロントエンドパイプラインを使用すると、フロントエンド開発者の作業の独立性が高まるほか、開発プロセスを速めることができます。
    • このプロセスの可能性を最大限に引き出すために知っておくべきいくつかの考慮事項と、このプロセスがどのように機能するかについては、フロントエンドパイプラインを使用したサイトの開発のドキュメントを参照してください。
  • Web 層の設定 - Web ページをクライアントに保存、処理、配信するための Dispatcher プロパティを設定します。
メモ
  • 選択した環境に web 階層コードパイプラインが存在する場合、この選択は無効になります。
  • 環境に既にフルスタックパイプラインがデプロイされている場合、同じ環境に web 階層設定パイプラインを作成すると、フルスタックパイプライン内の既存の web 階層設定は無視されます。
  • いつでも、環境ごとに 1 つの設定パイプラインしか使用できません。

実稼動以外のターゲットデプロイメントパイプラインの作成を完了する手順は、デプロイメントタイプを選択した場合と同じです。

  1. 必要なデプロイメントの種類を選択します。

ターゲットのデプロイメントオプション

  1. 次を定義: 適格なデプロイメント環境.

    • パイプラインがデプロイメントパイプラインの場合は、デプロイ先の環境を選択する必要があります。
  2. の下 ソースコード、次のオプションを定義します。

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

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

    • Git ブランチ - このオプションは、選択したパイプラインのどのブランチからコードを取得するかを定義します。
      • ブランチ名の最初の数文字と、このフィールドのオートコンプリート機能を入力します。これにより、選択可能な一致するブランチが検索されます。
    • コードの場所 - このオプションは、パイプラインがコードを取得する必要がある、選択したリポジトリーのブランチ内のパスを定義します。

    設定パイプライン

  3. 保存」をクリックします。

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

ターゲットのデプロイメントパイプラインを実行する際の設定 WAF 設定など パイプラインで定義した環境、リポジトリ、ブランチに保存されている場合は、デプロイされます。

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>

このページ