Zenn
📦

Artifact Registryのリモートリポジトリを使ってDocker HubからCloud Runへのお手軽デプロイ

2023/04/28に公開
Docker
Google Cloud
Cloud Run
Docker Hub
Artifact Registry
tech

TL;DR

  • Artifact Registry に Docker のリモートリポジトリというプレビュー機能が追加されました
  • リモートリポジトリを作ると、それ経由で Docker Hub のイメージを Cloud Run にデプロイでき、キャッシュもしてくれます
  • リモートリポジトリのコンテナイメージはこのように指定します：<REGION_NAME>-docker.pkg.dev/<PROJECT_ID>/<REPOSITORY_NAME>/<DOCKER_HUB_IMAGE_NAME>(:<TAG>)

はじめに

Cloud Run にデプロイするコンテナイメージは、必ず Google Cloud の Artifact Registry や Container Registry に Push する必要があります。そのためこれまでは、Docker Hub で公開されている既存のコンテナイメージであっても、デプロイ前にローカルの作業環境などを経由してそれらのプライベートリポジトリにコンテナイメージをアップロードし直す必要があり、それがちょっと面倒なポイントでした（AWS だと、Amazon ECR Public がそのあたりカバーしてくれていると思います）。

しかし、Artifact Registry の 2023 年 2 月のアップデート で、リモートリポジトリ という機能のプレビュー提供がはじまり、この点が改善されました。

Artifact Registry にリモートリポジトリを作成すると、そのリモートリポジトリを経由して、Docker Hub 上の公開イメージを Pull することが可能になります。リモートリポジトリがプロキシとして働いてくれるイメージですね（Docker Client/Cloud Run <-> Artifact Registry リモートリポジトリ <-> Docker Hub）。

使い方はシンプルですが、一応順を追って見てみましょう。

リモートリポジトリの作成

まずは、公式ドキュメント に従って Cloud Console からリモートリポジトリを作成してみます。Artifact Registry の画面を開いて API を有効化したあと、リポジトリの作成 から、「形式」を Docker、「モード」を リモート と指定してリポジトリを作成します。

リモートリポジトリの作成

現状では、リモートリポジトリの接続先としては Docker Hub のみに対応しているので、自動的に Docker Hub が選択されていますね。リポジトリの作成が終わったあと、詳細画面を開くと以下のように表示されます。

リモートリポジトリの詳細

なお、Cloud Console の画面ではなく Terraform を利用する場合には、Google Cloud 用 Provider の google_artifact_registry_repository を使って、mode = "REMOTE_REPOSITORY" を指定することで同様にリモートリポジトリを作成できます。

resource "google_artifact_registry_repository" "repo" {
  location      = "asia-northeast1"
  repository_id = "docker"
  description   = "docker remote repository for Docker Hub"
  format        = "DOCKER"
  mode          = "REMOTE_REPOSITORY"
  remote_repository_config {
    docker_repository {
      public_repository = "DOCKER_HUB"
    }
  }
}

リモートリポジトリを使う

では早速、作成したリモートリポジトリを経由して Docker Hub のコンテナイメージを Pull してみましょう。ここでは、Docker Hub で公開されている hello-world というサンプルのコンテナイメージを Pull してみます。

通常、Docker Hub から直接イメージを Pull する場合は、docker pull hello-world といったように、イメージ名のみで指定していると思います。一方、Artifact Registry のリモートリポジトリ経由で Pull する場合には、Artifact Registry の URL 形式にしたがって、Pull 対象を以下のように指定します。

<REGION_NAME>-docker.pkg.dev/<PROJECT_ID>/<REPOSITORY_NAME>/<DOCKER_HUB_IMAGE_NAME>(:<TAG>)

<DOCKER_HUB_IMAGE_NAME> というのが、今回で言うと hello-world なので、例えば以下のようになります。
asia-northeast1-docker.pkg.dev/nosu-sandbox/docker/hello-world

あるいは、タグを明示的に指定する場合にはこうなります。
asia-northeast1-docker.pkg.dev/nosu-sandbox/docker/hello-world:latest

それでは、実際に Cloud Shell を開き、Docker Hub のイメージを Pull できるか見てみましょう。
最初に認証設定を行います。これによって、Docker の構成ファイル（.docker/config.json）に Artifact Registry 用の認証設定が追加されます。

gcloud auth configure-docker asia-northeast1-docker.pkg.dev

認証設定ができたら、あとは docker pull するだけです。

docker pull asia-northeast1-docker.pkg.dev/${PROJECT_ID}/docker/hello-world
# ...
# => Status: Downloaded newer image for asia-northeast1-docker.pkg.dev/<PROJECT_ID>/docker/hello-world:latest
# => asia-northeast1-docker.pkg.dev/${PROJECT_ID}/docker/hello-world:latest

うまくいきましたね。

リモートリポジトリから Cloud Run へデプロイする

では、いよいよ Docker Hub のイメージを Cloud Run にデプロイしてみましょう。ここでは、Docker Hub で公開されている dockersamples/static-site というサンプルの Web アプリをデプロイしてみます。

まず、Cloud Console から Cloud Run のサービスデプロイ画面を開いてみると、先ほど Pull した hello-world のみが表示されているのがわかります。少なくとも現状では、一度 Pull してキャッシュされたイメージしか指定できないようです。

コンテナイメージの選択

一方で、gcloud コマンドを使えばキャッシュの有無に関わらず Docker Hub 上のコンテナイメージを何でもデプロイできるので、ここでは gcloud コマンドを使ってデプロイしてみます。

gcloud run deploy image-from-docker-hub \
  --image=asia-northeast1-docker.pkg.dev/nosu-sandbox/docker/dockersamples/static-site \
  --port=80 --allow-unauthenticated --region=asia-northeast1
# Deploying container to Cloud Run service [image-from-docker-hub] in project [nosu-sandbox] region [asia-northeast1]
# OK Deploying new service... Done.                                                                   
#   OK Creating Revision... Creating Service.
#   OK Routing traffic...
#   OK Setting IAM Policy...
# Done.
# Service [image-from-docker-hub] revision [image-from-docker-hub-00001-kuc] has been deployed and is serving 100 percent of traffic.
# Service URL: https://image-from-docker-hub-laqxooze7a-an.a.run.app

Service URL をブラウザで開くと、デプロイした Web サイトが表示されます。
デプロイが正常に完了して、Cloud Run でホストされた Web アプリが正常に動作していることが確認できました。

dockersamples/static-site

（おまけ）他のプロジェクトの Cloud Run からリモートリポジトリを利用する

ここからはおまけです。検証用途などで、Docker Hub 上のコンテナイメージをサクッと Cloud Run にデプロイしたいことは非常によくあると思いますが（？）、そのためだけにプロジェクトごとにリモートリポジトリを作成するのは面倒です。

その場合、どこかの共有プロジェクトにリモートリポジトリを一個作っておいて、（本番環境など細かい権限管理が必要なケースを除いた）雑多な用途で共通利用する、ということもできます。ただし、その場合は Cloud Run のプロジェクトから Artifact Registry を読み取ることができるように権限付与を行う必要があります。

具体的には、Cloud Run が Artifact Registry からイメージを Pull する際には、Cloud Run の属するプロジェクトにおける Cloud Run の Service Agent と呼ばれるサービスアカウント（service-<PROJECT_NUMBER>@serverless-robot-prod.iam.gserviceaccount.com）の権限が利用されます。この Service Agent がリモートリポジトリにアクセスできるようにするために、以下のようにしてリモートリポジトリが存在しているプロジェクトにおける Artifact Registry 読み取り（roles/artifactregistry.reader） 権限を付与します。

<PROJECT_NUMBER> は、Cloud Run をデプロイするプロジェクトのものです。よく利用する Project ID ではなく Project Number（プロジェクト番号）が必要なのでご注意ください。（参考：プロジェクト番号の確認方法）

gcloud artifacts repositories add-iam-policy-binding docker \
   --project=<PROJECT_ID (where Artifact Registry exists)> \
   --location=asia-northeast1 \
   --member="serviceAccount:service-<PROJECT_NUMBER (where Cloud Run exists)>@serverless-robot-prod.iam.gserviceaccount.com" \
   --role=roles/artifactregistry.reader

Terraform の場合はこんな感じです。

resource "google_artifact_registry_repository_iam_member" "repo-iam" {
  location = "asia-northeast1"
  repository = "docker"
  role   = "roles/artifactregistry.reader"
  member = "serviceAccount:service-<PROJECT_NUMBER (where Cloud Run exists)>@serverless-robot-prod.iam.gserviceaccount.com"
}

これで、異なるプロジェクトからでもリモートリポジトリを参照してデプロイできるようになりました。

gcloud run deploy image-from-other-project \
  --project=remote-repo-test \
  --image=asia-northeast1-docker.pkg.dev/nosu-sandbox/docker/dockersamples/static-site \
  --port=80 --allow-unauthenticated --region=asia-northeast1

感想

というわけで、リモートリポジトリの登場で、Docker Hub から Cloud Run へのデプロイがやりやすくなりました。Docker Hub に公開されているイメージや、あるいは自分で開発したアプリケーションでもオープンソース等で Docker Hub に公開するものであれば、リモートリポジトリ経由でのデプロイも検討してみると良さそうです。

なお、リモートリポジトリに加えて、仮想リポジトリ（Virtual Repository） という複数のリポジトリを一つのエンドポイントに集約するような機能も追加されています。これについても時間があるとき書こうと思います。

GitHubで編集を提案

Discussion