Jak se připojit k Hyperlift pomocí Hyperlift CLI

Hyperlift CLI je nástroj příkazového řádku pro správu aplikací Hyperlift na platformě Spaceship prostřednictvím terminálu. 

Nástroj je open source zde. Komunikuje s Spaceship External API a ověřuje se pomocí API klíče a tajného klíče. S jeho pomocí můžete provádět následující:

• Zobrazit a spravovat aplikaci;

• Sestavit, spustit, zastavit a restartovat aplikaci;

• Zobrazit běhové protokoly a protokoly sestavení;

• Zobrazit metriky aplikace;

• Spravovat proměnné prostředí;

• Používat výstup JSON pro skriptování a automatizaci;

• Udržujte CLI aktuální.

CLI komunikuje se Spaceship External API a pro ověřování používá klíč a tajný klíč Spaceship API. Interní a administrativní informace jsou proto skryté, protože CLI přistupuje přímo k interním službám.

V tomto článku se budeme věnovat:

1. Jak nainstalovat Hyperlift CLI;

2. Jak vytvořit API přihlašovací údaje;

3. Jak se přihlásit do CLI;

4. Jak spravovat aplikaci Hyperlift pomocí CLI;

5. Jak zobrazit protokoly a metriky;

6. Jak spravovat proměnné prostředí;

7. Jak aktualizovat CLI.

1. Instalace Hyperlift CLI

Hyperlift CLI lze nainstalovat na macOS, Windows a Linux. V závislosti na vašem operačním systému spusťte instalační příkaz. Skript automaticky rozpozná váš operační systém a architekturu, stáhne příslušné vydání, ověří jej a nainstaluje příkaz hyperlift.

macOS

Pokud používáte Homebrew, spusťte:

brew install nccloud/tap/hyperlift

Windows

Pokud používáte Scoop, spusťte:

scoop bucket add nccloud https://github.com/NCCloud/scoop-bucket

scoop install hyperlift

Linux nebo macOS

Můžete také použít instalační skript:

curl -fsSL https://raw.githubusercontent.com/NCCloud/hyperlift-cli/main/scripts/install.sh | sh

Ruční instalace

Případně si stáhněte archiv pro svůj operační systém ze stránkyHyperlift CLI Releases page, rozbalte jej a přidejte spustitelný soubor hyperliftdo systémové proměnné PATH.

2. Vytvoření API přihlašovacích údajů

Hyperlift CLI používá k ověření vašich požadavků API klíč a tajný klíč Spaceship.

Postup vytvoření API přihlašovacích údajů:

1. Přihlaste se ke svému účtu Spaceship.

2. Otevřete API Manager.

3. Kliknutím na tlačítko + New API key vytvořte nový klíč:
   
   

   

   
   

4. Pojmenujte klíč a vyberte oprávnění požadovaná pro akce, které chcete provádět:
   
   

   

   
   

5. Pokud vyberete úroveň přístupu Custom access, jsou pro Hyperlift k dispozici tři možnosti přístupu:
   

   

Klíč pouze s rozsahem Read je dostačující, pokud potřebujete pouze zobrazovat své aplikace, protokoly nebo metriky. Pro správu aplikací a proměnných prostředí jsou vyžadovány další rozsahy.

6. Zkopírujte vytvořený API klíč a tajný klíč a uložte si tyto údaje.

Důležité: Tajný klíč API se při vytváření přihlašovacích údajů zobrazí pouze jednou. Ujistěte se, že jej bezpečně uložíte.

Klikněte na Done:

7. Vytvořený klíč bude uveden v nabídce API Manager:

3. Přihlášení do Hyperlift CLI

Po instalaci CLI a vytvoření API přihlašovacích údajů spusťte:

hyperlift auth login

CLI vás vyzve k zadání API klíče a tajného klíče.

Po úspěšném ověření se API klíč uloží do konfiguračního souboru Hyperlift, zatímco tajný klíč API se bezpečně uloží do klíčenky vašeho operačního systému, pokud je k dispozici.

Chcete-li zkontrolovat stav přihlášení, spusťte:

hyperlift auth whoami

Chcete-li se odhlásit a odstranit uložené přihlašovací údaje, spusťte:

hyperlift auth logout

Tip: Pokud se zobrazí zpráva „Not logged in“, spusťte znovu hyperlift auth login. Pokud se zobrazí chyba 403, vašemu API klíči může chybět požadovaný rozsah. 

Neinteraktivní ověřování

Pokud potřebujete ověřování ze skriptu, můžete přihlašovací údaje zadat pomocí voleb příkazového řádku:

hyperlift auth login --key "$KEY" --secret "$SECRET"

Použití volby --secret však vystaví tajný klíč jako argument příkazového řádku. Pro lepší zabezpečení můžete tajný klíč předat přes standardní vstup:

printf '%s' "$SECRET" | hyperlift auth login --key "$KEY" --with-stdin

4. Základní příkazy pro správu aplikace Hyperlift

Pomocí příkazů apps můžete zobrazovat a spravovat své aplikace Hyperlift.

Zobrazit aplikace

Pomocí příkazů appsmůžete zobrazovat a spravovat své aplikace Hyperlift.

Sestavení aplikace

Chcete-li zahájit sestavení aplikace, spusťte:

hyperlift apps build <app-id>

Ve výchozím nastavení se příkaz vrátí poté, co API přijme požadavek na sestavení.

Pokud chcete, aby CLI čekalo, dokud nebude sestavení dokončeno, přidejte možnost --wait:

hyperlift apps build <app-id> --wait

Můžete také určit, jak dlouho má CLI čekat:

hyperlift apps build <app-id> --wait --timeout 15m

Výchozí časový limit je 10 minut.

Spusťte, zastavte nebo restartujte aplikaci

Ke správě stavu aplikace použijte následující příkazy:

Ve výchozím nastavení se tyto příkazy vrátí poté, co API přijme požadavek. Pokud chcete, aby CLI čekalo, dokud nebude operace dokončena, přidejte --wait.

Například:

hyperlift apps restart <app-id> --wait

Zobrazit protokoly aplikace

Pomocí příkazu logs můžete zobrazit jak protokoly běhu, tak protokoly sestavení.

Poznámka: Volba --follow pravidelně kontroluje nové záznamy protokolu. Nenavazuje živé streamovací připojení.

Zobrazit metriky aplikace

Pomocí příkazu metrics můžete sledovat využití prostředků vaší aplikace. Dostupné metriky zahrnují:

• Využití paměti;

• Využití CPU;

• Rychlost příjmu sítě;

• Rychlost odesílání sítě;

• Využití dočasného úložiště;

• Využití trvalého úložiště.

Správa proměnných prostředí

Pomocí příkazů envmůžete zobrazovat, přidávat, aktualizovat a odebírat proměnné prostředí.

Důležité: Aktualizace proměnných prostředí restartuje aplikaci. Před provedením další změny proměnné prostředí počkejte, dokud aplikace znovu nepoběží.

Hyperlift používá proměnnou prostředí APPLICATION_PORT k určení portu, na kterém je aplikace dostupná. Její výchozí hodnota je 8080.

Přizpůsobení výstupu příkazu 

Ve výchozím nastavení příkazy Hyperlift CLI zobrazují informace v člověkem čitelném formátu.

Pokud potřebujete výstup použít ve skriptech nebo jiných nástrojích, můžete použít následující možnosti.

Poznámka: Možnosti --json a --quiet nelze použít společně.

Aktualizace Hyperlift CLI

Získání nápovědy pro jednotlivé příkazy

Každý příkaz Hyperlift CLI má vlastní informace nápovědy.

Výstup nápovědy obsahuje dostupné možnosti a argumenty pro vybraný příkaz.

Nejnovější seznam příkazů a technické podrobnosti najdete vrepozitáři Hyperlift CLI.