はじめに
🎄🎅🎄🎅🎄🎅🎄「CI/CD Advent Calendar 2021」記念すべき1発目です🎄🎅🎄🎅🎄🎅🎄
（そして2年ぶりのAdvent Calendar参戦です）
というわけで早速、、、、、、本記事ではGCPのCloud Buildを使ってCI/CD環境を構築しSpring Bootアプリをビルド、デプロイしてみようと思います。
CI/CD環境を構築する上での課題
CI/CD環境は今や多くの現場で導入されており、私自身も利用した経験はあります。CI/CDのメリットは多くの記事で紹介されていますが、環境構築という点で以下のデメリットがあると思っています。
- CI/CDツールの選定工数がかかる
- CI/CD環境の構築工数がかかる
Cloud Buildとは
GCPが提供するサービスの1つで、GitHub等のVCSからソースを取得しビルド、デプロイを行うサービスです。定義ファイルに一連のビルドステップを記述することでビルド、デプロイを実行します。ビルドを行うための機能がBuilderという形で提供されているため、上記課題に頭を抱えることなくCI/CD環境を構築することができます。
構築するCI/CD環境構成
今回構築するCI/CD環境構成は以下の通りです。
■概要
- GitHubへのPushをトリガーにCloud Buildでビルドを実行します。
- ビルド成果物をContainer Registory(GCPのDockerイメージリポジトリ)へPushします。
- Container RegistoryへPushしたDockerイメージをCloud Run(GCPのフルマネージドのサーバーレスプラットフォーム)へデプロイします。
つまり、GitHubへPushするだけでビルドからデプロイまでを自動化(CI/CD)することが可能になります。
なお、利用する資材はJava8で書かれたSpring Boot + H2DBのRest APIのサンプルです。
環境構築してみる
1. ビルドトリガーを作成
何をトリガーにビルドを実行するか、、を最初に設定する必要があるのでそちらから作成していきます。2021年12月時点でサポートされているトリガーは以下の通りです。
1-1. GCPのナビゲーションメニューからCloud Buildを選択する
1-2. トリガーを作成ボタンをクリック
1-3. トリガーの名前とイベントを入力してリポジトリの設定
任意のトリガーの名前を入力し、Cloud Buildのトリガーとなるイベントを選択します。本稿では、VCSにコードがPushされたことをトリガーにCloud Buildを回すので「ブランチにpushする」を選択します。そのあとに、どのリポジトリにPushされたら、、を設定するために新しいリポジトリへ接続をクリックします。
以降は下記キャプチャの赤枠の通り進めます。最終的に設定したものがリポジトリに表示されていればOKです。ブランチは任意のブランチを選択します。
1-4. 構成の設定
Cloud Buildへの指示はCloud Build 構成ファイル（yaml または json）やDockerfileから行えます。本稿ではcloudbuild.yamlというyamlファイルをGitHubリポジトリの直下に配置することで指示するものとします。
最後に作成ボタンをクリックして完了です。
1-5. リポジトリの確認
トリガーで設定したリポジトリへアクセスし、Settings→IntegrationsにGoogle Cloud Buildが表示されていればOKです。
2. Cloud Build APIを有効化
GCPのナビゲーションメニューからAPIとサービスを選択→APIとサービスの有効化→Cloud Buildで検索しCloud Build APIを選択し有効化します（キャプチャでは有効化した状態になっています）
3. Cloud Buildのサービスアカウントの有効化
Cloud Buildの設定から、Cloud Run管理者とサービスアカウントユーザーのステータスを有効化します。
4. 必要なロールをCloud Buildサービスアカウントに付与
IAMにてCloud Buildサービスアカウントに必要なロールをします。具体的にはCloud Run管理者ロールとService Usage管理者ロールを追加します。以下の図のようになっていればOKです、他の2つのロールは最初から付与されているはずですが、なければ追加します。
5. ビルド構成ファイル（cloudbuild.yaml）の作成
続いて、ビルド構成ファイル（cloudbuild.yaml）を作成します。ビルド構成ファイルには、Cloud Buildに実行させたいアクションをビルドステップごとに記述していきます。今回はシンプルに以下の流れとなるのでその通りに記述します。
Dockerイメージの作成
↓
DockerイメージをContainer RegistryへPush
↓
Clourd RunへDockerイメージをデプロイ
steps:
# Dockerイメージの作成
- name: 'gcr.io/cloud-builders/docker'
args: ['build', '-t', 'gcr.io/$PROJECT_ID/spring-boot-restful-api-test:$COMMIT_SHA', '.']
# DockerイメージをContainer RegistryへPush
- name: 'gcr.io/cloud-builders/docker'
args: ['push', 'gcr.io/$PROJECT_ID/spring-boot-restful-api-test:$COMMIT_SHA']
# DockerイメージをClourd Runへデプロイ
- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
entrypoint: gcloud
args:
- 'run'
- 'deploy'
- 'spring-boot-restful-api-test'
- '--image'
- 'gcr.io/$PROJECT_ID/spring-boot-restful-api-test:$COMMIT_SHA'
- '--region'
- 'asia-northeast1'
images:
- 'gcr.io/$PROJECT_ID/spring-boot-restful-api-test:$COMMIT_SHA'
ビルド構成ファイルのスキーマ構成やクラウドビルダーの詳細については以下の公式を参照ください。
・ビルド構成ファイルのスキーマ構成
・クラウドビルダー
・gcloud runコマンド
6. Dockerfileの作成
続いて、Dockerfileを作成します。Dockerイメージを作成するタイミング(docker buildのタイミング)でビルドとテストを行うため、RUNコマンドでmvn packageを実行させます。デプロイ後のdocker runのタイミングでSpring Bootを起動(Embedded Tomcatを起動)させるために、CMDコマンドでjavaコマンドを実行するという流れで記述します。
# Spring BootアプリをビルドするためMaven/Java8のDockerイメージを利用
FROM maven:3.5-jdk-8-alpine AS builder
# ビルド時のワークディレクトリの設定
WORKDIR /app
COPY pom.xml .
COPY src ./src
# Maven packageでビルドとテストを実行し成果物(jarファイル)を作成
RUN mvn package
# Spring Bootアプリの実行環境にopenjdk:8-jre-alpineを利用
FROM openjdk:8-jre-alpine
COPY --from=builder /app/target/Spring-Boot-RESTful-API-Test-Sample-1.0.0-SNAPSHOT.jar /app.jar
# Docker Run時にjavaコマンドでSpring Bootを起動(Embedded Tomcatを起動)
CMD ["java", "-Djava.security.egd=file:/dev/./urandom", "-jar", "/app.jar"]
7. 動作確認
任意のファイルを適当に修正しGitHubへPushして動作確認をしてみます。
無事ビルドが開始しました。
そして問題なく終了しました。
ビルドログも確認したところ、テストもちゃんと回っていることが確認できます。
Cloud Runの方も問題なさそうです。
実際に任意のAPIを叩いてみても期待通りのレスポンスが返ってきました（H2DB接続も問題なさそうです）。
8. 最後に
Cloud Buildを使ってCI/CD環境を構築してみましたが、大きな躓きもなく構築することができました（強いて言うならIAMの設定周りとDockerfileの書き方くらい）。所要時間としては、調査時間等も含めて約10時間ほどになります。今回は対象外としましたが、Cloud Buildで以下をどのように実現するか等も今後試してみたいと思います。
- テストレポートやカバレッジをグラフィカルに表示させる
- Sonar等を用いた静的解析も行う
- デプロイ後にSlack等のチャットへ通知
Appendix
- ソースリポジトリ ※5年前くらいにCircle CI、CodeCov、Slack連携するのに作ったお試しリポジトリになります
以上です。