Läuft mein Playbook?
Prüfen Sie ein bestehendes Ansible-Projekt in wenigen Sekunden gegen dieses Release, ohne einen Host anzufassen.
Um herauszufinden, ob ein Playbook läuft, führen Sie im Wurzelverzeichnis des Repositorys volant check . aus und lassen das Playbook dann auf einem Host laufen. Volant liest die gesamte Grammatik von ansible-core 2.19, Ihr Playbook wird hier also so geparst wie unter Ansible. Bevor Volant sich mit irgendetwas verbindet, sucht eine zweite Prüfung, die Vorabprüfung, nach dem, was dieses Release noch nicht unterstützt, und bricht den Lauf mit einer Meldung ab, die es benennt. Die bekannten Lücken weiter unten sind die Ausnahmen: Dort kann ein Lauf eine Einstellung ignorieren oder ein falsches Ergebnis liefern, ohne einen Fehler zu melden.
Ein Projekt prüfen
Abschnitt betitelt „Ein Projekt prüfen“-
Prüfen Sie alle Playbooks auf einmal, ohne einen Host zu kontaktieren:
Terminal-Fenster volant check .Jedes Playbook bekommt ein Urteil:
ready,refusedmit Grund, Datei und Zeile, oderunknown, wenn nur ein Lauf es zeigen kann. Das ist nichtvolant playbook --check, das das Playbook im Prüfmodus gegen Hosts ausführt. Siehevolant check. -
Lesen Sie es, ohne es auszuführen. Auflistungen und
--syntax-checkbrechen nie wegen eines nicht unterstützten Moduls oder Keywords ab, sie funktionieren also auch bei einem Playbook, das dieses Release noch nicht ausführen kann:Terminal-Fenster volant playbook -i inventory.ini site.yml --syntax-checkvolant playbook -i inventory.ini site.yml --list-tasksStimmt die Task-Liste mit der Ausgabe von
ansible-playbook --list-tasksüberein, hat Volant Ihre Rollen, Imports und Tags genauso kompiliert. -
Fordern Sie einen echten Lauf gegen einen Host an, den Sie gefahrlos anfassen können.
--check --difflässt den Host unverändert, bis auf den zwischengespeicherten Agent, und ist deshalb ein sicherer erster Lauf:Terminal-Fenster volant playbook -i inventory.ini site.yml --limit test1 --check --diffvolant playbook -i inventory.ini site.yml --limit test1Das meiste, was dieses Release nicht ausführen kann, bricht den Lauf ab, bevor er sich verbindet. Die Meldung nennt das Modul, das Keyword oder den Wert, und der Lauf endet mit Exit-Code 4. Was heute abgelehnt wird listet die Meldungen auf.
-
Beheben Sie es oder warten Sie. Was noch nicht unterstützt wird, steht in Keywords, Module und den bekannten Lücken weiter unten, und für das meiste gibt es einen Workaround.
Häufige Fragen
Abschnitt betitelt „Häufige Fragen“| Frage | Antwort |
|---|---|
Funktioniert community.general? |
Ja, sobald es installiert ist. Volant installiert während eines Laufs keine Collection, führen Sie also zuerst volant runtime install --collections community.general aus. Ein Plugin, das ein Python-Paket braucht, das die verwaltete Runtime nicht mitbringt, etwa der Filter json_query mit jmespath, schlägt fehl. Verwenden Sie dafür Ihr eigenes Python mit VOLANT_PYTHON. Siehe Die verwaltete Runtime. |
Funktioniert copy? |
Ja. Der Controller liest die Datei oder nimmt content: und sendet sie an den Host. Ein Verzeichnis als src funktioniert ebenfalls. Siehe Module. |
Funktioniert async? |
Ja: async, poll und poll: 0 mit async_status. Ein Modul, das ansible-core nicht unter async ausführen kann, schlägt auf jedem Host mit This action (<name>) does not support async. fehl. Siehe Plays ausführen. |
Funktioniert --diff? |
Ja, mit --check oder allein. Ein Host braucht Python für apt, user, group, file, lineinfile und systemd, wenn ein Lauf einen Check oder einen Diff verlangt. Siehe Check-Modus, Diff und Auflistungen. |
Funktionieren become, Vault und ansible.cfg? |
become über sudo oder su, Vault und ansible.cfg funktionieren. doas und andere Methoden nicht. Siehe Verbindungen und become. |
| Funktionieren eigene Plugins? | Teilweise. Action-, Connection-, Inventory-, Callback-, Cache- und Vars-Plugins neben dem Playbook oder in einer Rolle laufen über ansible-core. Siehe die bekannten Lücken. |
Auf einen Blick
Abschnitt betitelt „Auf einen Blick“| Bereich | Läuft heute | Noch nicht |
|---|---|---|
| Plays | pre_tasks, Rollen, tasks, post_tasks, Handler, serial, strategy (linear, free, host_pinned, debug), order, throttle, timeout, debugger, any_errors_fatal, max_fail_percentage, ignore_errors, ignore_unreachable |
|
| Tasks | when, loop, jede Form with_<lookup>, register, until, retries, changed_when, failed_when, ignore_errors, ignore_unreachable, any_errors_fatal, no_log, environment, timeout, tags, async, poll, module_defaults |
|
| Blöcke | block, rescue, always |
|
| Wiederverwendung | Rollen und Abhängigkeiten, import_tasks, import_role, import_playbook, include_tasks, include_role, include_vars |
|
| Delegation | delegate_to, delegate_facts, local_action, run_once |
|
| Module | die Module von ansible-core für Linux-Hosts, darunter copy, template, dnf, service, uri und reboot, sowie die Module installierter Collections mit ihren Action-Plugins, sowie Action-Plugins in einem action_plugins/ neben dem Playbook oder in einer Rolle |
das Action-Plugin einer Collection, das Windows braucht |
| Inventories | INI-, YAML- und TOML-Dateien, Verzeichnisse, Skripte, constructed, generator und Collection-Plugins, mehrere -i, group_vars, host_vars, der Fact-Cache jsonfile |
nichts mehr offen |
| Verbindungen | ssh mit Schlüsseln, einem ssh-agent oder einem Passwort (-k oder ansible_password, braucht OpenSSH 8.4 oder neuer), local, sowie network_cli, netconf und httpapi für Netzwerkgeräte |
andere Connection-Plugins, Windows |
| Rechteausweitung | become über sudo oder su, mit oder ohne Passwort |
doas und andere Methoden |
| Templating | Jinja2 mit den Filtern, Tests und Lookups von Ansible, !unsafe, Filter und Lookups aus Collections |
einige Filterargumente, aufgeführt unter Templating |
| Laufmodi | normale Läufe, --check und --diff, Vault, --start-at-task, --step, die vier Auflistungsbefehle |
nichts mehr offen |
Häufige Hindernisse und was Sie tun können
Abschnitt betitelt „Häufige Hindernisse und was Sie tun können“| Noch nicht unterstützt | Warum | Was Sie heute tun können |
|---|---|---|
| Eine Collection, die nicht installiert ist | Volant installiert während eines Laufs keine. Es fragt vor der ersten Verbindung das ansible-core des Controllers, was installiert ist. | Führen Sie volant runtime install --collections NAME aus, den Befehl, den der Fehler nennt. Siehe Die verwaltete Runtime und Module aus Collections. |
| Kein Python mit ansible-core auf dem Controller | Volant installiert bei Bedarf ein eigenes, mit curl oder wget und tar. |
Nichts, oder volant runtime install vorab. Ohne Netzwerk verwenden Sie volant runtime pack und install --from. |
apt, user, group oder file unter --check oder --diff auf einem Host ohne Python |
Diese Module antworten über Python auf dem Host, wenn der Lauf einen Check oder einen Diff verlangt. | Installieren Sie Python auf dem Host, oder führen Sie das Play ohne --check und --diff aus. |
!!binary, ein doppelter Anchor oder ein Datum oder eine Menge als typisierter Wert |
Volant hat keinen Typ für Bytes, Daten oder Mengen. Ein Datum wird als sein ISO-Text geladen, ein !!set, !!omap oder !!pairs als das Mapping oder die Liste, als die es geschrieben ist. !!binary bricht das Laden ab, und ein zweiter &anchor desselben Namens wird akzeptiert. |
Schreiben Sie den Wert als einfachen String, Liste oder Mapping, und geben Sie jedem Anchor einen eigenen Namen. |
| Arithmetik mit einer Ganzzahl, die breiter als 128 Bit ist | Die Operatoren +, -, *, /, //, % und ** sowie die Filter abs und round lehnen einen breiten Operanden ab. Siehe Templating. |
Rechnen Sie in einem Modul oder in command mit python3 -c, und behalten Sie den breiten Wert als Text. |
Was heute abgelehnt wird
Abschnitt betitelt „Was heute abgelehnt wird“Die Vorabprüfung bricht den Lauf vor der ersten Verbindung ab, vor jedem Banner und vor jedem Recap. Ohne sie würde ein Keyword, das durchgerutscht ist, stillschweigend ignoriert, und der Lauf würde Erfolg melden, nachdem er übersprungen hat, was Sie verlangt haben. Die Vorabprüfung beschreibt, wie sie funktioniert.
| Was | Form der Meldung | Exit-Code |
|---|---|---|
Eine strategy außer linear, free, host_pinned und debug, aus dem Play oder aus ANSIBLE_STRATEGY, es sei denn, ihr Plugin leitet von einer davon ab und fügt nichts hinzu |
die Deprecation-Warnung von ansible-core für Strategie-Plugins außerhalb von ansible.builtin, dann strategy 'x' is not supported yet |
4 |
until, retries oder delay bei include_tasks oder include_role |
keyword 'until' is not supported yet on 'include_tasks' |
4 |
Ein pause mit prompt und seconds oder minutes, wenn die Standardeingabe ein Terminal ist |
pause cannot wait for a prompt and a duration together on a terminal ... |
4 |
| Ein Modulargument, das ansible-core hat und das dieses Release nicht umsetzt | argument 'x' is not supported yet on 'module', mit with 'v', wenn nur dieser Wert abgelehnt wird |
4 |
end_role außerhalb einer Rolle |
Cannot execute 'end_role' from outside of a role |
4 |
| Ein eingebautes Modul, das dieses Release nicht mitbringt | module 'x' is not available in this release |
4 |
Ein Modul oder eine Collection, die sich nicht auflösen lässt, als Schlüssel der Task geschrieben (in action: oder local_action: genannt, scheitert die Task erst beim Ausführen, mit Cannot resolve 'x' to an action or module.) |
couldn't resolve module/action 'x' ..., mit dem Installationsbefehl für eine fehlende Collection |
4 |
| Ein Collection-Modul, das ein Action-Plugin für Windows braucht | module 'x' needs an action plugin from its collection, which this release does not run |
4 |
Eine become_method außer sudo und su |
become_method 'x' is not supported yet |
2 |
Eine Rolle in roles: oder import_role, die niemand findet |
the role 'x' was not found in ... |
1 |
Die Ablehnung bei pause gilt nur für einen Schritt, der immer läuft. Ein when, ein loop oder ein rescue darum herum verschiebt die Prüfung auf den Moment, in dem das pause erreicht wird. Ein Lauf, den die Prüfung abbricht, endet mit Exit-Code 4, dem Code, den Ansible für ein Playbook verwendet, das es nicht laden kann. Exit-Codes listet jeden Code auf.
Bekannte Lücken
Abschnitt betitelt „Bekannte Lücken“Diese Punkte weichen von ansible-playbook ab, ohne eine Meldung vor dem Lauf oder mit einer Meldung, die etwas anderes nennt. Jede Zeile sagt, was geschieht.
| Was | Was geschieht |
|---|---|
Ein Task mit no_log: true, der fehlschlägt |
Absicht. Volant gibt [ERROR]: Task failed: Action failed: <error censored due to no log> aus und sonst nichts von der Ursache. ansible-core 2.19.12 gibt die Ursache aus: [ERROR]: Task failed: Action failed: <the msg of fail or assert>, den Fehler des Moduls und die Blöcke <<< caused by >>>. Dieser Text kann ein Geheimnis enthalten, etwa die msg eines fail, die ein Passwort nennt. Die Sicherheitsrichtlinie wertet ein Geheimnis, das in einem Log oder Terminal landet, wo no_log es in ansible-core verbirgt, als Sicherheitslücke, deshalb verbirgt Volant es. Die Zeile fatal:, das registrierte Ergebnis und der Recap sind in beiden gleich. Um die Ursache zu lesen, führen Sie den Task ohne no_log aus. |
| SIGTERM | Absicht. Volant beendet sich sauber: Es bricht die laufenden Tasks ab, entfernt das Verzeichnis mit dem Verbindungspasswort, gibt den Recap aus und endet mit Exit-Code 99, wie bei Strg-C. ansible-playbook fängt SIGTERM nicht ab. Es stirbt sofort mit Code 143 und gibt keinen Recap aus. Gemessen mit kill -TERM während eines command: sleep: 99 unter Volant, 143 unter ansible-core 2.19.12. |
_ansible_ansiballz_pydevd_config |
Absicht. Wird ignoriert. ansible-core behält diese Einstellung dem eigenen Gebrauch vor: Sie hängt einen Debugger an den Modul-Wrapper. Volant führt Python-Module mit einem eigenen Runner aus und seine nativen Module ohne Python. |
Templating listet die Filter und Argumente auf, die fehlschlagen. Die Paritätsseite markiert einen Filter als partial, wenn eines seiner Argumente fehlschlägt.
Verhält sich ein Playbook unter Volant und ansible-playbook unterschiedlich, ohne als nicht unterstützt gemeldet zu werden, ist das ein Bug. Eröffnen Sie bitte einen Kompatibilitätsbericht mit einem minimalen Playbook.
Einen Namen nachschlagen
Abschnitt betitelt „Einen Namen nachschlagen“Wenn Sie etwas über ein bestimmtes Keyword, Modul, einen Filter oder eine Option wissen möchten, öffnen Sie die zugehörige Referenzseite:
- Keywords listet jedes Keyword von Plays, Blöcken, Tasks und Schleifen auf und sagt, was Volant damit tut.
- Module listet die Module auf, die im Agent, auf dem Controller und über Python laufen, mit den Argumenten, die jedes unterstützt.
- Kommandozeile listet jede Option von
volant playbookundvolant runtimeauf. - Parität ist die vollständige Matrix: jedes Keyword, jede Option und jedes Plugin von ansible-core 2.19.12 sowie jedes Modul, jeder Filter, Test und Lookup der Collections im Paket ansible 12.3.0, mit dem Status
runs,partial,not yetoderlater.