Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

开始使用 EC2 TOE

EC2 Task Orchestrator and Executor (EC2 TOE) 应用程序是一个独立的应用程序，用于在组件定义框架内创建、验证和运行命令。 Amazon 服务可用于 EC2 TOE 协调工作流程、安装软件、修改系统配置和测试映像构建。

请按照以下步骤安装该 EC2 TOE 应用程序并首次使用它。

步骤 1：安装 EC2 TOE

要在本地开发组件，请下载并安装该 EC2 TOE 应用程序。

步骤 2：设置 Amazon 凭证

EC2 TOE 运行任务时需要 Amazon 凭证才能连接到其他任务 Amazon Web Services，例如 Amazon S3 和 Amazon CloudWatch，例如：

如果您在 EC2 实例 EC2 TOE 上运行，则运行 EC2 TOE 使用的权限与附加到 EC2 实例的 IAM 角色相同。

有关适用于 EC2 的 IAM 角色的更多信息，请参阅适用于 Amazon EC2 的 IAM 角色。

以下示例说明如何使用AWS_ACCESS_KEY_ID和AWS_SECRET_ACCESS_KEY环境变量设置 Amazon 凭证。

要在 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。

C:\> $env:AWS_ACCESS_KEY_ID=your_access_key_id

C:\> $env:AWS_SECRET_ACCESS_KEY=your_secret_access_key

要在 Windows 上使用命令提示设置这些变量，请使用 set。

C:\> set AWS_ACCESS_KEY_ID=your_access_key_id

C:\> set AWS_SECRET_ACCESS_KEY=your_secret_access_key

第 3 步：在本地开发组件文档

EC2 TOE 组件是用纯文本 YAML 文档创作的。有关文档语法的更多信息，请参阅 在中使用组件文档 EC2 TOE。

以下是 Hello World 组件文档示例，您可以使用这些文档在本地开发文档。

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.'

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.'

步骤 4：验证 EC2 TOE 组件

您可以使用 EC2 TOE 应用程序在本地验证 EC2 TOE 组件的语法。以下示例显示了无需运行组件即可验证其语法的 EC2 TOE 应用程序validate命令。

Windows

C:\> awstoe.exe validate --documents C:\Users\user\Documents\hello-world.yml

Linux

$ awstoe validate --documents /home/user/hello-world.yml

步骤 5：运行 EC2 TOE 组件

EC2 TOE 应用程序可以使用--phases命令行参数运行指定文档的一个或多个阶段。--phases 支持的值有 build、validate 和 test。可以用逗号分隔的值形式输入多个阶段值。

当您提供阶段列表时， EC2 TOE 应用程序会按顺序运行每个文档的指定阶段。例如， EC2 TOE 运行的build和validate阶段document1.yaml，然后运行的build和validate阶段document2.yaml。

为了确保您的日志安全存储并保留以供故障排除，我们建议您在 Amazon S3 中配置日志存储。在 Image Builder 中，用于发布日志的 Amazon S3 位置是在基础设施配置中指定的。有关基础设施配置的更多信息，请参阅 管理 EC2 Image Builder 基础设施配置

如果未提供阶段列表，则 EC2 TOE 应用程序将按照 YAML 文档中列出的顺序运行所有阶段。

要在单个或多个文档中运行特定阶段，请使用以下命令。

单个阶段

awstoe run --documents hello-world.yml --phases build

多个阶段

awstoe run --documents hello-world.yml --phases build,test

文档运行

在单个文档中运行所有阶段

awstoe run --documents documentName.yaml

在多个文档中运行所有阶段

awstoe run --documents documentName1.yaml,documentName2.yaml

输入 Amazon S3 信息以从用户定义的本地路径上传 EC2 TOE 日志（推荐）

awstoe run --documents documentName.yaml --log-s3-bucket-name <S3Bucket> --log-s3-key-prefix <S3KeyPrefix> --log-s3-bucket-owner <S3BucketOwner> --log-directory <local_path>

在单个文档中运行所有阶段，并在控制台上显示所有日志

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 <comma separated list of phases>

获取以下方面的帮助 EC2 TOE

awstoe --help