IronFlock CLI

ironflock ist das Befehlszeilenwerkzeug für die IronFlock-Software auf einer Maschine. Sie verbinden damit eine Linux-Maschine als Gerät mit IronFlock, schreiben IronFlockOS auf einen USB-Stick, eine SD-Karte oder eine Festplatte, ersetzen das Linux einer laufenden Maschine durch IronFlockOS, aktualisieren IronFlockOS-Geräte, rollen sie zurück oder setzen sie zurück, und installieren und betreuen eine IronFlock-Appliance.

ironflock ist eine statische Binärdatei pro Plattform. Es braucht keine Laufzeitumgebung und kein weiteres Paket. Installieren Sie es unter Linux oder macOS mit einer Zeile:


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

Das Skript prüft den Download gegen den Release-Schlüssel von IronFlock, bevor es /usr/local/bin/ironflock installiert. Später bringt sudo ironflock self-update es auf das neueste Release. Installation erklärt jeden Schritt, wie Sie das Skript vorher prüfen und wie Sie aktualisieren.

Die Befehle sind nach Produkt gruppiert: ironflock agent für den Geräte-Agenten, ironflock appliance für die IronFlock-Appliance, ironflock os für IronFlockOS. Ein Verb bedeutet in jeder Gruppe dasselbe. Befehle, die die Maschine als Ganzes betreffen, etwa ironflock status, haben keine Gruppe. ironflock --help listet die Befehle auf, und ironflock <command> --help beschreibt einen davon.

Befehle nach Aufgabe

Aufgabe	Befehl	Referenz
Eine Linux-Maschine als Gerät einer Gerätekonfigurationsdatei (`.flock`) mit IronFlock verbinden	`ironflock agent install`	Befehle für den Geräte-Agenten
Dem installierten Agenten eine andere `.flock`-Datei oder andere Proxy-Einstellungen geben	`ironflock agent configure`	Befehle für den Geräte-Agenten
Den Agenten sich selbst auf das Release seines Kanals aktualisieren lassen	`ironflock agent update`	Befehle für den Geräte-Agenten
Den Agenten entfernen und rückgängig machen, was seine Installation geändert hat	`ironflock agent remove`	Befehle für den Geräte-Agenten
Den Geräte-Agenten neu starten	`ironflock agent restart`	Befehle für den Geräte-Agenten
Den Geräte-Agenten stoppen, bis er wieder gestartet wird	`ironflock agent stop`	Befehle für den Geräte-Agenten
Den Geräte-Agenten starten	`ironflock agent start`	Befehle für den Geräte-Agenten
Das Log des Geräte-Agenten lesen	`ironflock agent logs`	Befehle für den Geräte-Agenten
Sehen, was von IronFlock auf einer Maschine vorhanden ist und ob es läuft	`ironflock status`	Status & Doctor
Prüfen, ob eine Maschine den Geräte-Agenten ausführen und IronFlock erreichen kann	`ironflock doctor`	Status & Doctor
Die IronFlockOS-Images auflisten, die sich auf ein Laufwerk schreiben lassen	`ironflock os images`	IronFlockOS auf ein Laufwerk schreiben
Die Laufwerke auflisten, auf die sich ein Image schreiben lässt	`ironflock os drives`	IronFlockOS auf ein Laufwerk schreiben
IronFlockOS und die `.flock`-Datei eines Geräts auf ein Laufwerk oder in eine Image-Datei schreiben	`ironflock os flash`	IronFlockOS auf ein Laufwerk schreiben
Das Linux einer laufenden Maschine durch IronFlockOS ersetzen	`ironflock os install`	Linux durch IronFlockOS ersetzen
Ein IronFlockOS-Gerät auf das Release seines Kanals aktualisieren	`ironflock os update`	Update, Rollback & Zurücksetzen
Zum IronFlockOS-System im anderen Slot zurückkehren	`ironflock os rollback`	Update, Rollback & Zurücksetzen
Ein IronFlockOS-Gerät auf den Zustand eines frisch geschriebenen zurücksetzen	`ironflock os reset`	Update, Rollback & Zurücksetzen
Eine IronFlock-Appliance auf dieser Maschine installieren, konfigurieren, aktualisieren und betreuen	`ironflock appliance`	Befehle für die Appliance
Die Version von `ironflock` anzeigen und ob ein neueres Release erschienen ist	`ironflock version`, `ironflock version --check`	Installation
`ironflock` durch das neueste Release ersetzen	`ironflock self-update`	Installation
Befehlszeilen mit der Tab-Taste vervollständigen	`ironflock completion`	Installation
Einen Befehl über SSH auf einer anderen Maschine ausführen, oder auf vielen	`--host`, `--hosts`	Entfernte Maschinen über SSH

Jeder Befehl akzeptiert die globalen Flags. Dazu gehören --yes, das die Frage des Befehls beantwortet, und --json, das das Ergebnis als ein JSON-Objekt schreibt, das ein Programm lesen kann.


# ironflock installieren und diese Linux-Maschine als Gerät von device.flock verbinden, in einer Zeile
curl -fsSL https://instance-registry.ironflock.com/dl/cli/install.sh | sudo bash -s -- agent install -c device.flock
 
# Prüfen, ob diese Maschine den Geräte-Agenten ausführen und die Hosts von device.flock erreichen kann
ironflock doctor -c device.flock
 
# IronFlockOS für das Gerät von device.flock auf das Laufwerk /dev/sdb schreiben
sudo ironflock os flash -c device.flock -d /dev/sdb
 
# Den Plan anzeigen, nach dem das Linux dieser Maschine durch IronFlockOS ersetzt wird, ohne etwas zu ändern
sudo ironflock os install -c device.flock --dry-run
 
# Den Zustand eines Geräts von Ihrem Laptop aus über SSH anzeigen
ironflock --host pi@device-17 status

Systeme

Das Release veröffentlicht ironflock für Linux auf amd64, arm64 und 32-Bit-ARM (v5 bis v7) sowie für macOS auf Apple Silicon und Intel.

Befehle	Linux	macOS
`version`, `completion`	ja	ja
`self-update`	ja; auf einem IronFlockOS-Gerät Exit-Code 3, da dort `os update` `ironflock` aktualisiert	ja
`status`, `doctor`	ja	ja; `status` zeigt das System und dass nichts installiert ist
`os images`, `os drives`, `os flash`	ja	ja
`agent ...`, `os install`	ja	Exit-Code 3
`os update`, `os rollback`, `os reset`	nur auf einem IronFlockOS-Gerät	Exit-Code 3

Ein Befehl, der auf einem System nicht läuft, ist trotzdem vorhanden: Er endet mit Exit-Code 3, bevor er sich irgendetwas ansieht. Die agent-Befehle brauchen ein Linux auf Basis von Debian oder Ubuntu mit systemd. os install braucht ein Linux mit systemd auf 64-Bit-UEFI-Firmware (amd64 oder arm64). Die appliance-Befehle beschreibt Befehle für die Appliance.

Auf einem IronFlockOS-Gerät bringt das Image den Geräte-Agenten mit seinem System mit. agent install und agent remove lehnen dort deshalb mit Exit-Code 3 ab, und agent configure -c gibt dem Gerät eine andere .flock-Datei.

Mit --host läuft jeder Befehl außer completion über SSH auf einer anderen Linux-Maschine. Von einem Mac aus führen Sie so die agent-Befehle, os install und die Befehle eines IronFlockOS-Geräts aus.

IronFlockOS-Releases nach 0.15.0 bringen ironflock auf dem Gerät mit, als /usr/bin/ironflock. IronFlockOS 0.15.0 und älter nicht: Führen Sie die Befehle des Geräts von einem anderen Computer aus mit --host aus, als SSH-Benutzer des Geräts (SSH-Zugriff):


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

Hinweis: Die Meldungen und JSON-Felder des Befehls sagen swarm für das, was IronFlock Studio und diese Dokumentation ein Projekt nennen, und „swarm owner“ für den Projekteigentümer. So nennt etwa das Feld agent.swarm von ironflock status --json das Projekt des Geräts.

In diesem Abschnitt

Installation: die Installationszeile, die Prüfung des Skripts, die Download-Basis und der Spiegel einer Appliance, die Tab-Vervollständigung, ironflock version und ironflock self-update.
Flags, Ausgabe & Exit-Codes: die globalen Flags, stdout und JSON, Fragen, root, Secrets und Exit-Codes, die für jeden Befehl gelten.
Entfernte Maschinen über SSH: --host für eine Maschine, --hosts und --parallel für viele.
Befehle für den Geräte-Agenten: den Geräte-Agenten installieren, konfigurieren, aktualisieren, entfernen, neu starten, stoppen und starten und sein Log lesen.
Status & Doctor: was von IronFlock auf einer Maschine läuft und ob die Maschine den Geräte-Agenten ausführen kann.
IronFlockOS auf ein Laufwerk schreiben: die Images und Laufwerke auflisten und IronFlockOS mit der .flock-Datei eines Geräts schreiben.
Linux durch IronFlockOS ersetzen: eine laufende Linux-Maschine in ein IronFlockOS-Gerät umwandeln.
Update, Rollback & Zurücksetzen: ein IronFlockOS-Gerät aktuell halten, zum vorherigen Release zurückkehren oder es zurücksetzen.
Befehle für die Appliance: eine IronFlock-Appliance auf einer Maschine installieren, konfigurieren, aktualisieren und betreuen.