Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Erstellen Sie ein YAML-Workflow-Dokument

Das Dokument zur Definition des YAML-Formats konfiguriert Eingabe-, Ausgabe- und Workflow-Schritte für die Erstellungs-, Test- und Verteilungsphasen des Image-Erstellungsprozesses. Für alle drei Workflowtypen gilt dasselbe Dokumentformat. Sie können mit Vorlagen beginnen, die standardisierte Schritte enthalten, oder Sie können ganz von vorne beginnen, um Ihren eigenen Workflow zu definieren. Unabhängig davon, ob Sie eine Vorlage verwenden oder ganz von vorne beginnen, können Sie den Workflow an Ihre Bedürfnisse anpassen.

Struktur eines YAML-Workflow-Dokuments

In den folgenden Abschnitten wird die Struktur des YAML-Workflow-Dokuments beschrieben, das Image Builder zum Erstellen, Testen und Verteilen von Images verwendet.

Identifizierung von Workflow-Dokumenten

Identifiziert den Workflow eindeutig. Dieser Abschnitt kann die folgenden Attribute enthalten.

Beispiel

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

Eingabeparameter für Workflow-Dokumente

Dieser Teil des Workflow-Dokuments definiert Eingabeparameter, die der Aufrufer angeben kann. Wenn Sie keine Parameter haben, können Sie diesen Abschnitt weglassen. Wenn Sie Parameter angeben, kann jeder Parameter die folgenden Attribute enthalten.

Sie können in einem Workflow-Dokument bis zu 25 Parameter definieren. Jeder Parameterwert kann bis zu 1.024 Zeichen enthalten. Ein Parameter muss einen von vier unterstützten Datentypen verwenden:string, integerboolean, oderstringList. Wenn Sie keinen default Wert für einen Parameter angeben, müssen Sie den Parameterwert zur Laufzeit angeben.

Beispiel

Geben Sie den Parameter im Workflow-Dokument an.

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

Verwenden Sie den Parameterwert im Workflow-Dokument.

$.parameters.waitForActionAtEnd

Schritte des Workflow-Dokuments

Gibt bis zu 15 Schrittaktionen für den Workflow an. Die Schritte werden in der Reihenfolge ausgeführt, in der sie im Workflow-Dokument definiert sind. Im Falle eines Fehlers wird ein Rollback in umgekehrter Reihenfolge ausgeführt, wobei mit dem fehlgeschlagenen Schritt begonnen und die vorherigen Schritte rückwärts durchgearbeitet werden.

Jeder Schritt kann sich auf die Ausgabe aller Aktionen eines vorherigen Schritts beziehen. Dies wird als Verkettung oder Referenzierung bezeichnet. Um auf die Ausgabe einer Aktion aus einem vorherigen Schritt zu verweisen, können Sie einen JSONPath-Selektor verwenden. Beispiel:

$.stepOutputs.step-name.output-name

Weitere Informationen finden Sie unter Verwenden Sie dynamische Variablen in Ihrem Workflow-Dokument.

Jeder Schritt kann die folgenden Attribute enthalten.

Beispiel

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"

Fehlgeschlagene Workflow-Schritte wiederholen

Standardmäßig wird jeder Schritt in einem Workflow einmal ausgeführt. Damit Image Builder einen Schritt automatisch erneut ausführt, wenn er fehlschlägt, fügen Sie dem Schritt das retry Attribut hinzu. Das retry Attribut enthält die folgenden Felder.

Wiederholungen funktionieren wie folgt:

Bei einigen Schrittaktionen gibt es ein zusätzliches Wiederholungsverhalten:

Verwenden Sie die ListWorkflowStepExecutions API-Operationen GetWorkflowStepExecution oder, um zu sehen, wie oft ein Schritt ausgeführt wurde. Die Antwort enthält die maxAttempts Felder attemptNumber und für den Schritt.

Beispiel

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

Ausgaben von Workflow-Dokumenten

Definiert Ausgaben für den Workflow. Jede Ausgabe ist ein Schlüssel-Wert-Paar, das den Namen der Ausgabe und den Wert angibt. Sie können Ausgaben verwenden, um zur Laufzeit Daten zu exportieren, die nachfolgende Workflows verwenden können. Dieser Abschnitt ist optional.

Sie können bis zu 25 Ausgaben in einem Workflow-Dokument definieren. Jeder Ausgabename muss in allen Workflows, die Sie in Ihre Pipeline aufnehmen, eindeutig sein. In einem späteren Workflow kann dann mit dem Namen auf eine Ausgabe verwiesen $.workflowOutputs.name werden.

Jede Ausgabe, die Sie definieren, umfasst die folgenden Attribute.

Beispiel

Erstellen Sie eine Ausgabebild-ID für das Workflow-Dokument mit der Schrittausgabe aus dem createProdImage Schritt.

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

Sehen Sie sich die Workflow-Ausgabe im nächsten Workflow an.

$.workflowOutputs.outputImageId