klaw

클로 ·

Klaw는 완전한 오픈소스입니다. ?

Klaw는 셀프 서비스 Apache Kafka® 주제 관리/거버넌스 도구/포털입니다. 조직의 다양한 팀 사용자에게 역할/권한 부여를 도입하여 Apache Kafka 주제, acls, avro 스키마, 커넥터를 생성하고 탐색하는 프로세스를 자동화하는 웹 애플리케이션입니다.

매주 여러 번 다운로드되므로 솔루션을 채택하지 않은 더 많은 회사가 Excel 시트, Confluence, Wiki 페이지, Git 등에서 Apache Kafka 구성 관리에서 벗어날 수 있습니다.

다음으로 제작됨

• 부트스트랩 UI, Angular, Javascript, HTML, CSS
• Maven - 종속성 관리
  • Maven 래퍼인 mvnw가 Klaw Git Repo에 포함되어 있습니다.
• Java(Jdk 17, 21), Spring boot 3, Spring 보안, SQL, Apache Kafka Admin 클라이언트
• 만들다

새로운 반응 UI

필수는 아니지만 최신 경험을 얻으려면 React UI도 구축하는 것이 좋습니다. 최신:

• pnpm (>=9.0.0 <10.0.0)
• nodejs (>=20.0.0 <21.0.0)

2024년 8월 20일 이전

• pnpm (>=8.0.0 <9.0.0)
• nodejs (>=18.0.0 <19.0.0)

로컬로 필요한 버전이 확실하지 않은 경우 여기 엔진 아래에서 정보를 볼 수 있습니다.

서식 지정

서식 지정은 까다로울 수 있으므로 Spotless Maven 플러그인을 사용하는 동안 일관된 Java 코드 형식을 유지해야 합니다. 아래 명령을 실행하여 코드 변경 사항의 형식을 지정하세요.

• mvn Spotless:적용

버전 관리

사용 가능한 버전은 이 저장소의 태그를 참조하세요.

건축학:

특징:

• 주제(승인): 생성, 업데이트, 삭제, 승격

  • 이제 React UI는 구성에서 기본적으로 활성화됩니다. 반응 기반 자산이 이미 구축된 경우 새 UI가 표시되어야 합니다.
  • React UI - 주제 찾아보기, 주제 생성 요청, Acl 요청, 스키마 요청 및 커넥터 요청에 대한 새로운 모양과 느낌
  • React UI - 주제, ACL, 스키마 및 커넥터 승인을 위한 새로운 모양과 느낌
  • React UI - 주제, ACL, 스키마 및 커넥터에 대한 '내 팀의 요청'을 보기 위한 새로운 모양과 느낌
  • 이제 주제 요청을 생성한 후 편집할 수 있으므로 변경하여 실수를 수정할 수 있습니다.

• Acls(승인): 생성,삭제

  • React UI - Acl 요청 생성
  • ACL용으로 생성된 서비스 계정은 생성 팀에 할당됩니다.

• 커넥터(승인): 생성

  • 필요한 플러그인 라이브러리가 서버에 설치되어 있는 한 모든 커넥터를 생성할 수 있습니다.
  • 이제 커넥터 구성은 보안을 위해 비밀번호 구성을 암호화합니다.

• Avro 스키마(승인): 생성

  • 주제별로 사용 ​​가능한 모든 주제 버전 보기
  • React UI - 스키마 요청 생성
  • 스키마 요청 생성 시 스키마 호환성 사전 검증

• 주제 개요:

  • 이제 React UI는 사용자 경험을 향상시키기 위해 새롭게 디자인된 주제 개요와 모든 기능을 제공합니다.
  • 주제 구성
  • 홍보하다
  • 리터럴 및 접두어 구독
  • 주제 문서
  • 소비자 오프셋/지연
  • 주제 내용 보기

• 생성됨, 완료됨, 거부됨, 모든 주제 요청 보기

• 생성됨, 완료됨, 거부됨, 모든 Acl 요청 보기

• 생성, 완료, 거부된 모든 커넥터 요청 보기

• 생성, 완료, 거부된 모든 Avro 스키마 요청 보기

• Apache Kafka 클러스터(주제, Acl, 스키마 및 커넥터)와의 동기화(마이그레이션)

• Klaw와 클러스터 간의 차이점에 대한 조정 및 이메일 알림

• 구성 복원(주제, ACL)

• 로그인

  • Azure/Active 디렉터리 통합
  • 싱글 사인온(OAuth2)
  • 데이터베이스 기반

• 클러스터 및 환경 구성

  • Apache Kafka 클러스터에 연결하여 클러스터를 생성할 수 있습니다. (Cluster Management API를 구성해야 함)
  • 환경은 클러스터에 대한 래퍼로서 접두사, 접미사 등과 같은 유연한 구성을 적용합니다.
  • Kafka Rest Proxy를 클러스터에 추가하여 나머지 프록시 URL 정보를 저장할 수 있습니다.

• 사용자, 팀 및 권한

  • 구성 가능한 사용자, 팀
  • 35개 이상의 권한
  • 구성 가능한 역할(인증을 위해 AD에서 역할을 가져올 수 있음)
  • 다른 팀 간 전환 기능

• 주제 명명 규칙

  • 환경별로 접두사, 접미사 및/또는 정규식 적용

• Excel 보고서(역할에 따라 귀하의 팀 및 모든 팀용)

  • 클러스터별 주제(팀용)
  • 클러스터당 파티션
  • 모든 클러스터의 전체 주제
  • 클러스터당 Acl(팀용)
  • 생산자 Acl(팀용)
  • 소비자 ACL(팀용)
  • 모든 환경의 소비자 그룹
  • 일일 요청

• 해석학

  • 주제, 파티션, ACL, 요청 차트 보기

• 멀티 테넌시

  • 각 테넌트는 자체 팀과 격리되어 주제를 관리할 수 있습니다.
  • 모든 테넌트는 고유한 Kafka 환경 세트를 가질 수 있으며, 한 테넌트의 사용자는 다른 테넌트의 항목, acl 또는 항목을 보거나 액세스할 수 없습니다.
  • 보안 침해를 방지하는 격리 기능을 제공합니다.

• 아파치 카프카 연결

  • 일반 텍스트, SSL, SASL

• 심사

  • 모든 주제, acl, 스키마 및 커넥터 요청

• 다음 경우에 이메일 알림

  • 요청이 생성, 승인, 거부되었습니다.
  • 사용자가 생성되고 승인되었습니다.

• Klaw 설정을 위한 도움말 마법사

문서에서 Klaw의 기능을 확인하세요

선적 서류 비치

• 사용자 문서 : https://klaw-project.io/docs
• 기여자를 위한 기술 문서:
  • 일반 문서: ./docs
  • React 앱 coral 에 대한 특정 문서: ./coral/docs
• 여기에서 Klaw 문서 개선에 기여해 주세요.

질문과 답변

우리는 모든 사람이 질문하도록 권장합니다. 질문이 있는 경우 다른 사람도 확실히 질문합니다.

• Klaw 커뮤니티 포럼에 문의하세요
• Klaw 커뮤니티 포럼에서 읽기
• Klaw GitHub 토론에서 질문하고 읽어보세요.

Klaw 팀은 두 포럼에 걸쳐 질문과 답변을 교차 게시할 것입니다. Aiven이 직접 주최하고 지원하는 Klaw 커뮤니티 지원 포럼은 다른 이해관계자들에게 더 많은 가시성을 제공하므로 그곳에서 질문을 하도록 권장합니다. 우리는 GitHub 토론과 커뮤니티 포럼에서 질문에 응답하고 답변할 것입니다.

설치하다

수동

Maven 래퍼 사용

• ./mvnw 새로 설치

자신만의 Maven을 사용하세요

• mvn 새로 설치

선택 단계: 새로운 React UI 자산의 경우 산호 자산을 구축하는 데 필요한 pnpm이 사전 설치되어 있는지 확인하세요.

두 개의 아티팩트 core/target/klaw-.jar 및 Cluster-api/target/cluster-api-.jar을 빌드합니다.

https://klaw-project.io/docs에 정의된 단계를 따르거나 아래와 같이 바이너리를 실행하세요.

자바 -jar 코어/대상/klaw-.jar

자바 -jar 클러스터-api/target/cluster-api-.jar --spring.config.location=cluster-api/target/classes/application.properties

또는 Mac/Linux용 bin/run-klaw.sh를 실행하세요.

make 와 함께

1. 두 개의 Maven 모듈(core 및 Cluster-api)을 포함하는 이 저장소를 복제하십시오. git clone [email protected]:aiven/klaw.git
2. make 실행하여 종속성을 설치하고 Klaw Core와 Klaw-Cluster-Api를 모두 설정합니다.
3. [선택 사항] Klaw Core의 경우 make edit-core-config 사용하거나 Klaw-Cluster-API의 경우 make edit-cluster-api-config 사용하여 모든 구성을 편집합니다.
4. 실행하려면 다른 터미널 창에서 make run-core 및 make run-cluster-api 사용하거나 make -j2 run-core run-cluster-api 실행하여 두 가지를 모두 실행할 수 있습니다(참고: 이렇게 하면 출력이 혼합되어 디버깅이 더 어려워집니다. )

docker 사용

도커허브

각 공식 릴리스는 두 저장소의 docker에서 사용할 수 있습니다. klaw-core docker 허브 페이지에는 Klaw를 다운로드하고 배포하는 데 도움이 되는 예제 docker-compose 파일이 포함되어 있습니다. Cluster-api는 docker 허브에서 별도로 찾을 수도 있습니다.

장소 상에서

이 프로젝트에는 Klaw/docker-scripts 에 제공된 스크립트를 사용하여 로컬 Docker 이미지를 빌드하고 배포하는 기능도 있습니다.

특허

Klaw는 Apache 라이선스 버전 2.0에 따라 라이선스가 부여됩니다. 전체 라이센스 텍스트는 LICENSE.md 파일에서 확인할 수 있습니다.

이 프로젝트는 기여자의 CLA(기여자 라이센스 계약)를 명시적으로 요구하지 않습니다.

연락하다

버그 보고서와 패치는 매우 환영합니다. https://github.com/aiven/klaw에 GitHub 문제 및 풀 요청으로 게시해 주세요. 가능한 취약점이나 기타 심각한 문제는 관리자 [email protected]에 직접 보고해야 합니다.

등록 상표

Apache Kafka는 미국 및/또는 기타 국가에서 Apache Software Foundation의 등록 상표 또는 상표입니다. 이 페이지에 사용된 모든 제품 및 서비스 이름은 식별 목적으로만 사용되었으며 보증을 의미하지 않습니다.

크레딧

Klaw(이전 Kafkawize)는 Aiven 오픈 소스 개발자가 관리합니다.

최근 기여자는 GitHub 프로젝트 페이지(https://github.com/aiven/klaw/graphs/contributors)에 나열되어 있습니다.

Copyright (c) 2024 Aiven Oy 및 klaw 프로젝트 기여자.