チュートリアル:Azure Container Apps ジョブを使用してセルフホスト型 CI/CD ランナーとエージェントをデプロイする

[アーティクル]
11/15/2023

GitHub Actions と Azure Pipelines を使うと、セルフホステッドランナーとエージェントを使って CI/CD ワークフローを実行できます。イベントドリブンの Azure Container Apps ジョブを使って、セルフホステッドランナーとエージェントを実行できます。

セルフホステッドランナーは、クラウドホステッドランナーでは使用できないローカルリソースまたはツールへのアクセスを必要とするワークフローを実行する必要がある場合に便利です。たとえば、ワークフローで Container Apps ジョブのセルフホステッドランナーを使うと、クラウドホステッドランナーからはアクセスできないジョブの仮想ネットワーク内のリソースにアクセスできます。

セルフホステッドランナーをイベントドリブンのジョブとして実行すると、Azure Container Apps のサーバーレスの性質を利用できます。ジョブは、ワークフローがトリガーされると自動的に実行して、完了すると終了します。

支払いは、ジョブが実行している時間に対してのみです。

このチュートリアルでは、イベントドリブンの Container Apps ジョブとして GitHub Actions ランナーを実行する方法について説明します。

セルフホステッドランナーをデプロイするための Container Apps 環境を作成する
セルフホステッドランナーを使用するワークフローを実行するための GitHub リポジトリを作成する
GitHub Actions ランナーを実行するコンテナーイメージをビルドする
ランナーをジョブとして Container Apps 環境にデプロイする
セルフホステッドランナーを使用するワークフローを作成し、動作することを確認する

重要

セルフホステッドランナーは、"プライベート" リポジトリの場合にのみ推奨されます。パブリックリポジトリで使うと、セルフホステッドランナーで危険なコードが実行される可能性があります。詳しくは、「セルフホステッドランナーのセキュリティ」をご覧ください。

このチュートリアルでは、イベントドリブンの Container Apps ジョブとして Azure Pipelines エージェントを実行する方法について説明します。

セルフホステッドエージェントをデプロイするための Container Apps 環境を作成する
Azure DevOps 組織とプロジェクトを作成する
Azure Pipelines エージェントを実行するコンテナーイメージをビルドする
手動ジョブを使って Container Apps 環境にプレースホルダーエージェントを作成する
エージェントをジョブとして Container Apps 環境にデプロイする
セルフホステッドエージェントを使用するパイプラインを作成し、動作することを確認する

重要

セルフホステッドエージェントは、"プライベート" プロジェクトの場合にのみ推奨されます。パブリックプロジェクトで使うと、セルフホステッドエージェントで危険なコードが実行される可能性があります。詳しくは、セルフホステッドエージェントのセキュリティに関する記事をご覧ください。

Note

Container Apps とジョブでは、コンテナーでの Docker の実行はサポートされていません。ワークフロー内の Docker コマンドを使うステップは、Container Apps ジョブのセルフホステッドランナーまたはエージェントで実行すると失敗します。

前提条件

Azure アカウント: ない場合は、無料で作成できます。
Azure CLI: Azure CLI をインストールします。

Azure DevOps 組織: アクティブなサブスクリプションのある DevOps 組織がない場合は、無料で作成できます。

制限事項の一覧については、「ジョブの制限」をご覧ください。

設定

CLI から Azure にサインインするには、次のコマンドを実行し、プロンプトに従って認証プロセスを完了します。

Bash
Azure PowerShell

az login

Connect-AzAccount

最新バージョンの CLI を実行していることを確認するには、upgrade コマンドを実行します。

Bash
Azure PowerShell

az upgrade

Install-Module -Name Az -Scope CurrentUser -Repository PSGallery -Force

現在使用中のモジュールに関する警告は無視します。

次に、CLI 用の Azure Container Apps 拡張機能をインストールまたは更新します。

Bash
Azure PowerShell

az extension add --name containerapp --upgrade

Install-Module -Name Az.App

Az.App モジュールの古いバージョンがインストールされている場合は、更新します。

Update-Module -Name Az.App

最新の拡張機能またはモジュールがインストールされたので、Microsoft.App および Microsoft.OperationalInsights 名前空間を登録します。

Note

Azure Container Apps リソースは、Microsoft.Web 名前空間から Microsoft.App 名前空間に移行されました。詳細については、「2022 年 3 月に Microsoft.Web から Microsoft.App に名前空間を移行する」を参照してください。

Bash
Azure PowerShell

az provider register --namespace Microsoft.App

az provider register --namespace Microsoft.OperationalInsights

Register-AzResourceProvider -ProviderNamespace Microsoft.App

Register-AzResourceProvider -ProviderNamespace Microsoft.OperationalInsights

環境変数を作成する

Azure CLI のセットアップが完了したところで、この記事全体で使用される環境変数を定義できます。

Bash
PowerShell

RESOURCE_GROUP="jobs-sample"
LOCATION="northcentralus"
ENVIRONMENT="env-jobs-sample"
JOB_NAME="github-actions-runner-job"

$RESOURCE_GROUP="jobs-sample"
$LOCATION="northcentralus"
$ENVIRONMENT="env-jobs-sample"
$JOB_NAME="github-actions-runner-job"

Bash
PowerShell

RESOURCE_GROUP="jobs-sample"
LOCATION="northcentralus"
ENVIRONMENT="env-jobs-sample"
JOB_NAME="azure-pipelines-agent-job"
PLACEHOLDER_JOB_NAME="placeholder-agent-job"

$RESOURCE_GROUP="jobs-sample"
$LOCATION="northcentralus"
$ENVIRONMENT="env-jobs-sample"
$JOB_NAME="azure-pipelines-agent-job"
$PLACEHOLDER_JOB_NAME="placeholder-agent-job"

Container Apps 環境を作成する

Azure Container Apps 環境は、コンテナーアプリとジョブを囲む安全な境界として機能するため、同じネットワークを共有したり、相互に通信したりすることができます。

Note

既存の仮想ネットワークと統合された Container Apps 環境の作成については、「内部の Azure Container Apps 環境に仮想ネットワークを提供する」をご覧ください。

リソースグループを作成するには、次のコマンドを使用します。

Bash
PowerShell

az group create \
    --name "$RESOURCE_GROUP" \
    --location "$LOCATION"

az group create `
    --name "$RESOURCE_GROUP" `
    --location "$LOCATION"

次のコマンドを使用して、Container Apps 環境を作成します。

Bash
PowerShell

az containerapp env create \
    --name "$ENVIRONMENT" \
    --resource-group "$RESOURCE_GROUP" \
    --location "$LOCATION"

az containerapp env create `
    --name "$ENVIRONMENT" `
    --resource-group "$RESOURCE_GROUP" `
    --location "$LOCATION"

ワークフローを実行するための GitHub リポジトリを作成する

ワークフローを実行するには、ワークフローの定義を含む GitHub リポジトリを作成する必要があります。

GitHub に移動し、サインインします。

次の値を入力して、新しいリポジトリを作成します。

設定	値
所有者	GitHub のユーザー名を選びます。
リポジトリ名です	リポジトリの名前を入力します。
表示	[プライベート] を選択します。
Initialize this repository with (このリポジトリの初期化方法)	[README ファイルを追加する] を選択します。

残りの値は既定の選択のままにします。

[Create repository] (リポジトリの作成) を選択します。
新しいリポジトリで、[Actions] (アクション) を選びます。
Simple workflow (シンプルワークフロー) テンプレートを検索して、[Configure] (構成) を選びます。
[Commit changes] (変更のコミット) を選んで、ワークフローをリポジトリに追加します。

ワークフローは、ubuntu-latest GitHub ホステッドランナーで実行されて、コンソールにメッセージを出力します。後で、GitHub ホステッドランナーをセルフホステッドランナーに置き換えます。

GitHub の個人用アクセストークンを取得する

セルフホステッドランナーを実行するには、GitHub で個人用アクセストークン (PAT) を作成する必要があります。ランナーが開始するたびに、PAT を使って、GitHub にランナーを登録するためのトークンが生成されます。 PAT は、リポジトリのワークフローキューを監視し、必要に応じてランナーを開始するために、GitHub Actions ランナースケールルールでも使われます。

GitHub の右上隅にある自分のプロファイル画像を選んで、[Settings] (設定) を選びます。
[Developper settings] (開発者設定) を選択します。
[Personal access tokens] (個人用アクセストークン) で、[Fine-grained tokens] (詳細なトークン) を選びます。
[新しいトークンの生成] を選択します。

[New fine-grained personal access token] (新しい詳細な個人用アクセストークン) 画面で、次の値を入力します。

設定	値
トークン名	トークンの名前を入力します。
[有効期限]	[30 days] (30 日) を選びます。
リポジトリアクセス	[Only select repositories] (リポジトリの選択のみ) を選んで、作成したリポジトリを選びます。

[Repository permissions] (リポジトリのアクセス許可) に次の値を入力します。

設定	値
アクション	[Read-only] (読み取りのみ) を選びます。
管理	[Read and write] (読み取りと書き込み) を選びます。
Metadata	[Read-only] (読み取りのみ) を選びます。

[Generate token](トークンの生成) を選択します。
トークンの値をコピーします。

後でランナーとスケールルールを構成するために使われる変数を定義します。

Bash
PowerShell

GITHUB_PAT="<GITHUB_PAT>"
REPO_OWNER="<REPO_OWNER>"
REPO_NAME="<REPO_NAME>"

$GITHUB_PAT="<GITHUB_PAT>"
$REPO_OWNER="<REPO_OWNER>"
$REPO_NAME="<REPO_NAME>"

プレースホルダーを次の値に置き換えます。

プレースホルダー	値
`<GITHUB_PAT>`	生成した GitHub PAT。
`<REPO_OWNER>`	前に作成したリポジトリの所有者。通常、この値は GitHub のユーザー名です。
`<REPO_NAME>`	前に作成したリポジトリの名前。この値は、[Repository name] (リポジトリ名) フィールドに入力した名前と同じです。

GitHub Actions ランナーのコンテナーイメージをビルドする

セルフホステッドランナーを作成するには、ランナーを実行するコンテナーイメージをビルドする必要があります。このセクションでは、コンテナーイメージをビルドして、コンテナーレジストリにそれをプッシュします。

Note

このチュートリアルでビルドするイメージには、Container Apps ジョブとして実行するのに適した基本的なセルフホステッドランナーが含まれています。ワークフローに必要な追加のツールや依存関係を含むようにカスタマイズできます。

コンテナーイメージとレジストリの名前を定義します。
- Bash
- PowerShell
```
CONTAINER_IMAGE_NAME="github-actions-runner:1.0"
CONTAINER_REGISTRY_NAME="<CONTAINER_REGISTRY_NAME>"
```
```
$CONTAINER_IMAGE_NAME="github-actions-runner:1.0"
$CONTAINER_REGISTRY_NAME="<CONTAINER_REGISTRY_NAME>"
```
<CONTAINER_REGISTRY_NAME> を、コンテナーレジストリを作成するための一意の名前に置き換えます。コンテナーレジストリ名は、"Azure 内で一意" であり、数字と小文字のみを含む 5 文字から 50 文字の長さにする必要があります。

コンテナーレジストリを作成します。

Bash
PowerShell

az acr create \
    --name "$CONTAINER_REGISTRY_NAME" \
    --resource-group "$RESOURCE_GROUP" \
    --location "$LOCATION" \
    --sku Basic \
    --admin-enabled true

az acr create `
    --name "$CONTAINER_REGISTRY_NAME" `
    --resource-group "$RESOURCE_GROUP" `
    --location "$LOCATION" `
    --sku Basic `
    --admin-enabled true

ランナーイメージを作成するための Dockerfile は、GitHub で入手できます。次のコマンドを実行してリポジトリをクローンし、クラウドで az acr build コマンドを使ってコンテナーイメージを構築します。

Bash
PowerShell

az acr build \
    --registry "$CONTAINER_REGISTRY_NAME" \
    --image "$CONTAINER_IMAGE_NAME" \
    --file "Dockerfile.github" \
    "https://github.com/Azure-Samples/container-apps-ci-cd-runner-tutorial.git"

az acr build `
    --registry "$CONTAINER_REGISTRY_NAME" `
    --image "$CONTAINER_IMAGE_NAME" `
    --file "Dockerfile.github" `
    "https://github.com/Azure-Samples/container-apps-ci-cd-runner-tutorial.git"

これで、コンテナーレジストリでイメージを使用できるようになります。

セルフホステッドランナーをジョブとしてデプロイする

これで、コンテナーイメージを使うためのジョブを作成できます。このセクションでは、セルフホステッドランナーを実行し、前に生成した PAT を使って GitHub での認証を行うジョブを作成します。このジョブでは、github-runner スケールルールを使い、保留中のワークフロー実行の数に基づいてジョブの実行を作成します。

Container Apps 環境でジョブを作成します。

Bash
PowerShell

az containerapp job create -n "$JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" \
    --trigger-type Event \
    --replica-timeout 1800 \
    --replica-retry-limit 0 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" \
    --min-executions 0 \
    --max-executions 10 \
    --polling-interval 30 \
    --scale-rule-name "github-runner" \
    --scale-rule-type "github-runner" \
    --scale-rule-metadata "githubAPIURL=https://api.github.com" "owner=$REPO_OWNER" "runnerScope=repo" "repos=$REPO_NAME" "targetWorkflowQueueLength=1" \
    --scale-rule-auth "personalAccessToken=personal-access-token" \
    --cpu "2.0" \
    --memory "4Gi" \
    --secrets "personal-access-token=$GITHUB_PAT" \
    --env-vars "GITHUB_PAT=secretref:personal-access-token" "GH_URL=https://github.com/$REPO_OWNER/$REPO_NAME" "REGISTRATION_TOKEN_API_URL=https://api.github.com/repos/$REPO_OWNER/$REPO_NAME/actions/runners/registration-token" \
    --registry-server "$CONTAINER_REGISTRY_NAME.azurecr.io"

az containerapp job create -n "$JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" `
    --trigger-type Event `
    --replica-timeout 1800 `
    --replica-retry-limit 0 `
    --replica-completion-count 1 `
    --parallelism 1 `
    --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" `
    --min-executions 0 `
    --max-executions 10 `
    --polling-interval 30 `
    --scale-rule-name "github-runner" `
    --scale-rule-type "github-runner" `
    --scale-rule-metadata "githubAPIURL=https://api.github.com" "owner=$REPO_OWNER" "runnerScope=repo" "repos=$REPO_NAME" "targetWorkflowQueueLength=1" `
    --scale-rule-auth "personalAccessToken=personal-access-token" `
    --cpu "2.0" `
    --memory "4Gi" `
    --secrets "personal-access-token=$GITHUB_PAT" `
    --env-vars "GITHUB_PAT=secretref:personal-access-token" "GH_URL=https://github.com/$REPO_OWNER/$REPO_NAME" "REGISTRATION_TOKEN_API_URL=https://api.github.com/repos/$REPO_OWNER/$REPO_NAME/actions/runners/registration-token" `
    --registry-server "$CONTAINER_REGISTRY_NAME.azurecr.io"

次の表で、コマンドで使われるキーパラメーターについて説明します。

パラメーター	説明
`--replica-timeout`	レプリカが実行できる最長時間。
`--replica-retry-limit`	失敗したレプリカを再試行する回数。
`--replica-completion-count`	このレプリカ数が正常に完了すると、ジョブの実行を成功と見なします。
`--parallelism`	ジョブの実行ごとに開始するレプリカ数。
`--min-executions`	ポーリング間隔ごとに実行するジョブの実行の最小数。
`--max-executions`	ポーリング間隔ごとに実行するジョブの実行の最大数。
`--polling-interval`	スケールルールを評価するポーリング間隔。
`--scale-rule-name`	スケールルールの名前。
`--scale-rule-type`	使うスケールルールの種類。 GitHub ランナースケーラーについて詳しくは、KEDA のドキュメントをご覧ください。
`--scale-rule-metadata`	スケールルールのメタデータ。 GitHub Enterprise を使用している場合は、その API URL を使用して `githubAPIURL` を更新します。
`--scale-rule-auth`	スケールルールの認証。
`--secrets`	ジョブに使うシークレット。
`--env-vars`	ジョブに使う環境変数。
`--registry-server`	ジョブに使うコンテナーレジストリサーバー。 Azure Container Registry の場合、このコマンドによって認証が自動的に構成されます。

スケールルールの構成によって、監視するイベントソースを定義します。これはポーリング間隔ごとに評価されて、トリガーするジョブ実行の数を決定します。詳細については、スケーリングルールの設定に関する記事を参照してください。

これでイベントドリブンジョブが Container Apps 環境に作成されました。

ワークフローを実行してジョブを検証する

このジョブは、スケールルールを 30 秒ごとに評価するように構成されています。各評価の間に、セルフホステッドランナーを必要とする保留中のワークフロー実行の数がチェックされ、構成されている最大実行回数の 10 を上限として、保留中のワークフローの新しいジョブ実行が開始されます。

ジョブが正しく構成されたことを確認するため、セルフホステッドランナーを使うようにワークフローを変更して、ワークフローの実行をトリガーします。その後、ジョブ実行ログを表示して、ワークフローの実行を確認できます。

GitHub リポジトリで、前に生成したワークフローに移動します。これは、.github/workflows ディレクトリ内の YAML ファイルです。
[Edit in place] (インプレース編集) を選びます。
runs-on プロパティを self-hosted に更新します。
```
runs-on: self-hosted
```
[変更をコミットする] を選択します。
[変更点のコミット] を選択します。
[Actions] (アクション) タブに移動します。

新しいワークフローがキューに登録されました。 30 秒以内にジョブの実行が開始され、その後すぐにワークフローが完了します。

アクションが完了するまで待ってから、次のステップに進みます。

ジョブの実行の一覧を表示し、ジョブの実行が正常に作成されて完了したことを確認します。

Bash
PowerShell

az containerapp job execution list \
    --name "$JOB_NAME" \
    --resource-group "$RESOURCE_GROUP" \
    --output table \
    --query '[].{Status: properties.status, Name: name, StartTime: properties.startTime}'

az containerapp job execution list `
    --name "$JOB_NAME" `
    --resource-group "$RESOURCE_GROUP" `
    --output table `
    --query '[].{Status: properties.status, Name: name, StartTime: properties.startTime}'

Azure DevOps のプロジェクトとリポジトリを作成する

パイプラインを実行するには、Azure DevOps のプロジェクトとリポジトリが必要です。

Azure DevOps に移動し、アカウントにサインインします。
既存の組織を選ぶか、新しく作成します。
組織の概要ページで、[新しいプロジェクト] を選んで次の値を入力します。

設定 [値]

プロジェクト名 プロジェクトの名前を入力します。

表示 [プライベート] を選択します。
[作成] を選択します。
サイドナビゲーションから、[リポジトリ] を選びます。
[Initialize main branch with a README or .gitignore] (README または .gitignore を使用してメインブランチを初期化する) で、[Add a README] (README の追加) を選びます。
残りの値は既定値のままにして、[初期化] を選びます。

設定	[値]
プロジェクト名	プロジェクトの名前を入力します。
表示	[プライベート] を選択します。

新しいエージェントプールを作成する

セルフホステッドランナーを実行するための新しいエージェントプールを作成します。

Azure DevOps プロジェクトで、左側のナビゲーションバーを展開し、[プロジェクトの設定] を選びます。
[プロジェクトの設定] ナビゲーションメニューの [パイプライン] セクションで、[エージェントプール] を選びます。

[プールの追加] を選んで、次の値を入力します。

設定	値
リンクするプール	新規をクリックします。
プールの種類	[セルフホステッド] を選びます。
名前	「container-apps」と入力します。
すべてのパイプラインへのアクセス許可を与える	このチェックボックスをオンにします。

[作成] を選択します。

Azure DevOps の個人用アクセストークンを取得する

セルフホステッドランナーを実行するには、Azure DevOps で個人用アクセストークン (PAT) を作成する必要があります。 PAT は、Azure DevOps でランナーの認証を行うために使われます。また、スケールルールによって、保留中のパイプライン実行の数を特定し、新しいジョブの実行をトリガーするためにも使われます。

Azure DevOps で、右上隅にあるユーザーのプロファイル画像の横の [ユーザー設定] を選びます。
[Personal access tokens] (個人用アクセストークン) を選択します。

[個人用アクセストークン] ページで [新しいトークン] を選び、次の値を入力します。

設定	値
名前	トークンの名前を入力します。
組織	前に選択または作成した組織を選びます。
スコープ	[カスタム定義] を選びます。
すべてのスコープを表示する	[すべてのスコープを表示する] をオンにします。
エージェントプール (読み取り、管理)	[エージェントプール (読み取り、管理)] をオンにします。

その他のスコープはすべてオフのままにします。

[作成] を選択します。
トークンの値を安全な場所にコピーします。

ページを離れた後はトークンを取得できません。

後で Container Apps ジョブを構成するために使われる変数を定義します。

Bash
PowerShell

AZP_TOKEN="<AZP_TOKEN>"
ORGANIZATION_URL="<ORGANIZATION_URL>"
AZP_POOL="container-apps"

$AZP_TOKEN="<AZP_TOKEN>"
$ORGANIZATION_URL="<ORGANIZATION_URL>"
$AZP_POOL="container-apps"

プレースホルダーを次の値に置き換えます。

プレースホルダー	値	説明
`<AZP_TOKEN>`	生成した Azure DevOps の PAT。
`<ORGANIZATION_URL>`	Azure DevOps 組織の URL。 URL の末尾に `/` が存在していないことを確認します。	たとえば、`https://dev.azure.com/myorg` または `https://myorg.visualstudio.com` です。

Azure Pipelines エージェントのコンテナーイメージをビルドする

セルフホステッドエージェントを作成するには、エージェントを実行するコンテナーイメージをビルドする必要があります。このセクションでは、コンテナーイメージをビルドして、コンテナーレジストリにそれをプッシュします。

Note

このチュートリアルでビルドするイメージには、Container Apps ジョブとして実行するのに適した基本的なセルフホステッドエージェントが含まれています。パイプラインに必要な追加のツールや依存関係を含むようにカスタマイズできます。

ターミナルに戻り、コンテナーイメージとレジストリの名前を定義します。
- Bash
- PowerShell
```
CONTAINER_IMAGE_NAME="azure-pipelines-agent:1.0"
CONTAINER_REGISTRY_NAME="<CONTAINER_REGISTRY_NAME>"
```
```
$CONTAINER_IMAGE_NAME="azure-pipelines-agent:1.0"
$CONTAINER_REGISTRY_NAME="<CONTAINER_REGISTRY_NAME>"
```
<CONTAINER_REGISTRY_NAME> を、コンテナーレジストリを作成するための一意の名前に置き換えます。

コンテナーレジストリ名は、"Azure 内で一意" であり、数字と小文字のみを含む 5 文字から 50 文字の長さにする必要があります。

コンテナーレジストリを作成します。

Bash
PowerShell

az acr create \
    --name "$CONTAINER_REGISTRY_NAME" \
    --resource-group "$RESOURCE_GROUP" \
    --location "$LOCATION" \
    --sku Basic \
    --admin-enabled true

az acr create `
    --name "$CONTAINER_REGISTRY_NAME" `
    --resource-group "$RESOURCE_GROUP" `
    --location "$LOCATION" `
    --sku Basic `
    --admin-enabled true

Bash
PowerShell

az acr build \
    --registry "$CONTAINER_REGISTRY_NAME" \
    --image "$CONTAINER_IMAGE_NAME" \
    --file "Dockerfile.azure-pipelines" \
    "https://github.com/Azure-Samples/container-apps-ci-cd-runner-tutorial.git"

az acr build `
    --registry "$CONTAINER_REGISTRY_NAME" `
    --image "$CONTAINER_IMAGE_NAME" `
    --file "Dockerfile.azure-pipelines" `
    "https://github.com/Azure-Samples/container-apps-ci-cd-runner-tutorial.git"

これで、コンテナーレジストリでイメージを使用できるようになります。

プレースホルダーのセルフホステッドエージェントを作成する

新しいエージェントプールでセルフホステッドエージェントを実行するには、その前にプレースホルダーエージェントを作成する必要があります。プレースホルダーエージェントは、エージェントプールが使用可能であることを保証します。プレースホルダーエージェントがない場合、エージェントプールを使うパイプラインは失敗します。

手動ジョブを実行して、オフラインプレースホルダーエージェントを登録できます。ジョブは 1 回実行され、削除できます。プレースホルダーエージェントは、Azure Container Apps または Azure DevOps のリソースを消費しません。

プレースホルダーエージェントを作成する Container Apps 環境で手動ジョブを作成します。

Bash
PowerShell

az containerapp job create -n "$PLACEHOLDER_JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" \
    --trigger-type Manual \
    --replica-timeout 300 \
    --replica-retry-limit 0 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" \
    --cpu "2.0" \
    --memory "4Gi" \
    --secrets "personal-access-token=$AZP_TOKEN" "organization-url=$ORGANIZATION_URL" \
    --env-vars "AZP_TOKEN=secretref:personal-access-token" "AZP_URL=secretref:organization-url" "AZP_POOL=$AZP_POOL" "AZP_PLACEHOLDER=1" "AZP_AGENT_NAME=placeholder-agent" \
    --registry-server "$CONTAINER_REGISTRY_NAME.azurecr.io"

    az containerapp job create -n "$PLACEHOLDER_JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" `
    --trigger-type Manual `
    --replica-timeout 300 `
    --replica-retry-limit 0 `
    --replica-completion-count 1 `
    --parallelism 1 `
    --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" `
    --cpu "2.0" `
    --memory "4Gi" `
    --secrets "personal-access-token=$AZP_TOKEN" "organization-url=$ORGANIZATION_URL" `
    --env-vars "AZP_TOKEN=secretref:personal-access-token" "AZP_URL=secretref:organization-url" "AZP_POOL=$AZP_POOL" "AZP_PLACEHOLDER=1" "AZP_AGENT_NAME=placeholder-agent" `
    --registry-server "$CONTAINER_REGISTRY_NAME.azurecr.io"

次の表で、コマンドで使われるキーパラメーターについて説明します。

パラメーター	説明
`--replica-timeout`	レプリカが実行できる最長時間。
`--replica-retry-limit`	失敗したレプリカを再試行する回数。
`--replica-completion-count`	このレプリカ数が正常に完了すると、ジョブの実行を成功と見なします。
`--parallelism`	ジョブの実行ごとに開始するレプリカ数。
`--secrets`	ジョブに使うシークレット。
`--env-vars`	ジョブに使う環境変数。
`--registry-server`	ジョブに使うコンテナーレジストリサーバー。 Azure Container Registry の場合、このコマンドによって認証が自動的に構成されます。

AZP_PLACEHOLDER 環境変数を設定すると、ジョブを実行せずにオフラインプレースホルダーエージェントとして登録するように、エージェントコンテナーが構成されます。

手動ジョブを実行してプレースホルダーエージェントを作成します。

Bash
PowerShell

az containerapp job start -n "$PLACEHOLDER_JOB_NAME" -g "$RESOURCE_GROUP"

az containerapp job start -n "$PLACEHOLDER_JOB_NAME" -g "$RESOURCE_GROUP"

ジョブの実行の一覧を表示し、ジョブの実行が正常に作成されて完了したことを確認します。

Bash
PowerShell

az containerapp job execution list \
    --name "$PLACEHOLDER_JOB_NAME" \
    --resource-group "$RESOURCE_GROUP" \
    --output table \
    --query '[].{Status: properties.status, Name: name, StartTime: properties.startTime}'

az containerapp job execution list `
    --name "$PLACEHOLDER_JOB_NAME" `
    --resource-group "$RESOURCE_GROUP" `
    --output table `
    --query '[].{Status: properties.status, Name: name, StartTime: properties.startTime}'

プレースホルダーエージェントが Azure DevOps に作成されたことを確認します。
1. Azure DevOps で、お使いのプロジェクトに移動します。
2. [プロジェクトの設定]>[エージェントプール]>container-apps>[エージェント] を選びます。
3. placeholder-agent という名前のプレースホルダーエージェントが一覧に表示され、その状態がオフラインであることを確認します。

このジョブはもう必要ありません。これは削除することができます。

Bash
PowerShell

az containerapp job delete -n "$PLACEHOLDER_JOB_NAME" -g "$RESOURCE_GROUP"

az containerapp job delete -n "$PLACEHOLDER_JOB_NAME" -g "$RESOURCE_GROUP"

セルフホステッドエージェントをイベントドリブンジョブとして作成する

プレースホルダーエージェントができたので、セルフホステッドエージェントを作成できます。このセクションでは、パイプラインがトリガーされたらセルフホステッドエージェントを実行するイベントドリブンジョブを作成します。

Bash
PowerShell

az containerapp job create -n "$JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" \
    --trigger-type Event \
    --replica-timeout 1800 \
    --replica-retry-limit 0 \
    --replica-completion-count 1 \
    --parallelism 1 \
    --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" \
    --min-executions 0 \
    --max-executions 10 \
    --polling-interval 30 \
    --scale-rule-name "azure-pipelines" \
    --scale-rule-type "azure-pipelines" \
    --scale-rule-metadata "poolName=$AZP_POOL" "targetPipelinesQueueLength=1" \
    --scale-rule-auth "personalAccessToken=personal-access-token" "organizationURL=organization-url" \
    --cpu "2.0" \
    --memory "4Gi" \
    --secrets "personal-access-token=$AZP_TOKEN" "organization-url=$ORGANIZATION_URL" \
    --env-vars "AZP_TOKEN=secretref:personal-access-token" "AZP_URL=secretref:organization-url" "AZP_POOL=$AZP_POOL" \
    --registry-server "$CONTAINER_REGISTRY_NAME.azurecr.io"

az containerapp job create -n "$JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" `
    --trigger-type Event `
    --replica-timeout 1800 `
    --replica-retry-limit 0 `
    --replica-completion-count 1 `
    --parallelism 1 `
    --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" `
    --min-executions 0 `
    --max-executions 10 `
    --polling-interval 30 `
    --scale-rule-name "azure-pipelines" `
    --scale-rule-type "azure-pipelines" `
    --scale-rule-metadata "poolName=$AZP_POOL" "targetPipelinesQueueLength=1" `
    --scale-rule-auth "personalAccessToken=personal-access-token" "organizationURL=organization-url" `
    --cpu "2.0" `
    --memory "4Gi" `
    --secrets "personal-access-token=$AZP_TOKEN" "organization-url=$ORGANIZATION_URL" `
    --env-vars "AZP_TOKEN=secretref:personal-access-token" "AZP_URL=secretref:organization-url" "AZP_POOL=$AZP_POOL" `
    --registry-server "$CONTAINER_REGISTRY_NAME.azurecr.io"

次の表では、コマンドで使われるスケールルールのパラメーターについて説明します。

パラメーター	説明
`--min-executions`	ポーリング間隔ごとに実行するジョブの実行の最小数。
`--max-executions`	ポーリング間隔ごとに実行するジョブの実行の最大数。
`--polling-interval`	スケールルールを評価するポーリング間隔。
`--scale-rule-name`	スケールルールの名前。
`--scale-rule-type`	使うスケールルールの種類。 Azure Pipelines のスケーラーについて詳しくは、KEDA のドキュメントをご覧ください。
`--scale-rule-metadata`	スケールルールのメタデータ。
`--scale-rule-auth`	スケールルールの認証。

これでイベントドリブンジョブが Container Apps 環境に作成されました。

パイプラインを実行してジョブを検証する

セルフホステッドエージェントジョブを構成したので、パイプラインを実行し、正常に動作していることを検証できます。

Azure DevOps プロジェクトの左側のナビゲーションで、[パイプライン] に移動します。
[パイプラインを作成] を選択します。
コードの場所として [Azure Repos Git] を選択します。
以前に選択したリポジトリを選択します。
[スタートパイプライン] を選択します。
パイプラインの YAML で、pool を vmImage: ubuntu-latest から name: container-apps に変更します。
```
pool:
  name: container-apps
```
[保存および実行] を選択します。

パイプラインは、実行すると、Container Apps 環境で作成したセルフホステッドエージェントジョブを使います。

ジョブの実行の一覧を表示し、ジョブの実行が正常に作成されて完了したことを確認します。

Bash
PowerShell

az containerapp job execution list \
    --name "$JOB_NAME" \
    --resource-group "$RESOURCE_GROUP" \
    --output table \
    --query '[].{Status: properties.status, Name: name, StartTime: properties.startTime}'

az containerapp job execution list `
    --name "$JOB_NAME" `
    --resource-group "$RESOURCE_GROUP" `
    --output table `
    --query '[].{Status: properties.status, Name: name, StartTime: properties.startTime}'

ヒント

問題がある場合は、 GitHub の Azure Container Apps リポジトリでイシューを開いて、お知らせください。

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

完了したら、次のコマンドを実行して、Container Apps のリソースを含むリソースグループを削除します。

注意事項

次のコマンドを実行すると、指定されたリソースグループとそれに含まれるすべてのリソースが削除されます。指定したリソースグループにこのチュートリアルの範囲外のリソースが含まれている場合、それらも削除されます。

Bash
PowerShell

az group delete \
    --resource-group $RESOURCE_GROUP

az group delete `
    --resource-group $RESOURCE_GROUP

GitHub リポジトリの削除については、「リポジトリの削除」をご覧ください。

次のステップ

Container Apps ジョブ

チュートリアル:Azure Container Apps ジョブを使用してセルフホスト型 CI/CD ランナーとエージェントをデプロイする

前提条件

設定

環境変数を作成する

Container Apps 環境を作成する

ワークフローを実行するための GitHub リポジトリを作成する

GitHub の個人用アクセス トークンを取得する

GitHub Actions ランナーのコンテナー イメージをビルドする

セルフホステッド ランナーをジョブとしてデプロイする

ワークフローを実行してジョブを検証する

Azure DevOps のプロジェクトとリポジトリを作成する

新しいエージェント プールを作成する

Azure DevOps の個人用アクセス トークンを取得する

Azure Pipelines エージェントのコンテナー イメージをビルドする

プレースホルダーのセルフホステッド エージェントを作成する

セルフホステッド エージェントをイベント ドリブン ジョブとして作成する

パイプラインを実行してジョブを検証する

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

次のステップ

その他のリソース

GitHub の個人用アクセストークンを取得する

GitHub Actions ランナーのコンテナーイメージをビルドする

セルフホステッドランナーをジョブとしてデプロイする

新しいエージェントプールを作成する

Azure DevOps の個人用アクセストークンを取得する

Azure Pipelines エージェントのコンテナーイメージをビルドする

プレースホルダーのセルフホステッドエージェントを作成する

セルフホステッドエージェントをイベントドリブンジョブとして作成する