Google Cloud BuildでSPAのビルドとFirebase Hostingへのデプロイを自動化する

やりたいこと

以下を自動化したい

  • GitHubリポジトリのmasterブランチにコードをpushしたら
  • Cloud BuildでSPAをビルドして
  • Firebase Hostingにデプロイ

準備

Firebaseのセットアップ

firebase-cli ( https://firebase.google.com/docs/cli/ ) を使ってセットアップする

// Firebase CLIでログイン
$ firebase login

// SPAのプロジェクトディレクトリでfirebaseを初期化
$ firebase init

// hostingを選択
? **Which Firebase CLI features do you want to setup for this folder? Press Space**
❯◉ Hosting: Configure and deploy Firebase Hosting sites

// buildディレクトリの内容をdeployする
? **What do you want to use as your public directory?** (public) build

// SPAの設定
? **Configure as a single-page app (rewrite all urls to /index.html)?** (y/N) y

デプロイの確認

念のため、Firebase Hostingにローカルからデプロイできることを確認しておく

$ yarn build
$ firebase deploy

Cloud Buildの設定

APIの有効化

https://console.cloud.google.com/cloud-build/builds
にアクセスしてCloud Build APIを有効にする

ビルドトリガーの作成

「トリガーの作成」からビルドトリガーを作成する。

f:id:nishaya:20181010141637p:plain

cloudbuild.yamlの作成

cloudbuild.yamlを追加する。

ひとまずビルドの動作確認のため、yarn installyarn build の設定のみ書いてcommitし、masterにpushする

steps:
  - name: 'gcr.io/cloud-builders/yarn'
    args: ['install']
  - name: 'gcr.io/cloud-builders/yarn'
    args: ['build']

pushして確認

cloudbuild.yamlをcommit、pushしてトリガーの確認を行う。

Cloud Buildのビルド履歴から、ビルドの結果が閲覧できる。 各ビルドステップがグリーンになっていればトリガーが発動し、ビルドが成功している。

f:id:nishaya:20181010141707p:plain

Firebaseデプロイのビルドステップを追加する

ここを参考にした

github.com

Firebaseのイメージを作成してgcr.ioにsubmitしておく

$ git clone https://github.com/GoogleCloudPlatform/cloud-builders-community.git
$ cd cloud-builders-community/firebase/
$ gcloud builds submit --config cloudbuild.yaml .

Firebaseトークンの取得

firebase-cliを使ってCI用のトークンを取得する

$ firebase login:ci
...
✔  Success! Use this token to login on a CI server:

[GENERATED_TOKEN] // 生成されたトークンが表示される

// 後で使うのでexportしておく
$ export FIREBASE_TOKEN=[GENERATED_TOKEN]

KMSでトークンを暗号化

KMSの有効化

https://console.cloud.google.com/security/kms の「セットアップ」でAPIを有効にする

Cloud BuildのサービスアカウントにKMS復号の権限を追加

f:id:nishaya:20181010143112p:plain

トークンの暗号化

$ gcloud auth login
$ gcloud config set project [PROJECT_ID]
$ gcloud kms keyrings create cloudbuilder --location global
$ gcloud kms keys create firebase-token --location global --keyring cloudbuilder --purpose encryption
$ echo -n $FIREBASE_TOKEN | gcloud kms encrypt \
  --plaintext-file=- \
  --ciphertext-file=- \
  --location=global \
  --keyring=cloudbuilder \
  --key=firebase-token | base64
[ENCRYPTED_TOKEN]

表示されたトークンをコピーしておく

cloudbuild.yamlにステップを追加

steps:
  - name: 'gcr.io/cloud-builders/yarn'
    args: ['install']
  - name: 'gcr.io/cloud-builders/yarn'
    args: ['build']
  - name: 'gcr.io/$PROJECT_ID/firebase'
    args: ['deploy', '--project=$PROJECT_ID']
    secretEnv: ['FIREBASE_TOKEN']
secrets:
# kmsKeyNameの中では$PROJECT_IDが使えないので直接書く必要あり
- kmsKeyName: 'projects/[PROJECT_ID]/locations/global/keyRings/cloudbuilder/cryptoKeys/firebase-token'
  secretEnv:
    FIREBASE_TOKEN: '[ENCRYPTED_TOKEN]' # ここにさきほどコピーしたトークンをペースト

確認

以上の設定を行い、cloudbuild.yamlをcommitしてGitHubにpushすればビルドが開始される

f:id:nishaya:20181010143230p:plain

余談: create-react-appの環境変数

ビルドトリガーにはsubstitution(代入変数)という形で変数を定義できるが、そのまま環境変数としてロードされるわけではないので env を使ってsubstitution -> 環境変数への変換を行う必要がある

f:id:nishaya:20181010143250p:plain

ビルドトリガーで上記のようにsubstitutionを設定し、cloudbuild.yamlで下記のようにして利用する

steps:
  - name: 'gcr.io/cloud-builders/yarn'
    args: ['install']
  - name: 'gcr.io/cloud-builders/yarn'
    args: ['build']
    env: # substitutionをenvに渡す
      - 'REACT_APP_GOOGLE_MAPS_API_KEY=$_GOOGLE_MAPS_API_KEY'
...
substitutions:
  _GOOGLE_MAPS_API_KEY: your-api-key