Skip to Content

IronFlock CLI

ironflock to narzędzie wiersza poleceń do obsługi oprogramowania IronFlock na maszynie. Za jego pomocą podłączasz maszynę z Linuksem do IronFlock jako urządzenie, zapisujesz IronFlockOS na pendrivie USB, karcie SD lub dysku, zastępujesz Linuksa działającej maszyny systemem IronFlockOS, na urządzeniach z IronFlockOS instalujesz aktualizacje, wycofujesz je i przeprowadzasz reset, a także instalujesz IronFlock Appliance i dbasz o niego.

ironflock to jeden statyczny plik binarny dla każdej platformy. Nie potrzebuje środowiska uruchomieniowego ani żadnego innego pakietu. W systemie Linux lub macOS instalujesz go jednym poleceniem:

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

Skrypt sprawdza pobrany plik kluczem wydań IronFlock, zanim zainstaluje /usr/local/bin/ironflock. Później sudo ironflock self-update aktualizuje go do najnowszego wydania. Strona Instalacja objaśnia każdy krok, wcześniejszą weryfikację skryptu i aktualizację.

Polecenia są pogrupowane według produktu: ironflock agent dla agenta urządzenia, ironflock appliance dla IronFlock Appliance, ironflock os dla IronFlockOS. Czasownik znaczy to samo w każdej grupie. Polecenia dotyczące całej maszyny, takie jak ironflock status, nie należą do żadnej grupy. ironflock --help wyświetla listę poleceń, a ironflock <command> --help opisuje jedno z nich.

Polecenia według zadań

ZadaniePolecenieDokumentacja
Podłączenie maszyny z Linuksem do IronFlock jako urządzenia z pliku konfiguracji urządzenia (.flock)ironflock agent installPolecenia agenta urządzenia
Przekazanie zainstalowanemu agentowi innego pliku .flock lub innych ustawień proxyironflock agent configurePolecenia agenta urządzenia
Samoaktualizacja agenta do wydania z jego kanałuironflock agent updatePolecenia agenta urządzenia
Usunięcie agenta i cofnięcie zmian wprowadzonych przy jego instalacjiironflock agent removePolecenia agenta urządzenia
Restart agenta urządzeniaironflock agent restartPolecenia agenta urządzenia
Zatrzymanie agenta urządzenia do czasu ponownego uruchomieniaironflock agent stopPolecenia agenta urządzenia
Uruchomienie agenta urządzeniaironflock agent startPolecenia agenta urządzenia
Odczyt logu agenta urządzeniaironflock agent logsPolecenia agenta urządzenia
Sprawdzenie, co z IronFlock jest na maszynie i czy działaironflock statusStatus i Doctor
Sprawdzenie, czy maszyna może uruchomić agenta urządzenia i połączyć się z IronFlockironflock doctorStatus i Doctor
Lista obrazów IronFlockOS, które można zapisać na nośnikuironflock os imagesZapis IronFlockOS na nośniku
Lista nośników, na których można zapisać obrazironflock os drivesZapis IronFlockOS na nośniku
Zapis IronFlockOS i pliku .flock urządzenia na nośniku lub w pliku obrazuironflock os flashZapis IronFlockOS na nośniku
Zastąpienie Linuksa działającej maszyny systemem IronFlockOSironflock os installZastąpienie Linuksa systemem IronFlockOS
Aktualizacja urządzenia z IronFlockOS do wydania z jego kanałuironflock os updateAktualizacja, wycofanie i reset
Powrót do systemu IronFlockOS w drugim slocieironflock os rollbackAktualizacja, wycofanie i reset
Reset urządzenia z IronFlockOS do stanu jak po świeżym zapisieironflock os resetAktualizacja, wycofanie i reset
Instalacja, konfiguracja, aktualizacja i obsługa IronFlock Appliance na tej maszynieironflock appliancePolecenia Appliance
Wyświetlenie wersji ironflock i sprawdzenie, czy jest nowsze wydanieironflock version, ironflock version --checkInstalacja
Zastąpienie ironflock najnowszym wydaniemironflock self-updateInstalacja
Uzupełnianie wierszy poleceń klawiszem Tabironflock completionInstalacja
Uruchomienie polecenia na innej maszynie przez SSH lub na wielu maszynach--host, --hostsZdalne maszyny przez SSH

Każde polecenie przyjmuje flagi globalne. Należą do nich --yes, która odpowiada na pytanie polecenia, oraz --json, która zapisuje wynik jako jeden obiekt JSON do odczytu przez program.

# Zainstaluj ironflock i podłącz tę maszynę z Linuksem jako urządzenie z device.flock, jednym poleceniem curl -fsSL https://instance-registry.ironflock.com/dl/cli/install.sh | sudo bash -s -- agent install -c device.flock # Sprawdź, czy ta maszyna może uruchomić agenta urządzenia i połączyć się z hostami z device.flock ironflock doctor -c device.flock # Zapisz IronFlockOS dla urządzenia z device.flock na nośniku /dev/sdb sudo ironflock os flash -c device.flock -d /dev/sdb # Pokaż plan zastąpienia Linuksa tej maszyny systemem IronFlockOS, niczego nie zmieniając sudo ironflock os install -c device.flock --dry-run # Pokaż stan urządzenia ze swojego laptopa, przez SSH ironflock --host pi@device-17 status

Systemy

Wydanie publikuje ironflock dla Linuksa na amd64, arm64 i 32-bitowym ARM (v5 do v7) oraz dla macOS na Apple silicon i Intel.

PoleceniaLinuxmacOS
version, completiontaktak
self-updatetak; na urządzeniu z IronFlockOS kod wyjścia 3, ponieważ tam ironflock aktualizuje os updatetak
status, doctortaktak; status pokazuje system i to, że nic nie jest zainstalowane
os images, os drives, os flashtaktak
agent ..., os installtakkod wyjścia 3
os update, os rollback, os resettylko na urządzeniu z IronFlockOSkod wyjścia 3

Polecenie, które nie działa w danym systemie, mimo to w nim istnieje: kończy się kodem wyjścia 3, zanim cokolwiek sprawdzi. Polecenia agent wymagają Linuksa opartego na Debianie lub Ubuntu z systemd. os install wymaga Linuksa z systemd na 64-bitowym firmware UEFI (amd64 lub arm64). Polecenia appliance opisuje strona Polecenia Appliance.

Na urządzeniu z IronFlockOS obraz dostarcza agenta urządzenia razem z systemem. Dlatego agent install i agent remove odmawiają tam działania z kodem wyjścia 3, a agent configure -c przekazuje urządzeniu inny plik .flock.

Z --host każde polecenie poza completion działa na innej maszynie z Linuksem przez SSH. Z Maca uruchamiasz w ten sposób polecenia agent, os install i polecenia urządzenia z IronFlockOS.

Wydania IronFlockOS nowsze niż 0.15.0 mają ironflock na urządzeniu, jako /usr/bin/ironflock. IronFlockOS 0.15.0 i starsze go nie mają: polecenia urządzenia uruchamiaj z innego komputera z --host, jako użytkownik SSH urządzenia (Dostęp SSH):

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

Uwaga: Komunikaty i pola JSON polecenia mówią swarm na to, co IronFlock Studio i ta dokumentacja nazywają projektem, oraz „swarm owner” na właściciela projektu. Na przykład pole agent.swarm w wyniku ironflock status --json podaje projekt urządzenia.

W tej sekcji

  • Instalacja: polecenie instalacyjne, weryfikacja skryptu, bazowy adres pobierania i kopia lustrzana Appliance, uzupełnianie klawiszem Tab, ironflock version i ironflock self-update.
  • Flagi, wyjście i kody wyjścia: flagi globalne, stdout i JSON, pytania, root, sekrety i kody wyjścia, czyli zasady obowiązujące każde polecenie.
  • Zdalne maszyny przez SSH: --host dla jednej maszyny, --hosts i --parallel dla wielu.
  • Polecenia agenta urządzenia: instalacja, konfiguracja, aktualizacja, usunięcie, restart, zatrzymanie i uruchomienie agenta urządzenia oraz odczyt jego logu.
  • Status i Doctor: co z IronFlock działa na maszynie i czy maszyna może uruchomić agenta urządzenia.
  • Zapis IronFlockOS na nośniku: lista obrazów i nośników oraz zapis IronFlockOS z plikiem .flock urządzenia.
  • Zastąpienie Linuksa systemem IronFlockOS: zamiana działającej maszyny z Linuksem w urządzenie z IronFlockOS.
  • Aktualizacja, wycofanie i reset: utrzymywanie urządzenia z IronFlockOS w aktualnym stanie, powrót do poprzedniego wydania lub reset.
  • Polecenia Appliance: instalacja, konfiguracja, aktualizacja i obsługa IronFlock Appliance na maszynie.
Last updated on