klaw

克劳·

Klaw 是完全开源的。 ？

Klaw 是一个自助式 Apache Kafka® 主题管理/治理工具/门户。它是一个 Web 应用程序，通过向组织中各个团队的用户引入角色/授权，自动执行创建和浏览 Apache Kafka 主题、acls、avro 模式、连接器的过程。

随着每周多次下载，更多未采用解决方案的公司可以愉快地摆脱在 excelsheet、confluence、wiki 页面、git 等中管理 Apache Kafka 配置。

内置

• Bootstrap UI、Angular、Javascript、HTML、CSS
• Maven - 依赖管理
  • Maven 包装器 mvnw 包含在 Klaw Git Repo 中
• Java（Jdk 17、21）、Spring boot 3、Spring security、SQL、Apache Kafka 管理客户端
• 制作

新的反应用户界面

不是必需的，但为了获得最新的体验，我们建议还构建 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)

如果对本地所需的版本有疑问，您可以在此处的引擎下查看信息。

格式化

格式化可能很棘手，因此为了在整个过程中保持一致的java代码格式，我们使用了spotless Maven插件。运行以下命令来格式化代码更改。

• mvn 一尘不染：应用

版本控制

有关可用版本，请参阅此存储库上的标签。

建筑学：

特征：

• 主题（批准）：创建、更新、删除、升级

  • React UI 现在在配置中默认启用。如果基于 React 的资产已经构建，则新的 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 和 Cluster 之间差异的调节和电子邮件通知

• 恢复配置（主题、acl）

• 登录

  • Azure/活动目录集成
  • 单点登录 (OAuth2)
  • 基于数据库

• 配置集群和环境

  • 可以创建连接到 Apache Kafka 集群的集群。 （需要配置集群管理API）
  • 环境是集群的包装器，强制执行灵活的配置，例如前缀、后缀等
  • 可以在集群中添加Kafka Rest Proxy来存储rest proxy url信息。

• 用户、团队和授权

  • 可配置的用户、团队
  • 超过35个权限
  • 可配置的角色（可以从AD中拉取角色进行授权）
  • 能够在不同团队之间切换

• 主题命名约定

  • 每个环境强制执行前缀、后缀和/或正则表达式

• Excel 报告（适用于您的团队和所有团队，具体取决于角色）

  • 每个集群的主题（针对团队）
  • 每个集群的分区数
  • 所有集群中的总体主题
  • 每个集群的 ACL（对于团队）
  • Producer Acls（针对团队）
  • 消费者 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 团队将在两个论坛上交叉发布问题和答案。 Klaw 社区支持论坛由 Aiven 直接主办和支持，对其他感兴趣的各方具有更高的知名度，因此我们鼓励在那里提出问题。我们将在 GitHub 讨论和社区论坛中回复和回答问题。

安装

手动的

使用 Maven 包装器

• ./mvnw 全新安装

使用你自己的 Maven

• mvn 干净安装

可选步骤：对于新的 React UI 资产，请确保预先安装了构建珊瑚资产所需的 pnpm。

构建两个工件 core/target/klaw-.jar 和 cluster-api/target/cluster-api-.jar

并遵循 https://klaw-project.io/docs 中定义的步骤或运行如下所示的二进制文件

java -jar 核心/目标/klaw-.jar

java -jar cluster-api/target/cluster-api-.jar --spring.config.location=cluster-api/target/classes/application.properties

或者对于 Mac/Linux 运行 bin/run-klaw.sh

与make

1. 克隆此包含两个 Maven 模块（核心和 cluster-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

Dockerhub

每个官方版本都可以在两个存储库中的 docker 上获得。 klaw-core docker hub 页面包含一个示例 docker-compose 文件，它将帮助下载和部署 Klaw。 cluster-api 也可以在 docker hub 上单独找到。

本地

该项目还能够使用 Klaw/docker-scripts 中提供的脚本构建和部署本地 docker 镜像。

执照

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 项目贡献者。