push-to-registry

HCP Packer Registry へのプッシュ

ビルドメタデータを HCP Packer Registry にプッシュするよう、Packer テンプレートを設定します。

リファレンス： HCP Packer Registry

注意： HCP Packer は基本的な用途であれば無料です。ビルドでプッシュされるのはメタデータのみ（実際のイメージは含まれません）で、オーバーヘッドは最小限です（1 分未満）。

基本的な Registry の設定

packer {
  required_version = ">= 1.7.7"
}

variable "image_name" {
  type    = string
  default = "web-server"
}

locals {
  timestamp = regex_replace(timestamp(), "[- TZ:]", "")
}

source "amazon-ebs" "ubuntu" {
  region        = "us-west-2"
  instance_type = "t3.micro"

  source_ami_filter {
    filters = {
      name = "ubuntu/images/*ubuntu-jammy-22.04-amd64-server-*"
    }
    most_recent = true
    owners      = ["099720109477"]
  }

  ssh_username = "ubuntu"
  ami_name     = "${var.image_name}-${local.timestamp}"
}

build {
  sources = ["source.amazon-ebs.ubuntu"]

  hcp_packer_registry {
    bucket_name = var.image_name
    description = "Ubuntu 22.04 base image for web servers"

    bucket_labels = {
      "os"   = "ubuntu"
      "team" = "platform"
    }

    build_labels = {
      "build-time" = local.timestamp
    }
  }

  provisioner "shell" {
    inline = [
      "sudo apt-get update",
      "sudo apt-get upgrade -y",
    ]
  }
}

認証

ビルドの前に環境変数を設定します。

export HCP_CLIENT_ID="your-service-principal-client-id"
export HCP_CLIENT_SECRET="your-service-principal-secret"
export HCP_ORGANIZATION_ID="your-org-id"
export HCP_PROJECT_ID="your-project-id"

packer build .

HCP サービスプリンシパルの作成

1. HCP → Access Control (IAM) に移動します
2. サービスプリンシパルを作成します
3. プロジェクトに「Contributor」ロールを付与します
4. クライアントシークレットを生成します
5. クライアント ID とシークレットを保存します

Registry の設定オプション

bucket_name（必須）

イメージ識別子です。ビルド間で一貫性を保つ必要があります。

bucket_name = "web-server"  # Keep this constant

bucket_labels（任意）

バケットレベルのメタデータです。ビルドのたびに更新されます。

bucket_labels = {
  "os"        = "ubuntu"
  "team"      = "platform"
  "component" = "web"
}

build_labels（任意）

各イテレーションのメタデータです。ビルド完了後は変更できません。

build_labels = {
  "build-time" = local.timestamp
  "git-commit" = var.git_commit
}

CI/CD との統合

GitHub Actions

name: Build and Push to HCP Packer

on:
  push:
    branches: [main]

env:
  HCP_CLIENT_ID: ${{ secrets.HCP_CLIENT_ID }}
  HCP_CLIENT_SECRET: ${{ secrets.HCP_CLIENT_SECRET }}
  HCP_ORGANIZATION_ID: ${{ secrets.HCP_ORGANIZATION_ID }}
  HCP_PROJECT_ID: ${{ secrets.HCP_PROJECT_ID }}

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: hashicorp/setup-packer@main

      - name: Build and push
        run: |
          packer init .
          packer build \
            -var "git_commit=${{ github.sha }}" \
            .

Terraform でのクエリ

data "hcp_packer_artifact" "ubuntu" {
  bucket_name  = "web-server"
  channel_name = "production"
  platform     = "aws"
  region       = "us-west-2"
}

resource "aws_instance" "web" {
  ami           = data.hcp_packer_artifact.ubuntu.external_identifier
  instance_type = "t3.micro"

  tags = {
    PackerBucket = data.hcp_packer_artifact.ubuntu.bucket_name
  }
}

よくある問題

認証に失敗する

• HCP_CLIENT_ID と HCP_CLIENT_SECRET を確認します
• サービスプリンシパルに Contributor ロールがあることを確認します
• 組織 ID とプロジェクト ID を確認します

バケット名の不一致

• ビルド間で bucket_name の一貫性を保ちます
• bucket_name にタイムスタンプを含めないでください
• 名前を変更すると、新しいバケットが作成されます

ビルドに失敗する

• メタデータをプッシュできない場合、Packer は直ちに失敗します
• アーティファクトと Registry の間にずれが生じるのを防ぎます
• HCP API へのネットワーク接続を確認します

ベストプラクティス

• 一貫したバケット名 - 同じイメージタイプでは変更しないでください
• わかりやすいラベル - バージョン、チーム、コンプライアンスに使用します
• CI/CD の自動化 - ビルドと Registry へのプッシュを自動化します
• 変更不可のビルドラベル - 変化するデータ（git SHA、日付）は build_labels に設定します

参考資料

• HCP Packer のドキュメント
• hcp_packer_registry ブロック
• HCP Terraform Provider