AWS Service Catalog と を使用して、Gitflow 環境にホットフィックスソリューションをデプロイするための動的パイプライン管理を自動化する AWS CodePipeline

各ワークロードアカウント (ステージ、本番用、およびオプションの QA) で CloudFormation テンプレートをパッケージ化するには、次のコマンドを使用します。次のコマンドで、S3bucketpackage をパッケージングに使用する Amazon S3 バケット名に置き換えます。

#InStageAccount
aws cloudformation package \
    --template-file pre-requisites/infrastack.yaml \
    --s3-bucket <S3bucketpackage> \
    --s3-prefix infraStack \
    --region ${DepRegion} \
    --output-template-file pre-requisites/infrastructure_stage.template

#InProdAccount
aws cloudformation package \
    --template-file pre-requisites/infrastack.yaml \
    --s3-bucket <S3bucketpackage> \
    --s3-prefix infraStack \
    --region ${DepRegion} \
    --output-template-file pre-requisites/infrastructure_prod.template

各ワークロードアカウントに CloudFormation テンプレートをデプロイするには、次のコマンドを使用します。

#InStageAccount
aws cloudformation deploy --stack-name inframainstack \
--parameter-overrides  ApplicationName=${ApplicationName} ToolsAccount=${ToolsAccount} DepRegion=${DepRegion} \
--template-file pre-requisites/infrastructure_stage.template  --region ${DepRegion} --capabilities CAPABILITY_NAMED_IAM

#InProdAccount
aws cloudformation deploy --stack-name inframainstack \
--parameter-overrides  ApplicationName=${ApplicationName} ToolsAccount=${ToolsAccount} DepRegion=${DepRegion} \
--template-file pre-requisites/infrastructure_prod.template  --region ${DepRegion} --capabilities CAPABILITY_NAMED_IAM

テンプレート pipeline-main.yaml と pipeline-hotfix.yaml を CodePipeline ディレクトリのリポジトリから、(DepRegion) にデプロイするリージョンの既存の Amazon S3 バケット (Bucketname) にアップロードします。

#InToolsAccount
aws s3 cp ./codepipeline/pipeline-main.yaml s3://<Bucketname>/pipeline-main.yaml
aws s3 cp ./codepipeline/pipeline-hotfix.yaml s3://<Bucketname>/pipeline-hotfix.yaml

main および hotfix ブランチのパイプラインを管理する Service Catalog ポートフォリオと製品を設定します。次のスタックの MainProductId と MainProductArtifactId の Outputs セクションの詳細を書き留めておきます。この情報は、main ブランチのパイプライン設定の後のステップで必要です。

#InToolsAccount
aws cloudformation deploy \
    --template-file pre-requisites/servicecatalogsetup.yaml \
    --stack-name servicecatalogsetup \
    --parameter-overrides TemplateBucket=<Bucketname> \
    --capabilities CAPABILITY_IAM CAPABILITY_NAMED_IAM --region ${DepRegion}

ツールアカウントのリソースを Service Catalog ポートフォリオのメインパイプラインポートフォリオにデプロイする IAM ロールへのアクセスを提供します。このポートフォリオを使用して、main ブランチを使用してアプリケーションをデプロイします。アクセス権を付与する方法の詳細については、AWS Service Catalog のドキュメントの「Granting Access to Users」を参照してください。

Lambda 関数の IAM ロールとアクセス許可を作成するには、次のコマンドを使用して CloudFormation スタックをデプロイします。

#InToolsAccount aws cloudformation deploy \ --template-file pre-requisites/lambdasetup.yaml \ --stack-name prsclambdasetup \ --capabilities CAPABILITY_IAM CAPABILITY_NAMED_IAM --region ${DepRegion}

スタックのデプロイ後、AWS マネジメントコンソール を使用して Service Catalog ポートフォリオホットフィックスパイプラインポートフォリオへの hotfix-lambda-execution-role アクセスを許可します。このアクセスにより、Lambda 関数はホットフィックスブランチの Service Catalog 製品を起動または終了できるようになります。

prereqs で作成された CodeCommit リポジトリのクローンを作成するには、git clone コマンドを使用します。詳細については、CodeCommit ドキュメントで説明されている「リポジトリをクローンして CodeCommit リポジトリに接続する」を参照してください。

リポジトリで使用可能な repotemplates ディレクトリからすべてのアプリケーションファイルをローカルリポジトリクローン (${ApplicationName}-repository) にコピーします。ToolsAccount ID を更新するには、次のファイルを変更します。各ファイルで、RegistryAccountid パラメータを見つけ、その値を ToolsAccount ID に設定します。CodeCommit リポジトリに変更をコミットし、main と develop ブランチの両方にファイルをプッシュします。

アプリケーションのデプロイを確認するには、 AWS マネジメントコンソールを使用して CodePipeline の実行をモニタリングします。デプロイが完了したら、ステージ環境で Application Load Balancer FQDN を使用してアプリケーションにアクセスします。アプリケーションが想定どおりに機能することを確認します。

本番環境へのデプロイを承認するには、CodePipeline コンソールを使用してアプリケーションのパイプラインを探します。ApprovalToStart ステージを見つけます。変更を確認し、満足できる場合は、本番デプロイを続行するための手動承認を付与します。

キーワード hotfix で始まる名前を使用してブランチを作成します。例えば、このパターンでは CodeCommit アプリケーションリポジトリ (${ApplicationName}-repository) の hotfix-check1 ブランチを使用します。詳細については、CodeCommit ドキュメントの「 AWS CodeCommit リポジトリに接続する」および「基本的な Git コマンド」を参照してください。 CodeCommit

Service Catalog 製品 Hotfix CICD Pipeline が hotfix-check1 ブランチに対して動的に正常にプロビジョニングされていることを確認します。プロビジョニングされた製品名は、この修正ブランチ名とアプリケーションの CodeCommit リポジトリ名に基づき命名されます。

index.html ファイルにいくつかの小さな変更をコミットし、CodeCommit リポジトリにプッシュします。

ステージ環境で CodePipeline が正常に実行されたことを確認します。本番環境にデプロイするには、CodePipeline で手動承認を提供します。

Application Load Balancer の完全修飾ドメイン名 (FQDN) を使用して、アプリケーションのホームページに変更が表示されることを確認します。FQDN は、inframainstack-ALBStack-* の Outputs セクションで利用できます。

CodeCommit アプリケーションリポジトリにある hotfix-check1 ブランチを削除します。

hotfix-check1 ブランチ用にプロビジョニングされた Service Catalog 製品が正常に終了したことを確認します。

Amazon ECS サービスをワークロードアカウントのゼロレプリカにスケールダウンするには、次のコマンドを使用します。

aws ecs update-service --cluster ${ApplicationName}-Cluster --service ${ApplicationName}-Service-stage --desired-count 0 --region ${DepRegion}
aws ecs update-service --cluster ${ApplicationName}-Cluster --service ${ApplicationName}-Service-prod --desired-count 0 --region ${DepRegion}

main ブランチ用にプロビジョニングされた Service Catalog 製品を終了します。

ツールアカウントの Amazon S3 バケットに作成されたオブジェクトをクリーンアップします。レジストリ自体を削除する前に、Amazon ECR 内のすべての Docker イメージを削除します。

Service Catalog ポートフォリオを削除する前に、Service Catalog ポートフォリオのアクセス許可セクションで IAM ロールを削除します。

ツールアカウントとワークロードアカウントにデプロイされた CloudFormation スタックを削除します。