Uruchamianie workflow

Uruchom workflow z formularza i śledź go na stronie zadań

  1. Formularz
  2. Zadanie
  3. Zatwierdzenia
  4. Przerywanie

Formularz

Formularz typu workflow uruchamia workflow wskazany przez workflow:, tak jak playbook: przez jego plik w folderze workflow, z podfolderami (team/deploy-app.yml), albo przez nazwę workflow wewnątrz pliku (deploy-app):

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

Pola formularza trafiają do każdego węzła jako extra vars, podobnie jak jego credentials, pod nazwami, które nadaje im formularz, tak jak w formularzu wieloetapowym trafiają do jego kroków:

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

Własne poświadczenia węzła, ustawione w pliku workflow, trafiają do jego playbooka pod własną nazwą i wygrywają przy nazwie używanej przez oba. Na karcie Wizualny formularza w projektancie Workflow to lista plików workflow projektanta.

Sama nazwa pliku zostanie znaleziona także w podfolderze, jeśli ma ją tylko jeden plik. Dwa workflowy o tej samej nazwie blokują formularz, który wskazuje workflow po nazwie, a projektant ostrzega przy zapisywaniu drugiego: zmień nazwę jednego z nich albo wskaż jego plik. Workflow, którego nie da się znaleźć, kończy zadanie błędem, z powodem w wyniku.

Zadanie

Zadanie workflow działa na serwerze AnsibleForms, a każdy węzeł playbooka działa jako osobne zadanie, podrzędne wobec zadania workflow, tak jak kroki formularza wieloetapowego: playbook projektanta na RTE albo, dla węzła z runner:, szablon lub zadanie tego runnera na AWX, AAP, Ascender, Semaphore, Rundeck lub Jenkins (zobacz Gdzie działa węzeł).

Strona zadania rysuje workflow na żywo: każdy węzeł pokolorowany według stanu, połączenia, które zadziałały, i węzły, które się nie uruchomią. Informacje na górze wskazują workflow zamiast playbooka.

  • Kliknij węzeł, który się zakończył, aby otworzyć jego wynik w oknie dialogowym.
  • Wynik zawiera wynik każdego węzła pod banerem WORKFLOW NODE [identifier] (status), w kolejności, w jakiej węzły się zakończyły.
  • Pokaż extravars i Pokaż artefakty, w nagłówku każdego węzła w wyniku i w oknie dialogowym otwieranym z grafu, pokazują własne extravars i artefakty tego węzła ({}, gdy ich nie ma), jako JSON lub YAML, z przyciskiem Kopiuj.

Extravars węzła zawierają to, co przekazały mu wcześniejsze węzły, a jego artefakty to, co jego playbook zebrał przez set_stats. Oba przyciski zależą od opcji ról showExtravars i showArtifacts. Te same dane zwraca GET /api/v2/job/{id}/node/{nodeId}, dla każdego, kto może widzieć zadanie.

Zadanie kończy się błędem, gdy węzeł zakończył się błędem i nic go nie obsłużyło, zgodnie z zasadą AWX; w przeciwnym razie kończy się sukcesem.

Zatwierdzenia

Węzeł zatwierdzenia wstrzymuje zadanie workflow, dopóki ktoś nie udzieli odpowiedzi.

Gdy workflow dochodzi do węzła zatwierdzenia, stan zadania zmienia się na Oczekuje na zatwierdzenie: widać to przy dzwonku i na stronie zadania, tak jak w przypadku punktu zatwierdzenia formularza. Nazwa węzła jest tytułem zatwierdzenia, a jego opis komunikatem; reszta pochodzi z approval formularza:

  • jego roles decydują, kto może je zatwierdzić lub odrzucić, a allowSelf, czy uruchamiający także może je zatwierdzić;
  • do jego notifications i channels wysyłana jest prośba.

Formularz workflow bez approval również wstrzymuje zadanie na węźle zatwierdzenia, ale wtedy zatwierdzić je może tylko administrator.

  • Zatwierdzone: węzeł kończy się sukcesem, a workflow idzie dalej połączeniami przy sukcesie.
  • Odrzucone: węzeł kończy się błędem, a workflow idzie dalej połączeniami przy błędzie.
  • Przekroczony czas: po upływie limitu czasu węzła bez odpowiedzi węzeł również kończy się błędem.

Przerywanie

Przerwij w działającym zadaniu workflow zatrzymuje je: działające zadania węzłów są przerywane, nic więcej nie startuje, a zatwierdzenie, na które czeka, jest anulowane. Zadanie workflow czekające na zatwierdzenie także można przerwać.