Artifact Registry による依存関係の管理

1. 概要

Container Registry の進化形である Artifact Registry は、コンテナイメージと言語パッケージ（Maven や npm など）を 1 か所で管理できるサービスです。Google Cloud のツールおよびランタイムと完全に統合されており、npm や Maven などのツールで使用する言語ベースの依存関係管理がサポートされています。これにより、CI / CD ツールと簡単に統合して自動化パイプラインを設定できるようになります。

このラボでは、Artifact Registry で利用できる機能について説明します。

学習内容

このラボの学習目標は何ですか？

コンテナと言語パッケージ用のリポジトリを作成する
Artifact Registry を使用してコンテナイメージを管理する
Java の依存関係に Artifact Registry を使用するように Maven を構成する

2. 設定と要件

セルフペース型の環境設定

Google Cloud Console にログインして、プロジェクトを新規作成するか、既存のプロジェクトを再利用します。Gmail アカウントも Google Workspace アカウントもまだお持ちでない場合は、アカウントを作成してください。

プロジェクト名は、このプロジェクトの参加者に表示される名称です。Google API では使用されない文字列です。この設定はいつでも変更できます。
プロジェクト ID は、すべての Google Cloud プロジェクトにおいて一意でなければならず、不変です（設定後は変更できません）。Cloud コンソールでは一意の文字列が自動生成されます。通常は、この内容を意識する必要はありません。ほとんどの Codelab では、プロジェクト ID（通常は PROJECT_ID と識別されます）を参照する必要があります。生成された ID が好みではない場合は、ランダムに別の ID を生成できます。または、ご自身で試して、利用可能かどうかを確認することもできます。このステップ以降は変更できず、プロジェクトを通して同じ ID になります。
なお、3 つ目の値として、一部の API が使用するプロジェクト番号があります。これら 3 つの値について詳しくは、こちらのドキュメントをご覧ください。

次に、Cloud のリソースや API を使用するために、Cloud コンソールで課金を有効にする必要があります。この Codelab の操作をすべて行って、費用が生じたとしても、少額です。このチュートリアルの終了後に請求が発生しないようにリソースをシャットダウンするには、作成したリソースを削除するか、プロジェクト全体を削除します。Google Cloud の新規ユーザーは、300 米ドル分の無料トライアルプログラムをご利用いただけます。

gcloud を設定する

Cloud Shell で、プロジェクト ID とプロジェクト番号を設定します。これらの情報は、PROJECT_ID 変数と PROJECT_NUMBER 変数として保存します。

export PROJECT_ID=$(gcloud config get-value project)
export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format='value(projectNumber)')

Google サービスを有効にする

gcloud services enable \
  cloudresourcemanager.googleapis.com \
  container.googleapis.com \
  artifactregistry.googleapis.com \
  containerregistry.googleapis.com \
  containerscanning.googleapis.com

ソースコードを取得する

このラボのソースコードは、GitHub の GoogleCloudPlatform 組織にあります。次のコマンドでクローンを作成し、ディレクトリに移動します。

git clone https://github.com/GoogleCloudPlatform/cloud-code-samples/

3. コンテナイメージの操作

Artifact Registry で Docker リポジトリを作成する

Artifact Registry は、コンテナイメージと言語パッケージの管理に役立ちます。アーティファクトのタイプによって必要な仕様が異なります。たとえば、Maven の依存関係のリクエストは Node の依存関係のリクエストとは異なります。

さまざまな API 仕様をサポートするために、ユーザーが求める API レスポンスの形式を Artifact Registry に把握させる必要があります。これを行うには、リポジトリを作成し、目的のリポジトリタイプを示す --repository-format フラグを渡します。

Cloud Shell から次のコマンドを実行して、Docker イメージのリポジトリを作成します。

gcloud artifacts repositories create container-dev-repo --repository-format=docker \
--location=us-central1 --description="Docker repository for Container Dev Workshop"

Cloud Shell の承認を求めるプロンプトが表示されたら、[承認] をクリックします。

Google Cloud コンソール（[Artifact Registry] - [リポジトリ]）に移動し、新しく作成された Docker リポジトリ container-dev-repo を確認します。クリックすると、現時点では空であることがわかります。

Artifact Registry に対する Docker の認証を構成する

Artifact Registry に接続する際には、アクセスのために認証情報が必要です。Docker は、個別の認証情報を設定するのではなく、gcloud 認証情報をそのまま使用するように構成できます。

Cloud Shell から次のコマンドを実行することによって、Google Cloud CLI を使用して us-central1 リージョンの Artifact Registry へのリクエストを認証するように Docker を構成します。

gcloud auth configure-docker us-central1-docker.pkg.dev

コマンドを実行すると、Cloud Shell の Docker 構成を変更するかどうかを確認するプロンプトが表示されるので、Enter キーを押します。

サンプルアプリケーションを調べる

前の手順でクローンを作成した Git リポジトリにサンプルアプリケーションが用意されています。java ディレクトリに移動して、アプリケーションコードを確認します。

cd cloud-code-samples/java/java-hello-world

このフォルダには、簡単なウェブページをレンダリングする Java アプリケーションのサンプルが含まれています。このラボでは扱わないさまざまなファイルのほかに、src フォルダの下にソースコードと、コンテナイメージをローカルでビルドするための Dockerfile が含まれています。

コンテナイメージをビルドする

Artifact Registry にコンテナイメージを保存するには、まずコンテナイメージを作成する必要があります。

次のコマンドを実行してコンテナイメージをビルドし、適切なタグを付けて次のステップでリポジトリに push します。

docker build -t us-central1-docker.pkg.dev/$PROJECT_ID/container-dev-repo/java-hello-world:tag1 .

コンテナイメージを Artifact Registry に push する

次のコマンドを実行して、以前に作成したリポジトリにコンテナイメージを push します。

docker push us-central1-docker.pkg.dev/$PROJECT_ID/container-dev-repo/java-hello-world:tag1

Artifact Registry のイメージを確認する

Google の Cloud コンソール - Artifact Registry - リポジトリに移動 . container-dev-repo をクリックして、java-hello-world イメージがあることを確認します。画像をクリックし、tag1 のタグが付いていることを確認します。脆弱性スキャンが実行中であるか、すでに完了していることがわかります。検出された脆弱性の数が表示されています。

脆弱性の数をクリックすると、イメージで検出された脆弱性が CVE 情報の名前および重大度とともに一覧表示されます。各脆弱性の [表示] をクリックすると、詳細を確認できます。

4. 言語パッケージを操作する

このセクションでは、Artifact Registry の Java リポジトリを設定し、そこにパッケージをアップロードして、さまざまなアプリケーションで利用する方法について説明します。

Java パッケージリポジトリを作成する

Cloud Shell から次のコマンドを実行して、Java アーティファクトのリポジトリを作成します。

gcloud artifacts repositories create container-dev-java-repo \
    --repository-format=maven \
    --location=us-central1 \
    --description="Java package repository for Container Dev Workshop"

Cloud Shell の承認を求めるプロンプトが表示されたら、[承認] をクリックします。

Google Cloud コンソール（[Artifact Registry] - [リポジトリ]）に移動し、新しく作成された Maven リポジトリ container-dev-java-repo を確認します。クリックすると、現時点では空であることがわかります。

Artifact Repository の認証を設定する

次のコマンドを使用して、アプリケーションのデフォルト認証情報（ADC）をユーザーアカウントの認証情報で更新します。これにより、Artifact Registry 認証情報ヘルパーが、リポジトリへの接続時にこの認証情報を使用できるようになります。

gcloud auth login --update-adc

Artifact Registry 用に Maven を構成する

java-hello-world フォルダから次のコマンドを実行して Cloud Shell エディタを開き、アプリケーションフォルダをワークスペースに追加します。

cloudshell workspace .

[サイトが機能していますか？]、[Cookie を許可] の順にクリックして、サードパーティ Cookie を有効にします。

ブラウザが再読み込みされたら、Cloud Shell を開き、上記のコマンドをもう一度実行してアプリケーションフォルダを読み込みます。

Cloud Shell エディタで pom.xml を開き、[エディタを開く] をクリックします。

Cloud Shell エディタからターミナルを開き、次のコマンドを実行して、Java プロジェクトに追加するリポジトリ構成をプリントします。

gcloud artifacts print-settings mvn \
    --repository=container-dev-java-repo \
    --location=us-central1

返された設定を pom.xml ファイルの適切なセクションに追加します。

組み込みターミナルを備えた Cloud エディタのビュー:

distributionManagement セクションを更新する

<distributionManagement>
   <snapshotRepository>
     <id>artifact-registry</id>
     <url>artifactregistry://us-central1-maven.pkg.dev/<PROJECT>/container-dev-java-repo</url>
   </snapshotRepository>
   <repository>
     <id>artifact-registry</id>
     <url>artifactregistry://us-central1-maven.pkg.dev/<PROJECT>/container-dev-java-repo</url>
   </repository>
</distributionManagement>

repositories セクションを更新する

 <repositories>
   <repository>
     <id>artifact-registry</id>
     <url>artifactregistry://us-central1-maven.pkg.dev/<PROJECT>/container-dev-java-repo</url>
     <releases>
       <enabled>true</enabled>
     </releases>
     <snapshots>
       <enabled>true</enabled>
     </snapshots>
   </repository>
 </repositories>

拡張機能を更新する

<extensions>
     <extension>
       <groupId>com.google.cloud.artifactregistry</groupId>
       <artifactId>artifactregistry-maven-wagon</artifactId>
       <version>2.1.0</version>
     </extension>
   </extensions>

参考として、完全なファイルの例を以下に示します。<PROJECT> は、プロジェクト ID に置き換えてください。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 
 <artifactId>hello-world</artifactId>
 <packaging>jar</packaging>
 <name>Cloud Code Hello World</name>
 <description>Getting started with Cloud Code</description>
 <version>1.0.0</version>
<distributionManagement>
   <snapshotRepository>
     <id>artifact-registry</id>
     <url>artifactregistry://us-central1-maven.pkg.dev/<PROJECT>/container-dev-java-repo</url>
   </snapshotRepository>
   <repository>
     <id>artifact-registry</id>
     <url>artifactregistry://us-central1-maven.pkg.dev/<PROJECT>/container-dev-java-repo</url>
   </repository>
 </distributionManagement>
 
 <repositories>
   <repository>
     <id>artifact-registry</id>
     <url>artifactregistry://us-central1-maven.pkg.dev/<PROJECT>/container-dev-java-repo</url>
     <releases>
       <enabled>true</enabled>
     </releases>
     <snapshots>
       <enabled>true</enabled>
     </snapshots>
   </repository>
 </repositories>
 
 <parent>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-parent</artifactId>
   <version>2.6.3</version>
 </parent>
 
 <properties>
   <java.version>1.8</java.version>
   <checkstyle.config.location>./checkstyle.xml</checkstyle.config.location>
 </properties>
 
 <build>
   <plugins>
     <plugin>
       <groupId>com.google.cloud.tools</groupId>
       <artifactId>jib-maven-plugin</artifactId>
       <version>3.2.0</version>
     </plugin>
     <plugin>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-maven-plugin</artifactId>
     </plugin>
     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-checkstyle-plugin</artifactId>
       <version>3.1.2</version>
     </plugin>
   </plugins>
   <extensions>
     <extension>
       <groupId>com.google.cloud.artifactregistry</groupId>
       <artifactId>artifactregistry-maven-wagon</artifactId>
       <version>2.1.0</version>
     </extension>
   </extensions>
 </build>
 
 <!-- The Spring Cloud GCP BOM will manage spring-cloud-gcp version numbers for you. -->
 <dependencyManagement>
   <dependencies>
     <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-gcp-dependencies</artifactId>
       <version>1.2.8.RELEASE</version>
       <type>pom</type>
       <scope>import</scope>
     </dependency>
   </dependencies>
 </dependencyManagement>
  
 <dependencies>
 
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter</artifactId>
   </dependency>
 
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-jetty</artifactId>
   </dependency>
 
   <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-webmvc</artifactId>
   </dependency>
 
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-thymeleaf</artifactId>
   </dependency>
 
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-test</artifactId>
     <scope>test</scope>
   </dependency>
 
   <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-gcp-starter-logging</artifactId>
   </dependency>
      
 </dependencies>
 
</project>

Java パッケージを Artifact Registry にアップロードする

Maven で Artifact Registry を構成したので、Artifact Registry を使用して Java Jar を保存し、組織内の他のプロジェクトで使用できるようになりました。

次のコマンドを実行して、Java パッケージを Artifact Registry にアップロードします。

mvn deploy

Artifact Registry で Java パッケージを確認する

Cloud コンソール - Artifact Registry - リポジトリに移動し、container-dev-java-repo をクリックして、hello-world バイナリアーティファクトがあることを確認します。

5. 完了

お疲れさまでした。これでこの Codelab は終了です。

学習した内容

コンテナと言語パッケージ用のリポジトリを作成しました
Artifact Registry で管理されるコンテナイメージ
Java の依存関係に Artifact Registry を使用するように Maven を構成しました

クリーンアップ

次のコマンドを実行してプロジェクトを削除します。

gcloud projects delete $PROJECT_ID