翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # を使用してカスタムコンポーネントを開発するための手動セットアップ AWSTOE AWS Task Orchestrator and Executor （AWSTOE) アプリケーションは、コンポーネント定義フレームワーク内でコマンドを作成、検証、実行するスタンドアロンアプリケーションです。 AWS のサービスでは、 AWSTOE を使用してワークフローのオーケストレーション、ソフトウェアのインストール、システム設定の変更、イメージビルドのテストを行うことができます。 AWSTOE アプリケーションを手動でインストールし、カスタムコンポーネントを開発するためのスタンドアロンアプリケーションとして使用するには、次の手順に従います。Image Builder コンソールまたは AWS CLI コマンドを使用してカスタムコンポーネントを作成する場合、Image Builder はこれらのステップを自動的に処理します。詳細については、「[Image Builder を使用したカスタムコンポーネントの作成](create-component.md)」を参照してください。 # AWSTOE インストールダウンロードの署名を確認する このセクションでは、Linux、macOS、Windows ベースのオペレーティングシステム AWSTOE での のインストールダウンロードの有効性を検証するための推奨プロセスについて説明します。 **Topics** + [Linux または macOS で AWSTOE のインストールダウンロードの署名を検証する](#awstoe-verify-sig-linux) + [Windows で AWSTOE のインストールダウンロードの署名を確認する](#awstoe-verify-sig-win) ## Linux または macOS で AWSTOE のインストールダウンロードの署名を検証する このトピックでは、Linux ベースまたは macOS オペレーティングシステム AWSTOE での のインストールダウンロードの有効性を検証するための推奨プロセスについて説明します。 インターネットからアプリケーションをダウンロードする際は、必ずソフトウェアパブリッシャーの身元を認証することをお勧めします。また、アプリケーションが公開されてから変更または破損していないことを確認してください。これにより、ウイルスやマルウェアに感染したバージョンのアプリケーションをインストールせずに済みます。 このトピックのステップを実行した後に AWSTOE アプリケーションのソフトウェアが変更されているか破損していることが判明した場合は、インストールファイルを実行しないでください。代わりに、 サポート にお問い合わせください。サポートオプションの詳細については、「」を参照してください[サポート](https://aws.amazon.com/premiumsupport/)。 AWSTOE Linux ベースおよび macOS オペレーティングシステム用の ファイルは`GnuPG`、安全なデジタル署名のための Pretty Good Privacy (OpenPGP) 標準のオープンソース実装である を使用して署名されます。 `GnuPG` ( とも呼ばれます`GPG`) は、デジタル署名による認証と整合性チェックを提供します。Amazon EC2 は、ダウンロードした Amazon EC2 CLI ツールの検証に使用できるパブリックキーと署名を公開します。`PGP` と `GnuPG` (`GPG`) の詳細については、[http://www.gnupg.org](https://www.gnupg.org/) を参照してください。 まず、ソフトウェア発行元との信頼を確立します。ソフトウェア発行元のパブリックキーをダウンロードし、キー所有者が一致していることを確認してから、*キーリング*に追加します。キーリングとは、既知のパブリックキーの集合です。真正性が確立されたパブリック キーは、アプリケーションの署名を確認するために使用できます。 **Topics** + [GPG ツールのインストール](#awstoe-verify-signature-of-binary-download-install-tools) + [パブリック キーの認証とインポート](#awstoe-verify-signature-of-binary-download-authenticate-import-public-key) + [パッケージの署名の確認](#awstoe-verify-signature-of-binary-package) ### GPG ツールのインストール 使用しているオペレーティングシステムが Linux、Unix、または macOS の場合、GPG ツールが既にインストールされている可能性があります。システムにツールがインストール済みかどうかをテストするには、コマンドラインプロンプトで **gpg** を入力します。GPG ツールがインストールされている場合、GPG のコマンドプロンプトが表示されます。GPG ツールがインストールされていない場合、コマンドが見つからないというエラーが表示されます。GnuPG パッケージはリポジトリからインストールできます。 GPG ツールをインストールするには、インスタンスに一致するオペレーティングシステムを選択します。 ------ #### [ Debian-based Linux ] ターミナルから、次のコマンドを実行します。 ``` apt-get install gnupg ``` ------ #### [ Red Hat–based Linux ] ターミナルから、次のコマンドを実行します。 ``` yum install gnupg ``` ------ #### [ macOS ] ターミナルから、次のコマンドを実行します。 ``` brew install gnupg ``` ------ ### パブリック キーの認証とインポート プロセスの次のステップでは、 AWSTOE パブリックキーを認証し、`GPG`キーリングに信頼されたキーとして追加します。 **AWSTOE パブリックキーを認証してインポートするには** 1. 次のいずれかを実行してパブリック `GPG` ビルドキーのコピーを取得します。 + 次の場所からキーをダウンロードします。 https://awstoe-****.s3.****.amazonaws.com/assets/awstoe.gpg。例えば、[https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/assets/awstoe.gpg](https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/assets/awstoe.gpg)。 + 次のテキストからキーをコピーし、[`awstoe.gpg`] という名前のファイルに貼り付けます。必ず次のすべてが含まれるようにしてください。 ``` -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v2 mQENBF8UqwsBCACdiRF2bkZYaFSDPFC+LIkWLwFvtUCRwAHtD8KIwTJ6LVn3fHAU GhuK0ZH9mRrqRT2bq/xJjGsnF9VqTj2AJqndGJdDjz75YCZYM+ocZ+r5HSJaeW9i S5dykHj7Txti2zHe0G5+W0v7v5bPi2sPHsN7XWQ7+G2AMEPTz8PjxY//I0DvMQns Sle3l9hz6wCClz1l9LbBzTyHfSm5ucTXvNe88XX5Gmt37OCDM7vfli0Ctv8WFoLN 6jbxuA/sV71yIkPm9IYp3+GvaKeT870+sn8/JOOKE/U4sJV1ppbqmuUzDfhrZUaw 8eW8IN9A1FTIuWiZED/5L83UZuQs1S7s2PjlABEBAAG0GkFXU1RPRSA8YXdzdG9l QGFtYXpvbi5jb20+iQE5BBMBCAAjBQJfFKsLAhsDBwsJCAcDAgEGFQgCCQoLBBYC AwECHgECF4AACgkQ3r3BVvWuvFJGiwf9EVmrBR77+Qe/DUeXZJYoaFr7If/fVDZl 6V3TC6p0J0Veme7uXleRUTFOjzbh+7e5sDX19HrnPquzCnzfMiqbp4lSoeUuNdOf FcpuTCQH+M+sIEIgPno4PLl0Uj2uE1o++mxmonBl/Krk+hly8hB2L/9n/vW3L7BN OMb1Ll9PmgGPbWipcT8KRdz4SUex9TXGYzjlWb3jU3uXetdaQY1M3kVKE1siRsRN YYDtpcjmwbhjpu4xm19aFqNoAHCDctEsXJA/mkU3erwIRocPyjAZE2dnlkL9ZkFZ z9DQkcIarbCnybDM5lemBbdhXJ6hezJE/b17VA0t1fY04MoEkn6oJg== =oyze -----END PGP PUBLIC KEY BLOCK----- ``` 1. **awstoe.gpg** を保存したディレクトリのコマンドプロンプトで、次のコマンドを使用して AWSTOE パブリックキーをキーリングにインポートします。 ``` gpg --import awstoe.gpg ``` コマンドで次のような結果が返されます。 ``` gpg: key F5AEBC52: public key "AWSTOE " imported gpg: Total number processed: 1 gpg: imported: 1 (RSA: 1) ``` 次のステップで必要になるため、キーの値を書きとめておきます。前述の例では、キーの値は `F5AEBC52` です。 1. 次のコマンドを使用してフィンガープリントを確認し、*キー値*を前述の手順の値と置き換えます。 ``` gpg --fingerprint key-value ``` このコマンドで次のような結果が返されます。 ``` pub 2048R/F5AEBC52 2020-07-19 Key fingerprint = F6DD E01C 869F D639 15E5 5742 DEBD C156 F5AE BC52 uid [ unknown] AWSTOE ``` さらに、前述の例のように、フィンガープリント文字列は「`F6DD E01C 869F D639 15E5 5742 DEBD C156 F5AE BC52`」になります。返されたキー フィンガープリントをこのページで公開されているものと比較します。これらは一致するはずです。一致しない場合は、 AWSTOE インストールスクリプトをインストールせず、 にお問い合わせください サポート。 ### パッケージの署名の確認 `GPG` ツールをインストール後、 AWSTOE パブリックキーを認証してインポートし、そのパブリック キーが信頼済みであることを確認すると、インストールスクリプトの署名を確認できるようになります。 **インストールスクリプトの署名を確認するには** 1. コマンドプロンプトで次のコマンドを実行し、アプリケーションバイナリをダウンロードします。 ``` curl -O https://awstoe-.s3..amazonaws.com/latest/linux//awstoe ``` 例えば、次のようになります。 ``` curl -O https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/amd64/awstoe ``` **architecture**でサポートされる値は `amd64`、`386`、および `arm64` です。 1. コマンドプロンプトで次のコマンドを実行し、同じ S3 キー接頭辞パスから対応するアプリケーションバイナリの署名ファイルをダウンロードします。 ``` curl -O https://awstoe-.s3..amazonaws.com/latest/linux//awstoe.sig ``` 例えば、次のようになります。 ``` curl -O https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/amd64/awstoe.sig ``` **architecture**でサポートされる値は `amd64`、`386`、および `arm64` です。 1. 保存したディレクトリのコマンドプロンプト`awstoe.sig`と AWSTOE インストールファイルで次のコマンドを実行して、署名を検証します。ファイルが2つとも存在している必要があります。 ``` gpg --verify ./awstoe.sig ~/awstoe ``` 出力は次のようになります。 ``` gpg: Signature made Mon 20 Jul 2020 08:54:55 AM IST using RSA key ID F5AEBC52 gpg: Good signature from "AWSTOE awstoe@amazon.com" [unknown] gpg: WARNING: This key is not certified with a trusted signature! gpg: There is no indication that the signature belongs to the owner. Primary key fingerprint: F6DD E01C 869F D639 15E5 5742 DEBD C156 F5AE BC52 ``` 出力に「`Good signature from "AWSTOE "`」という句が含まれる場合は、署名が正常に確認されており、 AWSTOE のインストールスクリプトを実行できることを意味しています。 出力結果に「`BAD signature`」という句が含まれる場合、手順が正しいことをもう一度確認してください。この応答が続く場合は、 サポートに連絡してください。以前にダウンロードしたインストール ファイルを実行しないでください。 以下は、表示される可能性のある警告の詳細です。 + 警告: このキーは、信頼済みの署名で認定されていません\$1 署名が所有者に属していることが確認できません。 AWS オフィスを訪問し、直接キーを受け取るのが理想的です。しかし、キーは多くの場合ウェブサイトからダウンロードされます。この場合、ウェブサイトは AWS ウェブサイトです。 + **gpg: 最終的に信用されたキーが見つかりません。**これは、特定のキーがユーザー (またはユーザーが信頼する他のユーザー) によって「最終的に信頼された」キーでないことを意味します。 詳細については、「[http://www.gnupg.org](http://www.gnupg.org)」を参照してください。 ## Windows で AWSTOE のインストールダウンロードの署名を確認する このトピックでは、Windows ベースのオペレーティングシステム上の AWS Task Orchestrator and Executor アプリケーションのインストールファイルの有効性を検証するための推奨プロセスについて説明します。 インターネットからアプリケーションをダウンロードする場合は、常にソフトウェア発行元のアイデンティティを認証し、アプリケーションの発行後に改ざん、あるいは破損がないか確認することをお勧めします。これにより、ウイルスやマルウェアに感染したバージョンのアプリケーションをインストールせずに済みます。 このトピックのステップを実行した後に AWSTOE アプリケーションのソフトウェアが変更されているか破損していることが判明した場合は、インストールファイルを実行しないでください。代わりに、 にお問い合わせください サポート。 Windows ベースのオペレーティングシステムでダウンロードした awstoe バイナリの有効性を確認するには、Amazon Services LLC の署名者証明書のサムプリントがこの値と等しいことを確認してください： **9D CA 72 17 DA FF B8 2F E4 C4 67 77 36 2F A4 AA C9 08 82 15** **注記** 新しいバイナリのロールアウトウィンドウ中に、署名者証明書が新しいサムプリントと一致しない場合があります。署名者証明書が一致しない場合は、サムプリントが次の値であることを確認してください。 **BA 81 25 EE AC 64 2E A9 F3 C5 93 CA 6D 3E B7 93 7D 68 75 74** この値を検証するには、以下の手順を実行します。 1. ダウンロードした `awstoe.exe` を右クリックして、**プロパティ**ウィンドウを開きます。 1. **デジタル署名**タブを選択します。 1. [**Signature List**] で [**Amazon Services LLC**] を選択し、[**Details**] をクリックします。 1. すでに選択していない場合は **一般**タブにアクセスし、**証明書の表示** を選びます。 1. **詳細** タブを選択し、まだの場合は **すべて**を**表示** のドロップダウンリストで選択します。 1. **拇印** フィールドが表示されるまでスクロールして、**拇印** を選択します。下のウィンドウにサムプリントの値全体が表示されます。 + 下のウィンドウのサムプリントの値が次の値と等しい場合、 **9D CA 72 17 DA FF B8 2F E4 C4 67 77 36 2F A4 AA C9 08 82 15** ダウンロードした AWSTOE バイナリは本物であり、安全にインストールできます。 + 下部の詳細ウィンドウのサムプリントの値が上記の値と等しくない場合には、`awstoe.exe` を実行しないでください。 **Topics** + [AWSTOE インストールダウンロードの署名を確認する](awstoe-verify-sig.md) + [ステップ 1: をインストールする AWSTOE](#toe-start-install) + [ステップ 2: AWS 認証情報を設定する](#toe-start-credentials) + [ステップ 3: コンポーネントドキュメントをローカルで開発する](#toe-start-develop) + [ステップ 4: AWSTOE コンポーネントを検証する](#toe-start-validate) + [ステップ 5: AWSTOE コンポーネントを実行する](#toe-start-run) ## ステップ 1: をインストールする AWSTOE コンポーネントをローカルで開発するには、 AWSTOE アプリケーションをダウンロードしてインストールします。 1. **AWSTOE アプリケーションをダウンロードする** インストールするには AWSTOE、アーキテクチャとプラットフォームに適したダウンロードリンクを選択します。アプリケーションのダウンロードリンクの詳細なリストについては、「[AWSTOE ダウンロード](toe-component-manager.md#toe-downloads)」を参照してください。 **重要** 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/)を参照してください。 1. **署名を検証する** ダウンロードを検証する手順は、インストール後に AWSTOE アプリケーションを実行するサーバープラットフォームによって異なります。Linux サーバーでダウンロードを確認する方法については、「[Linux または macOS での署名の検証](awstoe-verify-sig.md#awstoe-verify-sig-linux)」を参照してください。Windows サーバーでダウンロードを確認する方法については、「[Windows で署名を検証する](awstoe-verify-sig.md#awstoe-verify-sig-win)」を参照してください。 **注記** AWSTOE は、ダウンロード場所から直接呼び出されます。別途インストールを行う必要はありません。つまり、 はローカル環境を変更 AWSTOE することもできます。 コンポーネント開発中に変更を確実に分離するには、EC2 インスタンスを使用して AWSTOE コンポーネントを開発およびテストすることをお勧めします。 ## ステップ 2: AWS 認証情報を設定する AWSTOE では AWS のサービス、次のようなタスクを実行するときに、Amazon S3 や Amazon CloudWatch などの他の に接続するための AWS 認証情報が必要です。 + ユーザー提供の Amazon S3 パスから AWSTOE ドキュメントをダウンロードします。 + `S3Download` または `S3Upload` アクションモジュールを実行する。 + CloudWatch にログをストリーミングします (有効になっている場合)。 EC2 インスタンス AWSTOE で実行している場合、 の実行は EC2 インスタンスにアタッチされた IAM ロールと同じアクセス許可 AWSTOE を使用します。 EC2 の IAM ロールの詳細については、「[Amazon EC2 向けの IAM ロール](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html)」を参照してください。 次の例は、 `AWS_ACCESS_KEY_ID`および `AWS_SECRET_ACCESS_KEY`環境変数を使用して AWS 認証情報を設定する方法を示しています。 これらの変数を Linux、macOS、または Unix で設定するには、`export` を使用します。 ``` export AWS_ACCESS_KEY_ID=your_access_key_id ``` ``` export AWS_SECRET_ACCESS_KEY=your_secret_access_key ``` Windows で PowerShell を使ってこれらの変数を設定するには、`$env`を使う。 ``` $env:AWS_ACCESS_KEY_ID=your_access_key_id ``` ``` $env:AWS_SECRET_ACCESS_KEY=your_secret_access_key ``` Windows でコマンドプロンプトを使ってこれらの変数を設定するには、`set`を使う。 ``` set AWS_ACCESS_KEY_ID=your_access_key_id ``` ``` set AWS_SECRET_ACCESS_KEY=your_secret_access_key ``` ## ステップ 3: コンポーネントドキュメントをローカルで開発する コンポーネントは、プレーンテキストの YAML ドキュメントを使用して作成されます。ドキュメントの構文については[カスタム AWSTOE コンポーネントのコンポーネントドキュメントフレームワークを使用する](toe-use-documents.md)を参照。 以下は、開発の開始点として役立つ *Hello World* コンポーネントドキュメントの例です。 ------ #### [ Linux ] このガイドの Linux 用のコンポーネント例の一部は、`hello-world-linux.yml` という名前のコンポーネントドキュメントファイルを参照しています。これらの例を試すには、次のドキュメントを使用できます。 ``` name: Hello World description: This is hello world testing document for Linux. schemaVersion: 1.0 phases: - name: build steps: - name: HelloWorldStep action: ExecuteBash inputs: commands: - echo 'Hello World from the build phase.' - name: validate steps: - name: HelloWorldStep action: ExecuteBash inputs: commands: - echo 'Hello World from the validate phase.' - name: test steps: - name: HelloWorldStep action: ExecuteBash inputs: commands: - echo 'Hello World from the test phase.' ``` ------ #### [ Windows ] このガイドの Windows 用のコンポーネント例の一部は、`hello-world-windows.yml` という名前のコンポーネントドキュメントファイルを参照しています。これらの例を試すには、次のドキュメントを使用できます。 ``` name: Hello World description: This is Hello World testing document for Windows. schemaVersion: 1.0 phases: - name: build steps: - name: HelloWorldStep action: ExecutePowerShell inputs: commands: - Write-Host 'Hello World from the build phase.' - name: validate steps: - name: HelloWorldStep action: ExecutePowerShell inputs: commands: - Write-Host 'Hello World from the validate phase.' - name: test steps: - name: HelloWorldStep action: ExecutePowerShell inputs: commands: - Write-Host 'Hello World from the test phase.' ``` ------ #### [ macOS ] このガイドの macOS 用のコンポーネント例の一部は、`hello-world-macos.yml` という名前のコンポーネントドキュメントファイルを参照しています。これらの例を試すには、次のドキュメントを使用できます。 ``` name: Hello World description: This is hello world testing document for macOS. schemaVersion: 1.0 phases: - name: build steps: - name: HelloWorldStep action: ExecuteBash inputs: commands: - echo 'Hello World from the build phase.' - name: validate steps: - name: HelloWorldStep action: ExecuteBash inputs: commands: - echo 'Hello World from the validate phase.' - name: test steps: - name: HelloWorldStep action: ExecuteBash inputs: commands: - echo 'Hello World from the test phase.' ``` ------ ## ステップ 4: AWSTOE コンポーネントを検証する アプリケーションの AWSTOE コンポーネント構文を AWSTOE ローカルで検証できます。次の例は、コンポーネントを実行せずに構文を検証するための AWSTOE アプリケーション`validate`コマンドを示しています。 **注記** AWSTOE アプリケーションは、現在のオペレーティングシステムのコンポーネント構文のみを検証できます。例えば、`awstoe.exe` を Windows で実行している場合、`ExecuteBash` アクションモジュールを使用する Linux ドキュメントの構文は検証できません。 Linux または macOS ``` awstoe validate --documents /home/user/hello-world.yml ``` Windows ``` awstoe.exe validate --documents C:\Users\user\Documents\hello-world.yml ``` ## ステップ 5: AWSTOE コンポーネントを実行する AWSTOE アプリケーションは、`--phases`コマンドライン引数を使用して、指定されたドキュメントの 1 つ以上のフェーズを実行できます。`--phases`でサポートされている値は`build`、`validate`、`test`です。複数のフェーズ値をカンマで区切って入力できます。 フェーズのリストを指定すると、 AWSTOE アプリケーションは各ドキュメントの指定されたフェーズを順番に実行します。たとえば、 は の `build`および `validate`フェーズ AWSTOE を実行し`document1.yaml`、その後に の `build`および `validate`フェーズを実行します`document2.yaml`。 ログを安全に保存し、トラブルシューティングのために保持するには、Amazon S3 にログストレージを設定することをお勧めします。Image Builder では、ログを発行するための Amazon S3 の場所はインフラストラクチャ設定で指定されます。インフラ構成の詳細については、[Image Builder インフラストラクチャ設定の管理](manage-infra-config.md)を参照。 フェーズのリストが指定されていない場合、 AWSTOE アプリケーションは YAML ドキュメントに記載されている順序ですべてのフェーズを実行します。 1 つまたは複数のドキュメントで特定のフェーズを実行するには、以下のコマンドを使用します。 単一フェーズ ``` awstoe run --documents hello-world.yml --phases build ``` 複数フェーズ ``` awstoe run --documents hello-world.yml --phases build,test ``` **ドキュメント実行** 1 つのドキュメントですべてのフェーズを実行 ``` awstoe run --documents documentName.yaml ``` 複数のドキュメントで全フェーズを実行 ``` awstoe run --documents documentName1.yaml,documentName2.yaml ``` Amazon S3 情報を入力して、ユーザー定義のローカルパスから AWSTOE ログをアップロードする (推奨） ``` awstoe run --documents documentName.yaml --log-s3-bucket-name amzn-s3-demo-destination-bucket --log-s3-key-prefix S3KeyPrefix --log-s3-bucket-owner S3BucketOwner --log-directory local_path ``` 1 つのドキュメントですべてのフェーズを実行し、すべてのログをコンソールに表示する ``` awstoe run --documents documentName.yaml --trace ``` コマンドの例 ``` awstoe run --documents s3://bucket/key/doc.yaml --phases build,validate ``` 一意の ID でドキュメントを実行 ``` awstoe run --documents documentName.yaml --execution-id user-provided-id --phases build,test ``` のヘルプを取得する AWSTOE ``` awstoe --help ```