IronFlock CLI

ironflock è lo strumento a riga di comando per il software IronFlock su una macchina. Lo usi per collegare una macchina Linux a IronFlock come dispositivo, per scrivere IronFlockOS su una chiavetta USB, una scheda SD o un disco, per sostituire il Linux di una macchina in funzione con IronFlockOS, per eseguire aggiornamento, rollback e reset dei dispositivi IronFlockOS e per installare e gestire un IronFlock Appliance.

ironflock è un unico binario statico per piattaforma. Non richiede alcun runtime né altri pacchetti. Lo installi su Linux o macOS con una sola riga:


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

Prima di installare /usr/local/bin/ironflock, lo script verifica il download con la chiave di release di IronFlock. In seguito, sudo ironflock self-update lo porta alla release più recente. Installazione spiega ogni passo, come verificare prima lo script e come aggiornare.

I comandi sono raggruppati per prodotto: ironflock agent per l’agente del dispositivo, ironflock appliance per l’IronFlock Appliance, ironflock os per IronFlockOS. Un verbo ha lo stesso significato in ogni gruppo. I comandi che riguardano la macchina nel suo insieme, come ironflock status, non hanno un gruppo. ironflock --help elenca i comandi e ironflock <command> --help ne descrive uno.

Comandi per attività

Attività	Comando	Riferimento
Collegare una macchina Linux a IronFlock come il dispositivo definito in un file di configurazione del dispositivo (`.flock`)	`ironflock agent install`	Comandi dell’agente del dispositivo
Dare all’agente installato un altro file `.flock` o altre impostazioni del proxy	`ironflock agent configure`	Comandi dell’agente del dispositivo
Far aggiornare l’agente da solo alla release del suo canale	`ironflock agent update`	Comandi dell’agente del dispositivo
Rimuovere l’agente e annullare ciò che la sua installazione ha modificato	`ironflock agent remove`	Comandi dell’agente del dispositivo
Riavviare l’agente del dispositivo	`ironflock agent restart`	Comandi dell’agente del dispositivo
Arrestare l’agente del dispositivo finché non viene avviato di nuovo	`ironflock agent stop`	Comandi dell’agente del dispositivo
Avviare l’agente del dispositivo	`ironflock agent start`	Comandi dell’agente del dispositivo
Leggere il log dell’agente del dispositivo	`ironflock agent logs`	Comandi dell’agente del dispositivo
Vedere cosa c’è di IronFlock su una macchina e se è in esecuzione	`ironflock status`	Status e Doctor
Verificare se una macchina può eseguire l’agente del dispositivo e raggiungere IronFlock	`ironflock doctor`	Status e Doctor
Elencare le immagini IronFlockOS che si possono scrivere su un’unità	`ironflock os images`	Scrivere IronFlockOS su un’unità
Elencare le unità su cui si può scrivere un’immagine	`ironflock os drives`	Scrivere IronFlockOS su un’unità
Scrivere IronFlockOS e il file `.flock` di un dispositivo su un’unità o in un file immagine	`ironflock os flash`	Scrivere IronFlockOS su un’unità
Sostituire il Linux di una macchina in funzione con IronFlockOS	`ironflock os install`	Sostituire Linux con IronFlockOS
Aggiornare un dispositivo IronFlockOS alla release del suo canale	`ironflock os update`	Aggiornamento, rollback e reset
Tornare al sistema IronFlockOS nell’altro slot	`ironflock os rollback`	Aggiornamento, rollback e reset
Riportare un dispositivo IronFlockOS allo stato di un dispositivo appena scritto	`ironflock os reset`	Aggiornamento, rollback e reset
Installare, configurare, aggiornare e gestire un IronFlock Appliance su questa macchina	`ironflock appliance`	Comandi dell’Appliance
Mostrare la versione di `ironflock` e se è uscita una release più recente	`ironflock version`, `ironflock version --check`	Installazione
Sostituire `ironflock` con la release più recente	`ironflock self-update`	Installazione
Completare le righe di comando con il tasto Tab	`ironflock completion`	Installazione
Eseguire un comando su un’altra macchina via SSH, o su molte	`--host`, `--hosts`	Macchine remote via SSH

Ogni comando accetta i flag globali. Tra questi ci sono --yes, che risponde alla domanda del comando, e --json, che scrive il risultato come un unico oggetto JSON da far leggere a un programma.


# Installa ironflock e collega questa macchina Linux come il dispositivo di device.flock, in una sola riga
curl -fsSL https://instance-registry.ironflock.com/dl/cli/install.sh | sudo bash -s -- agent install -c device.flock
 
# Verifica se questa macchina può eseguire l'agente del dispositivo e raggiungere gli host di device.flock
ironflock doctor -c device.flock
 
# Scrivi IronFlockOS per il dispositivo di device.flock sull'unità /dev/sdb
sudo ironflock os flash -c device.flock -d /dev/sdb
 
# Mostra il piano per sostituire il Linux di questa macchina con IronFlockOS, senza modificare nulla
sudo ironflock os install -c device.flock --dry-run
 
# Mostra lo stato di un dispositivo dal tuo laptop, via SSH
ironflock --host pi@device-17 status

Sistemi

La release pubblica ironflock per Linux su amd64, arm64 e ARM a 32 bit (da v5 a v7) e per macOS su Apple silicon e Intel.

Comandi	Linux	macOS
`version`, `completion`	sì	sì
`self-update`	sì; su un dispositivo IronFlockOS codice di uscita 3, perché lì `os update` aggiorna `ironflock`	sì
`status`, `doctor`	sì	sì; `status` mostra il sistema e che non è installato nulla
`os images`, `os drives`, `os flash`	sì	sì
`agent ...`, `os install`	sì	codice di uscita 3
`os update`, `os rollback`, `os reset`	solo su un dispositivo IronFlockOS	codice di uscita 3

Un comando che non funziona su un sistema esiste comunque: termina con il codice di uscita 3 prima di esaminare qualsiasi cosa. I comandi agent richiedono un Linux basato su Debian o Ubuntu con systemd. os install richiede un Linux con systemd su firmware UEFI a 64 bit (amd64 o arm64). I comandi appliance sono descritti in Comandi dell’Appliance.

Su un dispositivo IronFlockOS l’immagine porta con sé l’agente del dispositivo insieme al sistema. Per questo lì agent install e agent remove rifiutano con il codice di uscita 3, mentre agent configure -c assegna al dispositivo un altro file .flock.

Con --host, ogni comando tranne completion viene eseguito su un’altra macchina Linux via SSH. Da un Mac esegui in questo modo i comandi agent, os install e i comandi di un dispositivo IronFlockOS.

Le release di IronFlockOS successive alla 0.15.0 portano ironflock sul dispositivo, come /usr/bin/ironflock. IronFlockOS 0.15.0 e le versioni precedenti non lo hanno: esegui i comandi del dispositivo da un altro computer con --host, come utente SSH del dispositivo (Accesso SSH):


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

Nota: I messaggi e i campi JSON del comando dicono swarm per ciò che IronFlock Studio e questa documentazione chiamano progetto, e «swarm owner» per il proprietario del progetto. Ad esempio, il campo agent.swarm di ironflock status --json indica il progetto del dispositivo.

In questa sezione

Installazione: la riga di installazione, la verifica dello script, la base di download e il mirror di un Appliance, il completamento con Tab, ironflock version e ironflock self-update.
Flag, output e codici di uscita: i flag globali, stdout e JSON, le domande, root, i segreti e i codici di uscita, validi per ogni comando.
Macchine remote via SSH: --host per una macchina, --hosts e --parallel per molte.
Comandi dell’agente del dispositivo: installare, configurare, aggiornare, rimuovere, riavviare, arrestare e avviare l’agente del dispositivo e leggerne il log.
Status e Doctor: cosa di IronFlock è in esecuzione su una macchina e se la macchina può eseguire l’agente del dispositivo.
Scrivere IronFlockOS su un’unità: elencare le immagini e le unità e scrivere IronFlockOS con il file .flock di un dispositivo.
Sostituire Linux con IronFlockOS: trasformare una macchina Linux in funzione in un dispositivo IronFlockOS.
Aggiornamento, rollback e reset: mantenere aggiornato un dispositivo IronFlockOS, tornare a una release precedente o resettarlo.
Comandi dell’Appliance: installare, configurare, aggiornare e gestire un IronFlock Appliance su una macchina.