Eseguire un workflow

Avviare un workflow da un modulo, e seguirlo nella pagina dei job

  1. Il modulo
  2. Il job
  3. Approvazioni
  4. Interruzione

Il modulo

Un modulo di tipo workflow avvia un workflow, indicato con workflow: come si fa con un playbook: con il suo file nella cartella dei workflow, con le sottocartelle (team/deploy-app.yml), oppure con il nome del workflow dentro il file (deploy-app):

- name: Deploy the app
  type: workflow
  workflow: team/deploy-app.yml
  roles:
    - admin
  fields:
    - name: app_name
      type: text
      default: orders-api

I campi del modulo arrivano a ogni nodo come extra vars, e lo stesso vale per le sue credentials, con i nomi che il modulo dà loro, come quelle di un modulo multistep arrivano ai suoi passi:

- name: Provision NAS storage
  type: workflow
  workflow: nas.yml
  credentials:
    ontap: ontap_automation   # every node's playbook gets `ontap`

Le credenziali proprie di un nodo, impostate nel file di workflow, arrivano al suo playbook con il proprio nome e prevalgono su un nome usato da entrambi. Nella scheda Visuale di un modulo nel designer, Workflow è un elenco dei file di workflow del designer.

Un nome di file da solo viene trovato anche in una sottocartella, quando un solo file ha quel nome. Due workflow con lo stesso nome bloccano un modulo che lo indica per nome, e il designer avvisa quando salvi il secondo: rinominane uno, oppure indica il suo file. Un workflow che non si riesce a trovare termina il job come fallito, con il motivo nel suo output.

Il job

Un job di workflow gira sul server AnsibleForms, e ogni nodo playbook gira come job a sé, figlio del job di workflow come i passi di un modulo multistep: un playbook del designer sull’RTE, oppure, per un nodo con un runner:, il template o job di quel runner su AWX, AAP, Ascender, Semaphore, Rundeck o Jenkins (vedi Dove gira un nodo).

La pagina del job disegna il workflow, in diretta: ogni nodo colorato in base al suo stato, i collegamenti scattati, e i nodi che non verranno eseguiti. I dati in alto indicano il workflow al posto di un playbook.

  • Fai clic su un nodo terminato per aprirne l’output in una finestra di dialogo.
  • L’output contiene l’output di ogni nodo sotto un’intestazione WORKFLOW NODE [identifier] (status), nell’ordine in cui i nodi sono terminati.
  • Mostra variabili extra e Mostra artefatti, sull’intestazione di ogni nodo nell’output e nella finestra di dialogo aperta dal grafo, mostrano le extravars e gli artefatti propri di quel nodo ({} quando non ne ha), come JSON o YAML, con un pulsante Copia.

Le extravars di un nodo contengono ciò che i nodi precedenti gli hanno passato, e i suoi artefatti ciò che il suo playbook ha raccolto con set_stats. I due pulsanti seguono le opzioni di ruolo showExtravars e showArtifacts. Gli stessi dati si ottengono da GET /api/v2/job/{id}/node/{nodeId}, per chiunque possa vedere il job.

Il job fallisce quando un nodo è fallito e nulla ha gestito l’errore, secondo la regola di AWX; altrimenti riesce.

Approvazioni

Un nodo di approvazione trattiene il job di workflow finché qualcuno non risponde.

Quando il workflow raggiunge un nodo di approvazione, lo stato del job diventa In attesa di approvazione: compare nella campanella e nella pagina del job, come un punto di approvazione di un modulo. Il nome del nodo è il titolo dell’approvazione e la sua descrizione il messaggio; il resto viene dall’approval del modulo:

  • i suoi roles decidono chi può approvarla o rifiutarla, e allowSelf se chi l’ha avviato può anche approvarla;
  • le sue notifications e i suoi channels ricevono la richiesta.

Un modulo workflow senza approval trattiene comunque il job su un nodo di approvazione, ma in quel caso solo un amministratore può approvarlo.

  • Approvata: il nodo riesce e il workflow prosegue lungo i suoi collegamenti in caso di successo.
  • Rifiutata: il nodo fallisce e il workflow prosegue lungo i suoi collegamenti in caso di errore.
  • Scaduta: dopo il timeout del nodo senza risposta, anche in questo caso il nodo fallisce.

Interruzione

Interrompi su un job di workflow in esecuzione lo ferma: i job dei nodi in esecuzione vengono interrotti, non parte più nulla, e un’approvazione in attesa viene annullata. Si può interrompere anche un job di workflow in attesa di un’approvazione.