翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
パイプライン、ステージ、アクションを作成する
AWS CodePipeline コンソールまたは AWS CLI を使用してパイプラインを作成できます。パイプラインには少なくとも 2 つのステージが必要です。パイプラインの第 1 ステージは、ソースステージである必要があります。パイプラインには、ビルドまたはデプロイステージである他のステージが少なくとも 1 つ必要です。
重要
パイプラインの作成の一環として、お客様が提供する S3 アーティファクトバケットがアーティファクト CodePipeline に によって使用されます。(これは S3 ソースアクションに使用されるバケットとは異なります)。S3 アーティファクトバケットがパイプラインのアカウントとは異なるアカウントにある場合は、S3 アーティファクトバケットが によって所有 AWS アカウント されており、安全で信頼できることを確認してください。
パイプライン AWS リージョン とは異なる にあるアクションをパイプラインに追加できます。クロスリージョンアクションは、 AWS のサービス がアクションのプロバイダーであり、アクションタイプまたはプロバイダータイプがパイプラインとは異なる AWS リージョンにあるアクションです。詳細については、「でクロスリージョンアクションを追加する CodePipeline」を参照してください。
Amazon をデプロイプロバイダーECSとして使用して、コンテナベースのアプリケーションを構築およびデプロイするパイプラインを作成することもできます。Amazon でコンテナベースのアプリケーションをデプロイするパイプラインを作成する前にECS、「」の説明に従ってイメージ定義ファイルを作成する必要がありますイメージ定義ファイルのリファレンス。
CodePipeline は、ソースコードの変更がプッシュされたときに変更検出方法を使用してパイプラインを開始します。この検出方法はソースタイプに基づいています。
-
CodePipeline は Amazon CloudWatch Events を使用して、 CodeCommit ソースリポジトリとブランチ、または S3 ソースバケットの変更を検出します。
注記
コンソールを使用してパイプラインを作成または編集すると、変更検出リソースが作成されます。を使用して AWS CLIパイプラインを作成する場合は、追加のリソースを自分で作成する必要があります。詳細については、「 CodeCommit ソースアクションと EventBridge」を参照してください。
カスタムパイプラインを作成する (コンソール)
コンソールでカスタムパイプラインを作成するには、ソースファイルの場所と、アクションに使用するプロバイダーに関する情報を提供する必要があります。
コンソールを使用してパイプラインを作成する場合、ソースステージに加えて、以下のいずれかまたは両方が必要です。
-
ビルドステージ
-
デプロイステージ
パイプラインウィザードを使用すると、 はステージの名前 (ソース、ビルド、ステージング) CodePipeline を作成します。これらの名前は変更できません。後で追加するステージには、より具体的な名前 ( BuildToGamma や など DeployToProd) を使用できます。
ステップ 1: パイプラインの作成と名前付け
にサインイン AWS Management Console し、http://console.aws.amazon.com/codesuite/codepipeline/home
で CodePipeline コンソールを開きます。 -
[Welcome (ようこそ)] ページで、[Create pipeline (パイプラインの作成)] を選択します。
を初めて使用する場合は CodePipeline、「スタート方法」を選択します。
-
ステップ 1: 作成オプションページ、作成オプション でカスタムパイプラインの構築オプションを選択します。[Next (次へ)] を選択します。
-
ステップ 2: パイプライン設定ページで、パイプライン名 にパイプラインの名前を入力します。
1 つの AWS アカウントで、 AWS リージョンで作成する各パイプラインには一意の名前が必要です。名前は、異なるリージョンのパイプラインに再利用できます。
注記
パイプラインを作成したら、その名前を変更することはできません。その他の制限についての詳細については、「のクォータ AWS CodePipeline」を参照してください。
-
[パイプラインのタイプ] で、次のいずれかのオプションを選択します。パイプラインのタイプによって特徴および価格が異なります。詳細については、「パイプラインのタイプ」を参照してください。
-
V1 タイプのパイプラインには、標準のパイプライン、ステージ、アクションレベルのパラメータを含むJSON構造があります。
-
V2 タイプのパイプラインは、V1 タイプと同じ構造で、Git タグやパイプラインレベルの変数に対するトリガーなど、追加のパラメータがサポートされています。
-
-
[Service role (サービスロール)] で、次のいずれかの操作を行います。
-
で新しいサービスロールを作成するために CodePipeline を許可する新しいサービスロールを選択しますIAM。
-
で既に作成されたサービスロールを使用するには、既存のサービスロールを選択しますIAM。ロール ARNARNで、リストからサービスロールを選択します。
注記
サービスロールが作成された日時によっては、追加の をサポートするためにアクセス許可を更新する必要がある場合があります AWS のサービス。詳細については、 CodePipeline サービスロールにアクセス許可を追加する を参照してください。
サービスロールとそのポリシーステートメントの詳細については、「 CodePipeline サービスロールを管理する」を参照してください。
-
-
(オプション) [変数] で [変数を追加] を選択し、パイプラインレベルの変数を追加します。
パイプラインレベルの変数の詳細については、「変数リファレンス」を参照してください。パイプラインの実行時に渡されるパイプラインレベルの変数のチュートリアルについては、「チュートリアル: パイプラインレベルの変数を使用する」を参照してください。
注記
パイプラインレベルの変数の追加はオプションですが、パイプラインレベルの変数に値が設定されていない場合、パイプラインの実行は失敗します。
-
(オプション) [詳細設定] を展開します。
-
[アーティファクトストア] で、以下のいずれかの操作を行います。
-
デフォルトの場所を選択して、パイプラインに AWS リージョン 選択した のパイプラインに、デフォルトとして指定された S3 アーティファクトバケットなどのデフォルトのアーティファクトストアを使用します。
-
S3 アーティファクトバケットなどのアーティファクトストアがパイプラインと同じリージョンに既に存在する場合は、[Custom location (カスタムの場所)] を選択します。[バケット] で、バケット名を選択します。
注記
これはソースコードのソースバケットではありません。パイプラインのアーティファクトストアです。パイプラインごとに S3 バケットなどの個別のアーティファクトストアが必要です。パイプラインを作成または編集するときは、パイプラインリージョンにアーティファクトバケットがあり、アクションを実行している AWS リージョンごとにアーティファクトバケットが 1 つ必要です。
詳細については、「入力および出力アーティファクト」および「CodePipeline パイプライン構造リファレンス」を参照してください。
-
-
[暗号化キー] で、次のいずれかの操作を行います。
-
CodePipeline デフォルトを使用してパイプラインアーティファクトストア (S3 バケット) AWS KMS key 内のデータを暗号化するには、デフォルトの AWS マネージドキー を選択します。
-
カスタマーマネージドキーを使用してパイプラインアーティファクトストア (S3 バケット) 内のデータを暗号化するには、[カスタマーマネージドキー] を選択します。キー ID、キー ARN、またはエイリアス を選択しますARN。
-
-
[Next (次へ)] を選択します。
ステップ 2: ソースステージを作成する
-
ステップ 3: ソースステージページ、ソースプロバイダー で、ソースコードが保存されているリポジトリのタイプを選択し、必要なオプションを指定します。次のように選択されたソースプロバイダーに応じて、追加のフィールドが表示されます。
-
Bitbucket Cloud、 GitHub (バージョン 2) GitHub、Enterprise Server、 GitLab.com、または GitLab セルフマネージド の場合:
-
接続 で、既存の接続を選択するか、新規の接続を作成します。 GitHub ソースアクションの接続を作成または管理する方法については、「」を参照してくださいGitHub 接続。
-
パイプラインのソース場所として使用するリポジトリを選択します。
トリガーを追加するか、トリガータイプをフィルタリングしてパイプラインを開始します。トリガーの操作の詳細については、「」を参照してくださいコードプッシュまたはプルリクエストのトリガーをフィルタリングする。glob パターンを使用したフィルタ処理の詳細については、「構文での glob パターンの使用」を参照してください。
-
Output artifact format で、アーティファクトのフォーマットを選択します。
-
デフォルトの メソッドを使用して GitHub アクションから出力アーティファクトを保存するには、CodePipelineデフォルトの を選択します。アクションは GitHub リポジトリからファイルにアクセスし、パイプラインアーティファクトストアのZIPファイルにアーティファクトを保存します。
-
リポジトリへのURL参照を含むJSONファイルを保存して、ダウンストリームアクションが Git コマンドを直接実行できるようにするには、フルクローン を選択します。このオプションは、 CodeBuild ダウンストリームアクションでのみ使用できます。
このオプションを選択した場合は、「」に示すように、 CodeBuild プロジェクトサービスロールのアクセス許可を更新する必要がありますトラブルシューティング CodePipeline。Full clone オプションを使用する方法を示すチュートリアルについては、チュートリアル: GitHub パイプラインソースでフルクローンを使用する を参照してください。
-
-
-
Amazon S3 については:
-
[Amazon S3 の場所] で、S3 バケットの名前と、バージョニングが有効になっているバケット内のオブジェクトへのパスを指定します。バケット名とパスの形式は以下のようになります。
s3://
bucketName
/folderName
/objectName
注記
Amazon S3 がパイプラインのソースプロバイダーである場合、ソースファイルあるいはファイルを 1 つの [.zip] に圧縮し、その [.zip] をソースバケットにアップロードすることができます。解凍されたファイルを 1 つアップロードすることもできます。ただし、.zip ファイルを想定するダウンストリームアクションは失敗します。
-
S3 ソースバケットを選択すると、 はこのパイプライン用に作成する Amazon CloudWatch Events ルールと AWS CloudTrail 証跡 CodePipeline を作成します。[Change detection options (変更検出オプション)] で、デフォルト値を受け入れます。これにより CodePipeline 、Amazon CloudWatch Events と AWS CloudTrail を使用して、新しいパイプラインの変更を検出できます。[Next (次へ)] を選択します。
-
-
AWS CodeCommit の場合:
-
リポジトリ名 で、パイプラインのソースロケーションとして使用する CodeCommit リポジトリの名前を選択します。[Branch name] で、ドロップダウンリストから使用するブランチを選択します。
-
Output artifact format で、アーティファクトのフォーマットを選択します。
-
デフォルトの メソッドを使用して CodeCommit アクションから出力アーティファクトを保存するには、CodePipelineデフォルトの を選択します。アクションは CodeCommit リポジトリからファイルにアクセスし、パイプラインアーティファクトストアのZIPファイルにアーティファクトを保存します。
-
リポジトリへのURL参照を含むJSONファイルを保存して、ダウンストリームアクションが Git コマンドを直接実行できるようにするには、フルクローン を選択します。このオプションは、 CodeBuild ダウンストリームアクションでのみ使用できます。
このオプションを選択した場合は、「」に示すように CodeBuild 、サービスロールに
codecommit:GitPull
アクセス許可を追加する必要がありますソースアクションの CodeBuild GitClone CodeCommitアクセス許可を追加する。また、「」に示すように、 CodePipeline サービスロールにアクセスcodecommit:GetRepository
許可を追加する必要があります CodePipeline サービスロールにアクセス許可を追加する。[完全クローン] オプションを使用する方法を示すチュートリアルについては、チュートリアル: GitHub パイプラインソースでフルクローンを使用する を参照してください。
-
-
CodeCommit リポジトリ名とブランチを選択すると、このパイプライン用に作成する Amazon CloudWatch Events ルールを示す変更検出オプションにメッセージが表示されます。[Change detection options (変更検出オプション)] で、デフォルト値を受け入れます。これにより CodePipeline 、Amazon CloudWatch Events を使用して新しいパイプラインの変更を検出できます。
-
-
Amazon ECRの場合:
-
リポジトリ名 で、Amazon ECRリポジトリの名前を選択します。
-
Image タグ で、 と異なる場合は、イメージ名とバージョンを指定しますLATEST。
-
出力アーティファクト で、次のステージで使用するイメージ名とリポジトリURI情報を含む MyAppなどの出力アーティファクトのデフォルトを選択します。
Amazon ECRソースステージを含むブルーグリーンデプロイECSで CodeDeploy Amazon のパイプラインを作成するチュートリアルについては、「」を参照してくださいチュートリアル: Amazon ECRソースと ECSからCodeDeploy デプロイまでのパイプラインを作成する。
パイプラインに Amazon ECRソースステージを含めると、ソースアクションは変更をコミットするときに出力アーティファクトとして
imageDetail.json
ファイルを生成します。imageDetail.json
ファイルの詳細については、「imageDetailAmazon ECS Blue/Green デプロイアクションの .json ファイル」を参照してください。 -
注記
オブジェクトとファイルタイプは、使用するデプロイシステムと互換性がある必要があります (Elastic Beanstalk や など CodeDeploy)。サポートされているファイルのタイプは .zip、.tar、.tgz ファイルなどです。Elastic Beanstalk でサポートされているコンテナのタイプの詳細については、Customizing and Configuring Elastic Beanstalk Environments と Supported Platforms を参照してください。でリビジョンをデプロイする方法については CodeDeploy、「アプリケーションリビジョンのアップロード」と「リビジョンの準備」を参照してください。
-
-
自動再試行のステージを設定するには、ステージ障害で自動再試行を有効にする を選択します。自動再試行の詳細については、「」を参照してください障害発生時の自動再試行のステージを設定する。
-
[Next (次へ)] を選択します。
ステップ 4: ビルドステージを作成する
デプロイステージを作成する予定の場合、このステップはオプションです。
-
[Step 3: Add build stage (ステップ 3: ビルドステージの追加)] ページで、以下のいずれかの操作を行い、[次へ] を選択します。
-
デプロイステージを作成する予定の場合は、[Skip build stage (ビルドステージのスキップ)] を選択します。
-
ビルドステージの コマンドアクションを選択するには、 コマンド を選択します。
注記
コマンドアクションを実行すると、 で個別の料金が発生します。 AWS CodeBuild
コマンド で、アクションのシェルコマンドを入力します。コマンドアクションの詳細については、「」を参照してくださいコマンドアクションリファレンス。
-
などの他のビルドプロバイダーを選択するには CodeBuild、その他のプロバイダー を選択します。[ビルドプロバイダー] から、ビルドサービスのカスタムアクションプロバイダーを選択し、そのプロバイダーの設定詳細を入力します。Jenkins をビルドプロバイダとして追加する方法の例については、「チュートリアル: 4 ステージのパイプラインを作成する」を参照してください。
-
[ビルドプロバイダ] から、[AWS CodeBuild] を選択します。
リージョン で、リソースが存在する AWS リージョンを選択します。リージョンフィールドは、このアクションタイプとプロバイダータイプの AWS リソースが作成される場所を指定します。このフィールドは、アクションプロバイダーが AWS のサービスである場合にのみ表示されます。リージョンフィールドは、デフォルトでパイプラインと同じ AWS リージョンになります。
[プロジェクト名] で、ビルドプロジェクトを選択します。でビルドプロジェクトを既に作成している場合は CodeBuild、それを選択します。または、 でビルドプロジェクトを作成し CodeBuild 、このタスクに戻ることもできます。CodeBuild ユーザーガイドの「 を使用するパイプラインを作成する CodeBuild」の指示に従います。
環境変数 で、ビルドアクションに環境変数を追加するには CodeBuild、環境変数 を追加 を選択します。各変数は、次の 3 つのエントリで構成されます。
-
[名前] には、環境変数の名前またはキーを入力します。
-
[値] には、環境変数の値を入力します。変数タイプの Parameter を選択した場合は、この値が AWS Systems Manager パラメータストアに既に保存されているパラメータの名前であることを確認します。
注記
環境変数を使用して、機密性の高い値、特に AWS 認証情報を保存することは強くお勧めしません。 CodeBuild コンソールまたは を使用すると AWS CLI、環境変数がプレーンテキストで表示されます。機密の値の場合は、代わりに [パラメータ] 型を使用することをお勧めします。
-
(オプション) [型] に、環境変数の型を入力します。有効な値は、[プレーンテキスト] または [パラメータ] です。デフォルトは [プレーンテキスト] です。
(オプション) Build type で、次のいずれかを選択します。
-
各ビルドを 1 回のビルドアクション実行で実行するには、Single build を選択します。
-
同じビルドアクションの実行で複数のビルドを実行するには、Batch build を選択します。
(オプション) バッチビルドを選択した場合、Combine all artifacts from batch into a single location を選択して、すべてのビルドアーティファクトを 1 つの出力アーティファクトに配置します。
-
-
-
自動再試行のステージを設定するには、ステージ障害で自動再試行を有効にする を選択します。自動再試行の詳細については、「」を参照してください障害発生時の自動再試行のステージを設定する。
-
[Next (次へ)] を選択します。
ステップ 5: デプロイステージを作成する
ビルドステージをすでに作成している場合、このステップはオプションです。
-
[Step 4: Add deploy stage (ステップ 4: デプロイステージの追加)] ページで、以下のいずれかの操作を行い、[次へ] を選択します。
-
前のステップでビルドステージを作成した場合は、[Skip deploy stage (デプロイステージのスキップ)] を選択します。
注記
すでにビルドステージをスキップしている場合、このオプションは表示されません。
-
[デプロイプロバイダ] で、デプロイプロバイダ用に作成したカスタムアクションを選択します。
リージョン では、クロスリージョンアクションでのみ、リソースが作成される AWS リージョンを選択します。[リージョン] フィールドは、このアクションタイプとプロバイダータイプに対して作成済みの AWS リソースの場所を示します。このフィールドには、アクションプロバイダーが AWS のサービスであるアクションのみが表示されます。リージョンフィールドは、デフォルトでパイプラインと同じ AWS リージョンになります。
-
[デプロイプロバイダ] で、デフォルトプロバイダ用の以下のフィールドを使用できます。
-
CodeDeploy
アプリケーション名 で、既存の CodeDeploy アプリケーションの名前を入力または選択します。[デプロイグループ] に、アプリケーションのデプロイグループの名前を入力します。[Next (次へ)] を選択します。コンソールで CodeDeployアプリケーション、デプロイグループ、またはその両方を作成することもできます。
-
AWS Elastic Beanstalk
Application name で、既存の Elastic Beanstalk アプリケーションの名前を入力または選択します。[環境名] に、アプリケーションの環境を入力します。[Next (次へ)] を選択します。アプリケーション、環境、または両方を Elastic Beanstalk コンソールで作成することもできます。
-
AWS OpsWorks Stacks
[スタック] で、使用するスタックの名前を入力または選択します。[レイヤー] で、ターゲットインスタンスがあるレイヤーを選択します。[デプロイ] で、更新およびデプロイするアプリケーションを選択します。アプリケーションを作成する必要がある場合は、[Create a new one in AWS OpsWorks] を選択します。
のスタックとレイヤーにアプリケーションを追加する方法については AWS OpsWorks、AWS OpsWorks 「 ユーザーガイド」の「アプリケーションの追加」を参照してください。
AWS OpsWorks レイヤーで実行するコードのソース CodePipeline として で単純なパイプラインを使用する方法 end-to-endの例については、「 CodePipeline で AWS OpsWorks Stacksを使用する」を参照してください。
-
AWS CloudFormation
次のいずれかを行います。
-
アクションモードで、スタック を作成または更新を選択し、スタック名とテンプレートファイル名を入力し、引き受け AWS CloudFormation る ロールの名前を選択します。必要に応じて、設定ファイルの名前を入力し、IAM機能オプションを選択します。
-
アクションモードで、変更セット を作成または置き換え、スタック名と変更セット名を入力し、引き受け AWS CloudFormation る ロールの名前を選択します。必要に応じて、設定ファイルの名前を入力し、IAM機能オプションを選択します。
のパイプラインに AWS CloudFormation 機能を統合する方法については CodePipeline、AWS CloudFormation 「 ユーザーガイド」の「 での継続的配信 CodePipeline」を参照してください。
-
-
Amazon ECS
クラスター名 で、既存の Amazon ECSクラスターの名前を入力または選択します。[サービス名] で、クラスターで実行されているサービスの名前を入力または選択します。クラスターとサービスを作成することもできます。[イメージのファイル名] で、サービスのコンテナとイメージを説明するイメージ定義ファイルの名前を入力します。
注記
Amazon ECSデプロイアクションには、デプロイアクションへの入力として
imagedefinitions.json
ファイルが必要です。ファイルのデフォルトのファイル名は、imagedefinitions.json です。別のファイル名を使用することを選択した場合は、パイプラインデプロイステージを作成するときにそれを指定する必要があります。詳細については、「Amazon ECS標準デプロイアクションの imagedefinitions.json ファイル」を参照してください。[Next (次へ)] を選択します。
注記
Amazon ECSクラスターが 2 つ以上のインスタンスで構成されていることを確認します。Amazon ECSクラスターには、1 つはプライマリインスタンスとして維持され、もう 1 つは新しいデプロイに対応するために使用されるように、少なくとも 2 つのインスタンスが含まれている必要があります。
パイプラインでのコンテナベースのアプリケーションのデプロイに関するチュートリアルについては、「チュートリアル: での継続的デプロイ CodePipeline」を参照してください。
-
Amazon ECS (ブルー/グリーン)
CodeDeploy アプリケーションとデプロイグループ、Amazon ECSタスク定義、 AppSpec ファイル情報を入力し、次へ を選択します。
注記
Amazon ECS (ブルー/グリーン) アクションには、デプロイアクションの入力アーティファクトとして imageDetail.json ファイルが必要です。Amazon ECRソースアクションはこのファイルを作成するため、Amazon ECRソースアクションを持つパイプラインは
imageDetail.json
ファイルを提供する必要はありません。詳細については、「imageDetailAmazon ECS Blue/Green デプロイアクションの .json ファイル」を参照してください。を使用して Amazon ECSクラスターにブルーグリーンデプロイするためのパイプラインを作成するチュートリアルについては CodeDeploy、「」を参照してくださいチュートリアル: Amazon ECRソースと ECSからCodeDeploy デプロイまでのパイプラインを作成する。
-
AWS Service Catalog
コンソールのフィールドを使用して設定を指定する場合は [Enter deployment configuration (デプロイ設定の入力)] を選択します。あるいは、個別の設定ファイルがある場合は [設定ファイル] を選択します。製品と設定の情報を入力し、[次へ] を選択します。
パイプラインを使用して製品の変更を Service Catalog にデプロイする方法のチュートリアルについては、「チュートリアル: Service Catalog にデプロイするパイプラインを作成する」を参照してください。
-
Alexa Skills Kit
[Alexa Skill ID (Alexa スキル ID)] に Alexa スキルのスキル ID を入力します。クライアント ID とクライアントシークレット で、Login with Amazon (LWA) セキュリティプロファイルを使用して生成された認証情報を入力します。更新トークン で、更新トークンを取得するための ASK CLI コマンドを使用して生成した更新トークンを入力します。[Next (次へ)] を選択します。
パイプラインでの Alexa スキルのデプロイとLWA認証情報の生成に関するチュートリアルについては、「」を参照してくださいチュートリアル: Amazon Alexa Skill をデプロイするパイプラインを作成する。
-
Amazon S3
[バケット] に、使用する S3 バケットの名前を入力します。デプロイステージへの入力アーティファクトが ファイルの場合は、デプロイ前にファイルの抽出を選択します。 ZIPデプロイ前にファイルを抽出を選択した場合は、必要に応じて、ZIPファイルを解凍するデプロイパスの値を入力できます。選択しなかった場合は、[S3 object key (S3 オブジェクトキー)] に値を入力する必要があります。
注記
ほとんどのソースステージおよびビルドステージの出力アーティファクトは圧縮されます。Amazon S3 zip を除くすべてのパイプラインソースプロバイダーは、ソースファイルを Zip してから、次のアクションに入力アーティファクトとして提供します。
(オプション) Canned ACLで、Amazon S3 にデプロイされたオブジェクトに適用する canned ACL を入力します。
注記
既定を適用すると、オブジェクトACLに適用されている既存のすべてがACL上書きされます。
(オプション) [キャッシュコントロール] で、バケットからオブジェクトをダウンロードするリクエストのキャッシュコントロールパラメータを指定します。有効な値のリストについては、 HTTPオペレーションの
Cache-Control
ヘッダーフィールドを参照してください。[Cache control (キャッシュコントロール)] に複数の値を入力するには、各値の間にカンマを使用します。この例に示すように、各カンマの後にスペースを追加できます (オプション)。 上記のエントリ例は、CLI次のように に表示されます。
"CacheControl": "public, max-age=0, no-transform"
[Next (次へ)] を選択します。
Amazon S3 デプロイアクションプロバイダとして を使用するパイプラインを作成する方法のチュートリアルについては、チュートリアル: Amazon S3 をデプロイプロバイダとして使用するパイプラインを作成する を参照してください。
-
-
-
自動再試行のステージを設定するには、ステージの失敗時に自動再試行を有効にする を選択します。自動再試行の詳細については、「」を参照してください障害発生時の自動再試行のステージを設定する。
-
自動ロールバックのステージを設定するには、「ステージ障害に対する自動ロールバックの設定」を選択します。自動ロールバックの詳細については、「」を参照してください自動ロールバックのステージを設定する。
-
[Next step]を選択します。
ステップ 6: パイプラインを確認する
-
[ステップ 6: 確認] ページで、パイプラインの設定を確認したら、[パイプラインの作成] を選択してパイプラインを作成するか、[戻る] を選択してオプションを編集します。パイプラインを作成せずにウィザードを終了するには、[Cancel] を選択します。
パイプラインが作成され、コンソールで表示できるようになりました。パイプラインは、作成後に実行されます。詳細については、「でパイプラインと詳細を表示する CodePipeline」を参照してください。パイプラインを変更する方法の詳細については、「でパイプラインを編集する CodePipeline」を参照してください。
パイプラインを作成する (CLI)
を使用してパイプライン AWS CLI を作成するには、パイプライン構造を定義するJSONファイルを作成し、 --cli-input-json
パラメータを使用して create-pipeline コマンドを実行します。
重要
を使用して、パートナーアクションを含むパイプライン AWS CLI を作成することはできません。代わりに CodePipeline コンソールを使用する必要があります。
パイプライン構造の詳細については、 CodePipeline APIリファレンスのCodePipeline パイプライン構造リファレンス「」および「create-pipeline」を参照してください。
JSON ファイルを作成するには、サンプルパイプラインJSONファイルを使用して編集し、create-pipelineコマンドの実行時にそのファイルを呼び出します。
前提条件:
CodePipeline で 用に作成したサービスロールARNの が必要ですの開始方法 CodePipeline。create-pipeline コマンドを実行するときは、パイプラインJSONファイルARNで CodePipeline サービスロールを使用します。サービスロールの作成の詳細については、「 CodePipeline サービスロールを作成する」を参照してください。コンソールとは異なり、 で create-pipeline コマンドを実行すると、 CodePipeline サービスロールを作成するオプション AWS CLI はありません。サービスロールがすでに存在している必要があります。
パイプラインのアーティファクトの保存先である S3 バケットの名前が必要です。このバケットはパイプラインと同じリージョンに存在する必要があります。create-pipeline コマンドを実行するときは、パイプラインJSONファイルのバケット名を使用します。コンソールとは異なり、 で create-pipeline コマンドを実行して AWS CLI も、アーティファクトを保存するための S3 バケットは作成されません。バケットが存在している必要があります。
注記
get-pipeline コマンドを使用して、そのパイプラインのJSON構造のコピーを取得し、プレーンテキストエディタでその構造を変更することもできます。
トピック
JSON ファイルを作成するには
-
ターミナル (Linux、 macOS、あるいは Unix)またはコマンドプロンプト(Windows)で、ローカルディレクトリに新規のテキストファイルを作成します。
-
(オプション) パイプラインレベルでは 1 つ以上の変数を追加できます。この値は、 CodePipeline アクションの設定で参照できます。パイプラインを作成するときに変数名と値を追加できます。また、コンソールでパイプラインを開始するときに値を割り当てることもできます。
注記
パイプラインレベルの変数の追加はオプションですが、パイプラインレベルの変数に値が設定されていない場合、パイプラインの実行は失敗します。
パイプラインレベルの変数は、パイプラインの実行時に解決されます。すべての変数は不変であり、値が割り当てられた後は更新できません。パイプラインレベルの変数のうち値が解決されたものは、実行ごとの履歴に表示されます。
パイプライン構造の変数属性を使用して、パイプラインレベルの変数を指定します。以下の例では、変数
Variable1
の値はValue1
です。"variables": [ { "name": "Timeout", "defaultValue": "1000", "description": "description" } ]
この構造をパイプライン に追加するかJSON、次のステップJSONの例に追加します。名前空間の情報など変数の詳細については、「変数リファレンス」を参照してください。
-
プレーンテキストエディタでファイルを開き、作成する構造を反映するように値を編集します。少なくとも、パイプラインの名前を変更する必要があります。また、変更するかを考慮する必要もあります。
-
このパイプラインのアーティファクトの保存先の S3 バケット。
-
コードのソースの場所。
-
デプロイのプロバイダ。
-
コードをデプロイする方法。
-
パイプラインのタグ。
以下の 2 ステージのサンプルパイプライン構造では、変更を検討する必要があるパイプラインの値を強調表示しています。パイプラインには多くの場合、2 つ以上のステージが含まれます。
{ "pipeline": { "roleArn": "arn:aws:iam::80398EXAMPLE::role/AWS-CodePipeline-Service", "stages": [ { "name": "
Source
", "actions": [ { "inputArtifacts": [], "name": "Source", "actionTypeId": { "category": "Source", "owner": "AWS", "version": "1", "provider": "S3" }, "outputArtifacts": [ { "name": "MyApp" } ], "configuration": { "S3Bucket": "amzn-s3-demo-source-bucket
", "S3ObjectKey": "ExampleCodePipelineSampleBundle.zip
", "PollForSourceChanges": "false" }, "runOrder": 1 } ] }, { "name": "Staging", "actions": [ { "inputArtifacts": [ { "name": "MyApp" } ], "name": "Deploy-CodeDeploy-Application
", "actionTypeId": { "category": "Deploy", "owner": "AWS", "version": "1", "provider": "CodeDeploy" }, "outputArtifacts": [], "configuration": { "ApplicationName": "CodePipelineDemoApplication
", "DeploymentGroupName": "CodePipelineDemoFleet
" }, "runOrder": 1 } ] } ], "artifactStore": { "type": "S3", "location": "codepipeline-us-east-2-250656481468" }, "name": "MyFirstPipeline", "version": 1, "variables": [ { "name": "Timeout", "defaultValue": "1000", "description": "description" } ] }, "triggers": [ { "providerType": "CodeStarSourceConnection", "gitConfiguration": { "sourceActionName": "Source", "push": [ { "tags": { "includes": [ "v1" ], "excludes": [ "v2" ] } } ] } } ] "metadata": { "pipelineArn": "arn:aws:codepipeline:us-east-2:80398EXAMPLE:MyFirstPipeline", "updated": 1501626591.112, "created": 1501626591.112 }, "tags": [{ "key": "Project", "value": "ProjectA" }] }この例では、パイプラインの
Project
タグキーとProjectA
値を含めることによって、タグ付けをパイプラインに追加します。でのリソースのタグ付けの詳細については CodePipeline、「」を参照してくださいリソースのタグ付け。JSON ファイル内の
PollForSourceChanges
パラメータが次のように設定されていることを確認します。"PollForSourceChanges": "false",
CodePipeline は Amazon CloudWatch Events を使用して、 CodeCommit ソースリポジトリとブランチ、または S3 ソースバケットの変更を検出します。次のステップには、パイプラインにこれらのリソースを手動で作成する手順が含まれています。フラグを
false
に設定すると、定期的なチェックが無効になります。これは、推奨される変更検出メソッドを使用している場合には、必要ではありません。 -
-
パイプラインとは異なるリージョンでビルド、テスト、またはデプロイアクションを作成するには、パイプライン構造に以下を追加する必要があります。手順については、でクロスリージョンアクションを追加する CodePipeline を参照してください。
-
Region
パラメータをアクションのパイプライン構造に追加します。 -
artifactStores
パラメータを使用して、アクションがある AWS リージョンごとにアーティファクトバケットを指定します。
-
-
その構造で問題がなければ、
pipeline.json
のような名前でファイルを保存します。
パイプラインを作成するには
-
create-pipeline コマンドを実行し、
--cli-input-json
パラメータを使用して、以前に作成したJSONファイルを指定します。という名前のパイプラインを作成するには
MySecondPipeline
という名前を含む pipeline.json という名前のJSONファイルMySecondPipeline
name
「」を の値として使用した場合JSON、コマンドは次のようになります。aws codepipeline create-pipeline --cli-input-json file://pipeline.json
重要
ファイル名の前に必ず
file://
を含めてください。このコマンドでは必須です。このコマンドは、作成したパイプライン全体の構造を返します。
-
パイプラインを表示するには、 CodePipeline コンソールを開いてパイプラインのリストから選択するか、 get-pipeline-state コマンドを使用します。詳細については、「でパイプラインと詳細を表示する CodePipeline」を参照してください。
-
を使用してパイプラインCLIを作成する場合は、パイプラインに推奨される変更検出リソースを手動で作成する必要があります。
-
CodeCommit リポジトリを持つパイプラインの場合、「」で説明されているように、 CloudWatch イベントルールを手動で作成する必要があります CodeCommit ソースの EventBridge ルールを作成する (CLI)。
-
Amazon S3 ソースを持つパイプラインの場合、「」で説明されているように、 CloudWatch イベントルールと AWS CloudTrail 証跡を手動で作成する必要があります EventBridge および を使用する Amazon S3 ソースアクションへの接続 AWS CloudTrail。
-
静的テンプレートからパイプラインを作成する
テンプレートを使用して、指定したソースコードとプロパティでパイプラインを設定するパイプラインをコンソールに作成できます。ソースファイルの場所と、アクションに使用するソースプロバイダーに関する情報を指定する必要があります。Amazon のソースアクション、ECRまたは など CodeConnections、 によって中断された任意のサードパーティーリポジトリを指定できます GitHub。
テンプレートは、次のリソースを含むパイプライン AWS CloudFormation の にスタックを作成します。
-
パイプラインは V2 パイプラインタイプで作成されます。[パイプラインのタイプ] で、次のいずれかのオプションを選択します。パイプラインのタイプによって特徴および価格が異なります。詳細については、「パイプラインのタイプ」を参照してください。
-
サービスロールはパイプライン用に作成され、テンプレートで参照されます。
-
アーティファクトストアは、パイプライン用に選択した の AWS リージョン パイプラインのデフォルトとして指定された S3 アーティファクトバケットなど、デフォルトのアーティファクトストアを使用して作成されます。
静的テンプレートを使用してパイプラインを作成する場合、パイプライン構造はユースケースのニーズに応じて各テンプレートに設定されます。例えば、 へのデプロイのテンプレート AWS CloudFormation は、この手順の例として使用されます。テンプレートは、次の構造DeployToCloudFormationServiceを持つ という名前のパイプラインを生成します。
-
ウィザードで指定した設定を持つソースアクションを含むビルドステージ。
-
デプロイアクションと関連するリソーススタックが にあるデプロイステージ AWS CloudFormation。
静的テンプレートを使用してパイプラインを作成すると、 はステージの名前 (ソース、ビルド、ステージング) CodePipeline を作成します。これらの名前は変更できません。後で追加するステージには、より具体的な名前 ( など DeployToProd) BuildToGamma を使用できます。
ステップ 1: 作成オプションを選択する
にサインイン AWS Management Console し、http://console.aws.amazon.com/codesuite/codepipeline/home
で CodePipeline コンソールを開きます。 -
[Welcome (ようこそ)] ページで、[Create pipeline (パイプラインの作成)] を選択します。
を初めて使用する場合は CodePipeline、「Get Started」を選択します。
-
ステップ 1: 作成オプションページ、作成オプション で、テンプレートからパイプラインを作成する オプションを選択します。[Next (次へ)] を選択します。
ステップ 2: テンプレートを選択する
テンプレートを選択して、デプロイステージ、オートメーション、または CI パイプラインを使用してパイプラインを作成します。
-
ステップ 2: テンプレートページを選択し、次のいずれかを実行してから、次へ を選択します。
-
デプロイステージを作成する場合は、デプロイを選択します。ECR または にデプロイするテンプレートのオプションを表示します CloudFormation。この例では、デプロイ を選択し、 にデプロイすることを選択します CloudFormation。
-
CI パイプラインを作成する場合は、「継続的統合」を選択します。Gradle への構築など、CI パイプラインのオプションを表示します。
-
自動パイプラインを作成する場合は、オートメーションを選択します。Python ビルドのスケジュールなど、オートメーションのオプションを表示します。
-
-
ステップ 3: ソースを選択する
-
ステップ 3: ソースページ、ソースプロバイダー で、ソースコードが保存されているリポジトリのプロバイダーを選択し、必要なオプションを指定してから、次のステップ を選択します。
-
Bitbucket Cloud、 GitHub (バージョン 2) GitHub、Enterprise Server、 GitLab.com、または GitLab セルフマネージド の場合:
-
接続 で、既存の接続を選択するか、新規の接続を作成します。 GitHub ソースアクションの接続を作成または管理する方法については、「」を参照してくださいGitHub 接続。
-
パイプラインのソース場所として使用するリポジトリを選択します。
トリガーを追加するか、トリガータイプをフィルタリングしてパイプラインを開始します。トリガーの操作の詳細については、「」を参照してくださいコードプッシュまたはプルリクエストのトリガーをフィルタリングする。glob パターンを使用したフィルタ処理の詳細については、「構文での glob パターンの使用」を参照してください。
-
Output artifact format で、アーティファクトのフォーマットを選択します。
-
デフォルトの メソッドを使用して GitHub アクションから出力アーティファクトを保存するには、CodePipelineデフォルトの を選択します。アクションは GitHub リポジトリからファイルにアクセスし、パイプラインアーティファクトストアのZIPファイルにアーティファクトを保存します。
-
リポジトリへのURL参照を含むJSONファイルを保存して、ダウンストリームアクションが Git コマンドを直接実行できるようにするには、フルクローン を選択します。このオプションは、 CodeBuild ダウンストリームアクションでのみ使用できます。
このオプションを選択した場合は、「」に示すように、 CodeBuild プロジェクトサービスロールのアクセス許可を更新する必要がありますトラブルシューティング CodePipeline。[完全クローン] オプションを使用する方法を示すチュートリアルについては、チュートリアル: GitHub パイプラインソースでフルクローンを使用する を参照してください。
-
-
-
Amazon ECRの場合:
-
リポジトリ名 で、Amazon ECRリポジトリの名前を選択します。
-
Image タグ で、 と異なる場合は、イメージ名とバージョンを指定しますLATEST。
-
出力アーティファクト で、次のステージで使用するイメージ名とリポジトリURI情報を含む MyAppなどの出力アーティファクトのデフォルトを選択します。
パイプラインに Amazon ECRソースステージを含めると、ソースアクションは変更をコミットするときに出力アーティファクトとして
imageDetail.json
ファイルを生成します。imageDetail.json
ファイルの詳細については、「imageDetailAmazon ECS Blue/Green デプロイアクションの .json ファイル」を参照してください。 -
注記
オブジェクトとファイルタイプは、使用するデプロイシステムと互換性がある必要があります (Elastic Beanstalk や など CodeDeploy)。サポートされているファイルのタイプは .zip、.tar、.tgz ファイルなどです。Elastic Beanstalk でサポートされているコンテナのタイプの詳細については、Customizing and Configuring Elastic Beanstalk Environments と Supported Platforms を参照してください。でリビジョンをデプロイする方法については CodeDeploy、「アプリケーションリビジョンのアップロード」と「リビジョンの準備」を参照してください。
-
ステップ 4: テンプレートを設定する
この例では、 へのデプロイが選択され CloudFormation ています。このステップでは、テンプレートの設定を追加します。
-
ステップ 4: テンプレート を設定する、スタック名 でパイプラインの名前を入力します。
-
テンプレートに適用されるアクセス許可のプレースホルダーIAMポリシーを編集します。
-
テンプレートからパイプラインを作成するを選択します。
-
パイプラインリソースが作成されていることを示すメッセージが表示されます。
ステップ 5: パイプラインを表示する
-
パイプラインを作成したら、コンソールで CodePipelineパイプラインを表示し、 でスタックを表示できます AWS CloudFormation。パイプラインは、作成後に実行されます。詳細については、「でパイプラインと詳細を表示する CodePipeline」を参照してください。パイプラインを変更する方法の詳細については、「でパイプラインを編集する CodePipeline」を参照してください。