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

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

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

開始する前に

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

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

手順

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

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

Azure DevOps ポータル (https://dev.azure.com) に移動し、自分の組織を開きます。
eShopOnWeb プロジェクトを開きます。
[パイプライン] > [パイプライン] に移動します。
[Create Pipeline] を選択します。
[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: 'southcentralus' #name of the Azure region you want to deploy your resources
  templateFile: '.azure/bicep/webapp.bicep'
  subscriptionid: 'YOUR-SUBSCRIPTION-ID'
  azureserviceconnection: 'YOUR-AZURE-SERVICE-CONNECTION-NAME'
  webappname: 'YOUR-WEB-APP-NAME'

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

[!NOTE] [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

variables:
  resource-group: 'rg-eshoponweb'
  location: 'southcentralus'
  templateFile: '.azure/bicep/webapp.bicep'
  subscriptionid: ''
  azureserviceconnection: 'azure subs'
  webappname: 'eshoponweb-lab'
  # webappname: 'webapp-windows-eshop'
   
stages:
- stage: Deploy
  displayName: Deploy to WebApp`

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

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

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

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

[パイプライン] > [パイプライン] に移動します。
eShopOnWeb-MultiStage-Main パイプラインを開きます。
[パイプラインの実行] を選択します。
パイプラインが Test 環境の Deploy ステージに到達したら、パイプラインを開き、”この実行でテストを続行する前に、リソースにアクセスするためのアクセス許可がこのパイプラインに必要です” というメッセージを確認します。 [表示] を選び、[許可] を選んでパイプラインの実行を許可します。

[!NOTE] Deploy ステージのジョブが失敗した場合は、パイプラインの実行ページに移動し、[失敗したジョブの再実行] を選択します。
パイプラインが Production 環境の Deploy ステージに到達したら、パイプラインを開き、”この実行で運用を続行する前に、リソースにアクセスするためのアクセス許可がこのパイプラインに必要です” というメッセージを確認します。 [表示] を選び、[許可] を選んでパイプラインの実行を許可します。
パイプラインが完了するまで待ってから、結果を確認します。

演習 2:Azure と Azure DevOps リソースのクリーンアップを実行する

この演習では、このラボで作成した Azure と Azure DevOps のリソースを削除します。

タスク 1:Azure リソースを削除する

Azure portal で、デプロイされたリソースを含むリソースグループ rg-eshoponweb-multi に移動し、[リソースグループの削除] を選んで、このラボで作成されたすべてのリソースを削除します。

タスク 2:Azure DevOps パイプラインを削除する

Azure DevOps ポータル (https://dev.azure.com) に移動し、自分の組織を開きます。
eShopOnWeb プロジェクトを開きます。
[パイプライン] > [パイプライン] に移動します。
[パイプライン] > [パイプライン] に移動し、既存のパイプラインを削除します。

タスク 3:Azure DevOps リポジトリを再作成する

Azure DevOps ポータルの eShopOnWeb プロジェクトで、左下隅にある [プロジェクトの設定] を選びます。
左側の [プロジェクトの設定] 縦型メニューの [リポジトリ] セクションで、[リポジトリ] を選びます。
[すべてのリポジトリ] ペインで、eShopOnWeb リポジトリエントリの右端にマウスポインターを置き、[その他のオプション] の […] アイコンが表示されたら、それを選びます。[その他のオプション] メニューで [名前の変更] を選びます。
[eShopOnWeb リポジトリの名前を変更する] ウィンドウの [リポジトリ名] テキストボックスに「eShopOnWeb_old」と入力し、[名前の変更] を選びます。
[すべてのリポジトリ] ペインに戻り、[+ 作成] を選びます。
[リポジトリの作成] ペインの [リポジトリ名] テキストボックスに「eShopOnWeb」と入力し、[Readme の追加] チェックボックスをオフにして、[作成] を選びます。
[すべてのリポジトリ] ペインに戻り、eShopOnWeb_old リポジトリエントリの右端にマウスポインターを置き、[その他のオプション] の […] アイコンが表示されたら、それを選びます。[その他のオプション] メニューで [削除] を選びます。
[eShopOnWeb_old リポジトリの削除] ウィンドウで「eShopOnWeb_old」と入力し、[削除] を選びます。
Azure DevOps ポータルの左側のナビゲーションメニューで [リポジトリ] を選びます。
[eShopOnWeb は空です。] をクリックします。ペインで [リポジトリのインポート] を選びます。
[Git リポジトリをインポートする] ウィンドウで、URL https://github.com/MicrosoftLearning/eShopOnWeb を貼り付けて、[インポート] を選びます。

確認

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