CDK for TerraformをCIに組み込む実践手順｜TypeScriptでインフラ定義する流れ

この記事のポイント

・cdktf synthでTerraform JSONへ変換できる
・cdktf deployでCI/CDから自動適用が可能
・ロジックが複雑な構成にCDKTFは向く
・GitHub ActionsはNode.js＋cdktf-cliで動く

# Node.jsバージョン確認
node -v

# 出力例（環境により異なります）
# v20.17.0

# cdktf-cliをグローバルインストール
npm install -g cdktf-cli@latest

# バージョン確認
cdktf --version
# 0.20.x

# TypeScriptテンプレートでプロジェクトを初期化（ローカルバックエンド）
cdktf init --template=typescript --local

# ディレクトリ構成（出力例、環境により異なります）
# .
# ├── cdktf.json          ← プロバイダーとスタック設定
# ├── main.ts             ← リソース定義の主ファイル
# ├── package.json
# └── tsconfig.json

{
  "language": "typescript",
  "app": "npx ts-node main.ts",
  "terraformProviders": [
    "aws@~> 5.0"
  ],
  "terraformModules": []
}

# プロバイダーバインディングを生成（初回は数分かかります）
cdktf get

# 生成後の確認（出力例、環境により異なります）
ls .gen/providers/aws/
# instance/ provider/ s3-bucket/ vpc/ ...

// main.ts
import { App, TerraformStack, TerraformOutput } from "cdktf";
import { AwsProvider } from "./.gen/providers/aws/provider";
import { Instance } from "./.gen/providers/aws/instance";

class MyStack extends TerraformStack {
  constructor(scope: App, id: string) {
    super(scope, id);

    // AWSプロバイダーの設定
    new AwsProvider(this, "aws", {
      region: "ap-northeast-1",
    });

    // EC2インスタンスの定義
    const instance = new Instance(this, "web-server", {
      ami:          "ami-0d52744d6551d851e",  // Amazon Linux 2023
      instanceType: "t3.micro",
      tags: {
        Name: "cdktf-web-server",
        Env:  "dev",
      },
    });

    // outputでパブリックIPを出力
    new TerraformOutput(this, "public_ip", {
      value: instance.publicIp,
    });
  }
}

const app = new App();
new MyStack(app, "my-stack");
app.synth();

# TypeScriptをコンパイルしてTerraform JSONを生成
cdktf synth

# 生成されたファイルを確認（出力例、環境により異なります）
ls cdktf.out/stacks/my-stack/
# cdk.tf.json

# 中身の確認（プレーンなTerraform JSONフォーマット）
cat cdktf.out/stacks/my-stack/cdk.tf.json | python3 -m json.tool | head -20

# .github/workflows/cdktf.yml
name: CDKTF CI

on:
  pull_request:
    branches: [main]
  push:
    branches: [main]

jobs:
  cdktf-plan:
    name: CDKTF Synth and Terraform Plan
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write       # OIDC認証用
      pull-requests: write  # PRコメント書き込み用

    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"
          cache: "npm"

      - name: Install cdktf-cli and dependencies
        run: |
          npm install -g cdktf-cli@latest
          npm ci

      - name: Generate provider bindings
        run: cdktf get

      - name: CDKTF Synth
        run: cdktf synth

      - name: Setup Terraform
        uses: hashicorp/setup-terraform@v3
        with:
          terraform_version: "1.9.x"

      - name: Terraform Init and Plan
        working-directory: cdktf.out/stacks/my-stack
        run: |
          terraform init
          terraform plan -out=tfplan

      # （cdktf-planジョブのstepsに追加）
      - name: Terraform Plan Output
        id: plan
        working-directory: cdktf.out/stacks/my-stack
        run: |
          terraform show -no-color tfplan > plan_output.txt
          {
            echo "plan_output<> "$GITHUB_OUTPUT"

      - name: Comment PR with Plan Result
        if: github.event_name == 'pull_request'
        uses: actions/github-script@v7
        with:
          script: |
            const plan = `${{ steps.plan.outputs.plan_output }}`;
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `## Terraform Plan\n\`\`\`\n${plan}\n\`\`\``
            });

  cdktf-apply:
    name: CDKTF Apply
    runs-on: ubuntu-latest
    needs: cdktf-plan
    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
    environment: production  # GitHub Environmentsで承認者を設定

    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"
          cache: "npm"

      - name: Install, Synth
        run: |
          npm install -g cdktf-cli@latest
          npm ci
          cdktf get
          cdktf synth

      - name: Setup Terraform
        uses: hashicorp/setup-terraform@v3
        with:
          terraform_version: "1.9.x"

      - name: Terraform Apply
        working-directory: cdktf.out/stacks/my-stack
        run: |
          terraform init
          terraform apply -auto-approve

// main.ts（S3バックエンド設定を追加）
import { App, TerraformStack, S3Backend } from "cdktf";
import { AwsProvider } from "./.gen/providers/aws/provider";

class MyStack extends TerraformStack {
  constructor(scope: App, id: string) {
    super(scope, id);

    // S3バックエンドの設定（コード内で宣言）
    new S3Backend(this, {
      bucket:        "my-tfstate-bucket",
      key:           "cdktf/my-stack/terraform.tfstate",
      region:        "ap-northeast-1",
      encrypt:       true,
      dynamodbTable: "terraform-lock",  // ステートロック用
    });

    new AwsProvider(this, "aws", { region: "ap-northeast-1" });
    // ... リソース定義は変わらない
  }
}

# GitHub Actionsでのキャッシュ設定例
      - name: Cache CDKTF provider bindings
        uses: actions/cache@v4
        with:
          path: |
            node_modules/.gen
            .gen
          key: cdktf-${{ hashFiles('cdktf.json') }}
          restore-keys: |
            cdktf-

# Terraformプロバイダーのキャッシュを有効化
      - name: Cache Terraform providers
        uses: actions/cache@v4
        with:
          path: ~/.terraform.d/plugins
          key: terraform-providers-${{ hashFiles('**/.terraform.lock.hcl') }}

# スタック名を明示してデプロイ
cdktf deploy my-stack

# 全スタックを依存関係の順にデプロイ
cdktf deploy '*'

# planのみ確認する場合
cdktf diff my-stack