

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

# Image Builder が AWS Task Orchestrator and Executor アプリケーションを使用してコンポーネントを管理する方法
<a name="toe-component-manager"></a>

EC2 Image Builder は AWS Task Orchestrator and Executor （AWSTOE) アプリケーションを使用して、追加の devops スクリプトやコードを使用せずに、複雑なワークフローの調整、システム設定の変更、イメージのテストを行います。このアプリケーションは、宣言型ドキュメントスキーマを実装するコンポーネントを管理および実行します。

AWSTOE は、イメージの作成時に Image Builder がビルドインスタンスとテストインスタンスにインストールするスタンドアロンアプリケーションです。これを手動で EC2 インスタンスにインストールして、独自のカスタムコンポーネントを作成することもできます。追加のセットアップは必要なく、オンプレミスでも実行できます。

**Topics**
+ [AWSTOE ダウンロード](#toe-downloads)
+ [サポート対象の リージョン](#toe-supported-regions)
+ [AWSTOE コマンドリファレンス](#toe-commands)
+ [を使用してカスタムコンポーネントを開発するための手動セットアップ AWSTOE](toe-get-started.md)
+ [カスタム AWSTOE コンポーネントのコンポーネントドキュメントフレームワークを使用する](toe-use-documents.md)
+ [AWSTOE コンポーネントマネージャーでサポートされるアクションモジュール](toe-action-modules.md)
+ [AWSTOE run コマンドの入力を設定する](toe-run-config-input.md)

## AWSTOE ダウンロード
<a name="toe-downloads"></a>

インストールするには AWSTOE、アーキテクチャとプラットフォームのダウンロードリンクを選択します。サービスの VPC エンドポイント (Image Builder など) にアタッチする場合、 AWSTOE ダウンロード用の S3 バケットへのアクセスを含むカスタムエンドポイントポリシーがアタッチされている必要があります。そうしないと、ビルドインスタンスとテストインスタンスはブートストラップスクリプト (`bootstrap.sh`) をダウンロードして AWSTOE アプリケーションをインストールできなくなります。詳細については、「[Image Builder 用 VPC エンドポイントポリシーの作成](vpc-interface-endpoints.md#vpc-endpoint-policy)」を参照してください。

**重要**  
AWS は TLS バージョン 1.0 および 1.1 のサポートを段階的に廃止しています。 AWSTOE ダウンロード用に S3 バケットにアクセスするには、クライアントソフトウェアで TLS バージョン 1.2 以降を使用する必要があります。詳細については、[AWS セキュリティのブログ記事](https://aws.amazon.com/blogs/security/tls-1-2-required-for-aws-endpoints/)を参照してください。


| アーキテクチャ | プラットフォーム | ダウンロードリンク | 例 | 
| --- | --- | --- | --- | 
| 386 | AL 2 と 2023 年<br />RHEL 7、8、および 9<br />Ubuntu 16.04、18.04、20.04、22.04、24.04<br />CentOS 7 および 8<br />スーズ 12 と 15 | `https://awstoe-<region>.s3.<region>.amazonaws.com/latest/linux/386/awstoe` | [https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/386/awstoe](https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/386/awstoe) | 
| AMD64 | AL 2 と 2023 年<br />RHEL 7、8、および 9<br />Ubuntu 16.04、18.04、20.04、22.04、24.04<br />CentOS 7 および 8<br />CentOS Stream 8<br />スーズ 12 と 15 | https://awstoe-<region>.s3.<region>.amazonaws.com/latest/linux/amd64/awstoe | [https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/amd64/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-{{region}}.s3.{{region}}.amazonaws.com/latest/darwin/amd64/awstoe | [https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/darwin/amd64/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-<region>.s3.<region>.amazonaws.com/latest/windows/amd64/awstoe.exe` | [https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/windows/amd64/awstoe.exe](https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/windows/amd64/awstoe.exe) | 
| ARM64 | AL 2 と 2023 年<br />RHEL 7、8、および 9<br />Ubuntu 16.04、18.04、20.04、22.04、24.04<br />CentOS 7 および 8<br />CentOS Stream 8<br />スーズ 12 と 15 | https://awstoe-<region>.s3.<region>.amazonaws.com/latest/linux/arm64/awstoe | [https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/arm64/awstoe](https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/arm64/awstoe) | 

## サポート対象の リージョン
<a name="toe-supported-regions"></a>

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 | 
| 中東 (アラブ首長国連邦) | me-central-1 | 
| 中東 (バーレーン) | me-south-1 | 
| 南米 (サンパウロ） | sa-east-1 | 
| 中国 (北京) | cn-north-1 | 
| 中国 (寧夏) | cn-northwest-1 | 

## AWSTOE コマンドリファレンス
<a name="toe-commands"></a>

AWSTOE は、Amazon EC2 インスタンスで実行されるコマンドラインコンポーネント管理アプリケーションです。Image Builder が EC2 ビルドインスタンスまたはテストインスタンスを起動すると、インスタンス AWSTOE に がインストールされます。次に、 で AWSTOE コマンドを実行して AWS CLI 、イメージまたはコンテナレシピで指定されたコンポーネントをインストールまたは検証します。

**注記**  
一部の AWSTOE アクションモジュールでは、Linux サーバーで実行するための昇格されたアクセス許可が必要です。昇格された権限を使用するには、コマンド構文の前に **sudo** を付けるか、ログイン時に **sudo su** コマンドを 1 回実行してから、以下にリンクされているコマンドを実行します。 AWSTOE アクションモジュールの詳細については、「」を参照してください[AWSTOE コンポーネントマネージャーでサポートされるアクションモジュール](toe-action-modules.md)。

***[run](#cmd-run)***  
**run** コマンドを使用して、1 つ以上のコンポーネントドキュメントの YAML ドキュメントスクリプトを実行します。

***[validate](#cmd-validate)***  
1 つ以上のコンポーネントドキュメントの YAML ドキュメント構文を検証するために、**validate**コマンドを実行する。

### awstoe run コマンド
<a name="cmd-run"></a>

このコマンドは、YAML コンポーネントドキュメントスクリプトを、`--config` パラメータで指定された設定ファイル、または `--documents` パラメータで指定されたコンポーネントドキュメントのリストに含まれている順序で実行します。

**注記**  
次のパラメータのうち、1 つのみを正確に指定する必要があります。両方は指定しないでください。  
--config  
--documents

#### 構文
<a name="run-syntax"></a>

```
awstoe run [--config <file path>] [--cw-ignore-failures <?>] 
      [--cw-log-group <?>] [--cw-log-region {{us-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 <?>] [--parameters {{name1}}={{value1}},{{name2}}={{value2}}...] 
      [--phases <phase name>] [--state-directory <directory path>] [--version <?>] 
      [--help] [--trace]
```

#### パラメータとオプション
<a name="run-parameters"></a>パラメータ

**--config {{`./config-example.json`}}**  
ショートフォーム:-c {{`./config-example.json`}}  
設定ファイル (条件付き)。このパラメータには、このコマンドが実行しているコンポーネントの構成設定を含む JSON ファイルの場所が含まれます。設定ファイルで **run** コマンド設定を指定する場合、`--documents` パラメータは指定しないでください。入力設定の詳細については、[AWSTOE run コマンドの入力を設定する](toe-run-config-input.md)を参照のこと。  
有効な場所は以下のとおり:  
+ ローカルファイルパス ({{`./config-example.json`}})
+ S3 URI (`s3://{{bucket/key}}`)

**--cw-ignore-failures**  
ショートフォーム:N/A  
CloudWatch Logs からのロギングエラーは無視してください。

**--cw-log-group**  
ショートフォーム:N/A  
CloudWatch Logs の `LogGroup` の名前。

**--cw-log-region**  
ショートフォーム:N/A  
CloudWatch Logs に適用される AWS リージョン。

**--cw-log-stream**  
ショートフォーム:N/A  
`console.log` ファイルのストリーミング AWSTOE 先を指定する CloudWatch Logs `LogStream`の名前。

**--document-s3-bucket-owner**  
ショートフォーム:N/A  
S3 URI ベースのドキュメントのバケット所有者のアカウントID。

**--documents {{`./doc-1.yaml`,`./doc-n.yaml`}}**  
ショートフォーム:-d {{`./doc-1.yaml`}},{{`./doc-n`}}  
コンポーネント文書 (条件付き)。このパラメータには、実行する YAML コンポーネントドキュメントのファイルロケーションのカンマ区切りリストが含まれます。`--documents` パラメータを使用して**run**コマンドに YAML ドキュメントを指定する場合、`--config` パラメータを指定してはなりません。  
有効な場所は以下のとおり:  
+ ローカルファイルパス ({{/component-doc-example.yaml}})。
+ S3 URI (`s3://{{bucket/key}}`)。
+ {{Image Builder コンポーネントビルドバージョン ARN (arn:aws:imagebuilder:us-west-{{2:123456789012}}:component/my-example-component}}/2021.12.02/1).
リスト内の項目間にはスペースがなく、カンマのみが入ります。

**--execution-id**  
短縮形： -i  
これは現在の **run** コマンドの実行に適用される固有の ID です。この ID は出力ファイル名とログファイル名に含まれ、これらのファイルを一意に識別し、現在のコマンド実行にリンクします。この設定を省略すると、 は GUID AWSTOE を生成します。

**--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 検証コマンド
<a name="cmd-validate"></a>

このコマンドを実行すると、`--documents` パラメータで指定された各コンポーネントドキュメントの YAML ドキュメント構文が検証されます。

#### 構文
<a name="validate-syntax"></a>

```
awstoe validate [--document-s3-bucket-owner <owner>] 
      --documents <file path,file path,...> [--help] [--trace]
```

#### パラメータとオプション
<a name="validate-parameters"></a>パラメータ

**--document-s3-bucket-owner**  
ショートフォーム:N/A  
S3 URI ベースのドキュメントのソースアカウント ID が提供されました。

**--documents {{`./doc-1.yaml`,`./doc-n.yaml`}}**  
ショートフォーム:-d {{`./doc-1.yaml`}},{{`./doc-n`}}  
コンポーネントのドキュメント (必須)。このパラメータには、実行する YAML コンポーネントドキュメントのファイルロケーションのカンマ区切りリストが含まれます。有効な場所は以下のとおり:  
+ ローカルファイルパス ({{./component-doc-example.yaml}})
+ S3 URI (`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  
コンソールへの冗長ロギングを有効にする。