Cách kết nối với Hyperlift bằng Hyperlift CLI

Hyperlift CLI là công cụ dòng lệnh để quản lý các ứng dụng Hyperlift trên nền tảng Spaceship thông qua terminal. 

Công cụ này là mã nguồn mở tại đây. Công cụ giao tiếp với Spaceship External API và xác thực bằng API key và secret. Với công cụ này, bạn có thể thực hiện những việc sau:

• Xem và quản lý ứng dụng;

• Build, khởi động, dừng và khởi động lại ứng dụng;

• Xem nhật ký thời gian chạy và nhật ký build;

• Xem chỉ số ứng dụng;

• Quản lý biến môi trường;

• Sử dụng đầu ra JSON cho scripting và tự động hóa;

• Luôn cập nhật CLI.

CLI giao tiếp với Spaceship External API và sử dụng khóa API cùng secret của Spaceship để xác thực. Vì vậy, thông tin nội bộ và quản trị được giữ ẩn, vì CLI truy cập trực tiếp vào các dịch vụ nội bộ.

Trong bài viết này, chúng tôi sẽ đề cập đến:

1. Cách cài đặt Hyperlift CLI;

2. Cách tạo thông tin xác thực API;

3. Cách đăng nhập vào CLI;

4. Cách quản lý ứng dụng Hyperlift qua CLI;

5. Cách xem nhật ký và chỉ số;

6. Cách quản lý biến môi trường;

7. Cách cập nhật CLI.

1. Cài đặt Hyperlift CLI

Hyperlift CLI có thể được cài đặt trên macOS, Windows và Linux. Tùy thuộc vào hệ điều hành của bạn, hãy chạy lệnh cài đặt. Script sẽ tự động phát hiện hệ điều hành và kiến trúc của bạn, tải xuống bản phát hành phù hợp, xác minh bản đó và cài đặt lệnh hyperlift.

macOS

Nếu bạn sử dụng Homebrew, hãy chạy:

brew install nccloud/tap/hyperlift

Windows

Nếu bạn sử dụng Scoop, hãy chạy:

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

scoop install hyperlift

Linux hoặc macOS

Bạn cũng có thể sử dụng script cài đặt:

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

Cài đặt thủ công

Ngoài ra, hãy tải xuống tệp lưu trữ cho hệ điều hành của bạn từtrang Hyperlift CLI Releases, giải nén tệp đó và thêm tệp thực thi hyperliftvào PATH của hệ thống.

2. Tạo thông tin xác thực API

Hyperlift CLI sử dụng API key và secret của Spaceship để xác thực các yêu cầu của bạn.

Để tạo thông tin xác thực API:

1. Đăng nhập vào tài khoản Spaceship của bạn.

2. Mở API Manager.

3. Nhấp vào nút + New API key để tạo khóa mới:
   
   

   

   
   

4. Đặt tên cho khóa và chọn các quyền cần thiết cho những hành động bạn muốn thực hiện:
   
   

   

   
   

5. Nếu bạn chọn mức Custom access, sẽ có ba tùy chọn truy cập cho Hyperlift:
   

   

Khóa chỉ có phạm vi Read là đủ nếu bạn chỉ cần xem ứng dụng, nhật ký hoặc chỉ số của mình. Các phạm vi bổ sung là cần thiết để quản lý ứng dụng và biến môi trường.

6. Sao chép API key và secret đã tạo, rồi lưu lại thông tin chi tiết.

Quan trọng: API secret chỉ được hiển thị một lần khi bạn tạo thông tin xác thực. Hãy đảm bảo lưu lại một cách an toàn.

Nhấp vào Done:

7. Khóa đã tạo sẽ được liệt kê trong menu API Manager:

3. Đăng nhập vào Hyperlift CLI

Sau khi cài đặt CLI và tạo thông tin xác thực API, hãy chạy:

hyperlift auth login

CLI sẽ yêu cầu bạn nhập API key và secret.

Sau khi xác thực thành công, API key sẽ được lưu trong tệp cấu hình Hyperlift, còn API secret sẽ được lưu an toàn trong keyring của hệ điều hành khi khả dụng.

Để kiểm tra trạng thái đăng nhập, hãy chạy:

hyperlift auth whoami

Để đăng xuất và xóa thông tin xác thực đã lưu, hãy chạy:

hyperlift auth logout

Mẹo: Nếu bạn nhận được thông báo "Not logged in", hãy chạy lại hyperlift auth login. Nếu bạn nhận được lỗi 403, API key của bạn có thể thiếu phạm vi bắt buộc. 

Xác thực không tương tác

Nếu bạn cần xác thực từ script, bạn có thể cung cấp thông tin xác thực bằng các tùy chọn dòng lệnh:

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

Tuy nhiên, việc sử dụng --secret sẽ làm lộ secret dưới dạng đối số dòng lệnh. Để bảo mật tốt hơn, bạn có thể truyền secret qua đầu vào tiêu chuẩn:

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

4. Các lệnh cơ bản để quản lý ứng dụng Hyperlift

Sử dụng các lệnh apps để xem và quản lý các ứng dụng Hyperlift của bạn.

Xem ứng dụng

Sử dụng các lệnh appsđể xem và quản lý các ứng dụng Hyperlift của bạn.

Build một ứng dụng

Để bắt đầu build một ứng dụng, hãy chạy:

hyperlift apps build <app-id>

Theo mặc định, lệnh sẽ trả về sau khi API chấp nhận yêu cầu build.

Nếu bạn muốn CLI chờ cho đến khi quá trình build hoàn tất, hãy thêm tùy chọn --wait:

hyperlift apps build <app-id> --wait

Bạn cũng có thể chỉ định CLI nên chờ trong bao lâu:

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

Thời gian chờ mặc định là 10 phút.

Khởi động, dừng hoặc khởi động lại một ứng dụng

Sử dụng các lệnh sau để quản lý trạng thái ứng dụng:

Theo mặc định, các lệnh này sẽ trả về sau khi API chấp nhận yêu cầu. Thêm --wait nếu bạn muốn CLI chờ cho đến khi thao tác hoàn tất.

Ví dụ:

hyperlift apps restart <app-id> --wait

Xem nhật ký ứng dụng

Bạn có thể dùng lệnh logs để xem cả nhật ký runtime và nhật ký build.

Lưu ý: Tùy chọn --follow sẽ kiểm tra định kỳ các mục nhật ký mới. Tùy chọn này không thiết lập kết nối phát trực tiếp.

Xem chỉ số ứng dụng

Sử dụng lệnh metrics để theo dõi mức sử dụng tài nguyên của ứng dụng. Các chỉ số khả dụng bao gồm:

• Mức sử dụng bộ nhớ;

• Mức sử dụng CPU;

• Tốc độ nhận mạng;

• Tốc độ truyền mạng;

• Mức sử dụng bộ nhớ tạm thời;

• Mức sử dụng bộ nhớ lưu trữ liên tục.

Quản lý biến môi trường

Bạn có thể sử dụng các lệnh envđể xem, thêm, cập nhật và xóa biến môi trường.

Quan trọng: Việc cập nhật biến môi trường sẽ khởi động lại ứng dụng. Hãy đợi cho đến khi ứng dụng chạy lại trước khi thực hiện thay đổi biến môi trường khác.

Hyperlift sử dụng biến môi trường APPLICATION_PORT để xác định cổng mà ứng dụng khả dụng. Giá trị mặc định của biến này là 8080.

Tùy chỉnh đầu ra lệnh 

Theo mặc định, các lệnh Hyperlift CLI hiển thị thông tin ở định dạng dễ đọc cho con người.

Nếu bạn cần sử dụng đầu ra trong script hoặc các công cụ khác, bạn có thể dùng các tùy chọn sau.

Lưu ý: Không thể sử dụng đồng thời các tùy chọn --json và --quiet.

Cập nhật Hyperlift CLI

Nhận trợ giúp cho từng lệnh

Mỗi lệnh Hyperlift CLI đều có thông tin trợ giúp riêng.

Đầu ra trợ giúp bao gồm các tùy chọn và đối số khả dụng cho lệnh đã chọn.

Để xem danh sách lệnh mới nhất và chi tiết kỹ thuật, hãy tham khảoHyperlift CLI repository.