Jak połączyć się z Hyperlift za pomocą Hyperlift CLI

Hyperlift CLI to narzędzie wiersza poleceń do zarządzania aplikacjami Hyperlift na platformie Spaceship za pośrednictwem terminala. 

Narzędzie jest open source tutaj. Komunikuje się z Spaceship External API i uwierzytelnia za pomocą klucza API oraz sekretu. Za jego pomocą możesz wykonać następujące czynności:

• Wyświetlać aplikację i zarządzać nią;

• Kompilować, uruchamiać, zatrzymywać i ponownie uruchamiać aplikację;

• Wyświetlać logi środowiska uruchomieniowego i kompilacji;

• Wyświetlać metryki aplikacji;

• Zarządzać zmiennymi środowiskowymi;

• Używać danych wyjściowych JSON do skryptów i automatyzacji;

• Aktualizuj CLI na bieżąco.

CLI komunikuje się z Spaceship External API i używa klucza API oraz sekretu Spaceship do uwierzytelniania. Dzięki temu informacje wewnętrzne i administracyjne pozostają ukryte, ponieważ CLI uzyskuje bezpośredni dostęp do usług wewnętrznych.

W tym artykule omówimy:

1. Jak zainstalować Hyperlift CLI

2. Jak utworzyć dane uwierzytelniające API

3. Jak zalogować się do CLI

4. Jak zarządzać aplikacją Hyperlift za pomocą CLI

   
   

1. Zainstaluj Hyperlift CLI

Hyperlift CLI można zainstalować w systemach macOS, Windows i Linux. W zależności od systemu operacyjnego uruchom polecenie instalacyjne. Skrypt automatycznie wykrywa system operacyjny i architekturę, pobiera odpowiednie wydanie, weryfikuje je i instaluje polecenie hyperlift.

macOS

Jeśli używasz Homebrew, uruchom:

brew install nccloud/tap/hyperlift

Windows

Jeśli używasz Scoop, uruchom:

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

scoop install hyperlift

Linux lub macOS

Możesz także użyć skryptu instalacyjnego:

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

Instalacja ręczna

Alternatywnie pobierz archiwum dla swojego systemu operacyjnego ze strony wydań Hyperlift CLI, rozpakuj je i dodaj plik wykonywalny hyperliftdo systemowej zmiennej PATH.

2. Utwórz dane uwierzytelniające API

Hyperlift CLI używa klucza API i sekretu Spaceship do uwierzytelniania Twoich żądań.

Aby utworzyć dane uwierzytelniające API:

1. Zaloguj się na swoje konto Spaceship.

2. Otwórz API Manager.

3. Kliknij przycisk + New API key, aby utworzyć nowy klucz:
   
   

   

   
   

4. Nadaj nazwę kluczowi i wybierz uprawnienia wymagane do działań, które chcesz wykonać:
   
   

   

   
   

5. Jeśli wybierzesz poziom dostępu Custom access, dla Hyperlift dostępne są trzy opcje dostępu:
   

   

Klucz tylko z zakresem Read jest wystarczający, jeśli potrzebujesz jedynie wyświetlać swoje aplikacje, logi lub metryki. Dodatkowe zakresy są wymagane do zarządzania aplikacjami i zmiennymi środowiskowymi.

6. Skopiuj utworzony klucz API i sekret oraz zapisz te dane.

Ważne: Sekret API jest wyświetlany tylko raz podczas tworzenia danych uwierzytelniających. Pamiętaj, aby zapisać go w bezpiecznym miejscu.

Kliknij Done:

7. Utworzony klucz będzie widoczny w menu API Manager:

3. Zaloguj się do Hyperlift CLI

Po zainstalowaniu CLI i utworzeniu danych uwierzytelniających API uruchom:

hyperlift auth login

CLI poprosi Cię o podanie klucza API i sekretu.

Po pomyślnym uwierzytelnieniu klucz API jest przechowywany w pliku konfiguracyjnym Hyperlift, a sekret API jest bezpiecznie przechowywany w pęku kluczy systemu operacyjnego, jeśli jest dostępny.

Aby sprawdzić status logowania, uruchom:

hyperlift auth whoami

Aby się wylogować i usunąć zapisane dane uwierzytelniające, uruchom:

hyperlift auth logout

Wskazówka: Jeśli otrzymasz komunikat "Not logged in", uruchom ponownie hyperlift auth login. Jeśli otrzymasz błąd 403, Twojemu kluczowi API może brakować wymaganego zakresu. 

Uwierzytelnianie nieinteraktywne

Jeśli potrzebujesz uwierzytelnić się ze skryptu, możesz podać dane uwierzytelniające za pomocą opcji wiersza poleceń:

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

Jednak użycie --secret ujawnia sekret jako argument wiersza poleceń. Dla lepszego bezpieczeństwa możesz przekazać sekret przez standardowe wejście:

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

4. Podstawowe polecenia do zarządzania aplikacją Hyperlift

Użyj poleceń apps do wyświetlania i zarządzania aplikacjami Hyperlift.

Wyświetlanie aplikacji

Użyj poleceń appsdo wyświetlania i zarządzania aplikacjami Hyperlift.

Kompilowanie aplikacji

Aby rozpocząć kompilowanie aplikacji, uruchom:

hyperlift apps build <app-id>

Domyślnie polecenie zwraca wynik po zaakceptowaniu żądania kompilacji przez API.

Jeśli chcesz, aby CLI czekało do zakończenia kompilacji, dodaj opcję --wait:

hyperlift apps build <app-id> --wait

Możesz także określić, jak długo CLI ma czekać:

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

Domyślny limit czasu to 10 minut.

Uruchom, zatrzymaj lub uruchom ponownie aplikację

Użyj następujących poleceń, aby zarządzać stanem aplikacji:

Domyślnie te polecenia zwracają wynik po zaakceptowaniu żądania przez API. Dodaj --wait, jeśli chcesz, aby CLI czekało do zakończenia operacji.

Na przykład:

hyperlift apps restart <app-id> --wait

Wyświetl logi aplikacji

Możesz użyć polecenia logs, aby wyświetlić zarówno logi środowiska uruchomieniowego, jak i logi kompilacji.

Uwaga: Opcja --follow okresowo sprawdza nowe wpisy logów. Nie ustanawia połączenia do transmisji na żywo.

Wyświetlanie metryk aplikacji

Użyj polecenia metrics, aby monitorować użycie zasobów swojej aplikacji. Dostępne metryki obejmują:

• Użycie pamięci;

• Użycie CPU;

• Szybkość odbioru sieciowego;

• Szybkość transmisji sieciowej;

• Użycie pamięci efemerycznej;

• Użycie pamięci trwałej.

Zarządzanie zmiennymi środowiskowymi

Możesz używać poleceń envdo wyświetlania, dodawania, aktualizowania i usuwania zmiennych środowiskowych.

Ważne: Aktualizacja zmiennych środowiskowych powoduje ponowne uruchomienie aplikacji. Poczekaj, aż aplikacja znów będzie działać, zanim wprowadzisz kolejną zmianę zmiennej środowiskowej.

Hyperlift używa zmiennej środowiskowej APPLICATION_PORT do określenia portu, na którym aplikacja jest dostępna. Jej wartość domyślna to 8080.

Dostosowywanie danych wyjściowych poleceń 

Domyślnie polecenia Hyperlift CLI wyświetlają informacje w formacie czytelnym dla człowieka.

Jeśli chcesz używać danych wyjściowych w skryptach lub innych narzędziach, możesz skorzystać z następujących opcji.

Uwaga: Opcji --json i --quiet nie można używać razem.

Aktualizacja Hyperlift CLI

Uzyskaj pomoc dla każdego polecenia

Każde polecenie Hyperlift CLI ma własne informacje pomocy.

Dane wyjściowe pomocy zawierają dostępne opcje i argumenty dla wybranego polecenia.

Aby uzyskać najnowszą listę poleceń i szczegóły techniczne, zapoznaj się z repozytorium Hyperlift CLI.