Hogyan csatlakozzon a Hyperlifthez a Hyperlift CLI használatával

Hyperlift CLI egy parancssori eszköz a Hyperlift alkalmazások kezelésére a Spaceship platformon terminálon keresztül. 

Az eszköz nyílt forráskódú itt. A Spaceship External API-val kommunikál, és API-kulccsal valamint titkos kulccsal hitelesít. A segítségével a következőket teheti:

• Az alkalmazás megtekintése és kezelése;

• Az alkalmazás buildelése, indítása, leállítása és újraindítása;

• Futásidejű és buildnaplók megtekintése;

• Alkalmazásmetrikák megtekintése;

• Környezeti változók kezelése;

• JSON-kimenet használata szkripteléshez és automatizáláshoz;

• Tartsa naprakészen a CLI-t.

A CLI a Spaceship External API-val kommunikál, és a hitelesítéshez Spaceship API-kulcsot és titkos kulcsot használ. Ezért a belső és adminisztratív információk rejtve maradnak, mivel a CLI közvetlenül fér hozzá a belső szolgáltatásokhoz.

Ebben a cikkben a következőket tárgyaljuk:

1. A Hyperlift CLI telepítése

2. API-hitelesítő adatok létrehozása

3. Bejelentkezés a CLI-be

4. Hyperlift alkalmazás kezelése CLI-n keresztül

   
   

1. A Hyperlift CLI telepítése

A Hyperlift CLI telepíthető macOS, Windows és Linux rendszeren. Az operációs rendszertől függően futtassa a telepítési parancsot. A szkript automatikusan felismeri az operációs rendszert és az architektúrát, letölti a megfelelő kiadást, ellenőrzi azt, és telepíti a hyperlift parancsot.

macOS

Ha Homebrew-t használ, futtassa a következőt:

brew install nccloud/tap/hyperlift

Windows

Ha Scoopot használ, futtassa a következőt:

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

scoop install hyperlift

Linux vagy macOS

Használhatja a telepítőszkriptet is:

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

Kézi telepítés

Alternatívaként töltse le az operációs rendszerének megfelelő archívumot a Hyperlift CLI Releases page oldalról, csomagolja ki, majd adja hozzá a hyperlift futtatható fájlt a rendszer PATH változójához.

2. API-hitelesítő adatok létrehozása

A Hyperlift CLI Spaceship API-kulcsot és titkos kulcsot használ a kérések hitelesítéséhez.

API-hitelesítő adatok létrehozásához:

1. Jelentkezzen be a Spaceship-fiókjába.

2. Nyissa meg az API Manager oldalt.

3. Kattintson a + New API key gombra új kulcs létrehozásához:
   
   

   

   
   

4. Nevezze el a kulcsot, és válassza ki az elvégezni kívánt műveletekhez szükséges jogosultságokat:
   
   

   

   
   

5. Ha a Custom access hozzáférési szintet választja, a Hyperlift számára három hozzáférési lehetőség áll rendelkezésre:
   

   

Csak Olvasás hatókörrel rendelkező kulcs elegendő, ha csak az alkalmazásait, naplóit vagy metrikáit szeretné megtekinteni. További hatókörök szükségesek az alkalmazáskezeléshez és a környezeti változókhoz.

6. Másolja ki a létrehozott API-kulcsot és a titkos kulcsot, majd mentse el az adatokat.

Fontos: Az API-titok csak egyszer jelenik meg a hitelesítő adatok létrehozásakor. Ügyeljen arra, hogy biztonságosan mentse el.

Kattintson a Done gombra:

7. A létrehozott kulcs megjelenik az API Manager menüben:

3. Bejelentkezés a Hyperlift CLI-be

A CLI telepítése és az API-hitelesítő adatok létrehozása után futtassa a következőt:

hyperlift auth login

A CLI kérni fogja az API-kulcs és a titkos kulcs megadását.

Sikeres hitelesítés után az API-kulcs a Hyperlift konfigurációs fájljában tárolódik, míg az API-titok biztonságosan az operációs rendszer kulcstartójában kerül tárolásra, ha az elérhető.

A bejelentkezési állapot ellenőrzéséhez futtassa a következőt:

hyperlift auth whoami

A kijelentkezéshez és a tárolt hitelesítő adatok eltávolításához futtassa a következőt:

hyperlift auth logout

Tipp: Ha "Not logged in" üzenetet kap, futtassa újra a hyperlift auth login parancsot. Ha 403-as hibát kap, előfordulhat, hogy az API-kulcsából hiányzik a szükséges hatókör. 

Nem interaktív hitelesítés

Ha szkriptből kell hitelesítenie, a hitelesítő adatokat parancssori opciókkal is megadhatja:

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

A --secret használata azonban a titkot parancssori argumentumként teszi láthatóvá. A nagyobb biztonság érdekében a titkot a szabványos bemeneten keresztül is átadhatja:

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

4. Alapvető parancsok egy Hyperlift alkalmazás kezeléséhez

Az apps parancsokkal megtekintheti és kezelheti Hyperlift alkalmazásait.

Alkalmazások megtekintése

Az appsparancsokkal megtekintheti és kezelheti Hyperlift alkalmazásait.

Alkalmazás buildelése

Egy alkalmazás buildelésének elindításához futtassa a következőt:

hyperlift apps build <app-id>

Alapértelmezés szerint a parancs azután tér vissza, hogy az API elfogadta a buildkérést.

Ha azt szeretné, hogy a CLI megvárja a build befejezését, adja hozzá a --wait opciót:

hyperlift apps build <app-id> --wait

Azt is megadhatja, hogy a CLI mennyi ideig várjon:

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

Az alapértelmezett időkorlát 10 perc.

Alkalmazás indítása, leállítása vagy újraindítása

Az alkalmazás állapotának kezeléséhez használja a következő parancsokat:

Alapértelmezés szerint ezek a parancsok azután térnek vissza, hogy az API elfogadta a kérést. Adja hozzá a --wait kapcsolót, ha azt szeretné, hogy a CLI megvárja a művelet befejezését.

Például:

hyperlift apps restart <app-id> --wait

Alkalmazásnaplók megtekintése

A logs paranccsal megtekintheti a futásidejű és a buildnaplókat is.

Megjegyzés: A --follow opció rendszeresen ellenőrzi az új naplóbejegyzéseket. Nem hoz létre élő streamkapcsolatot.

Alkalmazásmetrikák megtekintése

A metrics paranccsal figyelheti alkalmazása erőforrás-használatát. Az elérhető metrikák a következők:

• Memóriahasználat;

• CPU-használat;

• Hálózati fogadási sebesség;

• Hálózati küldési sebesség;

• Ideiglenes tárhelyhasználat;

• Állandó tárhelyhasználat.

Környezeti változók kezelése

Az envparancsokkal megtekintheti, hozzáadhatja, frissítheti és eltávolíthatja a környezeti változókat.

Fontos: A környezeti változók frissítése újraindítja az alkalmazást. Várja meg, amíg az alkalmazás újra fut, mielőtt újabb környezeti változót módosítana.

A Hyperlift az APPLICATION_PORT környezeti változót használja annak meghatározására, hogy melyik porton érhető el az alkalmazás. Az alapértelmezett értéke 8080.

Parancskimenet testreszabása 

Alapértelmezés szerint a Hyperlift CLI parancsai ember által olvasható formátumban jelenítik meg az információkat.

Ha a kimenetet szkriptekben vagy más eszközökben szeretné használni, a következő opciókat használhatja.

Megjegyzés: A --json és a --quiet opciók nem használhatók együtt.

A Hyperlift CLI frissítése

Segítség parancsonként

Minden Hyperlift CLI parancshoz saját súgóinformáció tartozik.

A súgó kimenete tartalmazza a kiválasztott parancshoz elérhető opciókat és argumentumokat.

A legfrissebb parancslistáért és technikai részletekért lásd a Hyperlift CLI repository oldalt.