演習 - パイプラインに複数の環境を追加する

7 分

テスト環境と運用環境の両方にパイプラインをデプロイするために、パイプラインを更新する準備ができました。このユニットでは、環境をまたいでステージを再利用できるようにするために、テンプレートを使用するようにパイプラインを更新します。

このプロセスでは、次のことを行います。

リントステージのパイプラインテンプレートを追加します。
任意の環境にデプロイするために必要なステージを定義するパイプラインテンプレートを追加します。
テンプレートを使用するようにパイプラインを更新します。
パイプラインを実行して結果を確認します。

リントステージのパイプラインテンプレートを追加する

パイプラインがいくつの環境に対してデプロイされるかに関わりなく、リントステージはパイプラインの実行中に一度だけ行われます。そのため、リントステージのテンプレートを使用することは必須ではありません。ただし、主要なパイプライン定義ファイルをシンプルかつ読みやすいものにするため、リントステージをテンプレートで定義することにします。

Visual Studio Code で、deploy フォルダー内に pipeline-templates という名前の新しいフォルダーを作成します。
pipeline-templates フォルダーで lint.yml という名前の新しいファイルを作成します。
次のパイプラインテンプレート定義をファイルに貼り付けます。
```
jobs:
- job: LintCode
  displayName: Lint code
  steps:
    - script: |
        az bicep build --file deploy/main.bicep
      name: LintBicepCode
      displayName: Run Bicep linter
```
このリントステージはすでにパイプラインにあるリントステージと同じですが、現在は別のパイプラインテンプレートファイルに含まれます。
変更を保存し、ファイルを閉じます。

デプロイ用のパイプラインテンプレートを追加する

各環境をデプロイするのに必要なすべてのステージを定義するパイプラインテンプレートを作成します。テンプレートパラメーターを使って、環境ごとに違う可能性のある設定を指定します。

pipeline-templates フォルダーで、deploy.yml という名前の新しいファイルを作成します。

このファイルは、それぞれの環境に対して実行されたすべてのデプロイアクティビティを示します。
次のパイプラインテンプレートパラメーターをファイルに貼り付けます。
```
parameters:
- name: environmentType
  type: string
- name: resourceGroupName
  type: string
- name: serviceConnectionName
  type: string
- name: deploymentDefaultLocation
  type: string
  default: westus3
```
Note

Visual Studio Code で YAML ファイルの編集を始めると、問題があることを示す赤い波線が表示されることがあります。これは、YAML ファイル用の Visual Studio Code 拡張機能がファイルのスキーマを誤って判断することがあるからです。

拡張機能が指摘する問題は無視してかまいません。または、次のコードをファイルの上部に追加して拡張機能が推測しないようにすることもできます。
```
# yaml-language-server: $schema=./deploy.yml
```

パラメーターの下に、検証ステージの定義を貼り付けます。

stages:

- ${{ if ne(parameters.environmentType, 'Production') }}:
  - stage: Validate_${{parameters.environmentType}}
    displayName: Validate (${{parameters.environmentType}} Environment)
    jobs:
    - job: ValidateBicepCode
      displayName: Validate Bicep code
      steps:
        - task: AzureResourceManagerTemplateDeployment@3
          name: RunPreflightValidation
          displayName: Run preflight validation
          inputs:
            connectedServiceName: ${{parameters.serviceConnectionName}}
            location: ${{parameters.deploymentDefaultLocation}}
            deploymentMode: Validation
            resourceGroupName: ${{parameters.resourceGroupName}}
            csmFile: deploy/main.bicep
            overrideParameters: >
              -environmentType ${{parameters.environmentType}}

条件がこのステージに適用されることに注目してください。これは非運用環境でのみ実行されます。

また、ステージ識別子に environmentType パラメーターの値が含まれていることにも注目してください。このパラメーターにより、パイプラインのすべてのステージに一意識別子が指定されるようになります。ステージには、読みやすく書式設定された名前を作成する displayName プロパティもあります。

検証ステージの下に、プレビューステージの定義を貼り付けます。

- ${{ if eq(parameters.environmentType, 'Production') }}:
  - stage: Preview_${{parameters.environmentType}}
    displayName: Preview (${{parameters.environmentType}} Environment)
    jobs:
    - job: PreviewAzureChanges
      displayName: Preview Azure changes
      steps:
        - task: AzureCLI@2
          name: RunWhatIf
          displayName: Run what-if
          inputs:
            azureSubscription: ${{parameters.serviceConnectionName}}
            scriptType: 'bash'
            scriptLocation: 'inlineScript'
            inlineScript: |
              az deployment group what-if \
                --resource-group ${{parameters.resourceGroupName}} \
                --template-file deploy/main.bicep \
                --parameters environmentType=${{parameters.environmentType}}

このステージにも適用される条件がありますが、検証ステージの条件とは逆であることに注目してください。プレビューステージは、運用環境でのみ実行されます。

プレビューステージの下に、デプロイステージの定義を貼り付けます。

- stage: Deploy_${{parameters.environmentType}}
  displayName: Deploy (${{parameters.environmentType}} Environment)
  jobs:
  - deployment: DeployWebsite
    displayName: Deploy website
    environment: ${{parameters.environmentType}}
    strategy:
      runOnce:
        deploy:
          steps:
            - checkout: self

            - task: AzureResourceManagerTemplateDeployment@3
              name: DeployBicepFile
              displayName: Deploy Bicep file
              inputs:
                connectedServiceName: ${{parameters.serviceConnectionName}}
                deploymentName: $(Build.BuildNumber)
                location: ${{parameters.deploymentDefaultLocation}}
                resourceGroupName: ${{parameters.resourceGroupName}}
                csmFile: deploy/main.bicep
                overrideParameters: >
                  -environmentType ${{parameters.environmentType}}
                deploymentOutputs: deploymentOutputs

            - bash: |
                echo "##vso[task.setvariable variable=appServiceAppHostName;isOutput=true]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.appServiceAppHostName.value')"
              name: SaveDeploymentOutputs
              displayName: Save deployment outputs into variables
              env:
                DEPLOYMENT_OUTPUTS: $(deploymentOutputs)

デプロイステージの下に、スモークテストステージの定義を貼り付けます。

- stage: SmokeTest_${{parameters.environmentType}}
  displayName: Smoke Test (${{parameters.environmentType}} Environment)
  jobs:
  - job: SmokeTest
    displayName: Smoke test
    variables:
      appServiceAppHostName: $[ stageDependencies.Deploy_${{parameters.environmentType}}.DeployWebsite.outputs['DeployWebsite.SaveDeploymentOutputs.appServiceAppHostName'] ]
    steps:
      - task: PowerShell@2
        name: RunSmokeTests
        displayName: Run smoke tests
        inputs:
          targetType: inline
          script: |
            $container = New-PesterContainer `
              -Path 'deploy/Website.Tests.ps1' `
              -Data @{ HostName = '$(appServiceAppHostName)' }
            Invoke-Pester `
              -Container $container `
              -CI

      - task: PublishTestResults@2
        name: PublishTestResults
        displayName: Publish test results
        condition: always()
        inputs:
          testResultsFormat: NUnit
          testResultsFiles: 'testResults.xml'

ホスト名を発行したステージを参照する際に、appServiceAppHostName 変数の定義は environmentTypeパラメーターを組み込みます。このパラメーターにより、各スモークテストステージが正しい環境に対して実行されるようになります。

deploy.yml ファイルが、次の例のようになっていることを確認します。

parameters:
- name: environmentType
  type: string
- name: resourceGroupName
  type: string
- name: serviceConnectionName
  type: string
- name: deploymentDefaultLocation
  type: string
  default: westus3

stages:

- ${{ if ne(parameters.environmentType, 'Production') }}:
  - stage: Validate_${{parameters.environmentType}}
    displayName: Validate (${{parameters.environmentType}} Environment)
    jobs:
    - job: ValidateBicepCode
      displayName: Validate Bicep code
      steps:
        - task: AzureResourceManagerTemplateDeployment@3
          name: RunPreflightValidation
          displayName: Run preflight validation
          inputs:
            connectedServiceName: ${{parameters.serviceConnectionName}}
            location: ${{parameters.deploymentDefaultLocation}}
            deploymentMode: Validation
            resourceGroupName: ${{parameters.resourceGroupName}}
            csmFile: deploy/main.bicep
            overrideParameters: >
              -environmentType ${{parameters.environmentType}}

- ${{ if eq(parameters.environmentType, 'Production') }}:
  - stage: Preview_${{parameters.environmentType}}
    displayName: Preview (${{parameters.environmentType}} Environment)
    jobs:
    - job: PreviewAzureChanges
      displayName: Preview Azure changes
      steps:
        - task: AzureCLI@2
          name: RunWhatIf
          displayName: Run what-if
          inputs:
            azureSubscription: ${{parameters.serviceConnectionName}}
            scriptType: 'bash'
            scriptLocation: 'inlineScript'
            inlineScript: |
              az deployment group what-if \
                --resource-group ${{parameters.resourceGroupName}} \
                --template-file deploy/main.bicep \
                --parameters environmentType=${{parameters.environmentType}}

- stage: Deploy_${{parameters.environmentType}}
  displayName: Deploy (${{parameters.environmentType}} Environment)
  jobs:
  - deployment: DeployWebsite
    displayName: Deploy website
    environment: ${{parameters.environmentType}}
    strategy:
      runOnce:
        deploy:
          steps:
            - checkout: self

            - task: AzureResourceManagerTemplateDeployment@3
              name: DeployBicepFile
              displayName: Deploy Bicep file
              inputs:
                connectedServiceName: ${{parameters.serviceConnectionName}}
                deploymentName: $(Build.BuildNumber)
                location: ${{parameters.deploymentDefaultLocation}}
                resourceGroupName: ${{parameters.resourceGroupName}}
                csmFile: deploy/main.bicep
                overrideParameters: >
                  -environmentType ${{parameters.environmentType}}
                deploymentOutputs: deploymentOutputs

            - bash: |
                echo "##vso[task.setvariable variable=appServiceAppHostName;isOutput=true]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.appServiceAppHostName.value')"
              name: SaveDeploymentOutputs
              displayName: Save deployment outputs into variables
              env:
                DEPLOYMENT_OUTPUTS: $(deploymentOutputs)

- stage: SmokeTest_${{parameters.environmentType}}
  displayName: Smoke Test (${{parameters.environmentType}} Environment)
  jobs:
  - job: SmokeTest
    displayName: Smoke test
    variables:
      appServiceAppHostName: $[ stageDependencies.Deploy_${{parameters.environmentType}}.DeployWebsite.outputs['DeployWebsite.SaveDeploymentOutputs.appServiceAppHostName'] ]
    steps:
      - task: PowerShell@2
        name: RunSmokeTests
        displayName: Run smoke tests
        inputs:
          targetType: inline
          script: |
            $container = New-PesterContainer `
              -Path 'deploy/Website.Tests.ps1' `
              -Data @{ HostName = '$(appServiceAppHostName)' }
            Invoke-Pester `
              -Container $container `
              -CI

      - task: PublishTestResults@2
        name: PublishTestResults
        displayName: Publish test results
        condition: always()
        inputs:
          testResultsFormat: NUnit
          testResultsFiles: 'testResults.xml'

ファイルに加えた変更を保存します。

パイプライン定義を更新して、テンプレートを使用するようにします。

azure-pipelines.yml ファイルを開きます。

内容を次のコードで置き換えることにより、新しいテンプレートを使用するようにファイルを更新します。

trigger:
  batch: true
  branches:
    include:
    - main

pool:
  vmImage: ubuntu-latest

stages:

# Lint the Bicep file.
- stage: Lint
  jobs: 
  - template: pipeline-templates/lint.yml

# Deploy to the test environment.
- template: pipeline-templates/deploy.yml
  parameters:
    environmentType: Test
    resourceGroupName: ToyWebsiteTest
    serviceConnectionName: ToyWebsiteTest

# Deploy to the production environment.
- template: pipeline-templates/deploy.yml
  parameters:
    environmentType: Production
    resourceGroupName: ToyWebsiteProduction
    serviceConnectionName: ToyWebsiteProduction

このパイプラインは、リントステージを一度実行します。その後、deploy.yml テンプレートファイルを 2 回使用します。環境ごとに 1 回です。これにより、パイプラインの定義が明確で理解しやすいものになります。また、コメントは状況を説明するのに役立ちます。

変更を保存します。
Visual Studio Code ターミナルで次のコマンドを実行し、変更をコミットして Git リポジトリにプッシュします。
```
git add .
git commit -m "Add pipeline templates"
git push
```

パイプライン実行を表示する

ブラウザーで、[Pipelines] に移動します。
パイプラインの最新の実行を選択します。

パイプライン実行には、YAML ファイルで定義したすべてのステージが示されています。すべてを確認するには水平方向にスクロールする必要があるかもしれません。
デプロイ (運用環境) ステージの前に、パイプラインが一時停止するのを待ちます。パイプラインがここに達するまでに数分かかることがあります。
[Review](レビュー) ボタンを選択して、運用環境へのデプロイを承認します。
[承認] ボタンを選択します。

パイプラインの実行が完了するまで待機します。
[テスト] タブを選んで、パイプライン実行からのテスト結果を表示します。

4 つのテスト結果が表示されます。スモークテストはテスト環境と運用環境の両方に対して実行されるため、両方のテストの結果が表示されます。
[Pipelines]>[環境] を選択します。
[運用] 環境を選択します。
環境の詳細画面に、運用環境のデプロイ履歴の概要が表示されます。
デプロイを選択して、[Changes](変更) タブを選択します。

[Changes](変更) タブに、デプロイに含まれるコミットの一覧が表示されます。この情報から、時間の経過とともに環境内で何が変更されたのかを正確に把握できます。
ブラウザーで、Azure portal に移動します。
ToyWebsiteProduction リソースグループに移動します。
リソースの一覧で、Azure App Service アプリを開きます。

App Service プランの種類は S1 です。
ToyWebsiteTest リソースグループの App Service アプリに移動します。

App Service プランの種類は F1 です。 Bicep ファイルで定義した通り、2 つの環境は異なる設定を使用します。

演習 - パイプラインに複数の環境を追加する

リント ステージのパイプライン テンプレートを追加する

デプロイ用のパイプライン テンプレートを追加する

パイプライン定義を更新して、テンプレートを使用するようにします。

パイプライン実行を表示する

フィードバック

リントステージのパイプラインテンプレートを追加する

デプロイ用のパイプラインテンプレートを追加する