翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Image Builder が AWS Task Orchestrator and Executor アプリケーションを使用してコンポーネントを管理する方法
EC2 Image Builder は AWS Task Orchestrator and Executor （AWSTOE) アプリケーションを使用して、複雑なワークフローの調整、システム設定の変更、イメージのテストを行います。追加の devops スクリプトやコードは必要ありません。このアプリケーションは、宣言型ドキュメントスキーマを実装するコンポーネントを管理および実行します。
AWSTOE は、イメージの作成時に Image Builder がビルドインスタンスとテストインスタンスにインストールするスタンドアロンアプリケーションです。EC2 インスタンスに手動でインストールして、独自のカスタムコンポーネントを作成することもできます。追加のセットアップは必要なく、オンプレミスでも実行できます。
内容
AWSTOE ダウンロード
インストールするには AWSTOE、アーキテクチャとプラットフォームのダウンロードリンクを選択します。サービスのVPCエンドポイント (Image Builder など) にアタッチする場合、 AWSTOE ダウンロード用の S3 バケットへのアクセスを含むカスタムエンドポイントポリシーがアタッチされている必要があります。そうしないと、ビルドインスタンスとテストインスタンスはブートストラップスクリプト (bootstrap.sh) をダウンロードして AWSTOE アプリケーションをインストールできなくなります。詳細については、「Image Builder のVPCエンドポイントポリシーを作成する」を参照してください。
重要
AWS はTLS、バージョン 1.0 および 1.1 のサポートを段階的に廃止しています。 AWSTOE ダウンロードのために S3 バケットにアクセスするには、クライアントソフトウェアでTLSバージョン 1.2 以降を使用する必要があります。詳細については、AWS セキュリティのブログ記事
| アーキテクチャ | プラットフォーム | ダウンロードリンク | 例 |
|---|---|---|---|
| 386 |
AL 2 と 2023 年 RHEL 7、8、および 9 Ubuntu 16.04、18.04、20.04、22.04、24.04 CentOS 7 および 8 SUSE 12 および 15 |
|
https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/386/awstoe |
| AMD64 |
AL 2 と 2023 年 RHEL 7、8、および 9 Ubuntu 16.04、18.04、20.04、22.04、24.04 CentOS 7 および 8 CentOS Stream 8 SUSE 12 および 15 |
https://awstoe- |
https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/amd64/awstoe |
| AMD64 |
macOS 10.14.x (Mojave)、10.15.x (Catalina)、11.x (Big Sur)、12.x (Monterey) |
https://awstoe- |
https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/darwin/amd64/awstoe |
|
AMD64 |
Windows Server 2012 R2、2016、2019、2022 年 |
|
https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/windows/amd64/awstoe.exe |
| ARM64 |
AL 2 と 2023 年 RHEL 7、8、および 9 Ubuntu 16.04、18.04、20.04、22.04、24.04 CentOS 7 および 8 CentOS Stream 8 SUSE 12 および 15 |
https://awstoe- |
https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/arm64/awstoe |
サポート対象の リージョン
AWSTOE は、以下のリージョンでスタンドアロンアプリケーションとしてサポートされています。
| AWS リージョン 名前 | AWS リージョン |
|---|---|
|
米国東部（オハイオ） |
us-east-2 |
|
米国東部 (バージニア北部) |
us-east-1 |
|
AWS GovCloud （米国東部） |
us-gov-east-1 |
|
AWS GovCloud （米国西部） |
us-gov-west-1 |
|
米国西部（北カリフォルニア） |
us-west-1 |
|
米国西部 (オレゴン) |
us-west-2 |
|
アフリカ (ケープタウン) |
af-south-1 |
|
アジアパシフィック (香港) |
ap-east-1 |
|
アジアパシフィック (大阪) |
ap-northeast-3 |
|
アジアパシフィック (ソウル) |
ap-northeast-2 |
|
アジアパシフィック (ムンバイ) |
ap-south-1 |
|
アジアパシフィック (ハイデラバード) |
ap-south-2 |
|
アジアパシフィック (シンガポール) |
ap-southeast-1 |
|
アジアパシフィック (シドニー) |
ap-southeast-2 |
|
アジアパシフィック (ジャカルタ) |
ap-southeast-3 |
|
アジアパシフィック (東京) |
ap-northeast-1 |
|
カナダ (中部) |
ca-central-1 |
|
欧州 (フランクフルト) |
eu-central-1 |
|
欧州 (チューリッヒ) |
eu-central-2 |
|
欧州 (ストックホルム) |
eu-north-1 |
|
欧州 (ミラノ) |
eu-south-1 |
|
欧州 (スペイン) |
eu-south-2 |
|
欧州 (アイルランド) |
eu-west-1 |
|
欧州 (ロンドン) |
eu-west-2 |
|
欧州 (パリ) |
eu-west-3 |
|
イスラエル (テルアビブ) |
il-central-1 |
|
中東 (UAE） |
me-central-1 |
|
中東 (バーレーン) |
me-south-1 |
|
南米 (サンパウロ） |
sa-east-1 |
|
中国 (北京) |
cn-north-1 |
|
中国 (寧夏) |
cn-northwest-1 |
AWSTOE コマンドリファレンス
AWSTOE は、Amazon EC2インスタンスで実行されるコマンドラインコンポーネント管理アプリケーションです。Image Builder がEC2ビルドインスタンスまたはテストインスタンスを起動すると、インスタンス AWSTOE に がインストールされます。次に、 で AWSTOE コマンドを実行して AWS CLI 、イメージまたはコンテナレシピで指定されたコンポーネントをインストールまたは検証します。
注記
一部の AWSTOE アクションモジュールでは、Linux サーバーで を実行するための昇格されたアクセス許可が必要です。昇格された権限を使用するには、コマンド構文の前に sudo を付けるか、ログイン時に sudo su コマンドを 1 回実行してから、以下にリンクされているコマンドを実行します。 AWSTOE アクションモジュールの詳細については、「」を参照してくださいAWSTOE コンポーネントマネージャーがサポートするアクションモジュール。
awstoe run コマンド
このコマンドは、 YAML --configパラメータで指定された設定ファイル、または --documentsパラメータで指定されたコンポーネントドキュメントのリストに含まれる順序でコンポーネントドキュメントスクリプトを実行します。
注記
次のパラメータのうち、1 つのみを正確に指定する必要があります。両方は指定しないでください。
--config
--documents
構文
awstoe run [--config <file path>] [--cw-ignore-failures <?>] [--cw-log-group <?>] [--cw-log-regionus-west-2] [--cw-log-stream <?>] [--document-s3-bucket-owner <owner>] [--documents <file path,file path,...>] [--execution-id <?>] [--log-directory <file path>] [--log-s3-bucket-name <name>] [--log-s3-bucket-owner <owner>] [--log-s3-key-prefix <?>] [--parametersname1=value1,name2=value2...] [--phases <phase name>] [--state-directory <directory path>] [--version <?>] [--help] [--trace]
パラメータとオプション
パラメータ
- --config
./config-example.json -
ショートフォーム:-c
./config-example.json設定ファイル (条件付き)。このパラメータには、このコマンドが実行されているコンポーネントの構成設定を含む JSONファイルのファイルの場所が含まれます。設定ファイルで run コマンド設定を指定する場合、
--documentsパラメータは指定しないでください。入力設定の詳細については、AWSTOE run コマンドの入力を設定するを参照のこと。有効な場所は以下のとおり:
-
ローカルファイルパス (
./config-example.json -
S3 URI (
s3://）bucket/key
-
- --cw-ignore-failures
-
ショートフォーム:N/A
CloudWatch ログからのログ記録の失敗を無視します。
- --cw-log-group
-
ショートフォーム:N/A
CloudWatch ログ
LogGroupの名前。 - --cw-log-region
-
ショートフォーム:N/A
CloudWatch ログに適用される AWS リージョン。
- --cw-log-stream
-
ショートフォーム:N/A
console.logファイルのストリーミング AWSTOE 先を指定する CloudWatch ログLogStreamの名前。 - --document-s3-bucket-owner
-
ショートフォーム:N/A
S3 URIベースのドキュメントのバケット所有者のアカウント ID。
- -- ドキュメント
./doc-1.yaml,./doc-n.yaml -
ショートフォーム:-d
./doc-1.yaml./doc-nコンポーネント文書 (条件付き)。このパラメータには、実行するYAMLコンポーネントドキュメントのファイルの場所のカンマ区切りリストが含まれます。
--documentsパラメータを使用してrunコマンドのYAMLドキュメントを指定する場合は、--configパラメータを指定しないでください。有効な場所は以下のとおり:
-
ローカルファイルパス (
./component-doc-example.yaml）。 -
S3 URIs (
s3://）。bucket/key -
Image Builder コンポーネントのビルドバージョン ARNs (arn:aws:imagebuilder:us-west-
2:123456789012:component/my-example-component/2021.12.02/1)。
注記
リスト内の項目間にはスペースがなく、カンマのみが入ります。
-
- --execution-id
-
短縮形： -i
これは現在の run コマンドの実行に適用される固有の ID です。この ID は出力ファイル名とログファイル名に含まれ、これらのファイルを一意に識別し、現在のコマンド実行にリンクします。この設定を省略すると、 は AWSTOE を生成しますGUID。
- --log-directory
-
短縮形： -l
がこのコマンド実行のすべてのログファイル AWSTOE を保存する送信先ディレクトリ。デフォルトでは、このディレクトリは親ディレクトリ
TOE_<DATETIME>_<EXECUTIONID>の中にあります。ログディレクトリを指定しない場合、 は現在の作業ディレクトリ () AWSTOE を使用します.。 - --log-s3-bucket-name
-
短縮形： -b
コンポーネントログが Amazon S3 に保存されている場合 (推奨）、 はコンポーネントアプリケーションログをこのパラメータで指定された S3 バケット AWSTOE にアップロードします。
- --log-s3-bucket-owner
-
ショートフォーム:N/A
コンポーネントログが Amazon S3 に保存されている場合 (推奨）、これは がログファイルを AWSTOE 書き込むバケットの所有者アカウント ID です。
- --log-s3-key-prefix
-
短縮形： -k
コンポーネントログが Amazon S3 に保存されている場合（推奨）、これはバケット内のログの場所を示す S3 オブジェクトキーのプレフィックスです。
- --parameters
name1=value1，name2=value2... -
ショートフォーム:N/A
パラメータは、コンポーネントドキュメントで定義される変更可能な変数であり、呼び出し元のアプリケーションが実行時に提供できる設定を持つ。
- --phases
-
ショートフォーム:-p
YAML コンポーネントドキュメントから実行するフェーズを指定するカンマ区切りリスト。コンポーネントドキュメントに追加のフェーズが含まれている場合、そのフェーズは実行されません。
- --state-directory
-
短縮形： -s
状態追跡ファイルが保存されているファイルパス。
- --version
-
短縮形： -v
コンポーネントアプリケーションのバージョンを指定します。
オプション
- --help
-
短縮形： -h
コンポーネント管理アプリケーションオプションを使用するためのヘルプマニュアルを表示します。
- --trace
-
短縮形： -t
コンソールへの冗長ロギングを有効にする。
awstoe 検証コマンド
このコマンドを実行すると、 --documentsパラメータで指定された各コンポーネントYAMLドキュメントのドキュメント構文が検証されます。
構文
awstoe validate [--document-s3-bucket-owner <owner>] --documents <file path,file path,...> [--help] [--trace]
パラメータとオプション
パラメータ
- --document-s3-bucket-owner
-
ショートフォーム:N/A
提供された S3 URIベースのドキュメントのソースアカウント ID。
- -- ドキュメント
./doc-1.yaml,./doc-n.yaml -
ショートフォーム:-d
./doc-1.yaml./doc-nコンポーネントのドキュメント (必須)。このパラメータには、実行するYAMLコンポーネントドキュメントのファイルの場所のカンマ区切りリストが含まれます。有効な場所は以下のとおり:
-
ローカルファイルパス (
./component-doc-example.yaml） -
S3 URIs (
s3://）bucket/key -
Image Builder コンポーネントビルドバージョン ARNs (arn:aws:imagebuilder:us-west-
2:123456789012:component/my-example-component/2021.12.02/1)
注記
リスト内の項目間にはスペースがなく、カンマのみが入ります。
-
オプション
- --help
-
短縮形： -h
コンポーネント管理アプリケーションオプションを使用するためのヘルプマニュアルを表示します。
- --trace
-
短縮形： -t
コンソールへの冗長ロギングを有効にする。
