AWS CDK を使用してマイクロサービス用の CI/CD パイプラインと Amazon ECS クラスターを自動的に構築する

作成者: Varsha Raju (AWS)

環境: PoC またはパイロット

テクノロジー: DevOps、コンテナとマイクロサービス、モダナイゼーション、インフラストラクチャ

AWS サービス: AWS CodeBuild; AWS CodeCommit; AWS CodePipeline; Amazon ECS; AWS CDK

[概要]

このパターンは、Amazon Elastic Container Service (Amazon ECS) でマイクロサービスを構築およびデプロイするための、継続的インテグレーションと継続的デリバリー (CI/CD) パイプラインと基盤となるインフラストラクチャを自動的に作成する方法を示しています。このアプローチは、 proof-of-concept CI/CD、マイクロサービス、および の利点を組織に表示するように CI/CD パイプラインを設定する場合に使用できます DevOps。また、このアプローチを使用して最初の CI/CD パイプラインを作成し、組織の要件に応じてカスタマイズまたは変更もできます。 

このパターンのアプローチでは、本番環境と非本番環境を作成し、それぞれに仮想プライベートクラウド (VPC) と 2 つのアベイラビリティゾーンで実行するように設定された Amazon ECS クラスターがあります。これらの環境はすべてのマイクロサービスとユーザーで共有され、各マイクロサービスに CI/CD パイプラインを作成します。これらの CI/CD パイプラインは、AWS のソースリポジトリから変更をプルし CodeCommit、変更を自動的に構築してから、本番環境と非本番環境にデプロイします。パイプラインがすべてのステージを正常に完了すると、URL を使用して本番環境と非本番環境のマイクロサービスにアクセスできます。

前提条件と制限

前提条件

• アクティブな Amazon Web Services (AWS)アカウント。

• starter-code.zip ファイル (添付) を含む既存の Amazon Simple Storage Service (Amazon S3) バケット。

• AWS Cloud Development Kit (AWS CDK) はお使いのアカウントにインストールおよび設定済みです。詳細については、AWS CDK ドキュメントの「Getting started with the AWS CDK」を参照してください。

• Python 3 と pip をインストールおよび設定済みです。詳細については、Python のドキュメントを参照してください。

• AWS CDK、AWS CodePipeline、AWS CodeBuild、Amazon Elastic Container Registry (Amazon ECR) CodeCommit、Amazon ECS、AWS Fargate に精通していること。

• Docker に精通していること。

• CI/CD と の理解 DevOps。

制約事項

• AWS アカウントの全般的な制限が適用されます。この詳細については、AWS 全般のリファレンスドキュメントの「AWS Service Quotas」を参照してください。

製品バージョン

• このコードは、 Node.js バージョン 16.13.0 および AWS CDK バージョン 1.132.0 を使用してテストされました。

アーキテクチャ

この図表は、次のワークフローを示しています：

1. アプリケーション開発者はコードを CodeCommit リポジトリにコミットします。

2. パイプラインが開始されます。

3. CodeBuild Docker イメージをビルドして Amazon ECR リポジトリにプッシュする

4. CodePipeline は、本番環境以外の Amazon ECS クラスターの既存の Fargate サービスに新しいイメージをデプロイします。

5. Amazon ECS は Amazon ECR リポジトリから非本番環境の Fargate サービスにイメージを引き出します。

6. テストは非本番環境の URL を使用して実行されます。

7. リリースマネージャーは本番環境へのデプロイを承認します。

8. CodePipeline は、新しいイメージを本番稼働用 Amazon ECS クラスターの既存の Fargate サービスにデプロイします。

9. Amazon ECS は Amazon ECR リポジトリから本番環境の Fargate サービスにイメージを引き出します。

10. 本番環境ユーザーは本番環境の URL を使用して機能にアクセスします。

テクノロジースタック

• AWS CDK

• CodeBuild

• CodeCommit 

• CodePipeline

• Amazon ECR 

• Amazon ECS 

• Amazon VPC

自動化とスケール

このパターンのアプローチを使用して、共有 AWS CloudFormation スタックにデプロイされたマイクロサービスのパイプラインを作成できます。自動化により、各 VPC に複数の Amazon ECS クラスターを作成できるほか、共有 Amazon ECS クラスターにデプロイされたマイクロサービスのパイプラインも作成できます。ただし、そのためには、新しいリソース情報をパイプラインスタックへの入力として提供する必要があります。

ツール

• AWS CDK – AWS Cloud Development Kit (AWS CDK) は、コードでクラウドインフラストラクチャを定義し、AWS を通じてプロビジョニングするためのソフトウェア開発フレームワークです CloudFormation。

• AWS CodeBuild – AWS CodeBuild は、cloud. CodeBuild compiles でフルマネージド型のビルドサービスであり、ソースコードをコンパイルしてユニットテストを実行し、すぐにデプロイできるアーティファクトを生成します。

• AWS CodeCommit – AWS CodeCommit は、Git リポジトリを AWS クラウドにプライベートに保存および管理できるバージョン管理サービスです。 CodeCommit は、独自のソース管理システムを管理したり、インフラストラクチャのスケーリングを心配したりする必要性を排除します。

• AWS CodePipeline – AWS CodePipeline は、ソフトウェアのリリースに必要なステップをモデル化、視覚化、および自動化するために使用できる継続的な配信サービスです。ソフトウェアリリースプロセスのさまざまな段階を迅速にモデル化して設定できます。 は、ソフトウェアの変更を継続的にリリースするために必要なステップ CodePipeline を自動化します。

• Amazon ECS – Amazon Elastic Container Service (Amazon ECS) は、クラスターでコンテナの実行、停止、管理に使用される、高度にスケーラブルで高速のコンテナ管理サービスです。タスクとサービスは、 AWS Fargate で管理されているサーバーレスインフラストラクチャで実行できます。または、インフラストラクチャをより詳細に制御するために、管理する Amazon Elastic Compute Cloud (Amazon EC2) インスタンスのクラスターでタスクとサービスを実行できます。

• Docker — Dockerを使用すると、開発者は任意のアプリケーションを軽量、ポータブル、自給自足のコンテナとして梱包、出荷、実行する上で役立ちます。

コード

このパターンのコードは、cicdstarter.zip および starter-code.zip ファイル (添付) にあります。

エピック

環境をセットアップします。

タスク	説明	必要なスキル
AWS CDK の作業ディレクトリを設定します。	ローカルマシンで cicdproject という名前のディレクトリを作成します。 cicdstarter.zip ファイル (添付)を cicdproject ディレクトリにダウンロードし、解凍します。これで、cicdstarter という名前のフォルダが作成されます。 cd <user-home>/cicdproject/cicdstarter コマンドを実行します。  python3 -m venv .venv コマンドを実行して Python 仮想環境を設定します。 source ./.venv/bin/activate コマンドを実行します。 aws configure コマンドを実行、または以下の環境変数を使用して AWS 環境を設定します。  AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY  AWS_DEFAULT_REGION	AWS DevOps、クラウドインフラストラクチャ

共有インフラストラクチャの作成

タスク	説明	必要なスキル
共有インフラストラクチャを作成します。	作業ディレクトリで、cd cicdvpcecs コマンドを実行します。  pip3 install -r requirements.txt コマンドを実行して、必要な Python 依存関係をすべてインストールします cdk bootstrap command を実行して、AWS CDK の AWS 環境を設定します。  cdk synth --context aws_account=<aws_account_ID> --context aws_region=<aws-region> コマンドを実行します。  cdk deploy --context aws_account=<aws_account_ID> --context aws_region=<aws-region> コマンドを実行します。 AWS CloudFormation スタックは次のインフラストラクチャを作成します。 cicd-vpc-ecs/cicd-vpc-nonprod という名前の非本番環境 VPC cicd-vpc-ecs/cicd-vpc-prod という名前の本番環境 VPC cicd-ecs-nonprod という名前の非本番環境用 Amazon ECS クラスター cicd-ecs-prod という名前の本番環境用 Amazon ECS クラスター	AWS DevOps、クラウドインフラストラクチャ
AWS CloudFormation スタックをモニタリングします。	AWS マネジメントコンソールにサインインし、AWS CloudFormation コンソールを開き、リストからcicd-vpc-ecsスタックを選択します。  スタックの詳細ペインで、[Events]（イベント）タブを選択し、スタックの作成の進行状況をモニタリングします。	AWS DevOps、クラウドインフラストラクチャ
AWS CloudFormation スタックをテストします。	AWS CloudFormation スタックが作成されたら、 cicd-vpc-ecs cicd-vpc-ecs/cicd-vpc-nonprodおよび cicd-vpc-ecs/cicd-vpc-prod VPCsが作成されていることを確認します。  cicd-ecs-nonprod と cicd-ecs-prod Amazon ECS クラスターが作成されていることを確認します。 重要: 2 つの VPC の ID と、両方の VPC のデフォルトセキュリティグループのセキュリティグループ ID が記録されていることを確認します。	AWS DevOps、クラウドインフラストラクチャ

マイクロサービスの CI/CD パイプラインの作成

タスク	説明	必要なスキル
マイクロサービスのインフラストラクチャーを作成します。	マイクロサービスに名前を付けます。たとえば、このパターンはマイクロサービスの名前として myservice1 を使用します。 作業ディレクトリで cd <working-directory>/cdkpipeline コマンドを実行します。 pip3 install -r requirements.txt コマンドを実行します。 このパターンの追加情報セクションにある cdk synth コマンドをすべて実行します。 このパターンの追加情報セクションにある cdk deploy コマンドをすべて実行します。 注: ディレクトリの cdk.json ファイルを使用して、両方のコマンドの値を指定することもできます。	AWS DevOps、クラウドインフラストラクチャ
AWS CloudFormation スタックをモニタリングします。	AWS CloudFormation コンソールを開き、myservice1-cicd-stackスタックの進行状況をモニタリングします。最終的に、ステータスは CREATE_COMPLETE に変わります。	AWS DevOps、クラウドインフラストラクチャ
AWS CloudFormation スタックをテストします。	AWS CodeCommit コンソールで、 という名前のリポジトリmyservice1が存在し、スターターコードが含まれていることを確認します。 AWS CodeBuild コンソールで、 という名前のビルドプロジェクトmyservice1が存在することを確認します。 Amazon ECR コンソールで、myservice1 という名前のAmazon ECR リポジトリが存在することを確認します。 Amazon ECS コンソールで、myservice1 という名前の Fargate サービスが非本番環境と本番環境の Amazon ECS クラスターの両方に存在することを確認します。 Amazon Elastic Compute Cloud (Amazon EC2) コンソールで、非本番環境と本番環境の Application Load Balancer が作成されていることを確認します。ALB の DNS 名を記録します。 AWS CodePipeline コンソールで、 という名前のパイプラインmyservice1が存在することを確認します。Source、Build、Deploy-NonProd および Deploy-Prod ステージが必要です。パイプラインにも in progress ステータスが必要です。 すべてのステージが完了するまでパイプラインを監視します。  本番環境用に手動で承認します。 ブラウザウィンドウに、 ALB の DNS 名を入力します。 アプリケーションは非本番環境 URL と本番環境 URL に Hello World が表示されるはずです。
パイプラインを使用します。	前に作成した CodeCommit リポジトリを開き、 index.js ファイルを開きます。  Hello World を Hello CI/CD に置き換えます。 変更を保存してメインブランチにコミットします。 パイプラインが開始され、変更がBuild、Deploy-NonProd および Deploy-Prod  ステージを通過することを確認します。  本番環境用に手動で承認します。 これで、本番環境 URL と非本番環境 URL の両方に Hello CICD が表示されるはずです。	AWS DevOps、クラウドインフラストラクチャ
各マイクロサービスにこのエピックを繰り返します。	このエピックのタスクを繰り返して、各マイクロサービスの CI/CD パイプラインを作成します。	AWS DevOps、クラウドインフラストラクチャ

関連リソース

• Python と AWS CDK の併用 

• AWS CDK Python リファレンス

• AWS CDK を使用して AWS Fargate サービスを作成する

追加情報

cdk synthコマンド

cdk synth --context aws_account=<aws_account_number> --context aws_region=<aws_region> --context vpc_nonprod_id=<id_of_non_production VPC> --context vpc_prod_id=<id_of_production_VPC> --context ecssg_nonprod_id=< default_security_group_id_of_non-production_VPC> --context ecssg_prod_id=<default_security_group_id_of_production_VPC> --context code_commit_s3_bucket_for_code=<S3 bucket name> --context code_commit_s3_object_key_for_code=<Object_key_of_starter_code> --context microservice_name=<name_of_microservice>

cdk deploy コマンド

cdk deploy --context aws_account=<aws_account_number> --context aws_region=<aws_region> --context vpc_nonprod_id=<id_of_non_production_VPC> --context vpc_prod_id=<id_of_production_VPC> --context ecssg_nonprod_id=< default_security_group_id_of_non-production_VPC> --context ecssg_prod_id=<default_security_group_id_of_production_VPC> --context code_commit_s3_bucket_for_code=<S3 bucket name> --context code_commit_s3_object_key_for_code=<Object_key_of_starter_code> --context microservice_name=<name_of_microservice> 

添付ファイル

このドキュメントに関連する追加コンテンツにアクセスするには、次のファイルを解凍してください。「attachment.zip」