Πώς να συνδεθείτε στο Hyperlift χρησιμοποιώντας το Hyperlift CLI

Hyperlift CLI είναι ένα εργαλείο γραμμής εντολών για τη διαχείριση εφαρμογών Hyperlift στην πλατφόρμα Spaceship μέσω του τερματικού. 

Το εργαλείο είναι ανοιχτού κώδικα εδώ. Επικοινωνεί με το Spaceship External API και πραγματοποιεί έλεγχο ταυτότητας με κλειδί API και μυστικό. Με τη βοήθειά του, μπορείτε να κάνετε τα εξής:

• Προβολή και διαχείριση της εφαρμογής;

• Δημιουργία build, εκκίνηση, διακοπή και επανεκκίνηση της εφαρμογής;

• Προβολή αρχείων καταγραφής χρόνου εκτέλεσης και build;

• Προβολή μετρήσεων εφαρμογής;

• Διαχείριση μεταβλητών περιβάλλοντος;

• Χρήση εξόδου JSON για scripting και αυτοματοποίηση;

• Διατηρείτε το 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. Ανάλογα με το λειτουργικό σας σύστημα, εκτελέστε την εντολή εγκατάστασης. Το script ανιχνεύει αυτόματα το λειτουργικό σας σύστημα και την αρχιτεκτονική, κατεβάζει την κατάλληλη έκδοση, την επαληθεύει και εγκαθιστά την εντολή 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

Μπορείτε επίσης να χρησιμοποιήσετε το script εγκατάστασης:

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

Χειροκίνητη εγκατάσταση

Εναλλακτικά, κατεβάστε το αρχείο για το λειτουργικό σας σύστημα από τησελίδα Hyperlift CLI Releases, αποσυμπιέστε το και προσθέστε το εκτελέσιμο hyperliftστο PATHτου συστήματός σας.

2. Δημιουργήστε διαπιστευτήρια API

Το Hyperlift CLI χρησιμοποιεί ένα κλειδί και μυστικό Spaceship API για τον έλεγχο ταυτότητας των αιτημάτων σας.

Για να δημιουργήσετε διαπιστευτήρια 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 σας μπορεί να μην έχει την απαιτούμενη εμβέλεια. 

Μη διαδραστική ταυτοποίηση

Αν χρειάζεται να πραγματοποιήσετε ταυτοποίηση από script, μπορείτε να παρέχετε τα διαπιστευτήρια χρησιμοποιώντας επιλογές γραμμής εντολών:

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

Ωστόσο, η χρήση του --secret εκθέτει το μυστικό ως όρισμα γραμμής εντολών. Για καλύτερη ασφάλεια, μπορείτε να περάσετε το μυστικό μέσω της τυπικής εισόδου:

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

4. Βασικές εντολές για τη διαχείριση μιας εφαρμογής Hyperlift

Χρησιμοποιήστε τις εντολές apps για να προβάλετε και να διαχειριστείτε τις εφαρμογές Hyperlift σας.

Προβολή εφαρμογών

Χρησιμοποιήστε τις εντολές appsγια να προβάλετε και να διαχειριστείτε τις εφαρμογές Hyperlift σας.

Δημιουργία build εφαρμογής

Για να ξεκινήσετε τη δημιουργία build μιας εφαρμογής, εκτελέστε:

hyperlift apps build <app-id>

Από προεπιλογή, η εντολή επιστρέφει αφού το API αποδεχτεί το αίτημα build.

Αν θέλετε το CLI να περιμένει μέχρι να ολοκληρωθεί το build, προσθέστε την επιλογή --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 repository.