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

このページでは、Docker イメージをビルドして格納するように Cloud Build を構成する方法について説明します。Cloud Build を初めて使用する場合は、最初にクイックスタートとビルド構成の概要をご覧ください。

Cloud Build では、事前にビルドされたイメージが用意されています。このイメージを Cloud Build 構成ファイルで参照してタスクを実行できます。 これらのイメージは Google Cloud でサポートされ、管理されています。サポートされているビルド済みの Docker イメージを使用して Docker コマンドを実行し、Docker イメージをビルドできます。

注: このガイドは、Linux コンテナを対象としています。Windows Server コンテナについては、Cloud Build gke-windows-builder を使用したマルチ アーキテクチャ イメージのビルドをご覧ください。

始める前に

このページの説明は、Docker の知識があることを前提としています。また、次の準備が必要です。

• アプリケーションのソースコードと Dockerfile を同じ場所に置きます。
• Artifact Registry にイメージを保存するための Docker リポジトリを用意するか、新しいリポジトリを作成します。
• このページの gcloud コマンドを使用する場合は、Google Cloud CLI をインストールします。
• イメージを実行する場合は、Docker をインストールします。

ビルド構成ファイルによるビルド

ビルド構成ファイルを使用して Docker イメージをビルドするには、次のことを行います。

1. アプリケーションのソースコード が含まれているディレクトリに、cloudbuild.yaml または cloudbuild.json という名前でファイルを作成します。

2. ビルド構成ファイルで、次のことを行います。

   • name フィールドを追加し、事前にビルドされている Docker イメージを指定します。事前にビルドされたイメージは、Container Registry の gcr.io/cloud-builders/docker に保存されています。以下の構成ファイルの例では、Cloud Build が使用するビルド済みの Docker イメージが name フィールドに指定されています。このイメージは、args フィールドで指定されたタスクの実行に使用されます。

   • args フィールドに引数を追加してイメージをビルドします。

     YAML

     steps:
     - name: 'gcr.io/cloud-builders/docker'
       args: [ 'build', '-t', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME', '.' ]
     

     JSON

     {
      "steps": [
       {
           "name": "gcr.io/cloud-builders/docker",
           "args": [
             "build",
             "-t",
             "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME",
             "."
            ]
        }
        ]
      }
     

     上記のビルド構成のプレースホルダ値を次のように置き換えます。

   • LOCATION: Artifact Registry の Docker リポジトリのリージョンまたはマルチリージョンのロケーション。

   • PROJECT_ID: 実際の Cloud プロジェクト ID。

   • REPOSITORY: Artifact Registry の Docker リポジトリの名前。

   • IMAGE_NAME: コンテナ イメージの名前。

     Dockerfile とソースコードが異なるディレクトリにある場合、-f と Dockerfile へのパスを args フィールドの引数リストに追加します。

     YAML

     steps:
     - name: 'gcr.io/cloud-builders/docker'
       args: [ 'build', '-t', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME', '-f', 'DOCKERFILE_PATH', '.' ]
     

     JSON

     {
      "steps": [
       {
           "name": "gcr.io/cloud-builders/docker",
           "args": [
             "build",
             "-t",
             "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME", '-f', 'DOCKERFILE_PATH', "."
            ]
        }
        ]
      }
     

     上記のビルド構成のプレースホルダ値を次のように置き換えます。

     • LOCATION: リポジトリのリージョンまたはマルチリージョンのロケーション。
     • PROJECT_ID: 実際の Cloud プロジェクト ID。
     • REPOSITORY: Artifact Registry リポジトリの名前。
     • IMAGE_NAME: コンテナ イメージの名前。
     • DOCKERFILE_PATH: Dockerfile へのパス。

3. ビルド構成ファイルを使用してビルドを開始します。

   gcloud builds submit --config CONFIG_FILE_PATH SOURCE_DIRECTORY
   

   上記のコマンドのプレースホルダ値を次のように置き換えます。

   • CONFIG_FILE_PATH: ビルド構成ファイルのパス。
   • SOURCE_DIRECTORY: ソースコードのパスまたは URL。

   gcloud builds submit コマンドに CONFIG_FILE_PATH と SOURCE_DIRECTORY を指定しないと、Cloud Build は、構成ファイルとソースコードが現在の作業ディレクトリにあることを前提とします。

Dockerfile によるビルド

Cloud Build では、Dockerfile のみを使用して Docker イメージをビルドできます。個別のビルド構成ファイルは不要です。

Dockerfile を使用してビルドするには、ソースコードと Dockerfile が格納されているディレクトリから次のコマンドを実行します。

    gcloud builds submit --tag LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME

上記のコマンドのプレースホルダ値を次のように置き換えます。

• LOCATION: リポジトリのリージョンまたはマルチリージョンのロケーション。
• PROJECT_ID: 実際の Cloud プロジェクト ID。
• REPOSITORY: Artifact Registry リポジトリの名前。
• IMAGE_NAME: コンテナ イメージの名前。

Cloud Native Buildpack によるビルド

Cloud Build では、Dockerfile やビルド構成ファイルを使用せずにイメージをビルドできます。これは、Cloud Native Buildpacks を使用して行います。

Buildpacks を使用してビルドするには、ソースコードが格納されているディレクトリから次のコマンドを実行します。

    gcloud builds submit --pack builder=BUILDPACK_BUILDER, \
        env=ENVIRONMENT_VARIABLE, \
        image=IMAGE_NAME

上記のコマンドのプレースホルダ値を次のように置き換えます。

• BUILDPACK_BUILDER: 使用する buildpacks ビルダー。ビルダーを指定しない場合、Cloud Build はデフォルトで gcr.io/buildpacks/builder を使用します。
• ENVIRONMENT_VARIABLE: ビルドの環境変数。
• IMAGE: Artifact Registry 内のイメージの URL。イメージの URL は、LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME の形式にする必要があります。

次にコマンドの例を示します。

• デフォルトの gcr.io/buildpacks/builder を使用してビルドを実行し、イメージ us-docker.pkg.dev/gcb-docs-project/containers/gke/hello-app を作成します。

    gcloud builds submit --pack image=us-docker.pkg.dev/gcb-docs-project/containers/gke/hello-app
  

• 区切り文字に ^--^ を使用して、複数の環境変数をビルドに渡します。引数のエスケープについての詳細は、gcloud topic escaping をご覧ください。

    gcloud builds submit --pack \
        ^--^image=gcr.io/my-project/myimage--env=GOOGLE_ENTRYPOINT='java -jar target/myjar.jar',GOOGLE_RUNTIME_VERSION='3.1.301'
  

Buildpacks を使用するようにトリガーを構成する: コマンドラインを使用してビルドするだけでなく、Buildpacks を使用してイメージを自動的にビルドするようにトリガーを構成できます。詳しくは、ビルドトリガーの作成と管理をご覧ください。

Artifact Registry にイメージを保存するさまざまな方法

ビルド済みのイメージを次のいずれかの方法で格納するように Cloud Build を構成できます。

• images フィールドを使用する。ビルドが完了した後、Artifact Registry にイメージを格納します。
• docker push コマンドを使用する。ビルドフローの中で Artifact Registry にイメージを格納します。

images フィールドを使用した場合と Docker push コマンドを使用した場合の違いは、images フィールドを使用した場合、保存されたイメージがビルド結果に表示されることです。たとえば、Google Cloud コンソールのビルドの [ビルドの説明] ページや、Build.get() の結果、gcloud builds list の結果に表示されます。一方、Docker push コマンドを使用してビルドされたイメージを保存すると、イメージはビルド結果に表示されません。

ビルドフローの中でイメージを保存し、ビルドの結果にイメージを表示する場合は、ビルド構成ファイルで Docker の push コマンドと images フィールドの両方を使用します。

ビルドの完了後に Artifact Registry にコンテナ イメージを格納するには次のことを行います。

1. ターゲット リポジトリが存在しない場合は、新しいリポジトリを作成します。
2. アプリケーションのソースコードと Dockerfile が含まれているディレクトリに、cloudbuild.yaml または cloudbuild.json という名前でファイルを作成します。

3. ビルド構成ファイルに、イメージをビルドするビルドステップを追加して、images フィールドを追加してビルドイメージを指定します。これにより、Artifact Registry にイメージが格納されます。以下のスニペットは、イメージをビルドして Artifact Registry に格納するビルド構成を示しています。

   YAML

   steps:
   - name: 'gcr.io/cloud-builders/docker'
     args: [ 'build', '-t', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME', '.' ]
   images: ['LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME']
   

   JSON

   {
   "steps": [
   {
       "name": "gcr.io/cloud-builders/docker",
       "args": [
           "build",
           "-t",
           "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME",
           "."
       ]
   }
   ],
   "images": [
       "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME"
   ]
   }
   

   ここで

   • LOCATION: リポジトリのリージョンまたはマルチリージョンのロケーション。
   • PROJECT_ID: 実際の Cloud プロジェクト ID。
   • REPOSITORY: Artifact Registry リポジトリの名前。
   • IMAGE_NAME: コンテナ イメージの名前。

4. ビルド構成ファイルを使用してビルドを開始します。

   gcloud builds submit --config CONFIG_FILE_PATH SOURCE_DIRECTORY
   

   ここで

   • CONFIG_FILE_PATH は、ビルド構成ファイルへのパスです。
   • SOURCE_DIRECTORY は、ソースコードへのパスまたは URL です。

ビルドフローの中で Artifact Registry にイメージを格納するには次のことを行います。

1. アプリケーションのソースコードと Dockerfile が含まれているディレクトリに、cloudbuild.yaml または cloudbuild.json という名前でファイルを作成します。

2. ビルド構成ファイルで、イメージをビルドする docker ビルドステップを追加します。さらに、別の docker ビルドステップを追加して引数を渡し、push コマンドを呼び出します。

   YAML

   steps:
   - name: 'gcr.io/cloud-builders/docker'
     args: ['build', '-t', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME', '.']
   - name: 'gcr.io/cloud-builders/docker'
     args: ['push', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME']
   

   JSON

   {
     "steps": [
      {
         "name": "gcr.io/cloud-builders/docker",
         "args": [
             "build",
             "-t",
             "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME",
             "."
          ]
      },
      {
          "name": "gcr.io/cloud-builders/docker",
          "args": [
             "push",
             "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME"
           ]
      }
     ]
   }
   

   ここで

   • LOCATION: リポジトリのリージョンまたはマルチリージョンのロケーション。
   • PROJECT_ID: 実際の Cloud プロジェクト ID。
   • REPOSITORY: Artifact Registry リポジトリの名前。
   • IMAGE_NAME: コンテナ イメージの名前。

3. ビルド構成ファイルを使用してビルドを開始します。

   gcloud builds submit --config CONFIG_FILE_PATH SOURCE_DIRECTORY
   

   ここで

   • CONFIG_FILE_PATH は、ビルド構成ファイルへのパスです。
   • SOURCE_DIRECTORY は、ソースコードへのパスまたは URL です。

ビルドフローの中でイメージを格納し、ビルド結果にイメージを表示するには次のことを行います。

1. アプリケーションのソースコードと Dockerfile が含まれているディレクトリに、cloudbuild.yaml または cloudbuild.json という名前でファイルを作成します。

2. ビルド構成ファイルで、push コマンドを呼び出す Docker 起動ステップをイメージのビルドステップの後に追加し、images フィールドを追加します

   YAML

   steps:
   - name: 'gcr.io/cloud-builders/docker'
     args: ['build', '-t', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME', '.']
   - name: 'gcr.io/cloud-builders/docker'
     args: ['push', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME']
   images: ['LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME']
   

   JSON

   {
       "steps": [
      {
          "name": "gcr.io/cloud-builders/docker",
          "args": [
              "build",
              "-t",
              "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME",
              "."
           ]
      },
      {
          "name": "gcr.io/cloud-builders/docker",
          "args": [
              "push",
              "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME"
           ]
      }
      ],
       "images": [
          "LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME"
       ]
   }
   

   ここで

   • LOCATION: リポジトリのリージョンまたはマルチリージョンのロケーション。
   • PROJECT_ID: 実際の Cloud プロジェクト ID。
   • REPOSITORY: Artifact Registry リポジトリの名前。
   • IMAGE_NAME: コンテナ イメージの名前。

3. ビルド構成ファイルを使用してビルドを開始します。

   gcloud builds submit --config CONFIG_FILE_PATH SOURCE_DIRECTORY
   

   ここで

   • CONFIG_FILE_PATH は、ビルド構成ファイルへのパスです。
   • SOURCE_DIRECTORY は、ソースコードへのパスまたは URL です。

Docker イメージを実行する

ビルドしたイメージが想定どおりに動作することを確認するため、Docker を使用してイメージを実行できます。

1. Artifact Registry を操作するときに Artifact Registry 認証情報を使用するように Docker を構成します。（この操作は初回のみ必要です。）gcloud 認証ヘルパーを使用して認証するには、次のコマンドを使用します。

   gcloud auth configure-docker HOSTNAME-LIST
   

   HOSTNAME-LIST は、認証ヘルパー構成に追加するリポジトリ ホスト名のカンマ区切りのリストです。

   たとえば、リージョン us-central1 と asia-northeast1 を追加するには、次のコマンドを実行します。

   gcloud auth configure-docker us-central1-docker.pkg.dev,asia-northeast1-docker.pkg.dev
   

2. 以前ビルドした Docker イメージを実行します。

   docker run LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE_NAME
   

   ここで

   • LOCATION: リポジトリのリージョンまたはマルチリージョンのロケーション。
   • PROJECT_ID: 実際の Cloud プロジェクト ID。
   • REPOSITORY: Artifact Registry リポジトリの名前。
   • IMAGE_NAME: コンテナ イメージの名前。

   出力は次のようになります。

   Hello, world! The time is Fri Feb  2 16:09:54 UTC 2018.
   

次のステップ

• Java アプリケーションをビルドする方法を学習する。
• Python アプリケーションのビルド方法について説明します。
• Go アプリケーションをビルドする方法を学習する。
• Cloud Storage にビルド アーティファクトを保存する方法を学習する。
• Artifact Registry にビルド アーティファクトを保存する方法を学習する。
• ビルドエラーをトラブルシューティングする方法について学習する。