Image Builder でカスタムYAMLコンポーネントのコンポーネントドキュメントを作成する - EC2 Image Builder

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

Image Builder でカスタムYAMLコンポーネントのコンポーネントドキュメントを作成する

コンポーネントを構築するには、 YAMLまたは JSON アプリケーションコンポーネントドキュメントを指定する必要があります。このドキュメントには、イメージをカスタマイズするために定義したフェーズとステップ中に実行されるコードが含まれています。

このセクションの例は、コンポーネント管理アプリケーションでUpdateOSアクションモジュールを呼び出すビルド AWSTOE コンポーネントを作成します。モジュールでは、オペレーティングシステムを更新します。UpdateOS アクションの使用方法の詳細については、UpdateOSを参照してください。アプリケーションコンポーネントドキュメントのフェーズ、ステップ、構文の詳細については、 AWSTOE 「」の「ドキュメントを使用する AWSTOE」を参照してください。

注記

Image Builder は、コンポーネントドキュメントで定義されているフェーズからコンポーネントタイプを次のように決定します。

  • ビルド — これはデフォルトのコンポーネントタイプです。テストコンポーネントとして分類されないものはすべてビルドコンポーネントです。このタイプのコンポーネントは、イメージビルドステージ 中に実行されます。このビルドコンポーネントにtestフェーズが定義されている場合、そのフェーズはテストステージ中に実行されます。

  • テスト — テストコンポーネントとして認定されるには、コンポーネントドキュメントにtestという名前のフェーズが 1 つだけ含まれている必要があります。ビルドコンポーネントの設定に関連するテストでは、スタンドアロンのテストコンポーネントを使用しないことをお勧めします。むしろ、関連するビルドコンポーネントのtestフェーズを使用してください。

Image Builder がステージとフェーズを使用してビルドプロセスのコンポーネントワークフローを管理する方法の詳細については、コンポーネントを使用して Image Builder イメージをカスタマイズするを参照してください。

サンプルYAMLアプリケーションのアプリケーションコンポーネントドキュメントを作成するには、イメージオペレーティングシステムに一致する タブのステップに従います。

Linux
YAML コンポーネントファイルを作成する

ファイル編集ツールを使用してコンポーネントドキュメントを作成します。ドキュメントの例では、 という名前のファイルを使用しupdate-linux-os.yaml、次の内容が含まれます。

# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: MIT-0 # # Permission is hereby granted, free of charge, to any person obtaining a copy of this # software and associated documentation files (the "Software"), to deal in the Software # without restriction, including without limitation the rights to use, copy, modify, # merge, publish, distribute, sublicense, and/or sell copies of the Software, and to # permit persons to whom the Software is furnished to do so. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, # INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A # PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. name: update-linux-os description: Updates Linux with the latest security updates. schemaVersion: 1 phases: - name: build steps: - name: UpdateOS action: UpdateOS # Document End
ヒント

このオンラインYAMLバリデーター などのツール、またはコード環境でYAMLのリント拡張を使用して、 YAMLが適切な形式であることを確認します。

Windows
YAML コンポーネントファイルを作成する

ファイル編集ツールを使用してコンポーネントドキュメントを作成します。ドキュメントの例では、 という名前のファイルを使用しupdate-windows-os.yaml、次の内容が含まれます。

# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: MIT-0 # # Permission is hereby granted, free of charge, to any person obtaining a copy of this # software and associated documentation files (the "Software"), to deal in the Software # without restriction, including without limitation the rights to use, copy, modify, # merge, publish, distribute, sublicense, and/or sell copies of the Software, and to # permit persons to whom the Software is furnished to do so. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, # INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A # PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. name: update-windows-os description: Updates Windows with the latest security updates. schemaVersion: 1.0 phases: - name: build steps: - name: UpdateOS action: UpdateOS # Document End
ヒント

このオンラインYAMLバリデーター などのツール、またはコード環境でYAMLのリント拡張を使用して、 YAMLが適切な形式であることを確認します。