Azure Pipelines を使用して、Python Web アプリをビルドし、Azure App Service にデプロイします

• Azure サブスクリプション。 アカウントがない場合は、 無料アカウントを作成してください。
• GitHub アカウント。 ない場合は、 無料で作成してください。
• Azure DevOps Services 組織。 無料で作成できます。

• Azure サブスクリプション。 アカウントがない場合は、 無料アカウントを作成してください。
• GitHub アカウント。 ない場合は、 無料で作成してください。
• Azure DevOps Server。
• セルフホステッド エージェント。 セルフホステッド エージェントを作成する必要がある場合は、「セルフホステッド エージェント」を参照してください。

1. ブラウザで dev.azure.com にアクセスし、サインインします。
2. 自分の組織を選択します。
3. [新しいプロジェクト] を選択して新しいプロジェクトを作成します。または、組織内で最初のプロジェクトを作成する場合は、 [プロジェクトの作成] を選択します。
4. プロジェクト名を入力します。
5. プロジェクトの [可視性] を選択します。
6. ［作成］ を選択します

1. ブラウザーで、Azure DevOps Server にアクセスします。
2. コレクションを選択します。
3. [新しいプロジェクト] を選択して新しいプロジェクトを作成します。または、コレクション内で最初のプロジェクトを作成する場合は、 [プロジェクトの作成] を選択します。
4. プロジェクト名を入力します。
5. プロジェクトの [可視性] を選択します。
6. ［作成］ を選択します

サービス プリンシパルの作成

サービス プリンシパルは、アプリケーション、ホステッド サービス、自動ツールを使用して Azure リソースにアクセスするために作成された ID です。 このアクセスはサービス プリンシパルに割り当てられているロールに制限されるため、どのリソースに、どのレベルでアクセスできるかを制御することができます。

サービス プリンシパルを作成するには、Cloud Shell (bash) に移動し、次のコマンドを実行します。 <service-principal-name> をサービス プリンシパルの名前に、 <your-subscription-id> をサブスクリプション ID に、 <your-resource-group> を Web アプリのリソース グループに置き換えます。

az ad sp create-for-rbac --display-name <service-principal-name> --role contributor --scopes /subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>

このコマンドは、次の例のような JSON オブジェクトを返します。

{
  "clientId": "<client GUID>",
  "clientSecret": "<string-value>",
  "subscriptionId": "<subscription GUID>",
  "tenantId": "<tenant GUID>",
  ...
}

clientId、 clientSecret、 subscriptionId、および tenantId の値をメモします。 これらの値は、次のセクションでサービス接続を作成するために必要です。

1. プロジェクト ページで、 [プロジェクト設定]を選択します。

   

2. メニューの [パイプライン] セクションで、 [サービス接続] を選択します。

3. サービス接続の作成を選択します。

4. [Azure Resource Manager] を選択し、 [次へ] を選択します。

   

5. 認証方法を選択し、 [次へ] を選択します。

6. [新しい Azure サービス接続] ダイアログで、選択した認証方法に固有の情報を入力します。 認証方法の詳細については、「Azure Resource Manager サービス接続を使用して Azure に接続する」を参照してください。

   たとえば、 ワークロード ID フェデレーション (自動) または サービス プリンシパル (自動) 認証方法を使用している場合は、必要な情報を入力します。

   

   フィールド	説明
   スコープのレベル	[サブスクリプション] を選択します。
   サブスクリプション	Azure サブスクリプション名。
   リソース グループ	Web アプリを含むリソース グループの名前。
   サービス接続名	接続のわかりやすい名前。
   すべてのパイプラインへのアクセス許可を与える	すべてのパイプラインへのアクセスを許可するには、このオプションを選択します。

7. [保存] を選択します。

新しい接続が [サービス接続] の一覧に表示され、Azure Pipeline で使用可能な状態になります。

1. プロジェクト ページで、 [プロジェクト設定]を選択します。

   

2. メニューの [パイプライン] セクションで、 [サービス接続] を選択します。

3. サービス接続の作成を選択します。

4. [Azure Resource Manager] を選択し、 [次へ] を選択します。

   

5. [新しい Azure サービス接続] で、 サービス プリンシパル (手動) を選択し、 [次へ]を選択します

6. 次のダイアログで、必要な情報を入力します。

   

   フィールド	説明
   Environment	[Azure Cloud] を選択します。
   スコープのレベル	[サブスクリプション] を選択します。
   サブスクリプション ID	サブスクリプション ID。
   サブスクリプション名	Azure サブスクリプション名。
   サービス プリンシパル ID	az ad sp create-for-rbac コマンドにより返される JSON からの appId 値。
   サービス プリンシパルのキー	az ad sp create-for-rbac コマンドにより返される JSON からの password 値。
   テナント ID	az ad sp create-for-rbac コマンドにより返される JSON からの tenant 値。

7. [確認] を選択して、接続を確認します。

8. サービス接続名を入力します。

9. [すべてのパイプラインへのアクセス許可を与える] が選択されていることを確認します。

10. [Verify and save] を選択します。

新しい接続が [サービス接続] の一覧に表示され、Azure Pipelines でプロジェクトから使用できるようになります。

セルフホステッド エージェントを構成する

独自のセルフホステッド エージェントを使用している場合は、Python を実行するようにエージェントを構成する必要があります。 セルフホステッド エージェントでは、Python バージョンのダウンロードはサポートされていません。 Python バージョンをプレインストールする必要があります。 完全なインストーラーを使用して、Python の pip 互換バージョンを取得します。

互換性のない問題を回避するには、Python のバージョンを Azure App Services Web アプリのランタイム バージョンと一致させる必要があります。 ランタイム バージョンは、 az webapp up コマンドの JSON 出力に表示されます。

目的の Python バージョンをセルフホステッド エージェントのツール キャッシュに追加して、タスクで使用できるようにする必要があります。 通常、ツール キャッシュはエージェントの _work/_tool ディレクトリの下にあります。または、環境変数 AGENT_TOOLSDIRECTORY でパスをオーバーライドすることもできます。 ツール ディレクトリの下に、Python のバージョンに基づいて次のディレクトリ構造を作成します。

$AGENT_TOOLSDIRECTORY/
    Python/
        {version number}/
            {platform}/
                {tool files}
            {platform}.complete

バージョン番号は、1.2.3 の形式に従う必要があります。 プラットフォームは x86 または x64 です。 ツール ファイルは、解凍された Python バージョン ファイルである必要があります。 {platform}.complete は、 x86.complete や x64.complete のような 0 バイトのファイルで、ツールがキャッシュに正しくインストールされていることを示すだけです。

たとえば、64 ビット Windows マシンで Python 3.11 を使用している場合、ディレクトリ構造は次のようになります。

$AGENT_TOOLSDIRECTORY/
    Python/
        3.11.4/
            x64/
                {python files}
            x64.complete

エージェントをホストしているコンピューターで使用する Python バージョンが既にある場合は、ツール キャッシュにファイルをコピーできます。 Python バージョンがない場合は、 Python Web サイトからダウンロードできます。

1. 左側のナビゲーション メニューで、 [パイプライン]を選択します。

   

2. [Create Pipeline] を選択します。

   

3. [コードはどこにありますか?] ダイアログで、 [GitHub]を選択します。 GitHub へのサインインを求められる場合があります。

   

4. [リポジトリの選択] 画面で、フォークされたサンプル リポジトリを選択します。

   

5. 確認として、GitHub のパスワードをもう一度入力するように求められる場合があります。

6. Azure Pipelines 拡張機能が GitHub にインストールされていない場合は、 Azure Pipelines 拡張機能をインストールするように求められます。

   

   このページで、 [リポジトリ アクセス] セクションまで下にスクロールし、拡張機能をすべてのリポジトリにインストールするか、選択したリポジトリのみにインストールするかを選択し、 [承認してインストール] を選択します。

   

7. [パイプラインの構成] ダイアログで、 [Python to Linux Web App on Azure] (Python を Azure 上の Linux Web アプリに) を選択します。

8. Azure サブスクリプションを選択し、 [続行] を選択します。

9. 認証にユーザー名とパスワードを使用している場合は、ブラウザーが開き、Microsoft アカウントにサインインできます。

10. ドロップダウン リストから Web アプリ名を選択し、 [検証と構成] を選択します。

Azure Pipelines によって azure-pipelines.yml ファイルが作成され、YAML パイプライン エディターに表示されます。 パイプライン ファイルにより、CI/CD パイプラインが一連の ステージ、 ジョブ、および ステップとして定義され、各ステップにはさまざまな タスク と スクリプトの詳細情報が含まれます。 パイプラインを調べて、何が行われているかを確認します。 すべての既定の入力が自分のコードに適していることを確認します。

1. ナビゲーション メニューで、 [パイプライン]を選択します。

   

2. [Create Pipeline] を選択します。

   

3. [コードはどこにありますか?] ダイアログで、 [GitHub Enterprise Server] を選択します。 GitHub へのサインインを求められる場合があります。

   

4. [リポジトリの選択] タブで、フォークされたサンプル リポジトリを選択します。

   

5. 確認として、GitHub のパスワードをもう一度入力するように求められる場合があります。

6. Azure Pipelines 拡張機能が GitHub にインストールされていない場合は、 Azure Pipelines 拡張機能をインストールするように求められます。

   

   このページで、 [リポジトリ アクセス] セクションまで下にスクロールし、拡張機能をすべてのリポジトリにインストールするか、選択したリポジトリのみにインストールするかを選択し、 [承認してインストール] を選択します。

   

7. [パイプラインの構成] ダイアログで、 [スタート パイプライン]を選択します。

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

   trigger:
   - main
   
   variables:
     # Azure Resource Manager connection created during pipeline creation
     azureServiceConnectionId: '<your-service-connection-name>'
   
     # Web app name
     webAppName: '<your-web-app-name>'
   
     # Environment name
     environmentName: '<your-web-app-name>'
   
     # Project root folder. 
     projectRoot: $(System.DefaultWorkingDirectory)
   
     # Python version: 
     pythonVersion: '<your-python-version>'
   
   stages:
   - stage: Build
     displayName: Build stage
     jobs:
     - job: BuildJob
       pool:
         name: '<your-pool-name>'
         demands: python
       steps:
       - task: UsePythonVersion@0
         inputs:
           versionSpec: '$(pythonVersion)'
         displayName: 'Use Python $(pythonVersion)'
   
       - script: |
           python -m venv antenv
           source antenv/bin/activate
           python -m pip install --upgrade pip
           pip install -r requirements.txt
         workingDirectory: $(projectRoot)
         displayName: "Install requirements"
   
       - task: ArchiveFiles@2
         displayName: 'Archive files'
         inputs:
           rootFolderOrFile: '$(projectRoot)'
           includeRootFolder: false
           archiveType: zip
           archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
           replaceExistingArchive: true
   
       - task: PublishBuildArtifacts@1
         inputs:
           PathtoPublish: '$(Build.ArtifactStagingDirectory)'
           ArtifactName: 'drop'
           publishLocation: 'Container'
   
   - stage: Deploy
     displayName: 'Deploy Web App'
     dependsOn: Build
     condition: succeeded()
     jobs:
     - deployment: DeploymentJob
       pool:
         name: '<your-pool-name'
       environment: $(environmentName)
       strategy:
         runOnce:
           deploy:
             steps:
   
             - task: UsePythonVersion@0
               inputs:
                 versionSpec: '$(pythonVersion)'
               displayName: 'Use Python version'
   
             - task: AzureWebApp@1
               displayName: 'Deploy Azure Web App : <your-web-app-name>'
               inputs:
                 azureSubscription: $(azureServiceConnectionId)
                 appName: $(webAppName)
                 package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
                 startUpCommand: 'startup.txt'
   
   

9. 以下のプレースホルダーを実際の値に置き換えます。

   プレースホルダー	説明
   <your-service-connection-name>	作成したサービス接続の名前。
   <your-web-app-name>	Azure App Service Web アプリの名前。
   <your-pool-name>	使用するエージェント プールの名前。
   <your-python-version>	エージェントで実行されている Python のバージョン。 このバージョンを Web アプリで実行されている Python バージョンと一致させることをお勧めします。 Web アプリのバージョンは、 az webapp up コマンドの JSON 出力に表示されます。

パイプライン YAML ファイルの完全な例を次に示します。

trigger:
- main

variables:
  # Azure Resource Manager connection created during pipeline creation
  azureServiceConnectionId: '<GUID>'

  # Web app name
  webAppName: '<your-webapp-name>'

  # Agent VM image name
  vmImageName: 'ubuntu-latest'

  # Environment name
  environmentName: '<your-webapp-name>'

  # Project root folder. Point to the folder containing manage.py file.
  projectRoot: $(System.DefaultWorkingDirectory)

  pythonVersion: '3.11'

stages:
- stage: Build
  displayName: Build stage
  jobs:
  - job: BuildJob
    pool:
      vmImage: $(vmImageName)
    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python $(pythonVersion)'

    - script: |
        python -m venv antenv
        source antenv/bin/activate
        python -m pip install --upgrade pip
        pip install setup
        pip install -r requirements.txt
      workingDirectory: $(projectRoot)
      displayName: "Install requirements"

    - task: ArchiveFiles@2
      displayName: 'Archive files'
      inputs:
        rootFolderOrFile: '$(projectRoot)'
        includeRootFolder: false
        archiveType: zip
        archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
        replaceExistingArchive: true

    - upload: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
      displayName: 'Upload package'
      artifact: drop

- stage: Deploy
  displayName: 'Deploy Web App'
  dependsOn: Build
  condition: succeeded()
  jobs:
  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)
    strategy:
      runOnce:
        deploy:
          steps:

          - task: UsePythonVersion@0
            inputs:
              versionSpec: '$(pythonVersion)'
            displayName: 'Use Python version'

          - task: AzureWebApp@1
            displayName: 'Deploy Azure Web App : $(webAppName)'
            inputs:
              azureSubscription: $(azureServiceConnectionId)
              appName: $(webAppName)
              package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip

variables セクションには、以下の変数が含まれています。

variables:
# Azure Resource Manager connection created during pipeline creation
azureServiceConnectionId: '<GUID>'

# Web app name
webAppName: '<your-webapp-name>'

# Agent VM image name
vmImageName: 'ubuntu-latest'

# Environment name
environmentName: '<your-webapp-name>'

# Project root folder.
projectRoot: $(System.DefaultWorkingDirectory)

# Python version: 3.11. Change this to match the Python runtime version running on your web app.
pythonVersion: '3.11'

variables セクションには、以下の変数が含まれています。

variables:
# Azure Resource Manager connection created during pipeline creation
azureServiceConnectionId: '<your-service-connection-name>'

# Web app name
webAppName: '<your-webapp-name>'

# Environment name
environmentName: '<your-webapp-name>'

# Project root folder. 
projectRoot: $(System.DefaultWorkingDirectory)

# Python version: 3.11. Change this to the version that is running on your agent and web app.
pythonVersion: '3.11'

ビルド ステージには、vmImageName 変数で定義されているオペレーティング システムで実行される 1 つのジョブが含まれています。

  - job: BuildJob
    pool:
      vmImage: $(vmImageName)

ビルド ステージには、name パラメーターで識別されるプール内のエージェントで実行される 1 つのジョブが含まれています。 エージェントの機能は、 demands キーワードで指定できます。 たとえば、 demands: python エージェントに Python がインストールされている必要があることを指定します。 セルフホステッド エージェントを名前で指定するには、 demands: Agent.Name -equals <agent-name> キーワードを使用できます。

  - job: BuildJob
    pool:
      name: <your-pool-name>
      demands: python

  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)

  - deployment: DeploymentJob
    pool:
      name: <your-pool-name>
    environment: $(environmentName)

パイプライン内の steps は以下のとおりです。

1. UsePythonVersion タスクを使用して、エージェントで使用する Python のバージョンを指定します。 バージョンは pythonVersion 変数で定義されます。

    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python version'
   

2. AzureWebApp@1 を使用して Web アプリをデプロイします。 このタスクは、パイプライン成果物 drop を Web アプリにデプロイします。

   - task: AzureWebApp@1
      displayName: 'Deploy Azure Web App : <your-web-app-name>'
      inputs:
         azureSubscription: $(azureServiceConnectionId)
         appName: $(webAppName)
         package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
   

   パラメーター	説明
   azureSubscription	使用する Azure Resource Manager サービス接続の ID または名前。
   appName	Web アプリの名前。
   package	デプロイする .zip ファイルの場所。

   また、 python-vscode-flask-tutorial リポジトリには、 startup.txt という名前のファイルに同じスタートアップ コマンドが含まれているため、パラメーター startUpCommand: 'startup.txt'を追加してそのファイルを指定できます。

パイプライン内の steps は以下のとおりです。

1. UsePythonVersion タスクを使用して、エージェントで使用する Python のバージョンを指定します。 バージョンは pythonVersion 変数で定義されます。

    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python version'
   

2. AzureWebApp@1 を使用して Web アプリをデプロイします。 このタスクは、パイプライン成果物 drop を Web アプリにデプロイします。

   - task: AzureWebApp@1
      displayName: 'Deploy Azure Web App : <your-web-app-name>'
      inputs:
         azureSubscription: $(azureServiceConnectionId)
         appName: $(webAppName)
         package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
   

   パラメーター	説明
   azureSubscription	使用する Azure Resource Manager サービス接続の ID または名前。
   appName	Web アプリの名前。
   package	デプロイする .zip ファイルの場所。

   また、 python-vscode-flask-tutorial リポジトリには、 startup.txt という名前のファイルに同じスタートアップ コマンドが含まれているため、パラメーター startUpCommand: 'startup.txt'を追加してそのファイルを指定できます。

     - task: AzureWebApp@1
        displayName: 'Deploy Azure Web App : $(webAppName)'
        inputs:
          azureSubscription: $(azureServiceConnectionId)
          appName: $(webAppName)
          package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
          startUpCommand: 'startup.txt'
   

   パラメーター	説明
   azureSubscription	使用する Azure Resource Manager サービス接続の ID または名前。
   appName	Web アプリの名前。
   package	デプロイする .zip ファイルの場所。
   startUpCommand	アプリのデプロイ後に実行するコマンド。 サンプル アプリでは、 startup.txtを使用しています。