วิธีเชื่อมต่อกับ Hyperlift โดยใช้ Hyperlift CLI

Hyperlift CLI เป็นเครื่องมือบรรทัดคำสั่งสำหรับจัดการแอปพลิเคชัน Hyperlift บนแพลตฟอร์ม Spaceship ผ่านเทอร์มินัล 

เครื่องมือนี้เป็นโอเพนซอร์ส ที่นี่ โดยเชื่อมต่อกับ Spaceship External API และยืนยันตัวตนด้วย API key และ secret ด้วยเครื่องมือนี้ คุณสามารถทำสิ่งต่อไปนี้ได้:

• ดูและจัดการแอปพลิเคชัน;

• บิลด์ เริ่ม หยุด และรีสตาร์ตแอปพลิเคชัน;

• ดูบันทึกรันไทม์และบันทึกการบิลด์;

• ดูเมตริกของแอปพลิเคชัน;

• จัดการตัวแปรสภาพแวดล้อม;

• ใช้ผลลัพธ์ 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 page แตกไฟล์ แล้วเพิ่มไฟล์ปฏิบัติการ hyperliftไปยัง PATH ของระบบของคุณ

2. สร้างข้อมูลรับรอง API

Hyperlift CLI ใช้ Spaceship API key และ secret เพื่อยืนยันตัวตนคำขอของคุณ

วิธีสร้างข้อมูลรับรอง API:

1. เข้าสู่ระบบบัญชี Spaceship ของคุณ

2. เปิด API Manager.

3. คลิกปุ่ม + New API key เพื่อสร้างคีย์ใหม่:
   
   

   

   
   

4. ตั้งชื่อคีย์และเลือกสิทธิ์ที่จำเป็นสำหรับการดำเนินการที่คุณต้องการทำ:
   
   

   

   
   

5. หากคุณเลือกระดับการเข้าถึง Custom access จะมีตัวเลือกการเข้าถึงสำหรับ Hyperlift อยู่สามแบบ:
   

   

คีย์ที่มีเฉพาะขอบเขต Read ก็เพียงพอแล้ว หากคุณต้องการเพียงดูแอปพลิเคชัน บันทึก หรือเมตริกของคุณ ขอบเขตเพิ่มเติมจำเป็นสำหรับการจัดการแอปพลิเคชันและตัวแปรสภาพแวดล้อม

6. คัดลอก API key และ secret ที่สร้างขึ้น แล้วบันทึกรายละเอียดไว้

สำคัญ: API secret จะแสดงเพียงครั้งเดียวเมื่อคุณสร้างข้อมูลรับรอง โปรดบันทึกไว้ในที่ปลอดภัย

คลิก Done:

7. คีย์ที่สร้างขึ้นจะแสดงอยู่ใต้เมนู API Manager:

3. เข้าสู่ระบบ Hyperlift CLI

หลังจากติดตั้ง CLI และสร้างข้อมูลรับรอง API ของคุณแล้ว ให้รัน:

hyperlift auth login

CLI จะขอให้คุณป้อน API key และ secret

หลังจากยืนยันตัวตนสำเร็จ API key จะถูกจัดเก็บไว้ในไฟล์การกำหนดค่า Hyperlift ขณะที่ API secret จะถูกจัดเก็บอย่างปลอดภัยใน keyring ของระบบปฏิบัติการของคุณเมื่อรองรับ

หากต้องการตรวจสอบสถานะการเข้าสู่ระบบของคุณ ให้รัน:

hyperlift auth whoami

หากต้องการออกจากระบบและลบข้อมูลรับรองที่จัดเก็บไว้ ให้รัน:

hyperlift auth logout

เคล็ดลับ: หากคุณได้รับข้อความ "Not logged in" ให้รัน hyperlift auth login อีกครั้ง หากคุณได้รับข้อผิดพลาด 403 API key ของคุณอาจไม่มีขอบเขตที่จำเป็น 

การยืนยันตัวตนแบบไม่โต้ตอบ

หากคุณต้องการยืนยันตัวตนจากสคริปต์ คุณสามารถระบุข้อมูลรับรองโดยใช้ตัวเลือกบรรทัดคำสั่ง:

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

อย่างไรก็ตาม การใช้ --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 repository.