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

创建 YAML 工作流文档

YAML 格式定义文档为图像创建过程的构建、测试和分发阶段配置输入、输出和工作流程步骤。相同的文档格式适用于所有三种工作流程类型。您可以从包含标准化步骤的模板开始，也可以从头开始定义自己的工作流。无论您使用模板还是从头开始，都可以自定义工作流以满足您的需求。

YAML 工作流文档的结构

以下各节介绍了 YAML 工作流程文档的结构，Image Builder 使用该文档执行映像构建、测试和分发操作。

工作流文档标识

对工作流进行唯一标识。此部分可以包含以下属性。

示例

---
name: sample-test-image
description: Workflow for a sample image, with extra configuration options exposed through workflow parameters.
schemaVersion: 1.0

工作流文档输入参数

工作流文档的这一部分定义了调用方可以指定的输入参数。如果您没有任何参数，则可以省略此部分。如果您确实指定了参数，则每个参数可以包含以下属性。

您最多可以在工作流程文档中定义 25 个参数。每个参数值最多可包含 1,024 个字符。参数必须使用四种支持的数据类型之一： string， integer， boolean，或 stringList。如果你没有指定 default 参数的值，必须在运行时提供参数值。

示例

在工作流文档中指定参数。

parameters:
  - name: waitForActionAtEnd
    type: boolean
    default: true
    description: "Wait for an external action at the end of the workflow"

在工作流文档中使用参数值。

$.parameters.waitForActionAtEnd

工作流文档步骤

为工作流指定最多 15 个步骤操作。步骤按照工作流文档中定义的顺序运行。如果失败，将按相反的顺序运行回滚，从失败的步骤开始，然后反向执行之前的步骤。

每个步骤都可以引用任何先前步骤操作的输出。这称为链接或引用。要引用先前步骤操作的输出，可以使用 JSONPath 选择器。例如：

$.stepOutputs.step-name.output-name

有关更多信息，请参阅 在工作流文档中使用动态变量。

每个步骤都可以包含以下属性。

示例

以下示例使用 waitForActionAtEnd 参数，工作流文档必须在其中声明该参数 parameters 部分。

steps:
  - name: LaunchTestInstance
    action: LaunchInstance
    onFailure: Abort
    inputs:
      waitFor: "ssmAgent"

  - name: ApplyTestComponents
    action: ExecuteComponents
    onFailure: Abort
    inputs:
      instanceId.$: "$.stepOutputs.LaunchTestInstance.instanceId"

  - name: TerminateTestInstance
    action: TerminateInstance
    onFailure: Continue
    inputs:
      instanceId.$: "$.stepOutputs.LaunchTestInstance.instanceId"

  - name: WaitForActionAtEnd
    action: WaitForAction
    if:
      booleanEquals: true
      value: "$.parameters.waitForActionAtEnd"

重试失败的工作流程步骤

默认情况下，工作流程中的每个步骤都运行一次。要让映像生成器在步骤失败时自动再次运行该步骤，请添加 retry 归因于该步骤。这个 retry 属性包含以下字段。

重试的工作原理如下：

一些步骤操作有额外的重试行为：

要查看一个步骤运行了多少次，请使用 GetWorkflowStepExecution 要么 ListWorkflowStepExecutions API 操作。该回应包括 attemptNumber 和 maxAttempts 该步骤的字段。

示例

steps:
  - name: LaunchBuildInstance
    action: LaunchInstance
    onFailure: Abort
    retry:
      maxAttempts: 3
      backoffSeconds: 60
    inputs:
      waitFor: "ssmAgent"

工作流文档输出

定义工作流的输出。每个输出都是一个键值对，用于指定输出名称和值。您可以使用输出在运行时导出后续工作流可以使用的数据。此部分是可选的。

您可以在工作流程文档中定义最多 25 个输出。在管道中包含的所有工作流程中，每个输出名称都必须是唯一的。然后，以后的工作流程可以按名称引用输出 $.workflowOutputs.name。

您定义的每个输出都包含以下属性。

示例

使用 createProdImage 步骤的步骤输出为工作流文档创建输出映像 ID。

outputs:
  - name: 'outputImageId'
    value: '$.stepOutputs.createProdImage.imageId'

请参阅下一个工作流中的工作流输出。

$.workflowOutputs.outputImageId