Aller au contenu
Installer

Installation

Installez Volant en une commande, vérifiez ce dont le contrôleur et les hôtes ont besoin, et gardez-le à jour.

Fenêtre de terminal
curl -fsSL https://volant.sh/install.sh | sh

Le script fonctionne sous Linux et macOS, en x86_64 et en arm64. Sous Linux, il prend le build statique. Il a besoin de curl, tar et sha256sum ou shasum, plus xz sous Linux. Il télécharge la dernière version pour votre machine, vérifie sa somme de contrôle SHA-256, la décompresse sous ~/.local/share/volant et lie volant et volant-playbook dans ~/.local/bin. Le script ne demande aucun accès root et n’écrit rien en dehors de ces deux répertoires. Ce que Volant écrit ensuite, quand il s’exécute, est listé dans Ce que Volant laisse sur vos machines. Vous pouvez lire le script avant de le lancer. Windows n’est pas encore pris en charge : un contrôleur Windows figure sur la feuille de route.

Vous n’avez pas besoin d’avoir Ansible installé. À la première exécution qui a besoin de Python, Volant télécharge sa propre copie de Python et d’ansible-core, environ 155 MB, et la garde dans ~/.local/share/volant/runtime. Il affiche une ligne quand il le fait. Ce que Volant laisse sur vos machines liste tout ce qu’il écrit.

Vérifiez que tout a fonctionné :

Fenêtre de terminal
volant --version

Si votre shell ne trouve pas volant, ajoutez ~/.local/bin à votre PATH. Le script affiche la ligne à ajouter quand elle manque.

Le script lit quatre variables d’environnement et prend une option, --shims, qui fait ce que fait VOLANT_SHIMS=1 :

Variable Valeur par défaut Ce qu’elle change
VOLANT_VERSION la dernière version La version à installer, par exemple v0.1.0-alpha.10.
VOLANT_HOME ~/.local/share/volant L’endroit où les versions sont décompressées.
VOLANT_BIN_DIR ~/.local/bin L’endroit où vont les liens volant et volant-playbook.
VOLANT_SHIMS non défini À 1, lie aussi les noms ansible-*. Voir ci-dessous.
Fenêtre de terminal
curl -fsSL https://volant.sh/install.sh | VOLANT_VERSION=v0.1.0-alpha.10 sh

Avec --shims, le script lie aussi les neuf noms de programmes d’ansible-core à volant, pour que vos lignes de commande existantes continuent de fonctionner : ansible, ansible-config, ansible-console, ansible-doc, ansible-galaxy, ansible-inventory, ansible-playbook, ansible-pull et ansible-vault.

Fenêtre de terminal
curl -fsSL https://volant.sh/install.sh | sh -s -- --shims
curl -fsSL https://volant.sh/install.sh | VOLANT_SHIMS=1 sh

Les noms des commandes ansible liste ce que chaque nom lance et ce qui diffère. Le script ne les installe jamais par défaut. Il lance volant shims install, qui laisse intact un fichier ou un lien qu’il n’a pas créé et signale quand un vrai Ansible du PATH est masqué ou passe encore en premier. Si un nom n’a pas pu être lié, le script affiche some ansible-* names were not linked, see above et sort quand même avec 0, parce que Volant est installé.

L’action setup-volant installe Volant dans un workflow. Elle lance le script d’installation ci-dessus, donc vérifie la même somme SHA-256, et ajoute le répertoire du lien volant au PATH des étapes suivantes. Elle fonctionne sur les runners Linux et macOS.

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: prend une branche, une étiquette ou un commit du dépôt volant. L’action est présente dans chaque version publiée après 0.1.0-alpha.13. Épinglez aussi version, pour qu’une nouvelle version ne change pas ce que lance le workflow.

Entrée Par défaut Effet
version la version la plus récente La version à installer, par exemple v0.1.0-alpha.13.
shims false Lie aussi les noms ansible-*, comme --shims.
runtime false Installe le runtime géré dans cette étape plutôt qu’à la première exécution qui en a besoin.
collections vide Collections à installer dans le runtime, comme avec volant runtime install --collections : des noms avec un :version facultatif, ou un fichier requirements, séparés par des espaces ou des retours à la ligne.
python vide Définit VOLANT_PYTHON. Les exécutions utilisent alors cet interpréteur et n’installent jamais le runtime.

Avec runtime ou collections, l’action met en cache le répertoire du runtime avec actions/cache. La clé du cache se compose du système et de l’architecture du runner, de la version de Volant, des collections et du contenu de tout fichier requirements parmi elles : une exécution suivante avec les mêmes entrées restaure le runtime au lieu de le télécharger.

Une version contient deux exécutables. volant embarque les agents qu’il envoie à vos hôtes. Un agent est un petit programme qui exécute vos tâches sur un hôte. Il n’y a rien d’autre à installer et rien à garder à côté :

Fichier Ce que c’est
volant Le contrôleur, la commande que vous lancez.
volant-playbook Le même contrôleur sous un nom qui rappelle ansible-playbook.
ansible, ansible-vault et les sept autres noms Des liens facultatifs vers volant, seulement avec --shims. Voir Les noms des commandes ansible.

À la première utilisation, le contrôleur écrit ses agents dans ~/.cache/volant/agents/<version>/, ou sous $XDG_CACHE_HOME quand elle est définie : l’agent de votre propre machine, utilisé par ansible_connection=local, et ceux qu’il envoie aux hôtes Linux x86_64 et arm64. Les exécutions suivantes les réutilisent, et une copie qui ne correspond pas à l’agent intégré au contrôleur est réécrite.

Chaque version propose une archive par plateforme. Linux a un build statique et un build glibc. macOS a un seul build, qui lie les bibliothèques du système.

Plateforme Archive Édition de liens Minimum Nécessaire à côté
Linux x86_64, statique volant-x86_64-unknown-linux-musl.tar.xz Statique. Pas de libc. N’importe quel Linux client ssh, Python pour les modules Python
Linux x86_64, glibc volant-x86_64-unknown-linux-gnu.tar.xz Dynamique, glibc seulement glibc 2.17 client ssh, Python pour les modules Python
Linux arm64, statique volant-aarch64-unknown-linux-musl.tar.xz Statique. Pas de libc. N’importe quel Linux client ssh, Python pour les modules Python
Linux arm64, glibc volant-aarch64-unknown-linux-gnu.tar.xz Dynamique, glibc seulement glibc 2.17 client ssh, Python pour les modules Python
macOS, Apple silicon volant-aarch64-apple-darwin.tar.xz Dynamique, bibliothèques système seulement macOS 11 client ssh, Python pour les modules Python
macOS, Intel volant-x86_64-apple-darwin.tar.xz Dynamique, bibliothèques système seulement macOS 10.12 client ssh, Python pour les modules Python

Les deux builds Linux exécutent le même code et embarquent les mêmes agents. Le build statique fonctionne sur toute distribution, y compris Alpine et un conteneur sans libc. Le build glibc exige glibc 2.17 ou plus récent, ce qui couvre Debian 8, Ubuntu 14.04, RHEL et CentOS 7 et tout ce qui a suivi, et il profite des mises à jour de sécurité de la libc du système.

Le script d’installation prend toujours le build statique sous Linux. volant-installer.sh prend le build glibc sur glibc 2.17 ou plus récent, et le build statique sur tout autre Linux. cargo binstall prend le build glibc sur tout hôte glibc et le build statique sur Alpine. Sur un hôte glibc plus ancien que 2.17, téléchargez l’archive statique à la main.

Le build statique n’a besoin de rien dans l’image : il fonctionne donc dans un conteneur construit FROM scratch :

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

Une image scratch n’a ni ssh, ni Python, ni shell, ni /etc/passwd. Avec le seul contrôleur dedans, un playbook peut s’exécuter avec connection: local et utiliser command avec argv. Les connexions SSH demandent un client ssh dans l’image, les modules Python et la collecte des facts demandent Python, et shell et raw demandent un shell. Le contrôleur garde l’agent qu’il extrait sous ~/.cache/volant, ou sous $XDG_CACHE_HOME quand elle est définie : donnez-lui un répertoire où il peut écrire.

  • Linux ou macOS.
  • Le client OpenSSH dans votre PATH. Volant lance lui-même ssh, donc votre ~/.ssh/config s’applique.
  • curl ou wget, et tar, la première fois qu’un playbook a besoin de Python.
  • Pour utiliser le script d’installation ou décompresser une version à la main, curl, tar, sha256sum ou shasum, et xz sous Linux.

Pour les modules qui s’exécutent en Python, Volant utilise un Python 3 avec ansible-core. S’il n’en trouve aucun, il télécharge le sien (environ 155 MB), vérifie chaque fichier par rapport à une empreinte fixée et le garde sous ~/.local/share/volant/runtime. Une exécution qui le fait affiche une ligne. Si vous avez déjà un tel Python, Volant peut l’utiliser : Quel interpréteur une exécution utilise donne l’ordre. Voir Le runtime géré.

Volant a une commande pour chaque programme d’ansible-core, et le script d’installation peut lier les noms ansible-* à ces commandes. Les noms des commandes ansible dit lesquelles s’exécutent dans Volant et lesquelles lancent l’outil propre d’ansible-core depuis le runtime géré.

Un playbook composé uniquement de command, shell, raw et de modules côté contrôleur, avec gather_facts: false, n’a besoin d’aucun Python.

Relancez la commande d’installation. Elle installe la dernière version à côté de celles que vous avez et fait pointer les liens vers elle. Les anciennes versions restent sous ~/.local/share/volant, donc revenir en arrière revient à définir VOLANT_VERSION.

Fenêtre de terminal
# Only pre-releases exist so far, so name the version.
cargo binstall volant@0.1.0-alpha.10

Cela télécharge un binaire de version avec ses agents inclus. Sur un hôte glibc, c’est le build glibc, sur Alpine le build statique.

Supprimez le répertoire des versions, les liens et les caches du contrôleur. Sur chaque hôte, le cache de l’agent est un répertoire par compte sous lequel l’exécution a agi. Rien d’autre ne change dans votre projet, donc revenir à ansible-playbook ne demande rien de plus :

Fenêtre de terminal
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-*'