Как да се свържете с Hyperlift чрез Hyperlift CLI

Hyperlift CLI е инструмент за команден ред за управление на Hyperlift приложения в платформата Spaceship чрез терминала. 

Инструментът е с отворен код тук. Той комуникира с Spaceship External API и се удостоверява с API ключ и тайна. С негова помощ можете да правите следното:

• Преглед и управление на приложението;

• Компилиране, стартиране, спиране и рестартиране на приложението;

• Преглед на логовете за изпълнение и компилация;

• Преглед на метриките на приложението;

• Управление на променливите на средата;

• Използване на JSON изход за скриптове и автоматизация;

• Поддържайте CLI актуален.

CLI комуникира с Spaceship External API и използва API ключ и тайна на Spaceship за удостоверяване. Следователно вътрешната и административната информация остава скрита, тъй като CLI осъществява директен достъп до вътрешните услуги.

В тази статия ще разгледаме:

1. Как да инсталирате Hyperlift CLI

2. Как да създадете API идентификационни данни

3. Как да влезете в CLI

4. Как да управлявате Hyperlift приложение чрез CLI

   
   

1. Инсталирайте Hyperlift CLI

Hyperlift CLI може да бъде инсталиран на macOS, Windows и Linux. В зависимост от вашата ОС изпълнете командата за инсталиране. Скриптът автоматично открива вашата операционна система и архитектура, изтегля подходящото издание, проверява го и инсталира командата hyperlift.

macOS

Ако използвате Homebrew, изпълнете:

brew install nccloud/tap/hyperlift

Windows

Ако използвате Scoop, изпълнете:

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

scoop install hyperlift

Linux или macOS

Можете също да използвате инсталационния скрипт:

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

Ръчна инсталация

Като алтернатива изтеглете архива за вашата операционна система отстраницата Hyperlift CLI Releases, разархивирайте го и добавете изпълнимия файл hyperliftкъм PATH на вашата система.

2. Създайте API идентификационни данни

Hyperlift CLI използва API ключ и тайна на Spaceship, за да удостоверява вашите заявки.

За да създадете API идентификационни данни:

1. Влезте в своя Spaceship акаунт.

2. Отворете API Manager.

3. Щракнете върху бутона + New API key, за да създадете нов ключ:
   
   

   

   
   

4. Дайте име на ключа и изберете разрешенията, необходими за действията, които искате да извършвате:
   
   

   

   
   

5. Ако изберете нивото на достъп Custom access, има три опции за достъп за Hyperlift:
   

   

Ключ с обхват само Read е достатъчен, ако трябва само да преглеждате своите приложения, логове или метрики. За управление на приложения и променливи на средата са необходими допълнителни обхвати.

6. Копирайте създадения API ключ и тайната и запазете данните.

Важно: Тайната на API се показва само веднъж, когато създавате идентификационните данни. Уверете се, че я запазвате сигурно.

Щракнете върху Done:

7. Създаденият ключ ще бъде показан в менюто API Manager:

3. Влезте в Hyperlift CLI

След като инсталирате CLI и създадете своите API идентификационни данни, изпълнете:

hyperlift auth login

CLI ще ви помоли да въведете своя API ключ и тайна.

След успешно удостоверяване API ключът се съхранява в конфигурационния файл на Hyperlift, а тайната на API се съхранява сигурно в keyring-а на вашата операционна система, когато е наличен.

За да проверите състоянието на влизането си, изпълнете:

hyperlift auth whoami

За да излезете и да премахнете съхранените си идентификационни данни, изпълнете:

hyperlift auth logout

Съвет: Ако получите съобщение "Not logged in", изпълнете hyperlift auth login отново. Ако получите грешка 403, на вашия API ключ може да му липсва необходимият обхват. 

Неинтерактивно удостоверяване

Ако трябва да се удостоверите от скрипт, можете да предоставите идентификационните данни чрез опции на командния ред:

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

Въпреки това използването на --secret излага тайната като аргумент на командния ред. За по-добра сигурност можете да подадете тайната чрез стандартния вход:

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

4. Основни команди за управление на Hyperlift приложение

Използвайте командите apps, за да преглеждате и управлявате своите Hyperlift приложения.

Преглед на приложения

Използвайте командите apps, за да преглеждате и управлявате своите Hyperlift приложения.

Компилиране на приложение

За да започнете компилирането на приложение, изпълнете:

hyperlift apps build <app-id>

По подразбиране командата връща резултат, след като API приеме заявката за компилация.

Ако искате CLI да изчака, докато компилацията завърши, добавете опцията --wait:

hyperlift apps build <app-id> --wait

Можете също така да посочите колко дълго CLI да изчаква:

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

Времето за изчакване по подразбиране е 10 минути.

Стартиране, спиране или рестартиране на приложение

Използвайте следните команди, за да управлявате състоянието на приложението:

По подразбиране тези команди връщат резултат, след като API приеме заявката. Добавете --wait, ако искате CLI да изчака, докато операцията бъде завършена.

Например:

hyperlift apps restart <app-id> --wait

Преглед на логовете на приложението

Можете да използвате командата logs, за да преглеждате както логовете по време на изпълнение, така и логовете от компилация.

Забележка: Опцията --follow периодично проверява за нови записи в логовете. Тя не установява връзка за поточно предаване в реално време.

Преглед на метриките на приложението

Използвайте командата metrics, за да наблюдавате използването на ресурсите на вашето приложение. Наличните метрики включват:

• Използване на паметта;

• Използване на CPU;

• Скорост на получаване по мрежата;

• Скорост на предаване по мрежата;

• Използване на временно хранилище;

• Използване на постоянно хранилище.

Управление на променливите на средата

Можете да използвате командите envза преглед, добавяне, актуализиране и премахване на променливи на средата.

Важно: Актуализирането на променливите на средата рестартира приложението. Изчакайте, докато приложението отново започне да работи, преди да правите друга промяна на променлива на средата.

Hyperlift използва променливата на средата APPLICATION_PORT, за да определи порта, на който приложението е достъпно. Нейната стойност по подразбиране е 8080.

Персонализиране на изхода на командите 

По подразбиране командите на Hyperlift CLI показват информация в удобен за четене от човек формат.

Ако трябва да използвате изхода в скриптове или други инструменти, можете да използвате следните опции.

Забележка: Опциите --json и --quiet не могат да се използват заедно.

Актуализиране на Hyperlift CLI

Получаване на помощ за всяка команда

Всяка команда на Hyperlift CLI има собствена помощна информация.

Изходът на помощта включва наличните опции и аргументи за избраната команда.

За най-новия списък с команди и технически подробности вижтехранилището на Hyperlift CLI.