klaw

คลอว์ ·

Klaw เป็นโอเพ่นซอร์สเต็มรูปแบบ -

Klaw คือเครื่องมือ/พอร์ทัลการจัดการหัวข้อ/การกำกับดูแล Apache Kafka® แบบบริการตนเอง เป็นเว็บแอปพลิเคชันที่ทำให้กระบวนการสร้างและการเรียกดูหัวข้อ Apache Kafka, Acls, avro schema และตัวเชื่อมต่อเป็นแบบอัตโนมัติ โดยการแนะนำบทบาท/การอนุญาตแก่ผู้ใช้ของทีมต่างๆ ในองค์กร

ด้วยการดาวน์โหลดหลายครั้งทุกสัปดาห์ บริษัทหลายแห่งที่ไม่ได้นำโซลูชันไปใช้ สามารถย้ายจากการจัดการการกำหนดค่า Apache Kafka ใน Excelsheets การบรรจบกัน หน้าวิกิ คอมไพล์ ฯลฯ ได้อย่างมีความสุข

สร้างด้วย

• Bootstrap UI, เชิงมุม, จาวาสคริปต์, HTML, CSS
• Maven - การจัดการการพึ่งพา
  • กระดาษห่อ maven mvnw รวมอยู่ใน Klaw Git Repo
• Java (Jdk 17, 21), Spring boot 3, ความปลอดภัยของ Spring, SQL, ไคลเอนต์ Apache Kafka Admin
• ทำ

UI ตอบสนองใหม่

ไม่จำเป็น แต่เพื่อให้ได้ประสบการณ์ล่าสุด เราขอแนะนำให้สร้าง React UI ด้วย ล่าสุด:

• เวลาต่อนาที (>=9.0.0 <10.0.0)
• nodejs (>=20.0.0 <21.0.0)

ก่อนวันที่ 20 สิงหาคม 2024

• เวลาต่อนาที (>=8.0.0 <9.0.0)
• nodejs (>=18.0.0 <19.0.0)

หากมีข้อสงสัยเกี่ยวกับเวอร์ชันที่คุณต้องการภายในเครื่อง คุณสามารถดูข้อมูลได้ที่นี่ภายใต้เครื่องมือ

การจัดรูปแบบ

การจัดรูปแบบอาจเป็นเรื่องยุ่งยาก ดังนั้นเพื่อรักษารูปแบบโค้ด Java ที่สอดคล้องกันตลอดทั้งที่เราใช้ปลั๊กอิน Maven ที่ไม่ซับซ้อน เรียกใช้คำสั่งด้านล่างเพื่อจัดรูปแบบการเปลี่ยนแปลงโค้ดของคุณ

• mvn สะอาดสะอ้าน: ใช้

การกำหนดเวอร์ชัน

สำหรับเวอร์ชันที่มี โปรดดูแท็กบนที่เก็บนี้

สถาปัตยกรรม:

คุณสมบัติ:

• หัวข้อ (การอนุมัติ): สร้าง อัปเดต ลบ โปรโมต

  • ตอนนี้ React UI เปิดใช้งานตามค่าเริ่มต้นในการกำหนดค่า หากมีการสร้างเนื้อหาตามปฏิกิริยาแล้ว UI ใหม่ควรมองเห็นได้
  • React UI - รูปลักษณ์ใหม่สำหรับการเรียกดูหัวข้อ, สร้างคำขอหัวข้อ, คำขอ Acl, คำขอ Schema และคำขอตัวเชื่อมต่อ
  • React UI - รูปลักษณ์ใหม่สำหรับการอนุมัติหัวข้อ, ACL, สคีมา และตัวเชื่อมต่อ
  • React UI - รูปลักษณ์ใหม่สำหรับการดู 'คำขอของทีมของฉัน' สำหรับหัวข้อ, ACL, สคีมา และตัวเชื่อมต่อ
  • ขณะนี้คำขอหัวข้อสามารถแก้ไขได้หลังจากสร้างแล้ว ดังนั้นคุณจึงสามารถแก้ไขคำขอหัวข้อเพื่อแก้ไขข้อผิดพลาดได้

• Acls (การอนุมัติ): สร้าง,ลบ

  • React UI - สร้างคำขอ Acl
  • บัญชีบริการที่สร้างขึ้นสำหรับ ACL ถูกกำหนดให้กับทีมที่สร้าง

• ตัวเชื่อมต่อ (การอนุมัติ): สร้าง

  • คุณสามารถสร้างตัวเชื่อมต่อใดก็ได้ตราบใดที่มีการติดตั้งไลบรารีปลั๊กอินที่จำเป็นบนเซิร์ฟเวอร์
  • ขณะนี้การกำหนดค่าตัวเชื่อมต่อเข้ารหัสการกำหนดค่ารหัสผ่านเพื่อความปลอดภัย

• Avro Schemas (อนุมัติ): สร้าง

  • ดูหัวข้อที่มีอยู่ทั้งหมดตามหัวข้อ
  • React UI - สร้างคำขอสคีมา
  • การตรวจสอบความเข้ากันได้ของ Schema ล่วงหน้าในการสร้างคำขอ Schema

• ภาพรวมหัวข้อ :

  • ขณะนี้ React UI มีภาพรวมหัวข้อที่ออกแบบใหม่และความสามารถทั้งหมดเพื่อปรับปรุงประสบการณ์ผู้ใช้
  • การกำหนดค่าหัวข้อ
  • ส่งเสริม
  • การสมัครสมาชิกตามตัวอักษรและคำนำหน้า
  • เอกสารประกอบหัวข้อ
  • การชดเชย/ความล่าช้าของผู้บริโภค
  • ดูเนื้อหาหัวข้อ

• ดูคำขอหัวข้อที่สร้าง เสร็จสมบูรณ์ ปฏิเสธทั้งหมด

• ดูคำขอ Acl ทั้งหมดที่สร้าง เสร็จสมบูรณ์ ปฏิเสธ

• ดูคำขอตัวเชื่อมต่อที่สร้าง เสร็จสมบูรณ์ เสร็จสมบูรณ์ ปฏิเสธทั้งหมด

• ดูคำขอสคีมา Avro ทั้งหมดที่สร้าง เสร็จสมบูรณ์ ปฏิเสธ

• การซิงโครไนซ์ (การโยกย้าย) จากและไปยังคลัสเตอร์ Apache Kafka (หัวข้อ, Acls, Schemas และตัวเชื่อมต่อ)

• การกระทบยอดและการแจ้งเตือนทางอีเมลเกี่ยวกับความแตกต่างระหว่าง Klaw และ Clusters

• คืนค่าการกำหนดค่า (หัวข้อ, acls)

• เข้าสู่ระบบ

  • การรวม Azure / Active Directory
  • การลงชื่อเพียงครั้งเดียว (OAuth2)
  • ขึ้นอยู่กับฐานข้อมูล

• กำหนดค่าคลัสเตอร์และสภาพแวดล้อม

  • สามารถสร้างคลัสเตอร์โดยเชื่อมต่อกับคลัสเตอร์ Apache Kafka (ควรกำหนดค่า API การจัดการคลัสเตอร์)
  • สภาพแวดล้อมเป็นแบบ Wrapper บนคลัสเตอร์ โดยบังคับใช้การกำหนดค่าที่ยืดหยุ่น เช่น คำนำหน้า คำต่อท้าย ฯลฯ
  • คุณสามารถเพิ่ม Kafka Rest Proxy ลงในคลัสเตอร์เพื่อจัดเก็บข้อมูล URL ของพร็อกซีที่เหลือ

• ผู้ใช้ ทีม และการอนุญาต

  • ผู้ใช้และทีมที่กำหนดค่าได้
  • สิทธิ์มากกว่า 35 รายการ
  • บทบาทที่กำหนดค่าได้ (สามารถดึงบทบาทจาก AD เพื่อขออนุมัติได้)
  • ความสามารถในการสลับระหว่างทีมต่างๆ

• แบบแผนการตั้งชื่อหัวข้อ

  • บังคับใช้คำนำหน้า ส่วนต่อท้าย และ/หรือ regex ตามสภาพแวดล้อม

• รายงาน Excel (สำหรับทีมของคุณและทุกทีม ขึ้นอยู่กับบทบาท)

  • หัวข้อต่อคลัสเตอร์ (สำหรับทีม)
  • พาร์ติชันต่อคลัสเตอร์
  • หัวข้อโดยรวมในทุกกลุ่ม
  • Acl ต่อคลัสเตอร์ (สำหรับทีม)
  • Acls ของผู้ผลิต (สำหรับทีม)
  • Consumer Acls (สำหรับทีม)
  • กลุ่มผู้บริโภคทุกสภาพแวดล้อม
  • คำขอต่อวัน

• การวิเคราะห์

  • ดูแผนภูมิหัวข้อ พาร์ติชัน acls คำขอ

• ผู้เช่าหลายราย

  • ผู้เช่าแต่ละรายสามารถจัดการหัวข้อของตนร่วมกับทีมของตนเองแยกกันได้
  • ผู้เช่าทุกคนสามารถมีชุดสภาพแวดล้อม Kafka ของตนเองได้ และผู้ใช้ของผู้เช่ารายหนึ่งไม่สามารถดู/เข้าถึงหัวข้อ, acls หรือสิ่งใด ๆ จากผู้เช่ารายอื่นได้
  • มันให้การแยกตัวเพื่อหลีกเลี่ยงการละเมิดความปลอดภัย

• การเชื่อมต่อ Apache Kafka

  • PLAINTEXT, SSL, SASL

• การตรวจสอบ

  • คำขอหัวข้อ, acl, สคีมา และตัวเชื่อมต่อทั้งหมด

• อีเมล์แจ้งเตือนเมื่อ

  • คำขอถูกสร้างขึ้น อนุมัติ และปฏิเสธ
  • ผู้ใช้ถูกสร้างขึ้นได้รับการอนุมัติ

• ตัวช่วยสร้างความช่วยเหลือในการตั้งค่า Klaw

ดูคุณลักษณะของ Klaw ในเอกสาร

เอกสารประกอบ

• เอกสารสำหรับผู้ใช้: https://klaw-project.io/docs
• เอกสารทางเทคนิคสำหรับผู้มีส่วนร่วม:
  • เอกสารทั่วไป: ./docs
  • เอกสารเฉพาะสำหรับแอป React coral : ./coral/docs
• มีส่วนร่วมในการปรับปรุงเอกสารของ Klaw ที่นี่

คำถามและคำตอบ

เราขอแนะนำให้ทุกคนถามคำถาม หากคุณมีคำถามที่คนอื่นก็ถามคำถามเช่นกัน

• ถามในฟอรั่มชุมชน Klaw
• อ่านในฟอรัมชุมชน Klaw
• ถามและอ่านในการสนทนา Klaw GitHub

ทีมงาน Klaw จะโพสต์คำถามและคำตอบในทั้งสองฟอรัม ฟอรัมสนับสนุนชุมชน Klaw ซึ่งโฮสต์และสนับสนุนโดย Aiven โดยตรง ช่วยให้ผู้มีส่วนได้เสียคนอื่นๆ มองเห็นได้มากขึ้น ดังนั้นเราจึงขอแนะนำให้ถามคำถามที่นั่น เราจะตอบกลับและตอบคำถามทั้งในการสนทนา GitHub และฟอรัมชุมชน

ติดตั้ง

คู่มือ

ใช้กระดาษห่อ Maven

• ./mvnw ติดตั้งใหม่หมด

ใช้มาเวนของคุณเอง

• mvn ติดตั้งใหม่ทั้งหมด

ขั้นตอนที่ไม่บังคับ: สำหรับเนื้อหา React UI ใหม่ ตรวจสอบให้แน่ใจว่าได้ติดตั้ง pnpm ไว้ล่วงหน้าซึ่งจำเป็นสำหรับการสร้างสินทรัพย์ปะการัง

สร้างสองสิ่งประดิษฐ์ core/target/klaw-.jar และคลัสเตอร์-api/target/cluster-api-.jar

และทำตามขั้นตอนที่กำหนดไว้ที่ https://klaw-project.io/docs หรือเรียกใช้ไบนารีตามด้านล่าง

java -jar core/target/klaw-.jar

java -jarคลัสเตอร์-api/target/cluster-api-.jar --spring.config.location=cluster-api/target/classes/application.properties

หรือเรียกใช้ bin/run-klaw.sh สำหรับ Mac/Linux

ด้วย make

1. โคลน repo นี้ที่มีสองโมดูล maven (core และคลัสเตอร์-api) : git clone [email protected]:aiven/klaw.git
2. เรียกใช้ make เพื่อติดตั้งการพึ่งพาและตั้งค่าทั้ง Klaw Core และ Klaw-Cluster-Api
3. [ไม่บังคับ] แก้ไขการกำหนดค่าใด ๆ โดยใช้ make edit-core-config สำหรับ Klaw Core หรือ make edit-cluster-api-config สำหรับ Klaw-Cluster-API
4. หากต้องการรัน คุณสามารถใช้ make run-core และ make run-cluster-api ในหน้าต่างเทอร์มินัลที่แตกต่างกัน หรือคุณสามารถเรียกใช้ make -j2 run-core run-cluster-api เพื่อดำเนินการทั้งสองอย่าง (หมายเหตุ: สิ่งนี้จะผสมเอาต์พุตและทำให้การดีบักยากขึ้น )

ด้วย docker

ด็อคเกอร์ฮับ

แต่ละรุ่นอย่างเป็นทางการมีอยู่ในนักเทียบท่าในที่เก็บทั้งสองแห่ง หน้าฮับนักเทียบท่า klaw-core มีตัวอย่างไฟล์เขียนนักเทียบท่าซึ่งจะช่วยดาวน์โหลดและปรับใช้ Klaw คุณสามารถพบคลัสเตอร์-api แยกต่างหากบนฮับนักเทียบท่า

ในท้องถิ่น

โปรเจ็กต์นี้ยังมีความสามารถในการสร้างและปรับใช้อิมเมจนักเทียบท่าในเครื่องโดยใช้สคริปต์ที่ให้ไว้ใน Klaw/docker-scripts

ใบอนุญาต

Klaw ได้รับอนุญาตภายใต้ใบอนุญาต Apache เวอร์ชัน 2.0 ข้อความลิขสิทธิ์แบบเต็มมีอยู่ในไฟล์ LICENSE.md

โปรดทราบว่าโครงการไม่จำเป็นต้องมี CLA (ข้อตกลงสิทธิ์การใช้งานผู้ร่วมโครงการ) จากผู้ร่วมโครงการอย่างชัดเจน

ติดต่อ

ยินดีอย่างยิ่งกับรายงานข้อผิดพลาดและแพทช์ โปรดโพสต์เป็นปัญหา GitHub และดึงคำขอได้ที่ https://github.com/aiven/klaw ช่องโหว่ใด ๆ ที่เป็นไปได้หรือปัญหาร้ายแรงอื่น ๆ ควรรายงานโดยตรงไปยังผู้ดูแล [email protected]

เครื่องหมายการค้า

Apache Kafka เป็นเครื่องหมายการค้าจดทะเบียนหรือเครื่องหมายการค้าของ Apache Software Foundation ในสหรัฐอเมริกาและ/หรือประเทศอื่นๆ ชื่อผลิตภัณฑ์และบริการทั้งหมดที่ใช้ในหน้านี้มีวัตถุประสงค์เพื่อการระบุตัวตนเท่านั้น และไม่ได้หมายความถึงการรับรอง

เครดิต

Klaw (เดิมชื่อ Kafkawize) ได้รับการดูแลโดยนักพัฒนาโอเพ่นซอร์สของ Aiven

ผู้ร่วมให้ข้อมูลล่าสุดแสดงอยู่ในหน้าโครงการ GitHub https://github.com/aiven/klaw/graphs/contributors

ลิขสิทธิ์ (c) 2024 Aiven Oy และผู้ร่วมโครงการ klaw