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

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

セルフホステッド ビルド エージェントでは、Python バージョンのダウンロードはサポートされていません。 独自のセルフホステッド エージェントを使用するには、Python を実行するようにエージェントを構成する必要があります。

互換性の問題を回避するには、Python のバージョンを Azure App Services Web アプリのランタイム バージョンと一致させます (この場合 3.11 )。 Python バージョンをプレインストールする必要があります。 完全なインストーラーを使用して、Python の pip 互換バージョンを取得します。

パイプライン タスクで使用できるように、目的の Python バージョンをセルフホステッド エージェントのツール キャッシュに追加する必要があります。 通常、ツール キャッシュはエージェントの _work/_tool ディレクトリにあります。 または、環境変数 AGENT_TOOLSDIRECTORYでパスをオーバーライドすることもできます。 tools ディレクトリの下に、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 サイトからダウンロードできます。

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

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

サービス プリンシパルを作成するには、Bash Cloud Shell で次のコマンドを実行します。 <service-principal-name>をサービス プリンシパルの名前に置き換え、<your-subscription-id>を Azure サブスクリプション 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 オブジェクトを返します。

{
  "appId": "<client GUID>",
  "displayName": "<service-principal-name">,
  "password": "<password-string>",
  "tenant": "<tenant GUID>"
  ...
}

次のセクションで、サービス接続の作成に使用する appId、 password、および tenantId の値をメモしておきます。

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

2. [プロジェクトの設定] で、[パイプライン>サービス接続] を選択します。

3. [ サービス接続 ] ページで、このサービス接続がプロジェクトの最初の接続である場合は、[ 新しい サービス接続] または [サービス接続の 作成 ] を選択します。

   

4. [ 新しいサービス接続 ] 画面で、[ Azure Resource Manager ] を選択し、[ 次へ] を選択します。

   

5. [ 新しい Azure サービス接続 ] 画面で、 ID の種類を選択します。 この例では 、推奨されるアプリ登録 (自動) を使用します。 認証方法の詳細については、「Azure Resource Manager サービス接続を使用して Azure に接続する」を参照してください。

6. [ 資格情報] で、[ ワークロード ID フェデレーション (自動)] を選択します。

7. 次のフィールドに入力します。

   • スコープ レベル: [サブスクリプション] を選択します。
   • サブスクリプション:Azure サブスクリプションを選択します。
   • リソース グループ: Web アプリを含むリソース グループを選択します。
   • サービス接続名: 接続のわかりやすい名前を入力します。
   • すべてのパイプラインにアクセス許可を付与する: プロジェクト内のすべてのパイプラインへのアクセスを許可するには、このチェック ボックスをオンにします。

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

   

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

2. [プロジェクトの設定] で、[パイプライン>サービス接続] を選択します。

3. [ サービス接続 ] ページで、このサービス接続がプロジェクトの最初の接続である場合は、[ 新しい サービス接続] または [サービス接続の 作成 ] を選択します。

   

4. [ 新しいサービス接続 ] 画面で、[ Azure Resource Manager ] を選択し、[ 次へ] を選択します。

   

5. [ サービス プリンシパル (手動)] を選択し、[ 次へ] を選択します。

   

6. [ 新しい Azure サービス接続 ] 画面で、次のフィールドに入力します。

   • 環境: Azure Cloud を選択します。
   • スコープ レベル: [サブスクリプション] を選択します。
   • サブスクリプション ID: Azure サブスクリプション ID を入力します。
   • サブスクリプション名: Azure サブスクリプション名を入力します。

7. [ 認証 ] セクションで、次のフィールドに入力します。

   • サービス プリンシパル ID: appId コマンドによって返されるaz ad sp create-for-rbac値を入力します。
   • 資格情報: サービス プリンシパル キーを選択します。
   • サービス プリンシパル キー: password コマンドによって返されるaz ad sp create-for-rbac値を入力します。
   • テナント ID: tenant コマンドによって返されるaz ad sp create-for-rbac値を入力します。
   • [確認] を選択して、接続を確認します。

8. [ 詳細 ] セクションの [ サービス接続名] に、サービス接続の名前を入力します。

9. [ すべてのパイプラインにアクセス許可を付与する] チェック ボックスをオンにします。

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

    

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

2. [パイプライン] ページ で 、[ 新しいパイプライン] を選択するか、このパイプラインがプロジェクトの最初のパイプラインである場合は [パイプラインの 作成 ] を選択します。

   

3. [コードの場所] 画面で、GitHub を選択します。 GitHub へのサインインを求められる場合があります。

   

4. [ リポジトリの選択 ] 画面で、フォークしたサンプル リポジトリを選択します。 GitHub では、GitHub パスワードをもう一度入力するか、 Azure Pipelines GitHub アプリをインストールするように求められる場合があります。 画面の指示に従ってアプリをインストールします。 詳細については、「 GitHub アプリ認証」を参照してください。

   

5. [ パイプラインの構成 ] ページで、 Python から Linux Web App on Azure を選択します。

6. 次の画面で、Azure サブスクリプションを選択し、[ 続行] を選択します。

7. 次の画面で、Azure Web アプリを選択し、[ 検証と構成] を選択します。

Azure Pipelines によって azure-pipelines.yml ファイルが作成され、YAML パイプライン エディターに表示されます。

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

2. [パイプライン] ページ で 、[ 新しいパイプライン] を選択するか、このパイプラインがプロジェクトの最初のパイプラインである場合は [パイプラインの 作成 ] を選択します。

   

3. [コードの場所] ページで、GitHub Enterprise Server を選択します。 GitHub へのサインインを求められる場合があります。

   

4. [ リポジトリの選択 ] タブで、フォークしたサンプル リポジトリを選択します。 GitHub では、GitHub パスワードをもう一度入力するか、 Azure Pipelines GitHub 拡張機能またはアプリをインストールするように求められる場合があります。 画面の指示に従ってアプリをインストールします。 詳細については、「Github リポジトリへのアクセス」を参照してください。

   

5. [ パイプラインの構成 ] ページで、[ スターター パイプライン] を選択します。

6. [ パイプライン YAML の確認 ] ページで、スターター azure-pipelines.yml ファイルの内容を次の YAML パイプライン ファイルに置き換えます。 YAML ファイルで次の手順を実行します。

   • <your-service-connection-name>と<your-web-app-name>のプレースホルダーを独自の値に置き換えます。

   • <your-pool-name>を使用するエージェント プールの名前に置き換え、<your-python-version>をエージェントで実行されている Python のバージョンに置き換えます。 このバージョンは、runtime_version コマンドの JSON 出力のaz webapp upと一致している必要があります。

次の完全な YAML パイプライン ファイルの例では、CI/CD パイプラインを一連の ステージ、 ジョブ、 およびステップとして定義します。各ステップには、さまざまな タスク とスクリプトの詳細が含 まれています。 生成された 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 setuptools
        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

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'

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

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

ビルド ステージには、pool パラメーターによって識別される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 キーワードは、ジョブがデプロイ先の環境を対象とするデプロイ ジョブであることを示します。 environmentは、ジョブの実行時にプロジェクトに自動的に作成されます。

• pool パラメーターはデプロイ エージェント プールを指定し、nameが指定されていない場合は既定のエージェント プールを使用します。 エージェントは、 vmImageName 変数で定義されているオペレーティング システム (この場合は ubuntu-latest) で実行されます。

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

• deployment キーワードは、ジョブがデプロイ先の環境を対象とするデプロイ ジョブであることを示します。 environmentは、ジョブの実行時にプロジェクトに自動的に作成されます。

• pool パラメーターはデプロイ エージェント プールを指定し、パイプラインで指定された Python バージョンを実行する機能を持つエージェントを含める必要があります。