Cara terhubung ke Hyperlift menggunakan Hyperlift CLI

Hyperlift CLI adalah alat baris perintah untuk mengelola aplikasi Hyperlift di platform Spaceship melalui terminal. 

Alat ini bersifat open source di sini. Alat ini berkomunikasi dengan Spaceship External API dan melakukan autentikasi dengan kunci dan secret API. Dengan bantuannya, Anda dapat melakukan hal berikut:

• Lihat dan kelola aplikasi;

• Build, mulai, hentikan, dan mulai ulang aplikasi;

• Lihat log runtime dan build;

• Lihat metrik aplikasi;

• Kelola variabel lingkungan;

• Gunakan output JSON untuk scripting dan otomatisasi;

• Pastikan CLI selalu diperbarui.

CLI berkomunikasi dengan Spaceship External API dan menggunakan kunci serta rahasia API Spaceship untuk autentikasi. Oleh karena itu, informasi internal dan administratif tetap tersembunyi, karena CLI mengakses layanan internal secara langsung.

Dalam artikel ini, kami akan membahas:

1. Cara menginstal Hyperlift CLI;

2. Cara membuat kredensial API;

3. Cara login ke CLI;

4. Cara mengelola aplikasi Hyperlift melalui CLI;

5. Cara melihat log dan metrik;

6. Cara mengelola variabel lingkungan;

7. Cara memperbarui CLI.

1. Instal Hyperlift CLI

Hyperlift CLI dapat diinstal di macOS, Windows, dan Linux. Bergantung pada OS Anda, jalankan perintah instalasi. Skrip secara otomatis mendeteksi sistem operasi dan arsitektur Anda, mengunduh rilis yang sesuai, memverifikasinya, dan menginstal perintah hyperlift.

macOS

Jika Anda menggunakan Homebrew, jalankan:

brew install nccloud/tap/hyperlift

Windows

Jika Anda menggunakan Scoop, jalankan:

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

scoop install hyperlift

Linux atau macOS

Anda juga dapat menggunakan skrip instalasi:

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

Instalasi manual

Sebagai alternatif, unduh arsip untuk sistem operasi Anda dari halaman Rilis Hyperlift CLI, ekstrak, lalu tambahkan executable hyperliftke PATH sistem Anda.

2. Buat kredensial API

Hyperlift CLI menggunakan kunci dan secret API Spaceship untuk mengautentikasi permintaan Anda.

Untuk membuat kredensial API:

1. Login ke akun Spaceship Anda.

2. Buka API Manager.

3. Klik tombol + New API key untuk membuat kunci baru:
   
   

   

   
   

4. Beri nama pada kunci dan pilih izin yang diperlukan untuk tindakan yang ingin Anda lakukan:
   
   

   

   
   

5. Jika Anda memilih tingkat akses Custom access, ada tiga opsi akses untuk Hyperlift:
   

   

Kunci yang hanya memiliki cakupan Read sudah cukup jika Anda hanya perlu melihat aplikasi, log, atau metrik Anda. Cakupan tambahan diperlukan untuk pengelolaan aplikasi dan variabel lingkungan.

6. Salin kunci API dan secret yang telah dibuat, lalu simpan detailnya.

Penting: Secret API hanya ditampilkan satu kali saat Anda membuat kredensial. Pastikan untuk menyimpannya dengan aman.

Klik Done:

7. Kunci yang dibuat akan tercantum di bawah menu API Manager:

3. Login ke Hyperlift CLI

Setelah menginstal CLI dan membuat kredensial API Anda, jalankan:

hyperlift auth login

CLI akan meminta Anda memasukkan kunci dan secret API Anda.

Setelah autentikasi berhasil, kunci API disimpan dalam file konfigurasi Hyperlift, sedangkan secret API disimpan dengan aman di keyring sistem operasi Anda jika tersedia.

Untuk memeriksa status login Anda, jalankan:

hyperlift auth whoami

Untuk logout dan menghapus kredensial yang tersimpan, jalankan:

hyperlift auth logout

Tip: Jika Anda menerima pesan "Not logged in", jalankan hyperlift auth login lagi. Jika Anda menerima error 403, kunci API Anda mungkin tidak memiliki cakupan yang diperlukan. 

Autentikasi non-interaktif

Jika Anda perlu melakukan autentikasi dari skrip, Anda dapat memberikan kredensial menggunakan opsi baris perintah:

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

Namun, penggunaan --secret mengekspos secret sebagai argumen baris perintah. Untuk keamanan yang lebih baik, Anda dapat meneruskan secret melalui input standar:

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

4. Perintah dasar untuk mengelola aplikasi Hyperlift

Gunakan perintah apps untuk melihat dan mengelola aplikasi Hyperlift Anda.

Lihat aplikasi

Gunakan perintah appsuntuk melihat dan mengelola aplikasi Hyperlift Anda.

Build aplikasi

Untuk mulai membangun aplikasi, jalankan:

hyperlift apps build <app-id>

Secara default, perintah akan kembali setelah API menerima permintaan build.

Jika Anda ingin CLI menunggu hingga build selesai, tambahkan opsi --wait:

hyperlift apps build <app-id> --wait

Anda juga dapat menentukan berapa lama CLI harus menunggu:

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

Batas waktu default adalah 10 menit.

Mulai, hentikan, atau mulai ulang aplikasi

Gunakan perintah berikut untuk mengelola status aplikasi:

Secara default, perintah-perintah ini akan kembali setelah API menerima permintaan. Tambahkan --wait jika Anda ingin CLI menunggu hingga operasi selesai.

Contohnya:

hyperlift apps restart <app-id> --wait

Lihat log aplikasi

Anda dapat menggunakan perintah logs untuk melihat log runtime dan log build.

Catatan: Opsi --follow secara berkala memeriksa entri log baru. Opsi ini tidak membuat koneksi streaming langsung.

Lihat metrik aplikasi

Gunakan perintah metrics untuk memantau penggunaan sumber daya aplikasi Anda. Metrik yang tersedia meliputi:

• Penggunaan memori;

• Penggunaan CPU;

• Laju penerimaan jaringan;

• Laju transmisi jaringan;

• Penggunaan penyimpanan ephemeral;

• Penggunaan penyimpanan persisten.

Kelola variabel lingkungan

Anda dapat menggunakan perintah envuntuk melihat, menambahkan, memperbarui, dan menghapus variabel lingkungan.

Penting: Memperbarui variabel lingkungan akan memulai ulang aplikasi. Tunggu hingga aplikasi berjalan kembali sebelum membuat perubahan variabel lingkungan lainnya.

Hyperlift menggunakan variabel lingkungan APPLICATION_PORT untuk menentukan port tempat aplikasi tersedia. Nilai default-nya adalah 8080.

Sesuaikan output perintah 

Secara default, perintah Hyperlift CLI menampilkan informasi dalam format yang mudah dibaca manusia.

Jika Anda perlu menggunakan output dalam skrip atau alat lain, Anda dapat menggunakan opsi berikut.

Catatan: Opsi --json dan --quiet tidak dapat digunakan bersamaan.

Perbarui Hyperlift CLI

Dapatkan bantuan per perintah

Setiap perintah Hyperlift CLI memiliki informasi bantuannya sendiri.

Output bantuan mencakup opsi dan argumen yang tersedia untuk perintah yang dipilih.

Untuk daftar perintah terbaru dan detail teknis, lihat repositori Hyperlift CLI.