Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Creare un documento di workflow YAML

Il documento di definizione del formato YAML configura le fasi di input, output e flusso di lavoro per le fasi di creazione, test e distribuzione del processo di creazione dell'immagine. Lo stesso formato di documento si applica a tutti e tre i tipi di flusso di lavoro. Puoi iniziare da modelli che includono passaggi standardizzati oppure puoi iniziare da zero per definire il tuo flusso di lavoro. Sia che utilizzi un modello o inizi da zero, puoi personalizzare il flusso di lavoro in base alle tue esigenze.

Struttura di un documento di workflow YAML

Le sezioni seguenti descrivono la struttura del documento del flusso di lavoro YAML utilizzato da Image Builder per eseguire azioni di creazione, test e distribuzione delle immagini.

Identificazione del documento di workflow

Identifica in modo univoco il flusso di lavoro. Questa sezione può includere i seguenti attributi.

Esempio

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

Parametri di input del documento del workflow

Questa parte del documento del flusso di lavoro definisce i parametri di input che il chiamante può specificare. Se non si dispone di alcun parametro, è possibile omettere questa sezione. Se specificate dei parametri, ogni parametro può includere i seguenti attributi.

È possibile definire fino a 25 parametri in un documento di workflow. Ogni valore di parametro può contenere fino a 1.024 caratteri. Un parametro deve utilizzare uno dei quattro tipi di dati supportati:string, integerboolean, ostringList. Se non si specifica un default valore per un parametro, è necessario fornire il valore del parametro in fase di esecuzione.

Esempio

Specificate il parametro nel documento del flusso di lavoro.

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

Utilizzate il valore del parametro nel documento del flusso di lavoro.

$.parameters.waitForActionAtEnd

Fasi del documento del workflow

Speciifica fino a 15 azioni in fasi per il flusso di lavoro. Le fasi vengono eseguite nell'ordine in cui sono definite nel documento del flusso di lavoro. In caso di errore, il rollback viene eseguito in ordine inverso, iniziando dal passaggio non riuscito e procedendo a ritroso rispetto ai passaggi precedenti.

Ogni passaggio può fare riferimento all'output di qualsiasi azione del passaggio precedente. Questa operazione è nota come concatenamento o riferimento. Per fare riferimento all'output di un'azione precedente, puoi utilizzare un selettore JsonPath. Ad esempio:

$.stepOutputs.step-name.output-name

Per ulteriori informazioni, consulta Utilizzate le variabili dinamiche nel documento del flusso di lavoro.

Ogni passaggio può includere i seguenti attributi.

Esempio

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"

Riprova i passaggi del flusso di lavoro non riusciti

Per impostazione predefinita, ogni passaggio di un flusso di lavoro viene eseguito una sola volta. Per fare in modo che Image Builder esegua nuovamente automaticamente un passaggio in caso di errore, aggiungete l'retryattributo al passaggio. L'retryattributo contiene i seguenti campi.

I nuovi tentativi funzionano come segue:

Alcune azioni della fase hanno un comportamento aggiuntivo per quanto riguarda i tentativi di ripetizione:

Per vedere quante volte è stato eseguito un passaggio, utilizza le operazioni GetWorkflowStepExecution o ListWorkflowStepExecutions API. La risposta include i maxAttempts campi attemptNumber e per il passaggio.

Esempio

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

Output dei documenti del flusso di lavoro

Definisce gli output per il flusso di lavoro. Ogni output è una coppia di valori chiave che specifica il nome dell'output e il valore. È possibile utilizzare gli output per esportare dati in fase di esecuzione che i flussi di lavoro successivi possono utilizzare. Questa sezione è facoltativa.

È possibile definire fino a 25 output in un documento di workflow. Ogni nome di output deve essere univoco in tutti i flussi di lavoro inclusi nella pipeline. Un flusso di lavoro successivo può quindi fare riferimento a un output per nome con. $.workflowOutputs.name

Ogni output definito include i seguenti attributi.

Esempio

Create un ID dell'immagine di output per il documento del flusso di lavoro con l'output del createProdImage passaggio.

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

Fate riferimento all'output del flusso di lavoro nel flusso di lavoro successivo.

$.workflowOutputs.outputImageId