IronFlock CLI

ironflock est l’outil en ligne de commande du logiciel IronFlock sur une machine. Il vous sert à connecter une machine Linux à IronFlock en tant qu’appareil, à écrire IronFlockOS sur une clé USB, une carte SD ou un disque, à remplacer le Linux d’une machine en fonctionnement par IronFlockOS, à mettre à jour, ramener à la version précédente et réinitialiser des appareils IronFlockOS, ainsi qu’à installer et entretenir une IronFlock Appliance.

ironflock est un binaire statique unique par plateforme. Il n’a besoin ni d’environnement d’exécution ni d’aucun autre paquet. Installez-le sous Linux ou macOS en une ligne :

curl -fsSL https://instance-registry.ironflock.com/dl/cli/install.sh | sudo bash

Le script vérifie le téléchargement avec la clé de publication d’IronFlock avant d’installer /usr/local/bin/ironflock. Par la suite, sudo ironflock self-update l’amène à la version la plus récente. Installation explique chaque étape, comment vérifier d’abord le script et comment faire une mise à jour.

Les commandes sont regroupées par produit : ironflock agent pour l’agent de l’appareil, ironflock appliance pour l’IronFlock Appliance, ironflock os pour IronFlockOS. Un verbe a le même sens dans chaque groupe. Les commandes qui concernent la machine dans son ensemble, comme ironflock status, n’ont pas de groupe. ironflock --help liste les commandes, et ironflock <command> --help en décrit une.

Commandes par tâche

Chaque commande accepte les options globales. Parmi elles, --yes répond à la question de la commande, et --json écrit le résultat sous la forme d’un seul objet JSON, destiné à être lu par un programme.

# Installer ironflock et connecter cette machine Linux comme l'appareil de device.flock, en une ligne
curl -fsSL https://instance-registry.ironflock.com/dl/cli/install.sh | sudo bash -s -- agent install -c device.flock
 
# Vérifier si cette machine peut exécuter l'agent de l'appareil et joindre les hôtes de device.flock
ironflock doctor -c device.flock
 
# Écrire IronFlockOS pour l'appareil de device.flock sur le lecteur /dev/sdb
sudo ironflock os flash -c device.flock -d /dev/sdb
 
# Afficher le plan du remplacement du Linux de cette machine par IronFlockOS, sans rien modifier
sudo ironflock os install -c device.flock --dry-run
 
# Afficher l'état d'un appareil depuis votre ordinateur portable, via SSH
ironflock --host pi@device-17 status

Systèmes

Chaque version publie ironflock pour Linux sur amd64, arm64 et ARM 32 bits (v5 à v7), et pour macOS sur Apple silicon et Intel.

Une commande qui ne s’exécute pas sur un système y existe tout de même : elle se termine avec le code de sortie 3 avant d’examiner quoi que ce soit. Les commandes agent nécessitent un Linux basé sur Debian ou Ubuntu avec systemd. os install nécessite un Linux avec systemd sur un firmware UEFI 64 bits (amd64 ou arm64). Les commandes appliance sont décrites dans Commandes de l’appliance.

Sur un appareil IronFlockOS, l’image apporte l’agent de l’appareil avec son système. agent install et agent remove y refusent donc de s’exécuter, avec le code de sortie 3, et agent configure -c donne à l’appareil un autre fichier .flock.

Avec --host, toutes les commandes sauf completion s’exécutent sur une autre machine Linux via SSH. Depuis un Mac, c’est ainsi que vous exécutez les commandes agent, os install et les commandes d’un appareil IronFlockOS.

Les versions d’IronFlockOS postérieures à 0.15.0 embarquent ironflock sur l’appareil, sous /usr/bin/ironflock. IronFlockOS 0.15.0 et les versions antérieures ne l’embarquent pas : exécutez les commandes de l’appareil depuis un autre ordinateur avec --host, sous l’utilisateur SSH de l’appareil (Accès SSH) :

ironflock --host operator@kitchen-pc os update --reboot --yes

Note : Les messages et les champs JSON de la commande disent swarm pour ce qu’IronFlock Studio et cette documentation appellent un projet, et « swarm owner » pour le propriétaire du projet. Par exemple, le champ agent.swarm de ironflock status --json indique le projet de l’appareil.

Dans cette section

• Installation : la ligne d’installation, la vérification du script, la base de téléchargement et le miroir d’une appliance, la complétion par tabulation, ironflock version et ironflock self-update.
• Options, sortie et codes de sortie : les options globales, stdout et JSON, les questions, root, les secrets et les codes de sortie, qui valent pour chaque commande.
• Machines distantes via SSH : --host pour une machine, --hosts et --parallel pour plusieurs.
• Commandes de l’agent de l’appareil : installer, configurer, mettre à jour, supprimer, redémarrer, arrêter et démarrer l’agent de l’appareil, et lire son journal.
• Status et Doctor : ce qui, d’IronFlock, s’exécute sur une machine, et si la machine peut exécuter l’agent de l’appareil.
• Écrire IronFlockOS sur un lecteur : lister les images et les lecteurs, et écrire IronFlockOS avec le fichier .flock d’un appareil.
• Remplacer Linux par IronFlockOS : transformer une machine Linux en fonctionnement en appareil IronFlockOS.
• Mise à jour, retour arrière et réinitialisation : maintenir un appareil IronFlockOS à jour, revenir à la version précédente ou réinitialiser l’appareil.
• Commandes de l’appliance : installer, configurer, mettre à jour et entretenir une IronFlock Appliance sur une machine.