注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
はじめに
このガイドでは、GitHub Actions を使用し、Docker コンテナーをビルドして Azure App Service にデプロイする方法について説明します。
前提条件
GitHub Actionsワークフローを作成する前に、まず以下のセットアップのステップを完了しておかなければなりません。
-
Azure App Service プランを作成する。
たとえば、Azure CLIを使って新しいApp Serviceのプランを作成できます。
Shell az appservice plan create \ --resource-group MY_RESOURCE_GROUP \ --name MY_APP_SERVICE_PLAN \ --is-linux
上記のコマンドでは、
MY_RESOURCE_GROUP
を既存の Azure リソース グループに、MY_APP_SERVICE_PLAN
を App Service プランの新しい名前に置き換えます。Azure CLI の使用に関する詳細については、Azure のドキュメントを参照してく� さい。
- 認証については、「Azure CLI を使用してサインインする」を参照してく� さい。
- 新しいリソース グループを作成する必要がある� �合は、「az group」を参照してく� さい。
-
Web アプリを作成する。
たとえば、Azure CLI を使用して Azure App Service Web アプリを作成できます。
Shell az webapp create \ --name MY_WEBAPP_NAME \ --plan MY_APP_SERVICE_PLAN \ --resource-group MY_RESOURCE_GROUP \ --deployment-container-image-name nginx:latest
上のコマンドで、パラメータは自分の値で置き換えてく� さい。
MY_WEBAPP_NAME
は Web アプリの新しい名前です。 -
Azure 発行プロファイルを構成し、
AZURE_WEBAPP_PUBLISH_PROFILE
シークレットを作成します。公開されたプロフィールを使って、Azureのデプロイ資� �情� �を生成してく� さい。 詳細については、Azure ドキュメントの「デプロイ資� �情� �の生成」を参照してく� さい。
GitHub リポジトリで、発行プロファイルの内容を含む
AZURE_WEBAPP_PUBLISH_PROFILE
という名前のシークレットを作成してく� さい。 シークレットの作成の詳細については、「暗号化されたシークレット」を参照してく� さい。 -
Web アプリのレジストリ資� �情� �を設定します。
repo
およびread:packages
スコープで個人のアクセス トークンを作成します。 詳細については、個人アクセス トークンの作成に関する記事を参照してく� さい。DOCKER_REGISTRY_SERVER_URL
をhttps://ghcr.io
に、DOCKER_REGISTRY_SERVER_USERNAME
を GitHub ユーザー名またはリポジトリ所有組織に、DOCKER_REGISTRY_SERVER_PASSWORD
を上記の個人アクセス トークンに設定します。 これにより、Web アプリに資� �情� �が与えられるため、新しくビルドされたイメージがレジストリにワークフローによってプッシュされた後、コンテナー イメージをプルできるようになります。 これを行うには、次の Azure CLI コマンドを使います。az webapp config appsettings set \ --name MY_WEBAPP_NAME \ --resource-group MY_RESOURCE_GROUP \ --settings DOCKER_REGISTRY_SERVER_URL=https://ghcr.io DOCKER_REGISTRY_SERVER_USERNAME=MY_REPOSITORY_OWNER DOCKER_REGISTRY_SERVER_PASSWORD=MY_PERSONAL_ACCESS_TOKEN
-
任意で、デプロイ環境を構成します。 環境は、一般的なデプロイ ターゲットを記述するために使用されます (例:
production
、staging
、またはdevelopment
)。 GitHub Actions ワークフローが環境にデプロイされると、その環境がリポジトリのメイン ページに表示されます。 環境を使用して、ジョブの続行に対する承認の要求、ワークフローをトリガーできるブランチの制限、シークレットへのアクセスの制限を実行できます。 環境の作成の詳細については、「デプロイに環境を使用する」を参照してく� さい。
ワークフローの作成
必要な環境を整えたら、ワークフローの作成に進むことができます。
次のサンプル ワークフローからは、main
ブランチへのプッシュがあるとき、Docker コンテナーをビルドし、Azure App Service にデプロイする方法がわかります。
ワークフロー env
キーの AZURE_WEBAPP_NAME
は、作成した Web アプリの名前に必ず設定してく� さい。
デプロイ環境を構成した� �合は、environment
の値を環境の名前に変更します。 環境を構成しなかった� �合 を使わない� �合は、environment
キーを削除します。
# このワークフローはGitHubによって認定されていないアクションを使用します。
# それらはサードパーティによって提供され、
# 別個の利用規約、プライバシーポリシー、
# ドキュメントを参照してく� さい。
# GitHub では、コミット SHA にアクションをピン留めすることが推奨されます。
# 新しいバージョンを取得するには、SHA を更新する必要があります。
# タグまたはブランチを参照することもできますが、アクションは警告なしに変更される可能性があります。
name: Build and deploy a container to an Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
on:
push:
branches:
- main
permissions:
contents: 'read'
packages: 'write'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- name: Log in to GitHub container registry
uses: docker/login-action@v1.10.0
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Lowercase the repo name
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
- name: Build and push container image to registry
uses: docker/build-push-action@v2
with:
push: true
tags: ghcr.io/${{ env.REPO }}:${{ github.sha }}
file: ./Dockerfile
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
steps:
- name: Lowercase the repo name
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
- name: Deploy to Azure Web App
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
images: 'ghcr.io/${{ env.REPO }}:${{ github.sha }}'
その他のリソース
以下のリソースも役に立つでしょう。
- もともとのスターター ワークフローについては、GitHub Actions
starter-workflows
リポジトリのazure-container-webapp.yml
を参照してく� さい。 - Web アプリのデプロイに使用されるアクションは、Azure の公式な
Azure/webapps-deploy
アクションです。 - Azure にデプロイする GitHub アクション ワークフローの例が他にも必要であれば、actions-workflow-samples リポジトリを参照してく� さい。