View a markdown version of this page

がサポート AWS リージョン していないパイプラインを に作成する AWS CodePipeline - AWS 規範ガイダンス
概要前提条件と制限事項アーキテクチャツールエピック関連リソース

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

がサポート AWS リージョン していないパイプラインを に作成する AWS CodePipeline

Amazon Web Services、Anand Krishna Varanasi

概要

AWS CodePipeline は、Amazon Web Services () の一連の DevOps ツールの一部である継続的デリバリー (CD) オーケストレーションサービスですAWS。さまざまなソース (バージョン管理システムやストレージソリューションなど）、 および AWS AWS パートナーからの継続的インテグレーション (CI) 製品およびサービス、オープンソース製品と統合され、アプリケーションやインフラストラクチャの迅速なデプロイのためのend-to-endのワークフローサービスを提供します。

ただし、CodePipeline はすべての でサポートされていないため AWS リージョン、 AWS CI/CD サービスを接続するオーケストレーターを非表示にしておくと便利です。このパターンでは、 AWS CodeCommit、 AWS CodeBuild、 などの AWS CI/CD サービスを使用して CodePipeline がまだサポートされていない AWS リージョン にend-to-endのワークフローパイプラインを実装する方法について説明します AWS CodeDeploy。

前提条件と制限事項

前提条件

  • アクティブな AWS アカウント

  • AWS Cloud Development Kit (AWS CDK) CLI バージョン 2.28 以降

アーキテクチャ

次の図表では、アフリカ (ケープタウン) リージョンなど、CodePipeline が適用されないリージョンで作成されたパイプラインを示しています。開発者は CodeDeploy 設定ファイル (デプロイライフサイクルフックスクリプト)とも呼ばれる) を CodeCommit がホストする Git リポジトリにプッシュします。(このパターンで提供されている GitHub リポジトリ を参照してください。) Amazon EventBridge ルールは、CodeBuild を自動で開始します。

CodeDeploy 設定ファイルは、パイプラインのソースステージの一部として CodeCommit から取得され、CodeBuild に転送されます。 

次のフェーズで、CodeBuild は次のタスクを実行します。 

  1. アプリケーションのソースコードの TAR ファイルをダウンロードします。このファイルの名前は、 の一機能である Parameter Store を使用して設定できます AWS Systems Manager。

  2. CodeDeploy 設定ファイルをダウンロードします。

  3. アプリケーションソースコードと、アプリケーションタイプに固有の CodeDeploy 設定ファイルを組み合わせたアーカイブを作成します。

  4. Amazon Elastic Compute Cloud (Amazon EC2) インスタンスに対する CodeDeploy デプロイをセットアップします。

適用されない AWS リージョンでのパイプライン作成

ツール

AWS サービス

  • AWS CodeBuild は完全管理型の構築サービスで、ソースコードのコンパイル、ユニットテストの実行、すぐに展開できるアーティファクトの生成に役立ちます。

  • AWS CodeCommit は、独自のソースコントロールシステムを管理することなく、Git リポジトリを非公開で保存および管理できるバージョン管理サービスです。

  • AWS CodeDeploy は、Amazon EC2、オンプレミスインスタンス、 AWS Lambda 関数、または Amazon Elastic Container Service (Amazon ECS) サービスへのデプロイを自動化します。

  • AWS CodePipeline は、ソフトウェアリリースのさまざまな段階を迅速にモデル化および設定し、ソフトウェアの変更を継続的にリリースするために必要なステップを自動化するのに役立ちます。

  • AWS Cloud Development Kit (AWS CDK) は、コードで AWS クラウド インフラストラクチャを定義およびプロビジョニングするのに役立つソフトウェア開発フレームワークです。

コード

このパターンのコードは、GitHub 内の「CodePipeline 適用されないリージョン」リポジトリで利用できます。

エピック

タスク説明必要なスキル

CLI AWS CDK をインストールします。

手順については、AWS CDK ドキュメントを参照してください。

AWS DevOps

SQL クライアントをインストールします。

ローカルコンピュータにインストールされた Git クライアントを使用してコミットを作成してから、それらのコミットを CodeCommit リポジトリにプッシュできます。Git クライアントで CodeCommit をセットアップするには、CodeCommit のドキュメント を参照してください。

AWS DevOps

npm をインストールします。

npm のパッケージマネージャーをインストールします。詳細については、npmドキュメントを参照してください。

AWS DevOps
タスク説明必要なスキル

コードリポジトリを複製します。

以下のコマンドを実行して、GitHub CodePipeline 適用されないリージョン のリポジトリをローカルマシンにクローンします。

git clone https://github.com/aws-samples/invisible-codepipeline-unsupported-regions
DevOps エンジニア

cdk.json にパラメーターを設定します。

cdk.json セクションで、次のパラメーターの値を指定します。

"pipeline_account":"XXXXXXXXXXXX",
"pipeline_region":"us-west-2",
"repo_name": "app-dev-repo",
"ec2_tag_key": "test-vm",
"configName" : "cbdeployconfig",
"deploymentGroupName": "cbdeploygroup",
"applicationName" : "cbdeployapplication",
"projectName" : "CodeBuildProject"

各パラメータの意味は次のとおりです。

  • pipeline_account は、パイプラインが構築される AWS アカウント です。

  • pipeline_region は、パイプラインが構築される AWS リージョン です。

  • コードリポジトリの名前 ( など)。

  • ec2_tag_key は、コードをデプロイする Amazon EC2 インスタンスにアタッチされたタグです。

  • configName はCodeDeploy コンフィギュレーションファイルの名前です

  • CodeDeploy デプロイグループの名前。

  • applicationName はCodeDeploy アプリケーション名です。

  • projectName はCodeBuild プロジェクト名です。

AWS DevOps

AWS CDK コンストラクトライブラリをセットアップします。

クローンされた GitHub リポジトリで、次のコマンドを使用して AWS CDK コンストラクトライブラリをインストールし、アプリケーションを構築し、合成してアプリケーションの AWS CloudFormation テンプレートを生成します。

npm i aws-cdk-lib
npm run build
cdk synth
AWS DevOps

サンプル AWS CDK アプリケーションをデプロイします。

適用されないリージョン (af-south-1 など)で次のコマンドを実行してコードをデプロイします。

cdk deploy
AWS DevOps
タスク説明必要なスキル

アプリケーションの CI/CD をセットアップします。

cdk.json ファイルに指定された CodeCommit リポジトリを複製して (デフォルトで app-dev-repo と呼ばれ)、アプリケーションの CI/CD パイプラインを設定します。

git clone https://git-codecommit.us-west-2.amazonaws.com/v1/repos/app-dev-repo

リポジトリ名とリージョンは、cdk.json ファイルに入力した値によって異なります。

AWS DevOps
タスク説明必要なスキル

デプロイインストラクションを使用してパイプラインをテストします。

GitHub CodePipelineサポートされていないリージョン リポジトリの CodeDeploy_Files フォルダには、CodeDeploy にアプリケーションをデプロイするように指示するサンプルファイルが含まれています。appspec.yml ファイルは、アプリケーションデプロイのフローを制御するフックを含む CodeDeploy 設定ファイルです。サンプルファイル index.html、start_server.sh、stop_server.sh、及び install_dependencies.sh を使用して、Apache でホストされているウェブサイトを更新します。これらは例です。GitHub リポジトリのコードを使用して、あらゆるタイプのアプリケーションをデプロイします。ファイルが CodeCommit リポジトリにプッシュされる場合、非表示のパイプラインが自動的に開始されます。デプロイ結果については、CodeBuild コンソールと CodeDeploy コンソールの個々のフェーズの結果を確認します。

AWS DevOps

関連リソース