演習 - 環境を設定する

4 分

重要

この演習を行うには、独自の Azure サブスクリプションが必要です。また、料金が発生することがあります。 Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

おもちゃ会社の pull request ワークフローを設定する前に、自分の環境を構成する必要があります。

このユニットでは、このモジュールの残りの部分を正常に完了するために Azure と GitHub 環境が設定されていることを確認します。

これらの目的を達成するには、次の作業を行います。

このモジュール向けに GitHub リポジトリを設定します。
リポジトリをコンピューターに複製します。
Microsoft Entra ID でワークロード ID を作成します。
GitHub にシークレットを作成します。

GitHub リポジトリを取得する

このセクションでは、テンプレートリポジトリに基づいて新しいリポジトリを作成して、このモジュールの残りの部分を完了するために GitHub リポジトリを設定します。テンプレートリポジトリには、このモジュールを開始するために必要なファイルが含まれています。

このラーニングパスのモジュールは、段階的に進めるラーニングパスの一部となっています。各モジュールには、学習のための、関連する GitHub テンプレートリポジトリがあります。

ヒント

ラーニングパスで前のモジュールを既に完了した場合でも、これらの手順に従って新しいリポジトリを作成し、新しい名前を付けてください。

テンプレートリポジトリから開始する

GitHub リポジトリを設定するテンプレートを実行します。

テンプレートの実行

GitHub サイトで、次の手順を実行して、テンプレートからリポジトリを作成します。

[このテンプレートを使用]>[新しいリポジトリの作成] の順に選択します。
GitHub のユーザー名または組織の名前をメモしておきます。この例の GitHub ユーザー名は、mygithubuser です。この名前はこの後すぐに必要になります。
新しいプロジェクトに名前 (toy-website-auto-review など) を入力します。
[Public](パブリック) オプションを選択します

独自のリポジトリを作成するときに、プライベートにしたい場合もあります。このモジュールでは、パブリックリポジトリと GitHub Enterprise アカウントでのみ動作する GitHub 機能を使用して作業します。
[Create repository] (リポジトリの作成) を選択します。

リポジトリの複製

これで、独自のアカウントでテンプレートリポジトリのコピーが作成されました。このリポジトリをローカルにクローンし、その中で作業を開始できるようにします。

[Code](コード) を選択し、コピーアイコンを選択します。
Visual Studio Code を開きます。
[ターミナル]>[新しいターミナル] を選択して、Visual Studio Code ターミナルウィンドウを開きます。このウィンドウは通常、画面の下部に表示されます。
ターミナルで、ローカルコンピューター上に GitHub リポジトリをクローンしたいディレクトリに移動します。たとえば、toy-website-auto-review フォルダーにリポジトリをクローンするには、次のコマンドを実行します。
```
cd toy-website-auto-review
```
「git clone」と入力し、先ほどコピーした URL を貼り付けると、次のようになります。
```
git clone https://github.com/mygithubuser/toy-website-auto-review.git
```
Visual Studio Code ターミナルで次のコマンドを実行して、リポジトリフォルダー内の Visual Studio Code を再度開きます。
```
code -r toy-website-auto-review
```

これで、リポジトリがコンピューターのローカルにクローンされたので、Azure 環境にサインインします。 Azure アカウントを使用して、GitHub Actions ワークフローによって使用されるワークロード ID を作成します。

Visual Studio Code のターミナルで次のコマンドを実行して、Azure にサインインします。
```
az login
```
開いたブラウザーで、Azure アカウントにサインインします。

Visual Studio Code ターミナルで、次のコマンドを実行して Azure にサインインします。
```
Connect-AzAccount
```
開いたブラウザーで、Azure アカウントにサインインします。

ワークロード ID を作成する

この Microsoft Learn モジュールの後半で、pull request ワークフローによって、サブスクリプションにリソースグループとリソースが作成されます。リソースをデプロイするには、ワークロード ID を作成し、それにサブスクリプションの共同作成者ロールを付与する必要があります。

警告

ここで作成するワークロード ID には、Azure サブスクリプションへの高レベルのアクセス権があります。偶発的な問題を回避するには、非運用サブスクリプションを使用します。実稼働ワークロードのいずれかを保持する環境では、これらの手順を行わないでください。

独自の pull request 検証ワークフローでは、専用の Azure サブスクリプションを使用することをお勧めします。

ワークロード ID を作成するため、Azure CLI コマンドでは jq を使って JSON 出力からのデータが解析されます。 jq をインストールしていない場合は、Azure Cloud Shell で Bash を使って、ワークロード ID、リソースグループ、ロールの割り当てを作成し、GitHub シークレットを準備できます。

次のコードを実行して、GitHub ユーザー名とリポジトリ名の変数を定義します。 mygithubuser は必ず、この演習で前にメモした GitHub ユーザー名に置き換えてください。また、正しい GitHub リポジトリ名を指定するようにしてください。
```
githubOrganizationName='mygithubuser'
githubRepositoryName='toy-website-auto-review'
```

デプロイワークフロー用のワークロード ID を作成します。

applicationRegistrationDetails=$(az ad app create --display-name 'toy-website-auto-review')
applicationRegistrationObjectId=$(echo $applicationRegistrationDetails | jq -r '.id')
applicationRegistrationAppId=$(echo $applicationRegistrationDetails | jq -r '.appId')

az ad app federated-credential create \
   --id $applicationRegistrationObjectId \
   --parameters "{\"name\":\"toy-website-auto-review\",\"issuer\":\"https://token.actions.githubusercontent.com\",\"subject\":\"repo:${githubOrganizationName}/${githubRepositoryName}:pull_request\",\"audiences\":[\"api://AzureADTokenExchange\"]}"

次のコードを実行して、GitHub ユーザー名とリポジトリ名の変数を定義します。 mygithubuser は必ず、この演習で前にメモした GitHub ユーザー名に置き換えてください。また、正しい GitHub リポジトリ名を指定するようにしてください。
```
$githubOrganizationName = 'mygithubuser'
$githubRepositoryName = 'toy-website-auto-review'
```

デプロイワークフロー用のワークロード ID を作成します。

$applicationRegistration = New-AzADApplication -DisplayName 'toy-website-auto-review'
New-AzADAppFederatedCredential `
   -Name 'toy-website-auto-review' `
   -ApplicationObjectId $applicationRegistration.Id `
   -Issuer 'https://token.actions.githubusercontent.com' `
   -Audience 'api://AzureADTokenExchange' `
   -Subject "repo:$($githubOrganizationName)/$($githubRepositoryName):pull_request"

ワークロード ID にサブスクリプションへのアクセス権を付与する

次に、Web サイト用のリソースグループを作成します。また、このプロセスでは、ワークロード ID にリソースグループの共同作成者ロールを付与し、ワークフローでリソースグループにデプロイできるようにします。

Visual Studio Code ターミナルで、次の Azure CLI コマンドを実行します。

az ad sp create --id $applicationRegistrationObjectId
az role assignment create \
   --assignee $applicationRegistrationAppId \
   --role Contributor

Visual Studio Code ターミナルで、次の Azure PowerShell コマンドを実行します。

New-AzADServicePrincipal -AppId $applicationRegistration.AppId
New-AzRoleAssignment `
   -ApplicationId $applicationRegistration.AppId `
   -RoleDefinitionName Contributor

GitHub シークレットを準備する

次のコードを実行して、GitHub シークレットとして作成する必要がある各値を表示します。

echo "AZURE_CLIENT_ID: $applicationRegistrationAppId"
echo "AZURE_TENANT_ID: $(az account show --query tenantId --output tsv)"
echo "AZURE_SUBSCRIPTION_ID: $(az account show --query id --output tsv)"

$azureContext = Get-AzContext
Write-Host "AZURE_CLIENT_ID: $($applicationRegistration.AppId)"
Write-Host "AZURE_TENANT_ID: $($azureContext.Tenant.Id)"
Write-Host "AZURE_SUBSCRIPTION_ID: $($azureContext.Subscription.Id)"

AZURE_CLIENT_ID のアプリケーション ID 値をメモしておきます。この値は、このモジュールの終了時にリソースをクリーンアップするときに使用できます。

GitHub シークレットを作成する

ワークロード ID を作成し、それにサブスクリプションにデプロイするためのアクセス許可を付与しました。次に、GitHub Actions でシークレットを作成します。

ブラウザーで GitHub リポジトリに移動します。
[設定]>[シークレットと変数]>[アクション] の順に選択します。
[New repository secret](新しいリポジトリシークレット) を選択します。

$GitHub インターフェイスの [Secrets]$シークレット$ ページのスクリーンショット。[Create repository secret]$リポジトリシークレットの作成$ ボタンが強調表示されています。$
シークレットに AZURE_CLIENT_ID という名前を付けます。
[値] フィールドに、ターミナル出力の最初の行の GUID を貼り付けます。値には、AZURE_CLIENT_ID、コロン、スペースを含めないでください。
[Add secret](シークレットの追加) を選択します。

$[New Secret]$新しいシークレット$ ページが表示されている GitHub インターフェイスのスクリーンショット。名前と値が入力され、[Add Secret]$シークレットの追加$ ボタンが強調表示されています。$
このプロセスを繰り返して AZURE_TENANT_ID と AZURE_SUBSCRIPTION_ID のシークレットを作成します。値は、ターミナル出力の対応するフィールドからコピーします。
シークレットの一覧に現在 3 つのシークレットが表示されていることを確認します。