新しいコンテナレシピのバージョンを作成

新しいコンテナレシピのバージョンを作成するには:

1. コンテナレシピの詳細ページで、ページの上部にある新しいバージョンの作成を選択します。コンソールで、コンテナレシピのレシピの作成ページが開きます。

2. 新しいバージョンを作成するには、変更を加え、レシピの作成を選択します。

1. CLI 入力 JSON ファイルの作成

   create-container-recipe コマンドのすべての入力をインラインコマンドパラメータで指定できます。ただし、生成されるコマンドはかなり長くなる可能性があります。コマンドを効率化するために、代わりにすべてのコンテナレシピ設定を含む JSON ファイルを提供できる

   注記

   JSON ファイル内のデータ値の命名規則は、Image Builder API オペレーションリクエストパラメータに指定されたパターンに従います。API オペレーションリクエストパラメータを確認するには、EC2 Image Builder API リファレンスの CreateContainerRecipe コマンドを参照してください。

   データ値をコマンドラインパラメータとして指定するには、AWS CLI コマンドリファレンスで指定されているパラメータ名を参照してください。

   以下に、この例のパラメータの概要を示します。

   • components (オブジェクトの配列、オプション) – ComponentConfiguration オブジェクトの配列が含まれます。コンテナレシピのコンポーネントはオプションです。出力イメージは BUILD コンポーネント、Dockerfile テンプレートの手順 ( RUN または COPYステートメントなど）、またはその両方を使用してカスタマイズできます。TEST コンポーネントはイメージを検証しますが、変更しません。

     注記

     Image Builder は、レシピで指定した順序でコンポーネントをインストールします。しかし、CIS のハードニング・コンポーネントは、ベンチマーク・テストが出力イメージに対して実行されるように、常に最後に実行します。

     • コンポーネント ARN (文字列、必須) — コンポーネント ARN。

       ヒント

       例の 1 つを使用して独自のコンテナレシピを作成するには、サンプル ARN をレシピに使用しているコンポーネントの ARN に置き換える必要があります。これらには AWS リージョン、それぞれの、名前、バージョン番号が含まれます。

     • パラメータ (オブジェクトの配列) — ComponentParameter オブジェクトの配列が含まれます。入力パラメータが必須で、コンポーネントにデフォルト値が定義されていない場合は、値を指定する必要があります。必須パラメータのいずれかが不足していてデフォルト値も定義されていない場合、Image Builder はレシピバージョンを作成しません。

       重要

       コンポーネントパラメータはプレーンテキストの値で、 AWS CloudTrailに記録されます。シークレットを保存するには、 AWS Secrets Manager または AWS Systems Manager Parameter Store を使用することをお勧めします。Secrets Manager の詳細については、AWS Secrets Manager ユーザーガイドの Secrets Manager とはを参照してください。 AWS Systems Manager パラメータストアについては、AWS Systems Manager ユーザーガイドのAWS Systems Manager パラメータストアを参照。

       • 名前 (文字列、必須) — 設定するコンポーネントパラメータの名前。

       • 値 (文字列の配列、必須) — 指定されたコンポーネントパラメータの値を設定する文字列の配列を含みます。コンポーネントにデフォルト値が定義されていて、他の値が指定されていない場合、 はデフォルト値 AWSTOE を使用します。

   • containerType (文字列、必須) — 作成するコンテナのタイプ。有効な値には DOCKER が含まれます。

   • dockerfileTemplateData (文字列) – イメージを構築するためのインライン Dockerfile テンプレート。インラインデータは 16,000 文字に制限されています。dockerfileTemplateData または dockerfileTemplateUri のパラメータを指定する必要があります。両方を指定することはできません。

     Dockerfile テンプレートには、コンテキスト変数 (Image Builder が実行時にビルド情報に置き換えるプレースホルダー) を含めることができます。少なくとも parentImage変数を含めます。レシピにコンポーネントが含まれている場合は、 environments変数と components変数も含めます。

     parentImage (必須)

     この変数は、ビルド時にレシピのベースイメージに解決されます。

     例:

     FROM
     {{{ imagebuilder:parentImage }}}

     environments (components が指定されている場合は必須)

     ビルド時に、この変数はビルドコンテキストでコンポーネントをステージングする Dockerfile ディレクティブに解決されます。これらのディレクティブは、コンポーネントスクリプトをイメージにコピーし、それらのスクリプトが使用する環境変数を設定します。環境を準備しますが、指定したコンポーネントは実行しません。この変数を components 変数の前に配置します。

     例:

     {{{ imagebuilder:environments }}}

     components (オプション)

     ビルド時に、この変数は、コンテナレシピに含まれるコンポーネントのビルドコンポーネントスクリプトとテストコンポーネントスクリプトを実行する コマンドに解決され、イメージからそれらのスクリプトを削除します。これは、コンポーネントを実行する変数です。environments 変数の後に配置します。

     例:

     {{{ imagebuilder:components }}}

     代わりに Amazon S3 にテンプレートを保存するには、有効な Amazon S3 URI を持つ dockerfileTemplateUri パラメータを使用します (例: s3://my-bucket/templates/Dockerfile)。

   • 名前 (文字列、必須) — コンテナレシピの名前。

   • 説明 (文字列) — コンテナレシピの説明。

   • parentImage (文字列、必須) – カスタマイズされたイメージのベースラインとしてDockerコンテナレシピで使用するコンテナイメージ。

     • でホストされているパブリックイメージ DockerHub

     • Amazon ECR の既存のコンテナイメージ

     • Amazon が管理するコンテナイメージ

   • platformOverride (文字列) –カスタムベースイメージを使用する場合のオペレーティングシステムプラットフォームを指定します。Docker Hub または Amazon ECR イメージを使用する場合は、この値を設定することをお勧めします。これを省略すると、Image Builder はコンテナマニフェストからプラットフォームを検出しようとしますが、常に利用できるとは限りません。親イメージが Image Builder イメージ ARN platformOverrideの場合、 を指定することはできません。有効な値は、Linux および Windows です。コンテナレシピは macOS プラットフォームをサポートしていません。

   • semanticVersion 文字列、必須） - コンテナレシピのセマンティックバージョンを以下のフォーマットで指定します：<major>.<minor>.<patch>。文字列の例は 1.0.0 などです。Image Builder リソースのセマンティックバージョニングの詳細については、Image Builder でのセマンティックバージョニングを参照してください。

   • タグ (文字列マップ)コンテナレシピにアタッチされているタグ。

   • instanceConfiguration (オブジェクト) —コンテナイメージの構築とテストを目的としてインスタンスを設定するために使用できるオプションのグループ。

     • image (文字列) – コンテナビルドおよびテストインスタンスのベースイメージ。これには AMI ID を含めることも、 AWS Systems Manager (SSM) Parameter Store パラメータを指定することもできます。プレフィックスは で、パラメータ名または ARN がssm:続きます。SSM パラメータを使用する場合は、パラメータ値に AMI ID が含まれている必要があります。ベースイメージを指定しない場合、Image Builder は適切な Amazon ECS 最適化 AMI をベースイメージとして使用します。

     • BlockDeviceMappings (オブジェクトの配列) — imageパラメータで指定した Image Builder AMI からインスタンスを構築するためにアタッチするブロックデバイスを定義します。

       • DeviceName (文字列) — これらのマッピングが適用されるデバイス。

       • ebs (オブジェクト) – このマッピングの Amazon EBS 固有の構成を管理するために使用します。

         • deleteOnTermination (Boolean) –関連付けられたデバイスの終了時に削除を設定するために使用します。

         • 暗号化済み (ブール値) — デバイス暗号化の設定に使用されます。

         • volumeSize (整数) — デバイスのボリュームサイズを上書きするために使用します。

         • volumeType (文字列) — デバイスのボリュームサイズを上書きするために使用します。

   • targetRepository (オブジェクト、必須) — パイプラインが稼働するリージョン (リージョン 1) のパイプラインのディストリビューション設定で他にリポジトリが指定されていない場合のコンテナイメージのデスティネーションリポジトリ。

     • repositoryName (文字列、必須) - 出力コンテナイメージを保存するコンテナリポジトリの名前。この名前の先頭には、リポジトリの場所が付きます。

     • service (文字列、必須) – 出力イメージを保存するリポジトリサービスを指定します。有効値は ECR です。ターゲットリポジトリは既に存在している必要があります。

   • workingDirectory (文字列) - ビルドとテストのワークフローで使用する作業ディレクトリ。

   次の例は、ビルドコンポーネントを含む Linux コンテナを定義する完全なDockerコンテナレシピ入力ファイルを示しています。として保存しcreate-container-recipe.json、 create-container-recipe コマンドで使用します。

   {
   	"components": [ 
   	  { 
   		 "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/helloworldal2/x.x.x"
   	  }
   	],
   	"containerType": "DOCKER",
   	"description": "My Linux Docker container image",
   	"dockerfileTemplateData": "FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}",
   	"name": "amazonlinux-container-recipe",
   	"parentImage": "amazonlinux:latest",
   	"platformOverride": "Linux",
   	"semanticVersion": "1.0.2",
   	"tags": { 
   	  "sometag" : "Tag detail" 
   	},
   	"instanceConfiguration": {
   	  "image": "ami-1234567890abcdef1",
   	  "blockDeviceMappings": [
   		 {
   			"deviceName": "/dev/xvda",
   			"ebs": {
   				"deleteOnTermination": true,
   				"encrypted": false,
   				"volumeSize": 8,
   				"volumeType": "gp2"
   			 }
   		  }			
   	  ]
   	},
   	"targetRepository": { 
   	  "repositoryName": "myrepo",
   	  "service": "ECR"
   	},
   	"workingDirectory": "/tmp"
   }

2. レシピを作成する

   レシピを作成するには以下のコマンドを使用します。前のステップで作成した JSON ファイルの名前を --cli-input-json パラメータに入力します。

   aws imagebuilder create-container-recipe --cli-input-json file://create-container-recipe.json

   注記

   • JSON ファイルパスの先頭に file:// 表記を含める必要があります。

   • JSON ファイルのパスは、コマンドを実行するベースオペレーティングシステムに適した規則に従う必要があります。例えば、Windows ではディレクトリパスを表すためにバックスプラッシュ (\) が使用され、Linux と macOS ではフォーワードスラッシュ (/) が使用されます。

   次の出力例は、新しく作成されたコンテナレシピの ARN と、リクエストのリクエスト ID とクライアントトークンを示しています。

   {
   	"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
   	"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
   	"containerRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:container-recipe/my-container-recipe/1.0.2"
   }