IronFlock CLI

ironflock es la herramienta de línea de comandos para el software de IronFlock en una máquina. Con ella conectas una máquina Linux a IronFlock como dispositivo, escribes IronFlockOS en una memoria USB, una tarjeta SD o un disco, reemplazas por IronFlockOS el Linux de una máquina en funcionamiento, actualizas, reviertes y restableces dispositivos IronFlockOS, e instalas y mantienes un appliance de IronFlock.

ironflock es un único binario estático por plataforma. No necesita entorno de ejecución ni ningún otro paquete. Instálalo en Linux o macOS con una sola línea:


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

El script comprueba la descarga con la clave de release de IronFlock antes de instalar /usr/local/bin/ironflock. Más adelante, sudo ironflock self-update lo lleva al release más reciente. Instalación explica cada paso, cómo verificar antes el script y cómo actualizar.

Los comandos se agrupan por producto: ironflock agent para el agente del dispositivo, ironflock appliance para el appliance de IronFlock, ironflock os para IronFlockOS. Un verbo significa lo mismo en todos los grupos. Los comandos que afectan a la máquina en su conjunto, como ironflock status, no tienen grupo. ironflock --help enumera los comandos, y ironflock <command> --help describe uno.

Comandos por tarea

Tarea	Comando	Referencia
Conectar una máquina Linux a IronFlock como el dispositivo de un archivo de configuración del dispositivo (`.flock`)	`ironflock agent install`	Comandos del agente del dispositivo
Dar al agente instalado otro archivo `.flock` u otra configuración de proxy	`ironflock agent configure`	Comandos del agente del dispositivo
Hacer que el agente se actualice al release de su canal	`ironflock agent update`	Comandos del agente del dispositivo
Eliminar el agente y deshacer lo que cambió su instalación	`ironflock agent remove`	Comandos del agente del dispositivo
Reiniciar el agente del dispositivo	`ironflock agent restart`	Comandos del agente del dispositivo
Detener el agente del dispositivo hasta que se vuelva a iniciar	`ironflock agent stop`	Comandos del agente del dispositivo
Iniciar el agente del dispositivo	`ironflock agent start`	Comandos del agente del dispositivo
Leer el registro del agente del dispositivo	`ironflock agent logs`	Comandos del agente del dispositivo
Ver qué hay de IronFlock en una máquina y si se ejecuta	`ironflock status`	Status y Doctor
Comprobar si una máquina puede ejecutar el agente del dispositivo y alcanzar IronFlock	`ironflock doctor`	Status y Doctor
Listar las imágenes de IronFlockOS que se pueden escribir en una unidad	`ironflock os images`	Escribir IronFlockOS en una unidad
Listar las unidades en las que se puede escribir una imagen	`ironflock os drives`	Escribir IronFlockOS en una unidad
Escribir IronFlockOS y el archivo `.flock` de un dispositivo en una unidad o en un archivo de imagen	`ironflock os flash`	Escribir IronFlockOS en una unidad
Reemplazar por IronFlockOS el Linux de una máquina en funcionamiento	`ironflock os install`	Reemplazar Linux por IronFlockOS
Actualizar un dispositivo IronFlockOS al release de su canal	`ironflock os update`	Actualizar, revertir y restablecer
Volver al sistema IronFlockOS del otro slot	`ironflock os rollback`	Actualizar, revertir y restablecer
Restablecer un dispositivo IronFlockOS al estado de uno recién escrito	`ironflock os reset`	Actualizar, revertir y restablecer
Instalar, configurar, actualizar y mantener un appliance de IronFlock en esta máquina	`ironflock appliance`	Comandos del appliance
Mostrar la versión de `ironflock`, y si ha salido un release más reciente	`ironflock version`, `ironflock version --check`	Instalación
Reemplazar `ironflock` por el release más reciente	`ironflock self-update`	Instalación
Completar líneas de comandos con la tecla Tab	`ironflock completion`	Instalación
Ejecutar un comando en otra máquina por SSH, o en muchas	`--host`, `--hosts`	Máquinas remotas por SSH

Todos los comandos aceptan los flags globales. Entre ellos están --yes, que responde a la pregunta del comando, y --json, que escribe el resultado como un único objeto JSON para que lo lea un programa.


# Instalar ironflock y conectar esta máquina Linux como el dispositivo de device.flock, en una sola línea
curl -fsSL https://instance-registry.ironflock.com/dl/cli/install.sh | sudo bash -s -- agent install -c device.flock
 
# Comprobar si esta máquina puede ejecutar el agente del dispositivo y alcanzar los hosts de device.flock
ironflock doctor -c device.flock
 
# Escribir IronFlockOS para el dispositivo de device.flock en la unidad /dev/sdb
sudo ironflock os flash -c device.flock -d /dev/sdb
 
# Mostrar el plan para reemplazar por IronFlockOS el Linux de esta máquina, sin cambiar nada
sudo ironflock os install -c device.flock --dry-run
 
# Mostrar el estado de un dispositivo desde tu portátil, por SSH
ironflock --host pi@device-17 status

Sistemas

Cada release publica ironflock para Linux en amd64, arm64 y ARM de 32 bits (v5 a v7), y para macOS en Apple silicon e Intel.

Comandos	Linux	macOS
`version`, `completion`	sí	sí
`self-update`	sí; en un dispositivo IronFlockOS, código de salida 3, ya que allí `os update` actualiza `ironflock`	sí
`status`, `doctor`	sí	sí; `status` muestra el sistema e indica que no hay nada instalado
`os images`, `os drives`, `os flash`	sí	sí
`agent ...`, `os install`	sí	código de salida 3
`os update`, `os rollback`, `os reset`	solo en un dispositivo IronFlockOS	código de salida 3

Un comando que no se ejecuta en un sistema existe igualmente en él: termina con el código de salida 3 antes de examinar nada. Los comandos agent necesitan un Linux basado en Debian o Ubuntu con systemd. os install necesita un Linux con systemd sobre firmware UEFI de 64 bits (amd64 o arm64). Los comandos appliance se describen en Comandos del appliance.

En un dispositivo IronFlockOS, la imagen trae el agente del dispositivo con su sistema. Por eso agent install y agent remove se niegan a ejecutarse allí con el código de salida 3, y agent configure -c da al dispositivo otro archivo .flock.

Con --host, todos los comandos salvo completion se ejecutan en otra máquina Linux por SSH. Desde un Mac, así es como ejecutas los comandos agent, os install y los comandos de un dispositivo IronFlockOS.

Los releases de IronFlockOS posteriores a 0.15.0 llevan ironflock en el dispositivo, como /usr/bin/ironflock. IronFlockOS 0.15.0 y anteriores no lo llevan: ejecuta los comandos del dispositivo desde otra computadora con --host, como el usuario SSH del dispositivo (Acceso SSH):


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

Nota: Los mensajes y los campos JSON del comando dicen swarm para lo que IronFlock Studio y esta documentación llaman proyecto, y «swarm owner» para el propietario del proyecto. Por ejemplo, el campo agent.swarm de ironflock status --json indica el proyecto del dispositivo.

En esta sección

Instalación: la línea de instalación, la verificación del script, la base de descarga y la réplica de un appliance, el autocompletado con Tab, ironflock version e ironflock self-update.
Flags, salida y códigos de salida: los flags globales, stdout y JSON, las preguntas, root, los secretos y los códigos de salida, que valen para todos los comandos.
Máquinas remotas por SSH: --host para una máquina, --hosts y --parallel para muchas.
Comandos del agente del dispositivo: instalar, configurar, actualizar, eliminar, reiniciar, detener e iniciar el agente del dispositivo, y leer su registro.
Status y Doctor: qué de IronFlock se ejecuta en una máquina, y si la máquina puede ejecutar el agente del dispositivo.
Escribir IronFlockOS en una unidad: listar las imágenes y las unidades, y escribir IronFlockOS con el archivo .flock de un dispositivo.
Reemplazar Linux por IronFlockOS: convertir una máquina Linux en funcionamiento en un dispositivo IronFlockOS.
Actualizar, revertir y restablecer: mantener al día un dispositivo IronFlockOS, volver a un release anterior o restablecerlo.
Comandos del appliance: instalar, configurar, actualizar y mantener un appliance de IronFlock en una máquina.