リポジトリの準備

Terraformコードを管理するGitHubリポジトリを作成します。

1. リポジトリの作成

まず、Terraformコードを管理するGitHubリポジトリを作成します。

GitHubにログインし、画面右上の「+」ボタンから「New repository」を選択します。表示されたフォームで、以下の内容を設定してください。

設定項目 値 設定の基準
Repository name terraform-cicd-handson 本章用のリポジトリ名として使用する
Choose visibility Public 誰でも閲覧できる公開リポジトリにする
Start with a template No template テンプレートは利用しない
Add README On(トグルを有効化) mainブランチをREADME.mdと初期コミットで初期化し、以降の作業はすべてPR経由で行えるようにする
Add .gitignore No .gitignore 追加しない
Add license No license 追加しない

設定を確認したら「Create repository」をクリックしてリポジトリを作成します。作成が完了すると、README.mdだけを含む初期コミットが入った状態のリポジトリが表示されます。

続いて、作成したリポジトリをローカル環境にクローンします。

以下のコマンドで、Git がインストールされていることを確認します。

git --version

以下のように Git のバージョンが表示されれば、インストールは確認できています。

git version 2.x.x

バージョンが表示されない場合は、Git/GitHubのセットアップ を先に実施してください。

インストールが確認できたら、任意のフォルダに移動して、以下のコマンドを実行してください。

git clone https://github.com/<your-github-account-name>/terraform-cicd-handson.git

<your-github-account-name>はご自身のGitHubアカウント名に置き換えてください。

クローンしたら、Visual Studio Codeでterraform-cicd-handsonフォルダを開きます。「ファイル」→「フォルダーを開く」から、クローンしたフォルダを選択してください。

エクスプローラーにterraform-cicd-handsonフォルダが表示されていれば、リポジトリの準備は完了です。

2. Terraformコードの配置

CI/CDパイプラインの対象となるTerraformコードを配置します。今回はTerraformでシンプルなAWS構成を作ろうと同等の内容を使うため、zipファイルで配布します。

以下からzipをダウンロードし、展開して出てくる3つのファイルを、先ほどクローンしたterraform-cicd-handsonフォルダ直下(README.mdと同じ階層)に配置してください。

配置すると、以下のようなファイル構成になります。

terraform-cicd-handson/
├── README.md
├── main.tf          ← ダウンロードしたファイル
├── variables.tf     ← ダウンロードしたファイル
└── terraform.tfvars ← ダウンロードしたファイル

Terraformのコードに関する解説は省略しますが、今回作成するAWSリソースは以下のとおりです。

リソース 内容
VPC 10.0.0.0/16のネットワーク空間を作成する
パブリックサブネット ap-northeast-1aに10.0.1.0/24のサブネットを配置する
インターネットゲートウェイ VPCをインターネットに接続する
ルートテーブル パブリックサブネットからインターネットへの経路を設定する
セキュリティグループ EC2に対してSSH(22)とHTTP(80)を許可する
EC2インスタンス Amazon Linux 2023をt2.microで起動する

コードの詳しい内容はTerraformでシンプルなAWS構成を作ろうに記載があります。

エクスプローラーに3つのファイルが表示されていれば、Terraformコードの配置は完了です。

3. CI/CD用AWSリソースの準備

CI/CDパイプラインを動かすために、以下のAWSリソースを事前に用意します。

リソース 内容
S3バケット Terraformのtfstateファイルを保存する。バージョニング・サーバサイド暗号化・パブリックアクセスブロックを有効にする
OIDCプロバイダ GitHub Actionsが発行するIDトークンをAWS側で検証・信頼するために設定する
IAMロール GitHub Actionsから引き受けて、Terraformが必要とするAWS操作を委譲する
💡 ポイント
これらのリソースはTerraformでも作成できますが、他のセクションに合わせてCloudFormationで作成します。tfstateバケットやIAMロールはCI/CDが動く前提となる土台のリソースなので、CI/CDパイプラインの外側で用意しておく構成にしています。

以下からCloudFormationテンプレートをダウンロードします。

CloudFormationのダッシュボードでスタックの作成 > 新しいリソースを使用(標準)をクリックし、スタック作成ウィザードを開きます。

3.1 ステップ1: スタックの作成

「テンプレートの準備」で既存のテンプレートを選択を、「テンプレートソース」でテンプレートファイルのアップロードを選択します。ファイルの選択からダウンロードしたtf-cicd-oidc.ymlをアップロードし、次へをクリックします。

3.2 ステップ2: スタックの詳細指定

「スタック名」と「パラメータ」を、以下の値で入力します。

設定項目 値 設定の基準
スタック名 tf-cicd-oidc ハンズオン用に分かりやすい名前をつける
GitHubOrg ご自身のGitHubユーザ名(すべて小文字) S3バケット名の一意性の確保と、どのGitHubリポジトリに信頼を委譲するかの指定に利用する
💡 ポイント
S3バケット名はグローバルで一意である必要があるため、末尾にGitHubユーザ名を付けてterraform-cicd-handson-tfstate-<GitHubユーザ名>という命名にしています。GitHubユーザ名は基本的に他のユーザと重複しないため、これで衝突を回避できます。S3バケット名は小文字のみ利用可能なため、GitHubユーザ名に大文字を含む場合はすべて小文字に変換して入力してください。

入力できたら次へをクリックします。

3.3 ステップ3: スタックオプションの設定

そのまま画面を下にスクロールし、「機能」セクションのAWS CloudFormation によって IAM リソースがカスタム名で作成される場合があることを承認します。にチェックを入れて次へをクリックします。

💡 ポイント
今回はハンズオンの簡略化のためIAMロールにAdministratorAccessを付与していますが、本番環境では必要最小限の権限に絞ることが推奨されます。

3.4 ステップ4: 確認して作成

内容を確認して、最下部の送信をクリックしてスタックを作成します。

3.5 スタックの作成完了確認

スタックのステータスがCREATE_COMPLETEになったら、出力タブにGitHubActionsRoleArn・AWSAccountId・TfStateBucketNameの3つが表示されていることを確認します。

3.6 main.tfのbucket名の置き換え

続いて、CloudFormationで作成したtfstateバケットの名前をmain.tfにも反映します。VS Codeでmain.tfを開き、backend "s3"ブロックのbucketの<your-github-username>を、GitHubユーザ名(すべて小文字)に置き換えて保存してください。

以下は、GitHubユーザ名がyamadaの場合の書き換え例です。

backend "s3" {
  bucket       = "terraform-cicd-handson-tfstate-yamada"
  key          = "terraform.tfstate"
  region       = "ap-northeast-1"
  use_lockfile = true
}

main.tfのbucketがCloudFormationで作成したバケット名と一致していれば、CI/CD用AWSリソースの準備は完了です。次のステップでAWSAccountIdの値を利用します。

4. シークレットの登録

GitHub ActionsからAWSに接続する際は、引き受けるIAMロールのARNをワークフロー内で組み立てる必要があります。ARNの構成要素であるAWSアカウントIDをリポジトリのシークレットに登録しておきます。

GitHubリポジトリのSettings > Secrets and variables > Actionsを開き、New repository secretをクリックして以下のシークレットを登録します。

シークレット名 値 設定の基準
AWS_ACCOUNT_ID CloudFormation出力のAWSAccountId GitHub Actionsから引き受けるIAMロールのARNを組み立てるために利用する

Repository secretsの一覧にAWS_ACCOUNT_IDが表示されていれば、登録は完了です。

配置したTerraformコードはmainブランチには直接Pushせず、次のセクションで作成するチェック用ワークフローと同じPull Requestで一緒にmainブランチへ投入します。PRのterraform plan結果に、TerraformコードそのものとCI/CDワークフローが新規追加として表示され、何がAWSに反映されるかを一目で確認できるようにするためです。