Konzepte
Die in dieser Dokumentation verwendeten Begriffe, jeweils mit ihrer Seite verlinkt
Glossar
Die in dieser Dokumentation verwendeten Begriffe:
| Begriff | Bedeutung |
|---|---|
| Formular | Eine YAML-Definition, die Eingaben sammelt und ein Playbook, eine Vorlage oder einen Workflow ausführt |
| Formularfeld | Eine Eingabe eines Formulars, etwa text, enum oder checkbox; ihr Wert wird zu einer Extravar |
| Kategorie | Eine Gruppe im Baum der Formulare auf der Seite Formulare, definiert in config.yaml |
| Rolle | Eine Menge von Benutzern und Gruppen; ein Formular listet die Rollen auf, die es sehen und ausführen dürfen, default für alle |
| Ausdruck | JavaScript, das einen Feldwert berechnet, im Browser (runLocal: true) oder auf dem Server |
| Extravars | Die Variablen, die an das Playbook oder die Vorlage gesendet werden, aufgebaut aus den Feldwerten |
| Anmeldedaten | Ein gespeicherter Login, verschlüsselt mit ENCRYPTION_SECRET: ein Benutzer und ein Passwort (und Host, Port, Datenbank), oder seit 7.3.0 die Adresse und Secrets eines LDAP-Verzeichnisses, eines SSO-Anbieters, eines Runners oder eines HashiCorp Vault |
| Secret Store | Eine Verbindung zu HashiCorp Vault oder CyberArk, die Benutzer und Passwort von Anmeldedaten liefert |
| Job | Ein Lauf eines Formulars, mit seinem Status, seinen Extravars und seiner Ausgabe, in der Job-Historie aufbewahrt |
| Runner | Wo ein Job läuft, hinzugefügt unter Verbindungen > Runner: rte für Playbooks, awx (AWX oder die Variante aap oder ascender), semaphore, rundeck oder jenkins für Vorlagen und Jobs. Ein Formular wählt einen mit runner: oder läuft auf dem Standard-Runner rte (Playbooks) oder awx (Vorlagen) |
| RTE | Eine Laufzeitumgebung: der AnsibleForms-Server, mit AF_ROLE=rte in einem eigenen Container gestartet, neben python und ansible, der die Playbooks eines Runners vom Typ rte ausführt |
| Genehmigungspunkt | Eine Pause in einem Job, bis ein Benutzer mit einer Genehmigungsrolle ihn genehmigt oder ablehnt |
| Workflow | Ein Graph aus Playbooks, Genehmigungen und anderen Workflows, verknüpft bei Erfolg, bei Fehler oder immer, in der Syntax von AWX |
| Multistep-Formular | Seit 7 veraltet: ein Formular, das mehrere Playbooks oder Vorlagen nacheinander ausführt; ein Workflow ersetzt es |
| Benachrichtigungskanal | Ein Mailserver, ein Slack- oder Teams-Webhook, ein Telegram-Chat oder ein Webhook, an den Benachrichtigungen und Genehmigungsanfragen gehen |
| Designer | Der Browser-Editor für Formulare, Playbooks, Inventare und Workflows, den jeweils eine Person gleichzeitig verwendet |
| Subform | Eine wiederverwendbare Gruppe von Feldern, die die Zeilen eines Felds list oder das Objekt eines Felds yaml beschreibt |
| config.yaml | Die Datei mit den Kategorien, den Rollen und den Konstanten; die Formulare liegen in eigenen Dateien |
| Konfigurations-Seed | Eine YAML-Datei (CONFIG_SEED_PATH), die die Admin-Objekte deklariert, etwa Runner und Anmeldedaten |
| Persistenter Ordner | Der Ordner mit den Dateien, die AnsibleForms über Neustarts und Aktualisierungen hinweg behalten muss |