【Terraform】HCP TerraformでVCSドリブンを使ってみた

HCP TerraformでVCSドリブンを使ってみた

やること

GitHubとHCP Terraformを連携させ、VCSドリブン(VCSへの変更をトリガーにHCP TerraformのWorkspacesを起動)を設定。

前提

HCP TerraformでOrganizationを作成済みであること
GitHub：GitHub.comを利用
GitHubでパブリックのリポジトリを作成済みであること

実践！

１．HCP TerraformのApplication情報取得
１－１．HCP Terraform - Orgnization - Settings
※ぱっと見WorkspacesのSettingsに見えるが、OrganizationのSettingsです。

１－２．「Version Control」内の「Providers」

１－３．「Add a VCS provider」

１－４．「GitHub」-「GitHub.com」

１－５．表示されているApplication nameなどを控える

２．GitHubのClientID取得
２－１．GitHub - 右上のアイコン - 「Settings」

２－２．「Developer settings」

２－３．「OAuth Apps」-「New OAuth app」

２－４．項番１で控えた情報を入力し、「Register application」

２－５．「Client ID」を控える

２－６．「Generate a new client secret」

２－７．「Client secrets」を控える

３．VCS連携
３－１．項番１の画面に戻り、「Client ID」、「Client secrets」を入力し、「Connect and continue」

３－２．「Authorize xxxxxx」

３－３．「Skip and finish」

４．HCP TerraformでWorkspaces作成
４－１．HCP Terraform - Workspaces - 「New」-「Workspace」

４－２．プロジェクトを選択し「Create」

４－３．「Version Control Workflow」

４－４．作成したGtiHubのProviderを選択

４－５．事前に作成している連携予定のリポジトリを選択

４－６．「Workspace Name」を入力し、「Advanced options」

４－７．「Branch-based」を選択、「VCS branch」に「main」を入力し、「Create」

４－８．Workspacesが作成されたことを確認

５．AWS アクセスキー取得
５－１．AWS - IAM
５－２．「ユーザー」-「ユーザーの作成」

５－３．「ユーザー名」を入力し、「次へ」

５－４．「ポリシーを直接アタッチする」、「AdministratorAccess」を選択し、「次へ」

５－５．「ユーザーの作成」

５－６．作成したユーザーを選択

５－７．「セキュリティ認証情報」タブ、「アクセスキーを作成」

５－８．「コマンドラインインターフェイス(CLI)」を選択、「上記のレコメンデーションを理解し、アクセスキーを作成します。」にチェックを入れ、「次へ」

５－９．「アクセスキーを作成」

５－１０．「アクセスキー」と「シークレットアクセスキー」を保存し、「完了」

６．HCP Terraformにアクセスキーを登録
６－１．HPC Terraform - 作成したWorkspaceを開き、「Variables」

６－２．「+ Add variable」

６－３．下記をそれぞれ追加し、「Add variable」
　・Select variable category：Environment variable
　・Key and Value：
　　　AWS_ACCESS_KEY_ID：取得したアクセスキー
　　　AWS_SECRET_ACCESS_KEY：取得したシークレットアクセスキー
　　　AWS_REGION：ap-northeast-1

７．GitHubへ下記main.tfをPush
７－１．GitBashなどを使いmainブランチへ下記コードをPush
main.tf

terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 5.0"
    }
  }

  cloud {
    organization = "<Your Organization>"

    workspaces {
      name = "<Your Workspaces>"
    }
  }
}

provider "aws" {
  region = "ap-northeast-1"
}

resource "aws_s3_bucket" "example" {
  bucket = "<CreateS3BucketName>"
}

８．HCP Terraform Workspaces実行
８－１．HCP Terraform - 作成したWorkspaces
８－２．「Runs」

８－３．「＋ New run」

８－４．「Run name」を入力し、「Run Type」に「Plan only」を選択し、「Start」

８－５．Planが完了することを確認

８－６．「＋ New run」

８－７．「Run Type」を「Plan and appy（standard）」を選択し、「Start」

８－８．Applyまで完了することを確認

９．AWSリソース作成確認
９－１．AWS - S3 - Bucket
９－２．リソースが作成されていることを確認