Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Creación de un documento de flujos de trabajo YAML

El documento de definición del formato YAML configura los pasos de entrada, salida y flujo de trabajo para las etapas de creación, prueba y distribución del proceso de creación de imágenes. El mismo formato de documento se aplica a los tres tipos de flujo de trabajo. Puede empezar con plantillas que incluyan pasos estandarizados, o bien puede empezar desde cero para definir su propio flujo de trabajo. Tanto si utiliza una plantilla como si empieza desde cero, puede personalizar el flujo de trabajo para adaptarlo a sus necesidades.

Estructura de un documento de flujos de trabajo YAML

En las siguientes secciones se describe la estructura del documento de flujo de trabajo de YAML que Image Builder utiliza para realizar acciones de creación, prueba y distribución de imágenes.

Identificación de documentos de flujo de trabajo

Identifica de forma única el flujo de trabajo. En esta sección se pueden incluir los siguientes atributos.

Ejemplo

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

Parámetros de entrada de documentos de flujo

En esta parte del documento de flujos de trabajo se definen los parámetros de entrada que la persona que llama puede especificar. Si no tiene ningún parámetro, puede omitir esta sección. Si especifica parámetros, cada parámetro puede incluir los siguientes atributos.

Puede definir hasta 25 parámetros en un documento de flujo de trabajo. Cada valor de parámetro puede contener hasta 1024 caracteres. Un parámetro debe usar uno de los cuatro tipos de datos compatibles: string, integer, boolean, o stringList. Si no especifica un default el valor de un parámetro, debe proporcionar el valor del parámetro en tiempo de ejecución.

Ejemplo

Especifique el parámetro en el documento de flujos de trabajo.

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

Utilice el valor del parámetro en el documento de flujos de trabajo.

$.parameters.waitForActionAtEnd

Flujo de documentos

Especifica hasta 15 acciones de paso para el flujo de trabajo. Los pasos se ejecutan en el orden en que se definen en el documento de flujos de trabajo. En caso de error, se ejecuta una restauración en orden inverso, empezando por el paso en el que se produjo el error y siguiendo por los pasos anteriores.

Cada paso puede hacer referencia a la salida de cualquier acción de paso anterior. Esto se conoce como encadenamiento o referencia. Para hacer referencia a la salida de la acción de un paso anterior, puede utilizar un selector JSONPath. Por ejemplo:

$.stepOutputs.step-name.output-name

Para obtener más información, consulte Uso de variables dinámicas en el documento de flujos de trabajo.

Cada paso puede incluir los siguientes atributos.

Ejemplo

En el siguiente ejemplo, se usa el waitForActionAtEnd parámetro, que el documento de flujo de trabajo debe declarar en su parameters sección.

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"

Reintentar los pasos del flujo de trabajo fallidos

De forma predeterminada, cada paso de un flujo de trabajo se ejecuta una vez. Para que Image Builder vuelva a ejecutar automáticamente un paso cuando se produzca un error, añada retry atributo al paso. El retry el atributo contiene los siguientes campos.

Los reintentos funcionan de la siguiente manera:

Algunas acciones escalonadas tienen un comportamiento de reintento adicional:

Para ver cuántas veces se ejecutó un paso, utilice el GetWorkflowStepExecution o ListWorkflowStepExecutions Operaciones de API. La respuesta incluye attemptNumber y maxAttempts campos para el paso.

Ejemplo

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

Resultados de documentos de flujo de trabajo

Define las salidas del flujo de trabajo. Cada salida es un par clave-valor que especifica el nombre de la salida y el valor. Puede utilizar las salidas para exportar datos en tiempo de ejecución que puedan utilizar los flujos de trabajo posteriores. Esta sección es opcional.

Puede definir hasta 25 salidas en un documento de flujo de trabajo. Cada nombre de salida debe ser único en todos los flujos de trabajo que incluyas en tu canalización. Un flujo de trabajo posterior puede hacer referencia a una salida por su nombre con $.workflowOutputs.name.

Cada salida que defina incluye los siguientes atributos.

Ejemplo

Cree un ID de imagen de salida para el documento de flujos de trabajo con la salida del paso createProdImage.

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

Consulte la salida del flujo de trabajo en el siguiente flujo de trabajo.

$.workflowOutputs.outputImageId