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

Azure DevOps Services

継続的インテグレーションと継続的デリバリー (CI/CD) のために、Azure Pipelines を使用して Python Web アプリをビルドし、Linux 上の Azure App Service にデプロイします。 パイプラインはリポジトリへのコミットがあるたびに、自動的に Python Web アプリをビルドして App Service にデプロイします。

この記事では、次のことについて説明します。

• Azure App Service で Web アプリを作成する。
• Azure DevOps でのプロジェクトの作成。
• DevOps プロジェクトを Azure に接続します。
• Python 固有のパイプラインを作成します。
• パイプラインを実行してアプリをビルドし、App Service のウェブ アプリにデプロイします。

前提条件

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

アプリ コード用のリポジトリを作成する

https://github.com/Microsoft/python-sample-vscode-flask-tutorial にあるサンプル リポジトリを、GitHub アカウントにフォークします。

ローカル ホストで、GitHub リポジトリを複製します。 次のコマンドを使用し、 <repository-url> をフォークされたリポジトリの URL に置き換えます。

git clone <repository-url>

アプリをローカルにテストする

アプリをローカルにビルドおよび実行して、動作することを確認します。

1. 複製したリポジトリ フォルダに変更します。

   cd python-sample-vscode-flask-tutorial
   

2. アプリをビルドして実行する

   Linux

   python -m venv .env
   source .env/bin/activate
   pip install --upgrade pip
   pip install -r ./requirements.txt
   export set FLASK_APP=hello_app.webapp
   python3 -m flask run
   

   PowerShell

   py -m venv .env
   .env\scripts\activate
   pip install -r ./requirements.txt
   $env:FLASK_APP = "hello_app.webapp"
   flask run
   

3. アプリを表示するには、ブラウザー ウィンドウを開き、 http://localhost:5000に移動します。 Visual Studio Flask Tutorial というタイトルが表示されることを確認します。

4. 完了したら、ブラウザー ウィンドウを閉じ、 Ctrl+C で Flask サーバーを停止します。

Cloud Shell を開く

1. Azure Portal ( https://portal.azure.com ) にサインインします。

2. ポータルのツールバーの [Cloud Shell] ボタンを選択して、Azure CLI を開きます。

   

3. Cloud Shell がブラウザーの下部に表示されます。 ドロップダウン メニューから、 [Bash] を選択します。

   

4. 作業するスペースを増やすには、最大化ボタンを選択します。

Azure App Service Web アプリを作成する

Azure ポータルの Cloud Shell から Azure App Service Web アプリを作成します。

ヒント

Cloud Shell に貼り付けるには、 Ctrl+Shift+V を使用するか、右クリックしてコンテキスト メニューから [貼り付け] を選択します。

1. 次のコマンドを使用してリポジトリを複製します。 <repository-url> をフォークされたリポジトリの URL に置き換えます。

   git clone <repository-url>
   

2. 複製されたリポジトリ フォルダーにディレクトリを変更して、 az webapp up コマンドによってアプリが Python アプリとして認識されるようにします。

   cd python-sample-vscode-flask-tutorial
   

3. az webapp up コマンドを使用して、App Service のプロビジョニングとアプリの最初のデプロイの両方を行います。 <your-web-app-name> を Azure 全体で一意の名前に置き換えます。 通常は、個人または会社の名前と共に、アプリの識別子を使います (例: <your-name>-flaskpipelines)。 アプリの URL が、 <your-appservice>.azurewebsites.netになります。

   az webapp up --name <your-web-app-name>
   

   az webapp up コマンドの JSON 出力に、次の情報が表示されます。

   {
     "URL": <your-web-app-url>,
     "appserviceplan": <your-app-service-plan-name>,
     "location": <your-azure-location>,
     "name": <your-web-app-name>,
     "os": "Linux",
     "resourcegroup": <your-resource-group>,
     "runtime_version": "python|3.11",
     "runtime_version_detected": "-",
     "sku": <sku>,
     "src_path": <repository-source-path>
   }
   

   URL と runtime_version の値をメモします。 パイプライン YAML ファイルで runtime_version を使用します。 URL は、Web アプリの URL です。 これを使用して、アプリが実行されていることを確認できます。

   Note

   az webapp up コマンドは、次の処理を実行します。

   • 既定の リソース グループを作成する。

   • 既定の App Service プランを作成する。

   • 指定された名前でアプリを作成 する。

   • ビルド自動化を有効にして、現在の作業ディレクトリからすべてのファイルを Zip デプロイ します。

   • 後で az webapp up またはプロジェクト フォルダー内の他の az webapp コマンドを使用してデプロイするときに再指定する必要がないように、パラメーターを .azure/config ファイルにローカルにキャッシュします。 キャッシュされた値は、既定で自動的に使用されます。

   コマンド パラメーターを使用して、既定のアクションを独自の値でオーバーライドできます。 詳細については、「az webapp up」を参照してください。

4. python-sample-vscode-flask-tutorial アプリには、Web アプリの特定のスタートアップ コマンドを含む startup.txt ファイルがあります。 Web アプリの構成プロパティ startup-file を startup.txt に設定します。

   1. az webapp up コマンドの出力から、 resourcegroup 値をコピーします。

   2. リソース グループとアプリ名を使用して、次のコマンドを入力します。

   az webapp config set --resource-group <your-resource-group> --name <your-web-app-name> --startup-file startup.txt
   

   コマンドが完了すると、Web アプリのすべての設定を含む JSON 出力が表示されます。

5. 実行中のアプリを表示するには、ブラウザーを開き、 az webapp up コマンド出力に示されている URL に移動します。 汎用ページが表示される場合は、App Service が起動するまで数秒待ってから、ページを更新します。 Visual Studio Flask Tutorial というタイトルが表示されることを確認します。

Azure DevOps プロジェクトの作成

新しい Azure DevOps プロジェクトを作成します。

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

サービス接続を作成する

サービス接続を使用すると、Azure Pipelines から外部およびリモート サービスへの認証済みアクセスを提供する接続を作成できます。 Azure App Service Web アプリにデプロイするには、Web アプリを含むリソース グループへのサービス接続を作成します。

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

   

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

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

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

   

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

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

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

   

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

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

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

パイプラインを作成する

パイプラインを作成して Python Web アプリをビルドし、Azure App Service にデプロイします。 パイプラインの概念を理解するには、以下をご覧ください。

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 パイプラインが一連の ステージ、 ジョブ、および ステップとして定義され、各ステップにはさまざまな タスク と スクリプトの詳細情報が含まれます。 パイプラインを調べて、何が行われているかを確認します。 すべての既定の入力が自分のコードに適していることを確認します。

YAML パイプライン ファイル

以下では、YAML パイプライン ファイルについて説明します。 パイプライン YAML ファイル スキーマについては、「YAML スキーマ リファレンス」を参照してください。

変数

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

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

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

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

# Environment name
environmentName: '<your-web-app-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'

変数	説明
azureServiceConnectionId	Azure Resource Manager サービス接続の ID または名前。
webAppName	Azure App Service Web アプリの名前。
vmImageName	ビルド エージェントに使用するオペレーティング システムの名前。
environmentName	デプロイ ステージで使用される環境の名前。 ステージ ジョブが実行されると、環境は自動的に作成されます。
projectRoot	アプリ コードを含むルート フォルダー。
pythonVersion	ビルドおよびデプロイ エージェントで使用する Python のバージョン。

ビルド ステージ

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

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

ジョブには複数のステップが含まれています。

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

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

2. このステップでは、スクリプトを使用して仮想 Python 環境を作成し、 requirements.txt ファイルに含まれるアプリの依存関係をインストールします。 --target パラメーターは、依存関係をインストールする場所を指定します。 workingDirectory パラメーターは、アプリ コードの場所を指定します。

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

3. ArchiveFiles タスクは、Web アプリを含む .zip アーカイブを作成します。 .zip ファイルは、 dropという名前の成果物としてパイプラインにアップロードされます。 .zip ファイルは、Web アプリにアプリをデプロイするためにデプロイ ステージで使用されます。

      - 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
   

   パラメーター	説明
   rootFolderOrFile	アプリ コードの場所。
   includeRootFolder	ルート フォルダーを .zip ファイルに含めるかどうかを示します。 このパラメーターを false に設定します。そうしない場合は、 .zip ファイルの内容が s という名前のフォルダーに格納され、App Service on Linux コンテナーはアプリ コードを見つけられません。
   archiveType	作成するアーカイブの種類。 zip に設定します。
   archiveFile	作成する .zip ファイルの場所。
   replaceExistingArchive	ファイルが既に存在する場合に、既存のアーカイブを置き換えるかどうかを示します。 true に設定します。
   upload	アップロードする .zip ファイルの場所。
   artifact	作成する成果物の名前。

展開ステージ

デプロイ ステージは、ビルド ステージが正常に完了した場合に実行されます。 次のキーワードでこの動作を定義します。

  dependsOn: Build
  condition: succeeded()

デプロイ ステージには、次のキーワードで構成された 1 つのデプロイ ジョブが含まれています。

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

キーワード	説明
deployment	ジョブが 環境を対象とする デプロイ ジョブ であることを示します。
pool	デプロイ エージェント プールを指定します。 名前が指定されていない場合の既定のエージェント プール。 vmImage キーワードは、エージェントの仮想マシン イメージ用のオペレーティング システムを特定します
environment	デプロイ先の環境を指定します。 ジョブが実行されると、環境はプロジェクト内に自動的に作成されます。

strategy キーワードは、デプロイ戦略の定義に使用されます。 runOnce キーワードは、デプロイ ジョブが 1 回実行されることを指定します。 deploy キーワードは、デプロイ ジョブで実行するステップを指定します。

  strategy:
    runOnce:
      deploy:
        steps:

パイプライン内の 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'を追加してそのファイルを指定できます。

パイプラインを実行する

これで、試してみる準備ができました。

1. エディターで、 [保存して実行] を選択します。

2. [保存して実行] ダイアログで、コミット メッセージを追加し、 [保存して実行] を選択します。

   パイプライン実行の概要でステージまたはジョブを選択することで、パイプラインの実行を監視できます。

   

   各ステージおよびジョブが正常に完了すると、それぞれの横に緑色のチェックマークが付きます。 エラーが発生した場合は、概要またはジョブ ステップにそれらが表示されます。

   

   YAMLエディターにすばやく戻るには、 [概要] ページの右上にある縦に並んだドットを選択し、 [パイプラインの編集]を選択します。

   

3. デプロイ ジョブから、 [Azure Web アプリのデプロイ] タスクを選択して、その出力を表示します。 デプロイされたサイトにアクセスするには、 Ctrl を押しながら、 App Service Application URLの後ろの URLを選択します。

   サンプル アプリを使用している場合、アプリは次のように表示されます。

   

重要

依存関係がないためにアプリが失敗した場合、 requirements.txt ファイルはデプロイ中に処理されませんでした。 この動作は、この記事で示すように az webapp up コマンドを使うのではなく、ポータルで Web アプリを直接作成した場合に発生します。

az webapp up コマンドは、ビルド アクション SCM_DO_BUILD_DURING_DEPLOYMENT を true に明示的に設定します。 ポータルを通じてアプリ サービスをプロビジョニングした場合、このアクションは自動的に設定されません。

次の手順でアクションが設定されます。

1. Azure portal を開き、App Service を選んでから、 [構成] を選びます。
2. [アプリケーションの設定] タブで、 [新しいアプリケーション設定]を選びます。
3. 表示されるポップアップで、 [名前] を SCM_DO_BUILD_DURING_DEPLOYMENTに設定し、 [値] を trueに設定して、 [OK]を選びます。
4. [構成] ページの上部にある [保存] を選択します。
5. パイプラインを再実行します。 デプロイの間に依存関係がインストールされるようになるはずです。

パイプラインの実行をトリガーする

パイプライン実行をトリガーするには、リポジトリに変更をコミットします。 たとえば、新しい機能をアプリに追加したり、アプリの依存関係を更新したりできます。

1. GitHub リポジトリに移動します。
2. アプリのタイトルの変更など、コードに変更を加えます。
3. 変更をリポジトリにコミットします。
4. パイプラインに移動し、新しい実行が作成されたことを確認します。
5. 実行が完了したら、新しいビルドが Web アプリにデプロイされていることを確認します。
   1. Azure Portal で、Web アプリに移動します。
   2. [デプロイ センター] を選択し、 [ログ] タブを選択します。
   3. 新しいデプロイが一覧表示されていることを確認します。

Django に関する考慮事項

別のデータベースを使用している場合は、Azure Pipelines を使用して Django アプリを Azure App Service on Linux にデプロイできます。 App Service は db.sqlite3 ファイルをロックし、読み取りと書き込みの両方を妨げるため、SQLite データベースを使うことはできません。 この動作は、外部データベースには影響しません。

App Service での Python アプリの構成の、コンテナー スタートアップ プロセスに関する記事で説明されているように、App Service はアプリ コード内で wsgi.py ファイルを自動的に検索します。このファイルには通常、アプリ オブジェクトが含まれます。 スタートアップ コマンドを何らかの方法でカスタマイズしたい場合は、前のセクションで説明したように、YAML パイプライン ファイルの AzureWebApp@1 ステップで、 startUpCommand パラメーターを使います。

Django を使うときは、通常、アプリ コードのデプロイ後に manage.py migrate を使ってデータ モデルを移行します。 この目的のために、デプロイ後のスクリプトを使用して startUpCommand を追加できます。 たとえば、AzureWebApp@1 タスクの startUpCommand プロパティを次に示します。

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

ビルド エージェントでテストを実行する

ビルド プロセスの一部として、アプリ コードでテストを実行することもできます。 テストはビルド エージェントで実行されるため、ビルド エージェントの仮想環境に依存関係をインストールする必要があります。 テストを実行した後、デプロイ用の .zip ファイルを作成する前に、仮想環境を削除します。 次のスクリプト要素は、このプロセスを示したものです。 これらを、 azure-pipelines.yml ファイルの ArchiveFiles@2 タスクの前に配置します。 詳しくは、「クロスプラットフォーム スクリプトを実行する」をご覧ください。

# The | symbol is a continuation character, indicating a multi-line script.
# A single-line script can immediately follow "- script:".
- script: |
    python -m venv .env
    source .env/bin/activate
    pip install setuptools
    pip install -r requirements.txt

  # The displayName shows in the pipeline UI when a build runs
  displayName: 'Install dependencies on build agent'

- script: |
    # Put commands to run tests here
    displayName: 'Run tests'

- script: |
    echo Deleting .env
    deactivate
    rm -rf .env
  displayName: 'Remove .env before zip'

PublishTestResults@2 などのタスクを使用して、テスト結果をパイプラインに発行することもできます。 詳しくは、 Python アプリのビルドのテストの実行に関する記事をご覧ください。

リソースをクリーンアップする

このチュートリアルで作成した Azure リソースに料金が発生しないようにするには、次の手順に従います。

• 作成したプロジェクトを削除します。 プロジェクトを削除すると、パイプラインとサービス接続が削除されます。

• App Service と App Service プランを含む Azure リソース グループを削除します。 Azure ポータルで、リソース グループに移動し、 [リソース グループの削除] を選択して、プロンプトに従います。

• Cloud Shell のファイル システムを維持するストレージ アカウントを削除します。 Cloud Shell を閉じ、 cloud-shell-storage- で始まるリソース グループに移動して、 [リソース グループの削除]を選択し、プロンプトに従います。

次のステップ

• Azure Pipelines で Python アプリをカスタマイズする
• App Service で Python アプリを構成する