複数のテンプレートを使用するようにパイプラインを拡張する

このラボでは、パイプラインを複数のテンプレートに拡張することの重要性と、Azure DevOps を使ってそれを行う方法を確認します。このラボでは、マルチステージパイプラインの作成、変数テンプレートの作成、ジョブテンプレートの作成、ステージテンプレートの作成に関する基本的な概念とベストプラクティスについて説明します。

これらの演習の所要時間は約 20 分です。

開始する前に

ラボの演習を行うには、Azure サブスクリプション、Azure DevOps 組織、eShopOnWeb アプリケーションが必要です。

手順に従ってラボ環境を検証します。

手順

演習 1:マルチステージの YAML パイプラインを作成する

この演習では、Azure DevOps でマルチステージの YAML パイプラインを作成します。

タスク 1:マルチステージのメイン YAML パイプラインを作成する

Azure DevOps ポータル (https://aex.dev.azure.com) に移動し、自分の組織を開きます。
eShopOnWeb プロジェクトを開きます。
[パイプライン] > [パイプライン] に移動します。
[新しいパイプライン] ボタンをクリックします。
[Azure Repos Git (Yaml)] を選びます。
eShopOnWeb リポジトリを選びます。
[スタートパイプライン] を選択します。

azure-pipelines.yml ファイルの内容を次のコードに置き換えます。

trigger:
- main

pool:
  vmImage: 'windows-latest'

stages:
- stage: Dev
  jobs:
  - job: Build
    steps:
    - script: echo Build
- stage: Test
  jobs:
  - job: Test
    steps:
    - script: echo Test
- stage: Production
  jobs:
  - job: Deploy
    steps:
    - script: echo Deploy

[保存および実行] を選択します。メインブランチに直接コミットすることを選び、[保存および実行] を選択します。
3 つのステージ (Dev、Test、Production) で実行されているパイプラインと、対応するジョブが表示されます。パイプラインが完了するまで待ってから、[パイプライン] ページに戻ります。
[…] (その他のオプション) を選択し (先ほど作成したパイプラインの右側)、[名前の変更/移動] を選択します。
パイプラインの名前を eShopOnWeb-MultiStage-Main に変更し、[保存] を選択します。

タスク 2:変数テンプレートを作成する

[リポジトリ] > [ファイル] に移動します。
.ado フォルダーを展開し、[新しいファイル] をクリックします。
ファイルに eshoponweb-variables.yml という名前を付け、[作成] をクリックします。

次のコードをファイルに追加します。

variables:
  resource-group: 'YOUR-RESOURCE-GROUP-NAME'
  location: 'centralus'
  templateFile: 'infra/webapp.bicep'
  subscriptionid: 'YOUR-SUBSCRIPTION-ID'
  azureserviceconnection: 'YOUR-AZURE-SERVICE-CONNECTION-NAME'
  webappname: 'YOUR-WEB-APP-NAME'

変数の値を実際の環境の値に置き換えます。
- YOUR-RESOURCE-GROUP-NAME を、このラボで使用するリソースグループの名前 (たとえば、rg-eshoponweb-secure) に置き換えます。
- location 変数の値を、リソースをデプロイする Azure リージョンの名前 (たとえば、centralus) に設定します。
- YOUR-SUBSCRIPTION-ID を、お使いの Azure サブスクリプション ID に置き換えます。
- YOUR-AZURE-SERVICE-CONNECTION-NAME を、azure subs に置き換えます
- YOUR-WEB-APP-NAME を、デプロイする Web アプリのグローバル一意識別子 (たとえば、文字列 eshoponweb-lab-multi-123456 の後にランダムな 6 桁の数字) に置き換えます。
[コミット] を選択し、コミットの [コメント] テキストボックスに「[skip ci]」と入力し、[コミット] を選択します。

注: [skip ci] コメントをコミットに追加すると、パイプラインが自動実行されなくなります。この時点では、パイプラインは既定でリポジトリへの変更が発生するたびに実行されています。

タスク 3:テンプレートを使用するようにパイプラインを準備する

Azure DevOps ポータルの eShopOnWeb プロジェクトページで、[リポジトリ] に移動します。
リポジトリのルートディレクトリで、azure-pipelines.yml を選択します。これには eShopOnWeb-MultiStage-Main パイプラインの定義が含まれています。
[編集] ボタンをクリックします。

azure-pipelines.yml ファイルの内容を次のコードに置き換えます。

trigger:
- main
variables:
- template: .ado/eshoponweb-variables.yml
   
stages:
- stage: Dev
  jobs:
  - template: .ado/eshoponweb-ci.yml
- stage: Test
  jobs:
  - template: .ado/eshoponweb-cd-webapp-code.yml
- stage: Production
  jobs:
  - job: Deploy
    steps:
    - script: echo Deploy to Production or Swap

[コミット] を選択し、コミットの [コメント] テキストボックスに「[skip ci]」と入力し、[コミット] を選択します。

タスク 4:CI/CD テンプレートを更新する

eShopOnWeb プロジェクトの [リポジトリ] で、.ado ディレクトリを選択し、eshoponweb-ci.yml ファイルを選択します。
[編集] ボタンをクリックします。

jobs セクションの上にあるものすべてを削除します。

#NAME THE PIPELINE SAME AS FILE (WITHOUT ".yml")
# trigger:
# - main
   
resources:
  repositories:
    - repository: self
      trigger: none
   
stages:
- stage: Build
  displayName: Build .Net Core Solution

[コミット] を選択し、コミットの [コメント] テキストボックスに「[skip ci]」と入力し、[コミット] を選択します。
eShopOnWeb プロジェクトの [リポジトリ] で、.ado ディレクトリを選択し、eshoponweb-cd-webapp-code.yml ファイルを選択します。
[編集] ボタンをクリックします。

jobs セクションの上にあるものすべてを削除します。

 # NAME THE PIPELINE SAME AS FILE (WITHOUT ".yml") #
 # Trigger CD when CI executed successfully
    
 resources:
   pipelines:
     - pipeline: eshoponweb-ci
       source: eshoponweb-ci # given pipeline name
       trigger: true
    
 repositories:
   - repository: eShopSecurity
     type: git
     name: eShopSecurity/eShopSecurity # name of the project and repository
    
 variables:
   - template: eshoponweb-secure-variables.yml@eShopSecurity # name of the template and repository
    
 stages:
   - stage: Test
     displayName: Testing WebApp
     jobs:
       - deployment: Test
         pool: eShopOnWebSelfPool
         environment: Test
         strategy:
           runOnce:
             deploy:
               steps:
                 - script: echo Hello world! Testing environments!
    
   - stage: Deploy
     displayName: Deploy to WebApp

#download artifacts ステップの既存の内容を次のように置き換えます。

    - download: current
      artifact: Website
    - download: current
      artifact: Bicep

[コミット] を選択し、コミットの [コメント] テキストボックスに「[skip ci]」と入力し、[コミット] を選択します。

タスク 5:メインパイプラインを実行する

[パイプライン] > [パイプライン] に移動します。
eShopOnWeb-MultiStage-Main パイプラインを開きます。
[パイプラインの実行] を選択します。

注: この実行を続ける前に、リソースにアクセスするためのアクセス許可がパイプラインに必要であるというメッセージが表示された場合は、[表示]、[許可]、さらにもう一度 [許可] を選択して、パイプラインの実行を許可します。

注: デプロイステージのジョブが失敗した場合は、パイプライン実行ページに移動し、[失敗したジョブの再実行] を選択します。
パイプラインが完了するまで待ってから、結果を確認します。

[!IMPORTANT] 不要な料金が発生しないように、Azure portal で作成されたリソースを必ず削除してください。

確認

このラボでは、Azure DevOps を使用してパイプラインを複数のテンプレートに拡張する方法を学びました。このラボでは、マルチステージパイプラインの作成、変数テンプレートの作成、ジョブテンプレートの作成、ステージテンプレートの作成に関する基本的な概念とベストプラクティスについて説明しました。