Azure Container Registry にカスタム イメージを継続的にデプロイする方法
フルスタック デベロッパー兼テクニカル ライター
Azure Container Registry (ACR) は、Microsoft 独自の Docker イメージ ホスティング プラットフォームです。プライベート docker コンテナー イメージや関連する成果物を保存、管理できるプライベート レジストリで、保存したイメージはプルしてローカルで実行することも、ホスティング プラットフォームへのコンテナー ベースのデプロイに使うこともできます。
このチュートリアルでは、カスタム docker イメージを作成し、Azure Container Registry に継続的にデプロイする方法を学びます。
前提条件
このチュートリアルを進めるには、以下の準備が必要です。
- システムにインストールされた Node.js (バージョン 24 以降)
- Azure アカウント。このチュートリアルでは
az acr buildとビルド タスクに Azure Container Registry のタスク実行を使いますが、タスク実行は Azure の無料クレジットで運用しているサブスクリプションでは一時的に停止されています。無料クレジットに依存しないサブスクリプションを使ってください。 - CircleCI アカウント
- GitHub アカウント
- システムにインストールされた Azure CLI
- システムにインストールされた Docker
これらのインストールとセットアップが済んだら、チュートリアルを始めましょう。
Azure でコンテナー レジストリを作成する
まず、Docker コンテナーを保存、ビルドするためのコンテナー レジストリを Azure に作成します。Azure portal のホーム ページで Create a resource を選択し、Infrastructure Services -> Container Registry -> Create の順に進みます。
レジストリの作成ページで、レジストリの名前など必要な情報を入力します。
Review + create ボタンをクリックします。確認ページでレジストリの情報を確認し、Create をクリックしてレジストリの作成を開始します。
リソースの作成に Azure CLI を使いたい場合は、次のコマンドでレジストリを作成することもできます。
az acr create --name circlecigwpregistry --resource-group Demos-Group --sku standard --admin-enabled true
ここではレジストリの名前を circlecigwpregistry にしています。レジストリ名は Azure 全体で一意である必要があるため、別の名前を使ってください。以降の手順では、このレジストリ名を自分のレジストリ名に置き換えて進めてください。
デモ プロジェクトのクローンを作成する
次に、Docker コンテナーをビルドして Azure Container Registry でホストするための Node.js プロジェクトを用意します。以下のコマンドを実行して、プロジェクトのクローンを作成します。
git clone --single-branch --branch base-project https://github.com/CIRCLECI-GWP/azure-custom-images.git
このプロジェクトは、2 つのエンドポイントを持つシンプルな Node.js API です。
- ルート エンドポイント (
/) はウェルカム メッセージを表示するだけです /todosエンドポイントはtodoタスク オブジェクトの配列を返します。プロジェクトには/todosエンドポイントをテストするためのテスト スイートも含まれています
カスタム Docker イメージを作成してビルドする
次に、アプリケーションをホストするカスタム Docker イメージを作成します。プロジェクト フォルダーのルートに移動し (cd azure-custom-images)、Dockerfile ファイルを作成します。ファイルに以下のコードを入力します。
FROM node:24-alpine
WORKDIR /app
COPY ./package.json ./
RUN npm install
COPY ./ ./
CMD ["npm", "start"]
Dockerfile では、ベース イメージに node:24-alpine を使い、このイメージをもとに作成されるコンテナー内の作業ディレクトリを /app に設定しています。まず package.json ファイルを /app にコピーし、npm install で依存関係をインストールします。最後に、プロジェクトの残りのファイルをイメージにコピーし、実行時に npm start でアプリケーションを起動します。Docker イメージとコンテナーについて詳しくは、こちらのページを参照してください。
プロジェクトのルートで以下のコマンドを実行し、customnodeimage という名前のタグを付けてイメージをビルドします。
docker build -t customnodeimage .
コマンドの末尾にあるドット (.) に注意してください。これはビルド コンテキストをカレント ディレクトリに指定するもので、忘れずに付ける必要があります。
ビルドが完了したら、以下のコマンドを実行して、customnodeimage Docker イメージをもとにしたコンテナーとして Node.js アプリケーションを実行します。
docker run -p 1337:1337 customnodeimage
コマンドの出力に Server running on localhost:1337 という行が含まれていれば、アプリケーションは実行中です。
このコマンドは、コンテナー内のアプリケーション ポート (1337) をマシンのポート 1337 に転送します。http://localhost:1337 にアクセスすると、アプリケーションのベース エンドポイントを確認できます。
/todos ルートにアクセスして、todo オブジェクトを読み込むこともできます。
このイメージをレジストリに登録するには、以下のコマンドを実行して、Dockerfile から ACR 上でイメージをビルドします。<container_registry_name> は、作成したレジストリの名前に置き換えてください。
az acr build --registry <container_registry_name> --image customnodeimage .
これで、レジストリ上でこのイメージを確認できます。Azure のリソース ページでレジストリをクリックします。レジストリは Azure portal のホーム ページの Recent resources に表示されているはずです。Services -> Repositories に進みます。
コンテナーのビルド タスクを設定する
アプリケーションのコードや Dockerfile が更新されたときは、その更新を ACR にプッシュしてビルドし、ACR 上のイメージを常に最新の状態に保ちたいところです。これが継続的デプロイです。
ACR では、リモート リポジトリのブランチを監視し、そのブランチの更新をトリガーにビルドを実行するように設定できます。イメージを継続的にデプロイする戦略として、ACR が監視するイメージ用のブランチをリモート リポジトリに作成します。アプリケーションのテストに合格すると、更新内容が監視対象のブランチに自動的にプッシュされ、更新後の内容でイメージが再ビルドされます。
まず、プロジェクトのルートで rm -rf .git コマンドを実行して既存の git 履歴を削除し、プロジェクトを GitHub にプッシュします。
次に、GitHub リポジトリで main ブランチから buildimage ブランチを作成します。
作成したブランチを監視するには、ACR タスクが必要です。ACR タスクを作成するには、GitHub の Personal Access Token が必要です。
GitHub トークンを作成するには、GitHub で Settings -> Developer settings に移動します。サイド メニューで Personal access tokens -> Tokens (classic) をクリックし、Generate new token -> Generate new token (classic) をクリックします。GitHub からアクセスの確認を求められた場合は、確認してトークンの作成ページに進みます。
Note フィールドに、トークンの用途を入力します。このデモでは、トークンに repo スコープ全体を付与します。このスコープにはリポジトリの Webhook へのアクセスが含まれており、ここではこれが最も重要です。ACR はこのアクセス権を使ってリポジトリに Webhook を作成し、その Webhook が Docker イメージの新しいビルドを開始するよう ACR に通知します。パブリック リポジトリの場合は、repo:status と public_repo スコープで十分です。Expiration には、デモを実行する期間をカバーする有効期限を選択します。ACR タスクはこのトークンを使ってリポジトリにアクセスするため、トークンの有効期限が切れたら、az acr task update --git-access-token で新しいトークンをタスクに設定してください。
Generate token ボタンをクリックします。トークンが生成されたらコピーします。トークンは二度と表示されません。
ACR タスクを作成するには、リポジトリのアドレス、レジストリ名、GitHub アクセス トークンを使って、プロジェクトのルートで以下のコマンドを実行します。
az acr task create --registry <container_registry_name> --name buildcustomimage --image customnodeimage --context <your_github_repo>#buildimage --file Dockerfile --git-access-token <access_token>
このチュートリアルのレジストリとリポジトリの場合、コマンドは次のようになります。
az acr task create --registry circlecigwpregistry --name buildcustomimage --image customnodeimage --context https://github.com/CIRCLECI-GWP/azure-custom-images.git#buildimage --file Dockerfile --git-access-token [My_TOKEN]
これで buildcustomimage タスクが作成されます。このタスクは、buildimage ブランチに更新がプッシュされるたびに customnodeimage イメージを再ビルドします。作成したタスクを確認するには、レジストリのページで Services -> Tasks に進みます。
CircleCI プロジェクトを作成する
このチュートリアルの CircleCI の手順は、github タイプの組織を前提としています。この組織は、ユーザーが GitHub でサインインしたときに CircleCI が作成するものです。circleci タイプの組織は CircleCI GitHub App で接続するため、プロジェクトの設定方法が異なり、ユーザー キーもサポートしていません。詳しくは Create a project を参照してください。
次に、CircleCI ダッシュボードの Projects ページに移動します。このチュートリアルで使う GitHub アカウントの組織が選択されていることを確認し、一覧からリポジトリを探します。
リポジトリの横にある Set up をクリックして、情報の追加を始めます。
表示されたモーダルで Faster を選択すると、スターター パイプラインが新しい circleci-project-setup ブランチにコミットされます。続いて Set Up Project をクリックします。このプロジェクト独自の設定は、チュートリアルの後半で main ブランチに追加します。追加が済んだら、circleci-project-setup ブランチは削除してかまいません。
GitHub の認証を設定する
継続的デプロイの戦略の一部として、このプロジェクト用に作成するパイプライン設定から buildimage ブランチにプッシュします。そのため、CircleCI が GitHub 上のリポジトリにアクセスするには認証済みのアクセス権が必要です。
CircleCI では、ユーザー キーを追加してこれを実現できます。プロジェクトで Project Settings -> SSH Keys に移動し、User Key セクションに進みます。セクションに Authorize with GitHub リンクが表示されている場合は、クリックして GitHub に接続し、SSH Keys ページの User Key セクションに戻ります。
Add User Key をクリックし、マシン ユーザーの使用に関する警告が表示されたら Confirm User をクリックします。
これで CircleCI はこのキーを使ってコードをチェックアウトするようになり、パイプラインは buildimage ブランチへのプッシュに必要な書き込み権限を得られます。
パイプライン スクリプトでは GitHub のメール アドレスとユーザー名を使うため、これらを環境変数として保存します。プロジェクト設定のサイド メニューで Environment Variables をクリックし、以下を追加します。
GITHUB_EMAIL: 接続した GitHub アカウントのメール アドレスGITHUB_USERNAME: GitHub のユーザー名
パイプライン スクリプトを作成する
このチュートリアルの最後のタスクは、カスタム docker イメージの継続的デプロイ パイプライン スクリプトを作成することです。
パイプライン スクリプトから GitHub リポジトリの buildimage ブランチに更新をプッシュできるようにするために、Node パッケージの gh-pages を使います。このパッケージは、任意のリポジトリ内で、あるブランチから別のブランチにファイルをプッシュするように設定できます。
プロジェクトのルートで以下のコマンドを実行して、このパッケージを開発用の依存関係としてインストールします。
npm install gh-pages --save-dev
次に、package.json ファイルに pushtobuild スクリプトを追加します。
"scripts" : {
.....,
"pushtobuild": "npx gh-pages -b buildimage --message '[skip ci] Updates' -d ./"
}
このスクリプトは npx を使って gh-pages を呼び出し、main ブランチから buildimage ブランチにファイルをプッシュします。--message パラメーターに [skip ci] Updates を指定しているのは、このブランチに変更がプッシュされたときに CircleCI がパイプラインを再実行しないようにするためです。
これで、パイプライン スクリプトを書き始められます。プロジェクトのルートに .circleci という名前のフォルダーを作成し、その中に config.yml という名前のファイルを作成します。config.yml に以下を入力します。
version: 2.1
jobs:
build:
working_directory: ~/repo
docker:
- image: cimg/node:lts
steps:
- checkout
- restore_cache:
key: dependency-cache-{{ checksum "package-lock.json" }}
- run:
name: install-packages
command: npm install
- save_cache:
key: dependency-cache-{{ checksum "package-lock.json" }}
paths:
- ./node_modules
- run:
name: Run tests
command: npm run test
deploy:
working_directory: ~/repo
docker:
- image: cimg/node:lts
steps:
- checkout
- run:
name: Configure Github credentials
command: |
git config user.email $GITHUB_EMAIL
git config user.name $GITHUB_USERNAME
- run:
name: Build Image on Azure Container Registry Task
command: npm run pushtobuild
workflows:
build:
jobs:
- build
- deploy:
requires:
- build # only deploy once build job has completed
filters:
branches:
only: main # only deploy on the main branch
このファイルでは、2 つの jobs を持つワークフローを定義しています。
build ジョブは、リモート リポジトリからコードをチェックアウトし、必要な依存関係をインストールして、コードにバグがないことを確認するためにテストを実行します。build ジョブが完了すると、deploy ジョブが引き継ぎ、コードのクリーンなコピーをチェックアウトします (前のジョブの node_modules フォルダーを監視対象のブランチにプッシュしたくないためです)。次に、パイプライン スクリプトが監視対象のブランチ (buildimage) にプッシュするコミットに使う Git のユーザー メール アドレスとユーザー名を設定します。最後に、deploy ジョブは Node.js スクリプトを実行して更新をプッシュし、docker イメージの新しいビルドを開始します。
更新をコミットして GitHub リポジトリにプッシュすると、ワークフローが成功します。
build ジョブをクリックすると、成功したテストを確認できます。
処理の詳細を確認するには、deploy ジョブをクリックします (ブラウザーで 1 つ前のページに戻ります)。
レジストリのタスクで Services -> Tasks に進み、Runs タブをクリックします。ビルドが実行中であることを確認できます。
しばらくするとビルドが完了し、Succeeded と表示されます。
Services -> Repositories でイメージをクリックすると、Last updated date が変わっており、新しいビルドが最新のイメージになったことがわかります。
まとめ
Azure Container Registry では、コンテナー イメージを保存し、コンテナー ワークロードを高速かつスケーラブルに取得できます。このチュートリアルでは、カスタム docker イメージをビルドし、アプリケーション コードや Dockerfile が変更されるたびに ACR に継続的にデプロイしました。学んだ内容を実際の業務に活かすには、今すぐ CircleCI の無料トライアルにサインアップしてください。
それでは、コーディングを楽しんでください!