[VM継続ビルド編] GCPでVMインスタンスを自動・自律的に構築する仕組み

# project root
.
├── packer
│  ├── config
│  │  └── build_env.yaml
│  ├── script
│  │  └── set_env.sh
│  └── source
│     ├── base.pkr.hcl
│     └── mysql.pkr.hcl
│     └── redis.pkr.hcl
│     └── memcached.pkr.hcl
├── ansible
│  ├── ansible.cfg
│  ├── base.yml
│  ├── group_vars
│  │   ├── base.yml
│  │   ├── mysql
│  │   └── ...
│  ├── inventory
│  └── roles
│     ├── base
│     │  ├── files
│     │  └── tasks
│     │     └── main.yml
│     ├── mysql
│     └── ...

name: packer build base image

on:
  # 定期実行のトリガー
  schedule:
    - cron: "15 0 * * 1"
  # 変更時のトリガー
  push:
    branches:
      - main
    # ファイル単位でのトリガー
    paths:
      - .github/workflows/packer_build_base.yaml
      - packer/source/base.pkr.hcl
      - ansible/base.yml
      - ansible/group_vars/**/*
      - ansible/roles/base/**/*

jobs:
  build:
    # self-hosted runnerで実行するタグ(実際は他にもタグがあり実行ホストを選別しています)
    runs-on:
      - self-hosted

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v2
        with:
          fetch-depth: 0

      # 動的なパラメータの生成と環境変数への保存(次のstepへ値を引き回す為)
      - name: set base image configurations to GITHUB_ENV
        run: . ./script/set_env.sh base
        working-directory: packer

      # packerのビルド・ジョブ実行
      - name: Packer build image
        run: packer build base.pkr.hcl
        working-directory: packer/source

# source/base.pkr.hcl

# プロジェクト名やネットワーク名など複数のビルドタスクで共通の静的な値として指定する値の定義
# 以下で"動的な値"とコメントされていない部分はすべて静的な値でlocal.configs.xxxxと呼び出されています。
locals {
  configs = yamldecode(file("../config/build_env.yaml"))
}

# 環境変数:PKR_VAR_source_imageで指定した値を受け取る定義
variable "source_image" {
  type = string
}

# 環境変数:PKR_VAR_image_nameで指定した値を受け取る定義
variable "image_name" {
  type = string
}

# 環境変数:PKR_VAR_image_familyで指定した値を受け取る定義
variable "image_family" {
  type = string
}

# Packerのビルド・ジョブの定義
source "googlecompute" "base" {
  # 基礎情報（プロジェクト名、ネットワーク、zoneなど）
  project_id       = local.configs.project_id
  network          = local.configs.network
  subnetwork       = local.configs.subnet
  zone             = local.configs.zone

  # ベースとなるイメージ名（環境変数で動的な値を指定/後述）
  source_image     = var.source_image

  # Packerが一時的に起動するインスタンスの情報
  disk_size        = local.configs.disk_size
  preemptible      = true
  omit_external_ip = true
  use_internal_ip  = true
  ssh_username     = "packer"
  tags             = local.configs.tags # GCPのネットワークタグでActions self-hosted-runnerからSSHを可能とするように定義します。
  scopes           = ["https://www.googleapis.com/auth/cloud-platform"]

  # カスタムイメージのイメージ名・ファミリー名（環境変数で動的な値を指定/後述）
  image_name       = var.image_name
  image_family     = var.image_family

  # 構築時に生成されるキーペアの公開鍵を削除する
  ssh_clear_authorized_keys = true

  service_account_email = "xxxx@dummy-project-name.iam.gserviceaccount.com"
}

# sourceセクションで定義されたサーバに対してansibleを実行してプロビジョニングを行う定義
build {
  sources = ["source.googlecompute.base"]

  provisioner "ansible" {
    groups        = ["base"] # ansible/group_vars/base.ymlの変数を利用
    playbook_file = "../../ansible/base.yml"
    inventory_directory = "../../ansible/inventory"
    user          = "packer"
  }
}

# packer/bin/set_env.sh
#!/bin/bash

# source iamge名: 例では執筆時点でのGCP公式のubuntu20.04イメージ
echo PKR_VAR_source_image=ubuntu-2004-focal-v20220308 >> $GITHUB_ENV
# カスタムイメージ名
echo PKR_VAR_image_name=custom-ubuntu2004-base-vYYYYMMDD-01 >> $GITHUB_ENV
# family名(グループ名のようなもの)
echo PKR_VAR_image_family=custom-ubuntu2004-base >> $GITHUB_ENV

source_image=$(gcloud compute images list \
  --project $project \
  --format="value(NAME)" \
  --filter='family = ubuntu-minimal-2004 AND architecture = X86_64'
)

# ansible/base.yaml
- hosts: base
  gather_facts: false
  remote_user: packer
  become: yes
  roles:
    - base

# 起動するイメージファミリー名を定義
locals {
  image_families = [
    "custom-ubuntu2004-base",
    "custom-ubuntu2004-self-hosted-runner"
    "custom-ubuntu2004-mysql"
  ]
}

# イメージファミリ名で検索し、カスタムイメージのデータリソースを作成
data "google_compute_image" "main" {
  for_each = toset(local.image_families)

  family  = each.value
  project = data.google_client_config.current.project
}

resource "google_compute_instance" "main" {
  #省略
  boot_disk {
    initialize_params {
      # custom-ubuntu2004-base-v20230308のような形式で最新のイメージ名が代入される
      image = data.google_compute_image.main["custom-ubuntu2004-base"].self_link
    }
  }
  #省略
}