abctl

abctl

เครื่องมือบรรทัดคำสั่งของ Airbyte สำหรับการปรับใช้ Airbyte ในเครื่อง

บันทึก

README นี้มุ่งเน้นไปที่เครื่องมือ abctl เป็นหลัก ไม่ใช่แพลตฟอร์ม Airbyte

หากคุณกำลังมองหาเอกสาร QuickStart อย่างเป็นทางการของ Airbyte สามารถพบได้ที่นี่

---

• เริ่มต้นอย่างรวดเร็ว

• ภาพรวม

• คำสั่ง

• มีส่วนร่วม

เริ่มต้นอย่างรวดเร็ว

สำคัญ

ข้อมูลประจำตัวการตรวจสอบความถูกต้องจะถูกสร้างขึ้นแบบสุ่มโดยเป็นส่วนหนึ่งของกระบวนการติดตั้ง

หลังจากการติดตั้งเสร็จสมบูรณ์ หากต้องการค้นหาข้อมูลรับรองการตรวจสอบของคุณให้เรียกใช้ abctl local credentials

1. ติดตั้ง Docker

• ลินุกซ์

• แม็ค

• หน้าต่าง

2. ติดตั้ง abctl

• ผ่านการชง

  brew tap airbytehq/tap
  brew install abctl

• ผ่านไปติดตั้ง

  go install github.com/airbytehq/abctl@latest

• ผ่านทาง Github

3. ติดตั้ง Airbyte

   # install Airbyte 
   abctl local install
   # fetch the login credentials
   abctl local credentials

บันทึก

abctl local install อาจใช้เวลานานกว่า 15 นาที ทั้งนี้ขึ้นอยู่กับความเร็วอินเทอร์เน็ต

ตามค่าเริ่มต้น abctl local install จะกำหนดค่า Airbyte ให้สามารถเข้าถึงได้โดยคำขอขาเข้าทั้งหมดบนพอร์ต 8000 โดยทั่วไปจะรวมถึงการเข้าถึงผ่านที่อยู่ IP ของโฮสต์และ localhost

หากไม่มีพอร์ต 8000 หรือพอร์ตอื่นที่ต้องการ - สามารถระบุ --port [PORT] ได้

4. เข้าสู่ระบบ Airbyte

   หาก abctl local install เสร็จสมบูรณ์ ควรเปิดเบราว์เซอร์ไปที่ http://localhost:8000 (หรือไปที่ --host และ --port จะแทนที่ หากระบุ) หากนี่เป็นครั้งแรกที่ติดตั้ง Airbyte คุณจะถูกขอให้ระบุอีเมลและชื่อองค์กร หากต้องการดึงรหัสผ่านของคุณเพื่อเข้าสู่ระบบ ให้เรียกใช้ abctl local credentials

ภาพรวม

ตามที่กล่าวไว้ในการเริ่มต้นอย่างรวดเร็ว ข้อกำหนดเบื้องต้นเพียงอย่างเดียวที่ abctl มีคือต้องติดตั้ง ใช้งาน และเข้าถึง Docker ได้ อย่างไรก็ตาม แพลตฟอร์ม Airbyte ต้องการคลัสเตอร์ Kubernetes ซึ่ง abctl สร้างขึ้นโดยใช้ประเภท (kind รันคลัสเตอร์ Kubernetes ภายในคอนเทนเนอร์ Docker) ด้วยคลัสเตอร์ Kubernetes ของ Kind abctl ใช้ helm เพื่อติดตั้ง (หรืออัปเดตเป็น) แผนภูมิ Airbyte helm ล่าสุด (โดยค่าเริ่มต้น) และแผนภูมิ helm NGINX Ingress Controller ล่าสุด

คำสั่ง

คำสั่งและคำสั่งย่อยทั้งหมดรองรับแฟล็กโกลบอลทางเลือกต่อไปนี้:

สั้น	ยาว	คำอธิบาย
-ชม	--ช่วย	แสดงข้อมูลวิธีใช้ คำอธิบายตัวเลือกที่มี
-v	--รายละเอียด	เปิดใช้งานเอาต์พุตแบบละเอียด (ดีบัก) มีประโยชน์เมื่อทำการดีบักพฤติกรรมที่ไม่คาดคิด

คำสั่งทั้งหมดรองรับตัวแปรสภาพแวดล้อมต่อไปนี้:

ชื่อ	คำอธิบาย
DO_NOT_TRACK	ตั้งค่าเป็นค่าใดก็ได้เพื่อปิดใช้งานการติดตามการวัดและส่งข้อมูลทางไกล

รองรับคำสั่งต่อไปนี้:

• ท้องถิ่น

• รุ่น

ท้องถิ่น

abctl local --help

คำสั่งย่อยในเครื่องมุ่งเน้นไปที่การจัดการการติดตั้ง Airbyte ในเครื่อง คำสั่งย่อยต่อไปนี้มีอยู่:

• ข้อมูลรับรอง

• การใช้งาน

• ติดตั้ง

• สถานะ

• ถอนการติดตั้ง

ข้อมูลรับรอง

abctl local credentials

แสดงข้อมูลประจำตัวที่จำเป็นในการเข้าสู่ระบบการติดตั้ง Airbyte ในเครื่อง

บันทึก

เมื่อดำเนิน abctl local install เป็นครั้งแรก password แบบสุ่ม , client-id และ client-secret จะถูกสร้างขึ้น

ส่งคืน email password client-id และข้อมูล client-secret ต้องใช้ email และ password เพื่อเข้าสู่ระบบ Airbyte client-id และ client-secret จำเป็นต่อการสร้าง Access Token สำหรับการโต้ตอบกับ Airbyte API

ตัวอย่างเช่น:

$ abctl local credentials
{
  "password": "[RANDOM PASSWORD]",
  "client-id": "[RANDOM CLIENT-ID]",
  "client-secret": "[RANDOM CLIENT-SECRET]"
}

credentials รองรับแฟล็กเสริมต่อไปนี้

ชื่อ	ค่าเริ่มต้น	คำอธิบาย
--อีเมล	-	เปลี่ยนที่อยู่อีเมลการรับรองความถูกต้อง
--รหัสผ่าน	-	เปลี่ยนรหัสผ่านการรับรองความถูกต้อง

การใช้งาน

abctl local deployments

แสดงข้อมูลการปรับใช้ Kubernetes และอนุญาตให้รีสตาร์ทการปรับใช้ Kubernetes

deployments รองรับแฟล็กเสริมต่อไปนี้

ชื่อ	ค่าเริ่มต้น	คำอธิบาย
--รีสตาร์ท	-	รีสตาร์ทการปรับใช้ที่ให้มา

ติดตั้ง

abctl local install

ติดตั้งอินสแตนซ์ Airbyte ในเครื่องหรืออัปเดตการติดตั้งที่มีอยู่ซึ่งติดตั้งครั้งแรกโดย abctl

บันทึก

abctl local install อาจใช้เวลานานกว่า 20 นาที ทั้งนี้ขึ้นอยู่กับความเร็วอินเทอร์เน็ตของคุณ

install รองรับแฟล็กทางเลือกต่อไปนี้:

บันทึก

เครื่องหมาย - ในคอลัมน์เริ่มต้นระบุว่าไม่สามารถระบุค่าได้

ธงเหล่านี้ทำงานเป็นสวิตช์ เปิดใช้งานหากมีให้ ปิดใช้งานหากไม่มี

ชื่อ	ค่าเริ่มต้น	คำอธิบาย
--แผนภูมิ	-	เส้นทางสู่แผนภูมิ
--แผนภูมิเวอร์ชัน	ล่าสุด	เวอร์ชันแผนภูมิหางเสือของ Airbyte ใดที่จะติดตั้ง
--นักเทียบท่าอีเมล	-	ที่อยู่อีเมลนักเทียบท่าเพื่อตรวจสอบสิทธิ์กับ --docker-server ยังสามารถระบุได้ด้วยตัวแปรสภาพแวดล้อม ABCTL_LOCAL_INSTALL_DOCKER_EMAIL
--นักเทียบท่ารหัสผ่าน	-	รหัสผ่านนักเทียบท่าเพื่อตรวจสอบสิทธิ์กับ --docker-server ยังสามารถระบุโดยตัวแปรสภาพแวดล้อม ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD
--นักเทียบท่าเซิร์ฟเวอร์	-	เซิร์ฟเวอร์นักเทียบท่าเพื่อตรวจสอบสิทธิ์ ยังสามารถระบุโดยตัวแปรสภาพแวดล้อม ABCTL_LOCAL_INSTALL_DOCKER_SERVER
--docker-ชื่อผู้ใช้	-	ชื่อผู้ใช้นักเทียบท่าเพื่อตรวจสอบสิทธิ์กับ --docker-server ยังสามารถระบุโดยตัวแปรสภาพแวดล้อม ABCTL_LOCAL_INSTALL_DOCKER_USERNAME
--คุกกี้ที่ไม่ปลอดภัย	-	ปิดใช้งานข้อกำหนดคุกกี้ที่ปลอดภัย ตั้งค่าเฉพาะเมื่อใช้ --host กับการเชื่อมต่อที่ไม่ปลอดภัย (ไม่ใช่ https )
--โหมดทรัพยากรต่ำ	เท็จ	เรียกใช้ Airbyte ในโหมดทรัพยากรต่ำ
--เจ้าภาพ	-	FQDN ที่จะเข้าถึงการติดตั้ง Airbyte ค่าเริ่มต้นคือการอนุญาตการรับส่งข้อมูลขาเข้าทั้งหมดบน port --port ตั้งค่านี้หากการติดตั้ง Airbyte ต้องการการกำหนดค่าโฮสต์ที่ถูกจำกัดมากกว่านี้
--โยกย้าย	-	เปิดใช้งานการย้ายข้อมูลจากการติดตั้ง Airbyte ที่สนับสนุนนักเทียบท่าที่มีอยู่ คัดลอก ปล่อยให้ข้อมูลต้นฉบับไม่มีการแก้ไข ข้อมูลจากนักเทียบท่าเขียน การติดตั้ง Airbyte ที่ได้รับการสนับสนุนในการติดตั้ง Airbyte ที่มีการจัดการ abctl นี้
--ไม่มีเบราว์เซอร์	-	ปิดใช้งานการเปิดเบราว์เซอร์เมื่อการติดตั้งเสร็จสิ้น มีประโยชน์ในการตั้งค่าในสถานการณ์ที่ไม่มีเบราว์เซอร์ให้บริการ
--ท่าเรือ	8000	พอร์ตที่จะเข้าถึงการติดตั้ง Airbyte ตั้งค่านี้หากมีการใช้งานพอร์ต 8000 อยู่แล้ว หรือต้องการใช้พอร์ตอื่น
--ความลับ	-	สามารถตั้งค่าได้หลายครั้ง สร้างข้อมูลลับของ kubernetes ตามเนื้อหาของไฟล์ที่ให้ไว้ มีประโยชน์เมื่อใช้ร่วมกับ --values สำหรับการปรับแต่งการติดตั้ง
--ค่า	-	ไฟล์ค่า Helm เพื่อปรับแต่งการติดตั้ง Airbyte เพิ่มเติม
--ปริมาณ	-	สามารถตั้งค่าได้หลายครั้ง ติดตั้งวอลุ่มเพิ่มเติมในคลัสเตอร์ kubernetes ต้องอยู่ในรูปแบบ <HOST_PATH>:<GUEST_PATH>

สถานะ

abctl local status

หากมีการติดตั้ง Airbyte จะส่งกลับข้อมูลเกี่ยวกับการติดตั้งนั้น

ตัวอย่างเช่น:

$ abctl local status
Existing cluster 'airbyte-abctl' found
Found helm chart 'airbyte-abctl'
  Status: deployed
  Chart Version: 0.422.2
  App Version: 0.63.15
Found helm chart 'ingress-nginx'
  Status: deployed
  Chart Version: 4.11.1
  App Version: 1.11.1
Airbyte should be accessible via http://localhost:8000

ถอนการติดตั้ง

abctl local uninstall

ถอนการติดตั้งอินสแตนซ์ Airbyte ในเครื่อง

บันทึก

ข้อมูลที่เกี่ยวข้องกับอินสแตนซ์ Airbyte ที่ติดตั้งจะไม่ถูกลบออก

การดำเนินการนี้เพื่อให้สามารถติดตั้ง Airbyte ใหม่ได้ในภายหลังโดยที่ข้อมูลทั้งหมดยังคงอยู่

uninstall รองรับแฟล็กเสริมต่อไปนี้:

บันทึก

เครื่องหมาย - ในคอลัมน์เริ่มต้นระบุว่าไม่สามารถระบุค่าได้

ธงเหล่านี้ทำงานเป็นสวิตช์ เปิดใช้งานหากมีให้ ปิดใช้งานหากไม่มี

ชื่อ	ค่าเริ่มต้น	คำอธิบาย
--คงอยู่	-	จะลบข้อมูลทั้งหมดสำหรับการติดตั้ง Airbyte สิ่งนี้ไม่สามารถยกเลิกได้

ภาพ

abctl images

จัดการรูปภาพที่ใช้โดย Airbyte และ abctl

คำสั่งย่อยต่อไปนี้มีอยู่:

• ประจักษ์

ประจักษ์

abctl images manifest

แสดงรายการรูปภาพที่ใช้โดย Airbyte และ abctl

ชื่อ	ค่าเริ่มต้น	คำอธิบาย
--แผนภูมิ	-	เส้นทางสู่แผนภูมิ
--แผนภูมิเวอร์ชัน	ล่าสุด	เวอร์ชันแผนภูมิหางเสือของ Airbyte ใดที่จะติดตั้ง
--ค่า	-	ไฟล์ค่า Helm เพื่อปรับแต่งการติดตั้ง Airbyte เพิ่มเติม

รุ่น

abctl version

แสดงข้อมูลเวอร์ชันเกี่ยวกับเครื่องมือ abctl

ตัวอย่างเช่น:

$ abctl version
version: v0.19.0

มีส่วนร่วม

รายงานปัญหา

หากคุณพบปัญหากับ abctl โปรดเปิด Github Issue และใช้เครื่องหมาย ? [abctl] Report an issue with the abctl tool

สร้าง

ติดตั้ง go

• ผ่านการชง

  brew install go

• ผ่าน go.dev

พื้นที่เก็บข้อมูลนี้ใช้ Makefile โดยล้อมคำสั่ง go แบบดั้งเดิมที่ใช้สำหรับการจัดรูปแบบ ตรวจสอบ การสร้าง และทดสอบโค้ด go

รองรับคำสั่ง make ต่อไปนี้:

ชื่อ	คำอธิบาย
make build	สร้างไบนารี abctl โดยวางไว้ในไดเร็กทอรี build
make clean	ลบไดเร็กทอรี build
make fmt	จัดรูปแบบโค้ด
make test	ดำเนินการทดสอบทั้งหมด
make vet	รันคำสั่งสัตวแพทย์