実稼動以外のパイプラインの追加 configuring-non-production-pipelines
Cloud Manager を使用して、コードをデプロイする実稼動以外のパイプラインを作成および設定する方法について説明します。 Cloud Manager でのパイプラインの動作に関する概念的な概要を最初に把握したい場合は、CI／CD パイプラインを参照してください。
概要 overview
Cloud Manager の パイプライン タイルを使用して、デプロイメントマネージャーは 2 種類のパイプラインを作成できます。
- 実稼動パイプライン – 実稼動パイプラインは、ソースコードを実稼動環境に導入するための一連のオーケストレーションされた手順で構成される、専用に構築されたパイプラインです。
- 実稼動以外のパイプライン - 実稼動以外のパイプラインは、コード品質スキャンの実行または開発環境へのソースコードのデプロイを目的としています。
このドキュメントでは、実稼動以外のパイプラインに焦点を当てます。 実稼動パイプラインの設定方法について詳しくは、実稼動パイプラインの設定のドキュメントを参照してください。
実稼動以外のパイプラインには次の 2 種類があります。
- コード品質パイプライン - これらの実行コード品質スキャンは、Git 分岐のコードに対して実行され、ビルドステップとコード品質ステップを実行します。
- デプロイメントパイプライン - コード品質パイプラインなどのビルドステップとコード品質ステップを実行するだけでなく、これらのパイプラインはコードを本番環境以外にもデプロイします。
新しい実稼動以外のパイプラインの追加 add-non-production-pipeline
Cloud Manager UIでプログラムと少なくとも1つの環境を設定したら、実稼動以外のパイプラインを追加できます。 実稼動環境にデプロイする前に、これらのパイプラインを使用してコード品質をテストします。
-
my.cloudmanager.adobe.com で Cloud Manager にログインし、適切な組織とプログラムを選択します。
-
Cloud Managerのホーム画面で、「Add」をクリックし、「実稼動以外のパイプラインを追加」を選択します。
-
実稼動以外のパイプラインを追加 ダイアログボックスの設定 タブで、作成するパイプラインのタイプを次のいずれかの方法で選択します。
- コード品質パイプライン - コードをビルドし、単体テストを実行し、環境にデプロイせずにコード品質を評価するパイプラインを作成します。
- デプロイメントパイプライン - コードのビルド、単体テストの実行、コード品質の評価、環境へのデプロイを行うパイプラインを作成します。
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
|---|---|---|
| セクション | オプション | 説明 |
| パイプライン設定 | 実稼動以外のパイプライン名 | パイプラインの説明を「実稼動以外のパイプライン名」フィールドに入力します。 |
| テスト |
実稼動以外のパイプラインを編集する場合にのみ表示されます。
|
|
| デプロイメントオプション | デプロイメントトリガー |
|
| 重要な指標の失敗の動作 |
|
|
| ステージデプロイメント後に承認 チェックボックス | 実稼動以外のパイプラインを編集する場合にのみ表示されます。 パイプラインを続行する前に、ステージ環境にデプロイした後に承認を必要とする場合は、このオプションを選択します。 このオプションを選択しない場合、設定した動作に基づいてパイプラインが続行されます。 |
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 | ||
|---|---|---|
| セクション | オプション | 説明 |
| パイプライン設定 | 実稼動以外のパイプライン名 | パイプラインの説明を「実稼動以外のパイプライン名」フィールドに入力します。 |
| 適格なデプロイメント環境 | パイプラインがデプロイメントパイプラインの場合は、Cloud Managerがコードをデプロイする環境を選択する必要があります。 | |
| テスト |
実稼動以外のパイプラインを編集する場合にのみ表示されます。
|
|
| デプロイメントオプション | デプロイメントトリガー |
|
| 重要な指標の失敗の動作 |
|
|
| ステージデプロイメント後に承認 チェックボックス | 実稼動以外のパイプラインを編集する場合にのみ表示されます。 パイプラインを続行する前に、ステージ環境にデプロイした後に承認を必要とする場合は、このオプションを選択します。 このオプションを選択しない場合、設定した動作に基づいてパイプラインが続行されます。 |
|
| ロードバランサーの変更をスキップ チェックボックス | パイプラインがデプロイメント中にロードバランサーを変更できないようにするには、このオプションを選択します。 | |
| Dispatcher Configuration |
デプロイメントマネージャー ロールは、パイプラインの実行時にAEM Dispatcher キャッシュから無効化またはフラッシュされるコンテンツパスのセットを設定できます。 Cloud Managerでは、コンテンツパッケージがデプロイされた直後に、デプロイメントパイプラインステップの一部として、これらのキャッシュアクションを実行します。 これらの設定では、AEM Dispatcher の標準的な動作を使用します。
|
|
| パイプライン | エクスペリエンス監査 チェックボックス | パイプラインにエクスペリエンス監査ステップを含めるには、このオプションを選択します。 有効にすると、パイプラインには「Source コード」タブの後に「エクスペリエンス監査」ステップが含まれます。 |
- 実稼動以外のパイプラインを追加 ダイアログボックスの右下隅にある「続行」をクリックします。
- パイプラインを構築してデプロイするように設定されているコードのタイプを選択します。
アプリケーションコードと、デフォルトではweb階層設定を含むAEM アプリケーション全体をデプロイします。
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
|---|---|---|
| セクション | オプション | 説明 |
| Source コード | リポジトリ | ドロップダウンリストから、パイプラインがソースとして使用するGit リポジトリを選択します。 Cloud Managerは、ここで選択したリポジトリからコードをビルドします。 |
| Git ブランチ | ドロップダウンリストから、選択したリポジトリ内のどのブランチからパイプラインを構築するかを選択します。 デフォルトは、main です。 パイプラインは、選択したブランチをビルドとデプロイメントのソースとして使用します。 必要に応じて、更新をクリックして、選択したリポジトリで使用可能なブランチのリストを更新します。 最近作成したブランチがリストに表示されない場合は、このオプションを使用します。 |
|
| 戦略の構築 |
|
|
| Web階層設定を無視 チェックボックス | フルスタックコードパイプラインでのweb階層設定のデプロイメントをスキップするには、このオプションを選択します。 パイプラインのコードと一緒にweb階層設定をデプロイする場合は、このオプションを選択しないままにします。 | |
| パイプライン | エクスペリエンス監査 チェックボックス | パイプラインにエクスペリエンス監査ステップを含めるには、このオプションを選択します。 有効にすると、パイプラインには「Source コード」タブの後に「エクスペリエンス監査」ステップが含まれます。 |
web ページの保存、処理、クライアントへの配信に使用されるDispatcher プロパティなど、web階層設定のみをデプロイします。 Web階層設定を選択すると、Cloud Managerはweb階層設定デプロイメント専用のパイプラインを作成します。
フルスタックパイプラインが既に存在する場合、Cloud Managerには、web階層設定パイプラインを作成すると、既存のフルスタックパイプラインがweb階層設定を無視するという通知が表示されます。 web階層設定パイプラインを作成した後、Cloud Managerはフルスタックパイプラインではなく、そのパイプラインを通じてweb階層設定デプロイメントを管理します。
| table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
|---|---|---|
| セクション | オプション | 説明 |
| Source コード | リポジトリ | ドロップダウンリストから、web階層設定を含むGit リポジトリを選択します。 |
| Git ブランチ | Cloud Managerがデプロイメントに使用するリポジトリ内のブランチを選択します。 必要に応じて、更新をクリックして、選択したリポジトリで使用可能なブランチのリストを更新します。 最近作成したブランチがリストに表示されない場合は、このオプションを使用します。 | |
| コードの場所 | デプロイするweb階層設定を含む、選択したリポジトリ内のパスを入力します。 デフォルトの場所は、リポジトリのルート （/）です。 |
- 「保存」をクリックします。
実稼動以外のパイプラインでのスマートビルドの使用について about-smart-build
Cloud Managerの スマートビルド は、実稼動以外のパイプライン向けに最適化されたビルド戦略です。 スマートビルド モジュールをキャッシュし、前回の正常な実行以降に変更されたモジュールのみを再構築することで、ビルド時間を短縮します。 変更されていないモジュールはキャッシュから再利用されますが、変更されたモジュールとその依存関係のみが再構築され、反復的な開発ワークフローの効率が向上します。
スマートビルドは現在、次の場合にのみ使用できます。
- コード品質パイプライン。
- フルスタックのデプロイメントパイプラインを開発する。
次のような場合は、スマートビルドをお勧めします。
- 段階的な変更を頻繁に行っています。
- プロジェクトに複数のMaven モジュールが含まれています。
- 完全なビルドには膨大な時間がかかります。
スマートビルドは、次のような場合には必ずしも理想的ではありません。
- ビルドは、Mavenの依存グラフ外で操作を実行するプラグインに大きく依存しています。
- すべての実行に対して完全な再構築の検証が必要です。
ビルドパフォーマンスについて smart-build-performance
スマートビルドの使用によるパフォーマンスの向上は、次のような要因によって異なります。
- プロジェクト内のモジュール数。
- コード変更の頻度と範囲。
- モジュール間の依存関係の分布：
一般的に、多くの独立したモジュールを伴うプロジェクトは、大きな改善が見られます。
モジュールごとのキャッシュオプトアウト smart-build-cache-optout
スマートビルドでは、特定のモジュールのキャッシュを無効にできるきめ細かい制御が提供されます。 この機能は、特定のモジュールで次のような場合に便利です。
exec-maven-pluginやmaven-antrun-pluginなどのプラグインを使用します。- Mavenの依存関係によって追跡されないファイル操作を実行します。
- キャッシュすると一貫性のない結果が生成される。
モジュールのキャッシュを無効にする smart-build-disable-caching
影響を受けるモジュールのpom.xmlに次のプロパティを追加できます。
<properties>
<maven.build.cache.enabled>false</maven.build.cache.enabled>
</properties>
この構文により、モジュールはパイプラインの実行ごとに再構築され、他のモジュールはキャッシュから引き続きメリットを得ることができます。
スマートビルドを使用する際の制限事項と考慮事項 smart-build-limitations
スマートビルドを使用する場合は、次の点に注意してください。
- スマートビルドはMaven依存関係分析に依存しています。
- 依存グラフ以外の変更は、トリガーの再構築ができない場合があります。
- 一部のプラグインは、キャッシュと完全に互換性がない場合があります。
- 実稼動以外のパイプラインを編集することで、いつでも フルビルド に切り替えることができます。
予期しないビルド動作が発生した場合は、特定のモジュールのキャッシュを無効にするか、ビルド戦略を フルビルド に一時的に切り替えることを検討してください。
スマートビルドの問題のトラブルシューティング smart-build-troubleshoot
・ プラグインの動作を確認します（特に
exec/antrun プラグイン）。・ほとんどのモジュールが頻繁に変更されているかどうかを確認します。
・ 完全ビルドを使用して検証します。
スマートビルドを有効にする実稼動以外のパイプラインを追加を参照してください。
次の手順 the-next-steps
パイプラインを設定したら、コードをデプロイできます。 詳しくは、コードのデプロイメントを参照してください。
ビデオチュートリアル video-tutorial
このビデオでは、パイプライン作成プロセスの概要を説明します。詳しくは、このドキュメントで説明します。