Hyperlift CLI kullanarak Hyperlift'e nasıl bağlanılır

Hyperlift CLI, terminal üzerinden Spaceship platformundaki Hyperlift uygulamalarını yönetmek için kullanılan bir komut satırı aracıdır. 

Araç, burada bulunan açık kaynaklı bir projedir. Spaceship External API ile iletişim kurar ve bir API anahtarı ile gizli anahtar kullanarak kimlik doğrulaması yapar. Bunun yardımıyla şunları yapabilirsiniz:

• Uygulamayı görüntüleyin ve yönetin;

• Uygulamayı derleyin, başlatın, durdurun ve yeniden başlatın;

• Çalışma zamanı ve derleme günlüklerini görüntüleyin;

• Uygulama metriklerini görüntüleyin;

• Ortam değişkenlerini yönetin;

• Betik oluşturma ve otomasyon için JSON çıktısını kullanın;

• CLI'yi güncel tutun.

CLI, Spaceship External API ile iletişim kurar ve kimlik doğrulama için bir Spaceship API anahtarı ile gizli anahtar kullanır. Bu nedenle, CLI dahili hizmetlere doğrudan eriştiğinden, dahili ve yönetimsel bilgiler gizli tutulur.

Bu makalede şunları ele alacağız:

1. Hyperlift CLI nasıl kurulur

2. API kimlik bilgileri nasıl oluşturulur

3. CLI'da nasıl oturum açılır

4. Hyperlift uygulaması CLI üzerinden nasıl yönetilir

   
   

1. Hyperlift CLI'ı kurun

Hyperlift CLI, macOS, Windows ve Linux'a kurulabilir. İşletim sisteminize bağlı olarak kurulum komutunu çalıştırın. Betik, işletim sisteminizi ve mimarinizi otomatik olarak algılar, uygun sürümü indirir, doğrular ve hyperlift komutunu kurar.

macOS

Homebrew kullanıyorsanız, şunu çalıştırın:

brew install nccloud/tap/hyperlift

Windows

Scoop kullanıyorsanız, şunu çalıştırın:

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

scoop install hyperlift

Linux veya macOS

Kurulum betiğini de kullanabilirsiniz:

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

Manuel kurulum

Alternatif olarak, işletim sisteminiz için arşivi Hyperlift CLI Releases page sayfasından indirin, arşivi çıkarın ve hyperliftçalıştırılabilir dosyasını sisteminizin PATH değişkenine ekleyin.

2. API kimlik bilgileri oluşturun

Hyperlift CLI, isteklerinizin kimliğini doğrulamak için bir Spaceship API anahtarı ve gizli anahtarı kullanır.

API kimlik bilgileri oluşturmak için:

1. Spaceship hesabınızda oturum açın.

2. API Manager bölümünü açın.

3. Yeni bir anahtar oluşturmak için + New API key düğmesine tıklayın:
   
   

   

   
   

4. Anahtarı adlandırın ve gerçekleştirmek istediğiniz işlemler için gereken izinleri seçin:
   
   

   

   
   

5. Custom access düzeyini seçerseniz, Hyperlift için üç erişim seçeneği vardır:
   

   

Yalnızca Read kapsamına sahip bir anahtar, yalnızca uygulamalarınızı, günlüklerinizi veya metriklerinizi görüntülemeniz gerekiyorsa yeterlidir. Uygulama yönetimi ve ortam değişkenleri için ek kapsamlar gereklidir.

6. Oluşturulan API anahtarını ve gizli anahtarı kopyalayın ve ayrıntıları kaydedin.

Önemli: API gizli anahtarı, kimlik bilgilerini oluşturduğunuzda yalnızca bir kez görüntülenir. Güvenli bir şekilde kaydettiğinizden emin olun.

Done seçeneğine tıklayın:

7. Oluşturulan anahtar API Manager menüsü altında listelenecektir:

3. Hyperlift CLI'da oturum açın

CLI'ı kurup API kimlik bilgilerinizi oluşturduktan sonra şunu çalıştırın:

hyperlift auth login

CLI sizden API anahtarınızı ve gizli anahtarınızı girmenizi isteyecektir.

Kimlik doğrulama başarılı olduktan sonra API anahtarı Hyperlift yapılandırma dosyasında saklanır; API gizli anahtarı ise mevcut olduğunda işletim sisteminizin anahtarlığında güvenli bir şekilde saklanır.

Oturum durumunuzu kontrol etmek için şunu çalıştırın:

hyperlift auth whoami

Oturumu kapatmak ve saklanan kimlik bilgilerinizi kaldırmak için şunu çalıştırın:

hyperlift auth logout

İpucu: "Not logged in" mesajını alırsanız, hyperlift auth login komutunu yeniden çalıştırın. 403 hatası alırsanız, API anahtarınızda gerekli kapsam eksik olabilir. 

Etkileşimsiz kimlik doğrulama

Bir betikten kimlik doğrulaması yapmanız gerekiyorsa, kimlik bilgilerini komut satırı seçeneklerini kullanarak sağlayabilirsiniz:

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

Ancak, --secret kullanmak gizli anahtarı komut satırı bağımsız değişkeni olarak açığa çıkarır. Daha iyi güvenlik için gizli anahtarı standart girdi üzerinden iletebilirsiniz:

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

4. Bir Hyperlift uygulamasını yönetmek için temel komutlar

Hyperlift uygulamalarınızı görüntülemek ve yönetmek için apps komutlarını kullanın.

Uygulamaları görüntüleyin

Hyperlift uygulamalarınızı görüntülemek ve yönetmek için appskomutlarını kullanın.

Bir uygulama derleyin

Bir uygulamayı derlemeye başlamak için şunu çalıştırın:

hyperlift apps build <app-id>

Varsayılan olarak komut, API derleme isteğini kabul ettikten sonra döner.

CLI'ın derleme tamamlanana kadar beklemesini istiyorsanız, --wait seçeneğini ekleyin:

hyperlift apps build <app-id> --wait

CLI'ın ne kadar beklemesi gerektiğini de belirtebilirsiniz:

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

Varsayılan zaman aşımı 10 dakikadır.

Bir uygulamayı başlatın, durdurun veya yeniden başlatın

Uygulama durumunu yönetmek için aşağıdaki komutları kullanın:

Varsayılan olarak, bu komutlar API isteği kabul ettikten sonra döner. CLI'nin işlem tamamlanana kadar beklemesini istiyorsanız --wait ekleyin.

Örneğin:

hyperlift apps restart <app-id> --wait

Uygulama günlüklerini görüntüleyin

Hem çalışma zamanı hem de derleme günlüklerini görüntülemek için logs komutunu kullanabilirsiniz.

Not:--follow seçeneği, yeni günlük girdilerini düzenli aralıklarla kontrol eder. Canlı akış bağlantısı kurmaz.

Uygulama metriklerini görüntüleyin

Uygulamanızın kaynak kullanımını izlemek için metrics komutunu kullanın. Kullanılabilir metrikler şunlardır:

• Bellek kullanımı;

• CPU kullanımı;

• Ağ alma hızı;

• Ağ gönderim hızı;

• Geçici depolama kullanımı;

• Kalıcı depolama kullanımı.

Ortam değişkenlerini yönetin

Ortam değişkenlerini görüntülemek, eklemek, güncellemek ve kaldırmak için envkomutlarını kullanabilirsiniz.

Önemli: Ortam değişkenlerini güncellemek uygulamayı yeniden başlatır. Başka bir ortam değişkeni değişikliği yapmadan önce uygulama yeniden çalışır duruma gelene kadar bekleyin.

Hyperlift, uygulamanın hangi bağlantı noktasında kullanılabilir olduğunu belirlemek için APPLICATION_PORT ortam değişkenini kullanır. Varsayılan değeri 8080'dir.

Komut çıktısını özelleştirin 

Varsayılan olarak, Hyperlift CLI komutları bilgileri insan tarafından okunabilir bir biçimde gösterir.

Çıktıyı betiklerde veya diğer araçlarda kullanmanız gerekiyorsa, aşağıdaki seçenekleri kullanabilirsiniz.

Not:--json ve --quiet seçenekleri birlikte kullanılamaz.

Hyperlift CLI'ı güncelleyin

Komut bazında yardım alın

Her Hyperlift CLI komutunun kendi yardım bilgisi vardır.

Yardım çıktısı, seçilen komut için kullanılabilir seçenekleri ve bağımsız değişkenleri içerir.

En güncel komut listesi ve teknik ayrıntılar için Hyperlift CLI repository sayfasına bakın.