Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création d'un document de flux de travail YAML

Le document de définition du format YAML configure les étapes d'entrée, de sortie et de flux de travail pour les étapes de création, de test et de distribution du processus de création d'images. Le même format de document s'applique aux trois types de flux de travail. Vous pouvez partir de modèles qui incluent des étapes standardisées, ou vous pouvez repartir de zéro pour définir votre propre flux de travail. Que vous utilisiez un modèle ou que vous partiez de zéro, vous pouvez personnaliser le flux de travail en fonction de vos besoins.

Structure d'un document de flux de travail YAML

Les sections suivantes décrivent la structure du document de flux de travail YAML qu'Image Builder utilise pour effectuer des actions de création, de test et de distribution d'images.

Identification des documents relatifs au flux

Identifie le flux de travail de manière unique. Cette section peut inclure les attributs suivants.

Exemple

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

Paramètres de saisie des documents du flux de travail

Cette partie du document de flux de travail définit les paramètres d'entrée que l'appelant peut spécifier. Si vous ne disposez d'aucun paramètre, vous pouvez omettre cette section. Si vous spécifiez des paramètres, chaque paramètre peut inclure les attributs suivants.

Vous pouvez définir jusqu'à 25 paramètres dans un document de flux de travail. Chaque valeur de paramètre peut contenir jusqu'à 1 024 caractères. Un paramètre doit utiliser l'un des quatre types de données pris en charge : string, integer, boolean, ou stringList. Si vous ne spécifiez pas default valeur pour un paramètre, vous devez fournir la valeur du paramètre lors de l'exécution.

Exemple

Spécifiez le paramètre dans le document de flux de travail.

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

Utilisez la valeur du paramètre dans le document de flux de travail.

$.parameters.waitForActionAtEnd

Étapes du document de travail

Spécifie jusqu'à 15 actions par étapes pour le flux de travail. Les étapes sont exécutées dans l'ordre dans lequel elles sont définies dans le document de flux de travail. En cas d'échec, une restauration s'exécute dans l'ordre inverse, en commençant par l'étape qui a échoué et en revenant aux étapes précédentes.

Chaque étape peut faire référence au résultat de toutes les actions de l'étape précédente. C'est ce que l'on appelle chaînage ou référencement. Pour faire référence à la sortie d'une action d'étape précédente, vous pouvez utiliser un sélecteur JSONPath. Par exemple :

$.stepOutputs.step-name.output-name

Pour plus d’informations, consultez Utilisez des variables dynamiques dans votre document de flux de travail.

Chaque étape peut inclure les attributs suivants.

Exemple

L'exemple suivant utilise waitForActionAtEnd paramètre, que le document de flux de travail doit déclarer dans son parameters section.

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"

Réessayer les étapes du flux de travail qui ont échoué

Par défaut, chaque étape d'un flux de travail s'exécute une fois. Pour qu'Image Builder exécute à nouveau automatiquement une étape en cas d'échec, ajoutez le retry attribut de l'étape. Le retry L'attribut contient les champs suivants.

Les nouvelles tentatives fonctionnent comme suit :

Certaines actions par étapes comportent un comportement de nouvelle tentative supplémentaire :

Pour voir combien de fois une étape a été exécutée, utilisez GetWorkflowStepExecution ou ListWorkflowStepExecutions Opérations d'API. La réponse inclut le attemptNumber et maxAttempts champs pour l'étape.

Exemple

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

Sorties de documents liés au flux

Définit les sorties pour le flux de travail. Chaque sortie est une paire clé-valeur qui spécifie le nom de la sortie et la valeur. Vous pouvez utiliser les sorties pour exporter des données au moment de l'exécution que les flux de travail suivants pourront utiliser. Cette section est facultative.

Vous pouvez définir jusqu'à 25 sorties dans un document de flux de travail. Chaque nom de sortie doit être unique pour tous les flux de travail que vous incluez dans votre pipeline. Un flux de travail ultérieur peut ensuite référencer une sortie par son nom avec $.workflowOutputs.name.

Chaque sortie que vous définissez inclut les attributs suivants.

Exemple

Créez un ID d'image de sortie pour le document de flux de travail à l'aide de la sortie des étapes createProdImage étape.

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

Reportez-vous à la sortie du flux de travail dans le flux de travail suivant.

$.workflowOutputs.outputImageId