Zum Inhalt springen
Installieren

Die verwaltete Runtime

Das Python und ansible-core, die Volant für sich selbst installiert, wo sie liegen, was sie herunterladen und wie Sie sie verwalten.

Volant braucht auf dem Controller ein Python 3 mit ansible-core für Python-Module, das Sammeln von Facts und die Filter und Lookups, die es nicht selbst umsetzt. Hat der Rechner keines, installiert Volant sein eigenes, einmal, und verwendet es von da an. Sie müssen ansible nicht installiert haben, um ein Playbook auszuführen, und auch nicht für volant doc, config, galaxy, pull und console, die die eigenen Werkzeuge von ansible-core aus dieser Runtime ausführen.

Die Runtime ist CPython 3.13 und ansible-core 2.19.12, die Version, der Volant entspricht. Sie liegt in einem einzigen Verzeichnis, das Volant gehört, sodass sie weder ein System-Python noch eine virtuelle Umgebung von Ihnen berührt.

Ein Lauf installiert die Runtime, wenn er den Python-Helfer braucht und keinen verwendbaren Interpreter findet. Er gibt eine Zeile auf der Standardfehlerausgabe aus und macht weiter:

Installing Volant's Python runtime (cpython-3.13.16-ansible-core-2.19.12-98a5d8b2) ...

Ein Lauf, der nur Facts sammelt, installiert nie etwas. Sie können die Runtime auch vorab installieren, zum Beispiel in einem Image:

Terminal-Fenster
volant runtime install

Auf einem frischen Rechner mit normaler Verbindung dauerte die Installation etwa 8 Sekunden. Spätere Läufe finden sie mit zwei Dateiprüfungen.

Der erste, der zutrifft:

  1. VOLANT_PYTHON, wenn es gesetzt ist. Volant verwendet genau diesen Interpreter und installiert nie.
  2. Die verwaltete Runtime, wenn sie installiert ist.
  3. Die aktive virtuelle Umgebung, dann python3 in Ihrem PATH, wenn sie ansible-core haben.
  4. Eine neue verwaltete Runtime, jetzt installiert.

Volant startet den Interpreter mit -P, sodass eine Datei im Arbeitsverzeichnis, etwa ansible.py oder json.py, nie anstelle des echten Moduls importiert wird. -P braucht Python 3.11 oder neuer, was auch ansible-core 2.19 verlangt. Ein eigener Interpreter behält PYTHONPATH und seine User-Site. volant doc wählt seinen Interpreter ebenfalls nach dieser Regel und führt darin das eigene ansible-doc von ansible-core aus.

volant runtime status zeigt die Wahl, die der nächste Lauf treffen würde, mit jedem Kandidaten und seiner Herkunft. Die Einstellung runtime ändert diese Reihenfolge.

Volant holt einen eigenständigen CPython-Build und die ansible-core-Wheels mit curl, oder mit wget, wenn curl fehlt. Außerdem führt es tar aus. Die URLs und der SHA-256 jeder Datei sind in die Volant-Binärdatei fest eingetragen, sodass jedes Release genau weiß, welche Dateien es verwenden darf.

  • Jeder Download wird gegen seinen eingetragenen Hash geprüft, bevor irgendetwas daraus läuft. Bei einer Abweichung löscht Volant den Download und hält mit beiden Hashes an.
  • pip installiert nur die eingetragenen Wheels, mit --require-hashes und ohne Index.
  • Die Installation geschieht in einem temporären Verzeichnis neben dem endgültigen und wird an ihren Platz verschoben, nachdem geprüft wurde, dass import ansible funktioniert. Eine fehlgeschlagene Installation entfernt ihr temporäres Verzeichnis. Eine unterbrochene kann ein Verzeichnis .<id>.partial-* hinterlassen, das die nächste Installation löscht.
  • Eine Lock-Datei verhindert, dass zwei Volant-Prozesse gleichzeitig installieren. Der zweite wartet und findet dann die installierte Runtime.
  • Jeder Kindprozess läuft mit PYTHONNOUSERSITE=1 und ohne PYTHONPATH, sodass Pakete in Ihrem Home-Verzeichnis oder Ihrer Umgebung ihn nicht erreichen können.

Die Plattformen sind Linux und macOS auf x86_64 und arm64. Unter Linux liest Volant die libc des Rechners, auf dem es läuft, glibc oder musl, und wählt den passenden Build, wofür es auch kompiliert wurde. Volant wurde auf macOS nicht getestet: Es stand kein Mac zur Verfügung. Jedes andere System wird mit einer Meldung abgelehnt, die es nennt und auf VOLANT_PYTHON verweist.

Unter $XDG_DATA_HOME/volant/runtime oder ~/.local/share/volant/runtime. Unter macOS ist der Standard ~/Library/Application Support/volant/runtime. Jede Runtime hat ihr eigenes Verzeichnis, benannt nach ihrer Kennung (Python-Version, ansible-core-Version und ein kurzer Hash der eingetragenen Dateiliste), sodass ein Release mit anderen Einträgen neben der alten installiert wird. Eine Runtime belegt etwa 155 MB.

Volant installiert während eines Laufs keine Collection. So installieren Sie eine in die Runtime:

Terminal-Fenster
volant runtime install --collections community.general ansible.posix:2.2.2
volant runtime install --collections requirements.yml

--collections nimmt Namen, jeden mit optionalem :version, oder eine Requirements-Datei, die auf .yml oder .yaml endet. Die Collections landen in collections/ innerhalb der Runtime. Volant sucht dort nach den Pfaden in ANSIBLE_COLLECTIONS_PATH und [defaults] collections_path, sodass Collections, die Sie selbst installiert haben, gewinnen. volant galaxy installiert in den ersten Eintrag dieses Pfads, standardmäßig ~/.ansible/collections, und listet das Verzeichnis der Runtime zuletzt.

Die Installation ist Volants eigene: volant runtime install --collections führt volant galaxy collection install -p <runtime>/collections aus, gibt dieselben Zeilen aus und braucht für diesen Schritt kein Python.

Die Runtime enthält ansible-core und seine Abhängigkeiten und sonst nichts. Eine Collection, deren Plugins ein weiteres Python-Paket brauchen, etwa jmespath für json_query, funktioniert darin nicht. Nutzen Sie dafür Ihre eigene Umgebung mit VOLANT_PYTHON.

Manche Connection-Plugins brauchen Python-Pakete, die ansible-core nicht mitbringt. Zwei Sets davon sind für jede Plattform festgelegt, wie die Basis-Wheels, und werden nur auf Wunsch installiert:

Set Pakete Platz auf der Platte (Linux x86_64)
windows pywinrm, pypsrp und ihre Abhängigkeiten etwa 7 MB
network paramiko, ansible-pylibssh, ncclient und ihre Abhängigkeiten etwa 31 MB
Terminal-Fenster
volant runtime install --extras windows
volant runtime install --extras windows,network

--extras installiert zuerst die Runtime, wenn sie fehlt, oder fügt die Sets der vorhandenen Runtime hinzu, ohne ihre Basis-Wheels anzufassen. Die Wheels werden gegen ihre festgelegten Hashes geprüft und mit --require-hashes, ohne Index und ohne Auflösung von Abhängigkeiten installiert. volant runtime status listet die installierten Sets. Für ansible-pylibssh gibt es keinen musl-Build, daher enthält das Set network auf Alpine und anderen musl-Rechnern nur paramiko und ncclient.

Ein Lauf installiert kein Set. Verbindet sich ein Host eines Plays mit winrm oder psrp und ist das Python des Controllers die verwaltete Runtime ohne das Set windows, hält der Lauf vor jeder Verbindung an, mit Exit-Code 4:

host 'win1': the winrm connection needs the "windows" runtime extras: run volant runtime install --extras windows

network_cli und netconf verlangen das Set network auf dieselbe Weise. Mit VOLANT_PYTHON lässt Volant den Interpreter, wie er ist, und der Fehler des Plugins nennt das fehlende Paket.

Mit dem Set windows funktioniert winrm mit den Transporten basic, plaintext, ssl, certificate und ntlm, und psrp mit den Authentifizierungen basic, certificate, ntlm und negotiate, wobei negotiate auf NTLM zurückfällt. Kerberos und CredSSP brauchen Systembibliotheken und Pakete, die das Set nicht enthält: Nutzen Sie dafür Ihre eigene Umgebung mit VOLANT_PYTHON.

Befehl Was er tut
volant runtime install Installiert die Runtime, wenn sie fehlt.
volant runtime install --collections NAME_OR_FILE... Installiert zusätzlich Collections.
volant runtime install --extras SET,... Installiert auch optionale Wheel-Sets: windows, network.
volant runtime install --from FILE Installiert aus einer Datei, die pack erzeugt hat, ohne Download.
volant runtime install --from FILE --sha256 HASH Installiert aus der Datei nur, wenn ihr SHA-256 HASH ist.
volant runtime pack FILE Schreibt die installierte Runtime in eine Datei und gibt ihren SHA-256 aus.
volant runtime pack FILE --extras SET,... Fügt der Runtime zuerst die Sets hinzu, damit die Datei sie enthält.
volant runtime status Zeigt den Modus, den Interpreter, den der nächste Lauf verwendet, und die verwaltete Runtime.
volant runtime path Gibt das Python der verwalteten Runtime aus. Endet mit Exit-Code 1, wenn sie nicht installiert ist.
volant runtime remove [ID] Löscht die aktuelle Runtime oder die genannte.
volant runtime remove --all Löscht jede Runtime.

Packen Sie eine Runtime auf einem Rechner mit Netzwerk, kopieren Sie die Datei und installieren Sie sie auf einem Rechner derselben Plattform:

Terminal-Fenster
volant runtime pack runtime.tar.gz
# packed runtime.tar.gz
# sha256 3f1c...e9
volant runtime install --from runtime.tar.gz --sha256 3f1c...e9

install --from lehnt eine Datei ab, die für eine andere Plattform oder eine andere Runtime gemacht wurde, und nennt beide. pack gibt den SHA-256 der Datei in einer Zeile sha256 aus. Mit --sha256 HASH lehnt install --from eine Datei mit abweichendem Hash vor dem Entpacken ab und zeigt beide Hashes. Ohne die Option gibt die Installation den Hash der verwendeten Datei aus, sodass Sie ihn selbst vergleichen können. Das Installieren eines Packs führt das darin enthaltene Python aus, übergeben Sie also den Hash, den Sie von dem Rechner erhalten haben, der es erzeugt hat.

Die Datei enthält die Sets, die die Runtime hatte. Packen Sie mit --extras, um sie hinzuzufügen, und nennen Sie sie auf dem anderen Rechner erneut, wo install --from prüft, ob die Datei sie enthält:

Terminal-Fenster
volant runtime pack runtime.tar.gz --extras windows
volant runtime install --from runtime.tar.gz --sha256 3f1c...e9 --extras windows

Setzen Sie runtime = system im Abschnitt [volant] der ansible.cfg oder VOLANT_RUNTIME=system. Volant verwendet dann nur, was vorher vorhanden war, und ein fehlender Interpreter wird mit der alten Meldung plus einem Hinweis auf die Runtime abgelehnt. Mit managed verwendet Volant nur VOLANT_PYTHON oder die verwaltete Runtime, installiert die Runtime, wenn sie fehlt, und ignoriert python3 im PATH. Siehe Konfiguration.