Zum Inhalt springen
Installieren

Installation

Installieren Sie Volant mit einem Befehl, prüfen Sie, was Controller und Hosts brauchen, und halten Sie es aktuell.

Terminal-Fenster
curl -fsSL https://volant.sh/install.sh | sh

Das Skript läuft unter Linux und macOS, auf x86_64 und arm64. Unter Linux nimmt es den statischen Build. Es braucht curl, tar und sha256sum oder shasum, unter Linux zusätzlich xz. Es lädt das neueste Release für Ihren Rechner herunter, prüft dessen SHA-256-Prüfsumme, entpackt es unter ~/.local/share/volant und verlinkt volant und volant-playbook nach ~/.local/bin. Das Skript verlangt keinen Root-Zugriff und schreibt nichts außerhalb dieser beiden Verzeichnisse. Was Volant später beim Ausführen schreibt, steht unter Was Volant auf Ihren Rechnern ablegt. Sie können das Skript lesen, bevor Sie es ausführen. Windows wird noch nicht unterstützt: Ein Windows-Controller steht auf der Roadmap.

Sie brauchen kein installiertes Ansible. Beim ersten Lauf, der Python benötigt, lädt Volant eine eigene Kopie von Python und ansible-core herunter, etwa 155 MB, und legt sie in ~/.local/share/volant/runtime ab. Dabei gibt es eine einzelne Zeile aus. Was Volant auf Ihren Rechnern ablegt listet alles auf, was es schreibt.

Prüfen Sie, ob es funktioniert hat:

Terminal-Fenster
volant --version

Findet Ihre Shell volant nicht, fügen Sie ~/.local/bin zu Ihrem PATH hinzu. Das Skript gibt die Zeile aus, die Sie ergänzen müssen, wenn sie fehlt.

Das Skript liest vier Umgebungsvariablen und kennt eine Option, --shims, die tut, was VOLANT_SHIMS=1 tut:

Variable Standard Was sie ändert
VOLANT_VERSION das neueste Release Das Release, das installiert wird, etwa v0.1.0-alpha.10.
VOLANT_HOME ~/.local/share/volant Wohin Releases entpackt werden.
VOLANT_BIN_DIR ~/.local/bin Wohin die Links volant und volant-playbook kommen.
VOLANT_SHIMS nicht gesetzt Auf 1 setzen, um auch die Namen ansible-* zu verlinken. Siehe unten.
Terminal-Fenster
curl -fsSL https://volant.sh/install.sh | VOLANT_VERSION=v0.1.0-alpha.10 sh

Mit --shims verlinkt das Skript zusätzlich die neun Programmnamen von ansible-core mit volant, damit bestehende Kommandozeilen weiter funktionieren: ansible, ansible-config, ansible-console, ansible-doc, ansible-galaxy, ansible-inventory, ansible-playbook, ansible-pull und ansible-vault.

Terminal-Fenster
curl -fsSL https://volant.sh/install.sh | sh -s -- --shims
curl -fsSL https://volant.sh/install.sh | VOLANT_SHIMS=1 sh

Ansible-Befehlsnamen listet auf, was jeder Name startet und was abweicht. Das Skript installiert sie nie von sich aus. Es führt volant shims install aus, das eine Datei oder einen Link, die es nicht angelegt hat, in Ruhe lässt und meldet, wenn ein echtes Ansible im PATH verdeckt wird oder weiter zuerst läuft. Konnte ein Name nicht verlinkt werden, gibt das Skript some ansible-* names were not linked, see above aus und endet trotzdem mit 0, weil Volant installiert ist.

Die Action setup-volant installiert Volant in einem Workflow. Sie führt das Installationsskript von oben aus, prüft also dieselbe SHA-256-Prüfsumme, und fügt das Verzeichnis des volant-Links dem PATH der folgenden Schritte hinzu. Sie läuft auf Linux- und macOS-Runnern.

steps:
- uses: actions/checkout@v7
- uses: lorica-labs/volant/setup-volant@main
with:
version: v0.1.0-alpha.13
shims: true
- run: ansible-playbook -i inventory.yml site.yml

uses: nimmt einen Branch, ein Tag oder einen Commit des volant-Repositorys. Die Action ist in jedem Release nach 0.1.0-alpha.13 enthalten. Legen Sie auch version fest, damit ein neues Release nicht ändert, was der Workflow ausführt.

Eingabe Standard Wirkung
version das neueste Release Das zu installierende Release, etwa v0.1.0-alpha.13.
shims false Verlinkt zusätzlich die ansible-*-Namen, wie --shims.
runtime false Installiert die verwaltete Laufzeit in diesem Schritt statt beim ersten Lauf, der sie braucht.
collections leer Collections, die in die Laufzeit installiert werden, wie mit volant runtime install --collections: Namen mit optionalem :version oder eine Requirements-Datei, getrennt durch Leerzeichen oder Zeilenumbrüche.
python leer Setzt VOLANT_PYTHON. Läufe verwenden dann diesen Interpreter und installieren die Laufzeit nie.

Mit runtime oder collections legt die Action das Laufzeitverzeichnis mit actions/cache im Cache ab. Der Cache-Schlüssel besteht aus System und Architektur des Runners, der Volant-Version, den Collections und dem Inhalt jeder Requirements-Datei darunter. Ein späterer Lauf mit denselben Eingaben stellt die Laufzeit so wieder her, statt sie herunterzuladen.

Das Release enthält zwei ausführbare Dateien. volant bringt die Agents mit, die es auf Ihre Hosts hochlädt. Ein Agent ist ein kleines Programm, das Ihre Tasks auf einem Host ausführt. Sonst ist nichts zu installieren, und es muss nichts danebenliegen:

Datei Was es ist
volant Der Controller, der Befehl, den Sie ausführen.
volant-playbook Derselbe Controller unter einem Namen, der wie ansible-playbook klingt.
ansible, ansible-vault und die anderen sieben Namen Optionale Links auf volant, nur mit --shims. Siehe Ansible-Befehlsnamen.

Bei der ersten Verwendung schreibt der Controller seine Agents nach ~/.cache/volant/agents/<version>/, oder unter $XDG_CACHE_HOME, wenn gesetzt: den Agent für Ihren eigenen Rechner, den ansible_connection=local nutzt, und die Agents, die er auf x86_64- und arm64-Linux-Hosts hochlädt. Spätere Läufe verwenden sie wieder, und eine Kopie, die nicht zum eingebauten Agent des Controllers passt, wird neu geschrieben.

Jedes Release hat ein Archiv pro Plattform. Für Linux gibt es einen statischen und einen glibc-Build. Für macOS gibt es einen Build, der die Systembibliotheken einbindet.

Plattform Archiv Linkung Minimum Zusätzlich nötig
Linux x86_64, statisch volant-x86_64-unknown-linux-musl.tar.xz Statisch. Keine libc. Beliebiges Linux ssh-Client, Python für Python-Module
Linux x86_64, glibc volant-x86_64-unknown-linux-gnu.tar.xz Dynamisch, nur glibc glibc 2.17 ssh-Client, Python für Python-Module
Linux arm64, statisch volant-aarch64-unknown-linux-musl.tar.xz Statisch. Keine libc. Beliebiges Linux ssh-Client, Python für Python-Module
Linux arm64, glibc volant-aarch64-unknown-linux-gnu.tar.xz Dynamisch, nur glibc glibc 2.17 ssh-Client, Python für Python-Module
macOS, Apple Silicon volant-aarch64-apple-darwin.tar.xz Dynamisch, nur Systembibliotheken macOS 11 ssh-Client, Python für Python-Module
macOS, Intel volant-x86_64-apple-darwin.tar.xz Dynamisch, nur Systembibliotheken macOS 10.12 ssh-Client, Python für Python-Module

Beide Linux-Builds führen denselben Code aus und enthalten dieselben Agents. Der statische Build läuft auf jeder Distribution, auch auf Alpine und in einem Container ohne libc. Der glibc-Build braucht glibc 2.17 oder neuer. Das deckt Debian 8, Ubuntu 14.04, RHEL und CentOS 7 und alles danach ab, und er erhält die Sicherheitsupdates der System-libc.

Das Installationsskript nimmt unter Linux immer den statischen Build. volant-installer.sh nimmt den glibc-Build ab glibc 2.17 und auf jedem anderen Linux den statischen Build. cargo binstall nimmt auf jedem glibc-Host den glibc-Build und unter Alpine den statischen Build. Laden Sie auf einem glibc-Host älter als 2.17 das statische Archiv von Hand herunter.

Der statische Build braucht nichts aus dem Image, also läuft er in einem Container, der mit FROM scratch gebaut ist:

FROM scratch
COPY volant /volant
ENTRYPOINT ["/volant"]

Ein scratch-Image hat kein ssh, kein Python, keine Shell und keine /etc/passwd. Mit nur dem Controller darin kann ein Playbook mit connection: local laufen und command mit argv verwenden. Für SSH-Verbindungen braucht das Image einen ssh-Client, für Python-Module und das Sammeln von Facts braucht es Python, und shell und raw brauchen eine Shell. Der Controller legt den Agent, den er entpackt, unter ~/.cache/volant ab, oder unter $XDG_CACHE_HOME, wenn gesetzt: Geben Sie ihm ein Verzeichnis, in das er schreiben kann.

  • Linux oder macOS.
  • Der OpenSSH-Client in Ihrem PATH. Volant führt ssh selbst aus, daher gilt Ihre ~/.ssh/config.
  • curl oder wget sowie tar, wenn ein Playbook zum ersten Mal Python braucht.
  • Um das Installationsskript zu nutzen oder ein Release von Hand zu entpacken: curl, tar, sha256sum oder shasum und unter Linux xz.

Für die Module, die in Python laufen, verwendet Volant ein Python 3 mit ansible-core. Findet es keines, lädt es ein eigenes herunter (etwa 155 MB), prüft jede Datei gegen einen festgelegten Hash und legt es unter ~/.local/share/volant/runtime ab. Ein Lauf, der das tut, gibt eine einzelne Zeile aus. Wenn Sie bereits ein solches Python haben, kann Volant es verwenden: Welchen Interpreter ein Lauf verwendet nennt die Reihenfolge. Siehe Die verwaltete Runtime.

Volant hat für jedes Programm von ansible-core einen Befehl, und das Installationsskript kann die Namen ansible-* mit ihnen verlinken. Ansible-Befehlsnamen sagt, welche in Volant laufen und welche das eigene Werkzeug von ansible-core aus der verwalteten Runtime starten.

Ein Playbook, das nur aus command, shell, raw und Modulen besteht, die auf dem Controller laufen, und gather_facts: false setzt, braucht überhaupt kein Python.

Führen Sie den Installationsbefehl erneut aus. Er installiert das neueste Release neben den vorhandenen und richtet die Links darauf aus. Ältere Releases bleiben unter ~/.local/share/volant, sodass Sie mit VOLANT_VERSION einfach zurückwechseln können.

Terminal-Fenster
# Only pre-releases exist so far, so name the version.
cargo binstall volant@0.1.0-alpha.10

Das lädt ein Release-Binary samt Agents herunter. Auf einem glibc-Host ist es der glibc-Build, unter Alpine der statische Build.

Entfernen Sie das Release-Verzeichnis, die Links und die Caches des Controllers. Auf jedem Host ist der Agent-Cache ein Verzeichnis pro Konto, als das der Lauf gehandelt hat. Sonst ändert sich in Ihrem Projekt nichts, daher braucht die Rückkehr zu ansible-playbook nichts weiter:

Terminal-Fenster
volant runtime remove --all
volant shims remove
rm -rf ~/.local/share/volant ~/.local/bin/volant ~/.local/bin/volant-playbook ~/.cache/volant
ssh web1 'rm -rf ~/.ansible/tmp/volant-*'