サンプルアプリケーションとAWSベース環境の準備

ハンズオンを始める前に、サンプルアプリケーションと、AWS上のベースリソース(VPC・サブネット・ECR・ECSクラスタ・IAMロール・DynamoDBテーブルなど)を用意しておきます。ここで作成する土台は、フェーズ1〜4の全体で使います。

1. サンプルアプリケーションの準備

このセクションでは、FastAPIで作成した最小構成のAPIを使います。今回はBlue/Greenデプロイメントの仕組み自体に集中したいため、前のセクションのようにGitHubリポジトリやGitHub Actionsは使わず、ローカルフォルダから直接ビルド・デプロイする形で進めます。

以下のボタンからサンプルコードのZIPファイルをダウンロードしてください。

ダウンロードしたZIPファイルを、任意の場所に解凍してください。解凍するとdevopscamp-bg-handsonという名前のフォルダができます。このフォルダの中身は以下のようになっています。

devopscamp-bg-handson/
├── Dockerfile
├── requirements.txt
└── main.py

各ファイルの役割を以下の表にまとめます。

ファイル名 役割
main.py FastAPIアプリケーションのエントリーポイント。ヘルスチェック用の/healthと、動作確認用の/の2つのエンドポイントだけを持つシンプルな構成
requirements.txt Pythonプロジェクトで利用するパッケージの一覧を記載したファイル
Dockerfile コンテナイメージを作成するための手順を記述した設定ファイル

main.pyの中身は以下のとおりです。後のハンズオンでこのファイルを書き換えて、Blue/Greenデプロイメントの動作を体験します。

from fastapi import FastAPI

app = FastAPI()

@app.get("/health")
def health():
    return {"status": "ok"}

@app.get("/")
def root():
    return {"message": "API呼び出しテストに成功しました"}

2. AWS環境の構築

VPC、サブネット、セキュリティグループ、ECR、ECSクラスタ、IAMロールなどのベースリソースをCloudFormationで作成します。これらはBlue/Greenデプロイメントの本質ではないため、テンプレートで一括構築します。

📝 CloudFormationとは
CloudFormationは、AWSのリソースをテンプレート(YAML/JSON)で定義し、自動的に作成・管理できるサービスです。手動でリソースを一つずつ作成する代わりに、テンプレートをアップロードするだけで必要なリソースをまとめて構築できます。なお、このセクションではCloudFormationテンプレートの内容を理解する必要はありません。テンプレートをそのままアップロードして環境を構築してください。

CloudFormationで作成されるリソースは以下のとおりです。

リソース 名前 説明
VPC bg-handson-vpc 10.0.0.0/16のアドレス範囲を持つ仮想ネットワーク
パブリックサブネット1 bg-handson-public-subnet-1 ap-northeast-1aに配置するサブネット(10.0.1.0/24)
パブリックサブネット2 bg-handson-public-subnet-2 ap-northeast-1cに配置するサブネット(10.0.2.0/24)。ALBにマルチAZ構成が必須のため2つ作成
インターネットゲートウェイ bg-handson-igw パブリックサブネットからのインターネットアクセス用
ルートテーブル bg-handson-rt パブリックサブネット用のルーティング設定
ALBセキュリティグループ bg-handson-alb-sg ALB用(HTTP:80を許可)
ECSセキュリティグループ bg-handson-ecs-sg ECSタスク用(ALBからのHTTP:80を許可)
ECRリポジトリ bg-handson-repo コンテナイメージを格納するリポジトリ
ECSクラスター bg-handson-cluster ECSサービスを管理する論理グループ
タスク実行ロール bg-handson-task-execution-role ECSタスクがCloudWatch Logsなどを操作するためのIAMロール
ECSインフラロール bg-handson-ecs-infra-role ECSがBlue/Greenデプロイ中にALBやターゲットグループを操作するためのIAMロール
CloudWatch Logs /ecs/bg-handson-task ECSタスクのログ出力先
DynamoDBテーブル bg-handson-approvals フェーズ4で使用する承認レコード管理用のテーブル。パーティションキーはdeployment_id

2.1 テンプレートファイルの準備

まず、CloudFormationにアップロードするテンプレートファイルを用意します。以下のボタンからテンプレートファイルをダウンロードしてください。

ファイルがダウンロードできたら、次のステップに進みます。

2.2 CloudFormationスタックの作成

AWSマネジメントコンソールでCloudFormationのダッシュボードを開きます。検索バーに「CloudFormation」と入力し、サービスを選択してください。

CloudFormationのダッシュボードが表示されたら、スタックの作成 > **新しいリソースを使用(標準)**をクリックします。

ステップ1: テンプレートの指定

テンプレートの指定画面が表示されます。下記表に従い、設定を行ってください。

設定項目 値 設定の基準
テンプレートの準備 既存のテンプレートを選択 事前に作成したテンプレートファイルを使用するため
テンプレートソース テンプレートファイルのアップロード ローカルのテンプレートファイルを直接アップロードするため
テンプレートファイルのアップロード 先ほど保存したblue-green-handson.yml ハンズオン環境を構築するテンプレートを指定するため

設定後、次へをクリックしてください。

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

スタックの詳細を指定する画面が表示されます。下記表に従い、設定を行ってください。

設定項目 値 設定の基準
スタック名 bg-handson スタックを識別するための名前

設定後、次へをクリックしてください。

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

スタックオプションの設定画面が表示されます。画面下部の「AWS CloudFormation によって IAM リソースがカスタム名で作成される場合があることを承認します。」にチェックを入れてから、次へをクリックしてください。

ステップ4: 確認と作成

確認画面が表示されます。設定内容を確認し、送信をクリックします。

2.3 スタックの作成完了を確認

スタックの作成が開始されます。ステータスがCREATE_COMPLETEに変わったら、環境構築は完了です。完了まで数分かかります。

スタックの出力タブを開くと、後の手順で使用するリソースのID・ARNが一覧で表示されます。このページは後から参照するため、開いたままにしておいてください。

3. 初回イメージのプッシュ

CloudFormationでECRリポジトリが作成されたので、先ほど解凍したサンプルアプリケーションをコンテナイメージとしてビルドし、ECRにプッシュしておきます。フェーズ1以降でECSサービスを作成する際、タスク定義はECR上のイメージを参照するため、環境構築の段階で初回イメージを用意しておきます。

devopscamp-bg-handsonフォルダでターミナルを開きます。

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

aws --version

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

aws-cli/2.x.x Python/3.x.x Darwin/xx.x.x source/arm64

バージョンが表示されない場合は、AWS CLIのインストール を先に実施してください。

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

docker --version

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

Docker version 27.x.x, build xxxxxxx

バージョンが表示されない場合は、Docker Desktopのインストール を先に実施してください。

インストールが確認できたら、以下のコマンドを順に実行します。

ECRにログインします。このセクションは東京リージョン(ap-northeast-1)で進めます。<アカウントID>はご自身のAWSアカウントIDに置き換えてください。

aws ecr get-login-password --region ap-northeast-1 | docker login --username AWS --password-stdin <アカウントID>.dkr.ecr.ap-northeast-1.amazonaws.com

イメージをビルドします。リポジトリのルートにDockerfileがあるため、カレントディレクトリ(.)を指定してビルドします。

このセクションではFargateをX86_64アーキテクチャで動かすため、--platform linux/amd64を指定してビルドします。Apple シリコン(M1/M2/M3など)のMacではこれを指定しないとarm64のイメージが作成され、Fargate上でexec format errorとなりコンテナが起動しません。Intel MacやWindowsでも付けて問題ないため、常にこのオプションを付けて進めます。

docker build --platform linux/amd64 -t bg-handson-repo .

イメージにECRのURIタグを付けます。

docker tag bg-handson-repo:latest <アカウントID>.dkr.ecr.ap-northeast-1.amazonaws.com/bg-handson-repo:latest

ECRにプッシュします。

docker push <アカウントID>.dkr.ecr.ap-northeast-1.amazonaws.com/bg-handson-repo:latest

ECRのbg-handson-repoリポジトリにlatestタグのイメージが登録されていれば、環境構築は完了です。