Download klaw - download do código-fonte klaw

klaw

Outro código-fonte

v2.9.0

Baixar

Garra ·

Klaw é totalmente de código aberto. ?

Klaw é uma ferramenta/portal de gerenciamento/governança de tópicos Apache Kafka® de autoatendimento. É uma aplicação web que automatiza o processo de criação e navegação de tópicos, acls, esquemas avro e conectores do Apache Kafka, introduzindo funções/autorizações para usuários de diversas equipes de uma organização.

Com vários downloads todas as semanas, muito mais empresas que não adotaram uma solução podem felizmente deixar de gerenciar configurações do Apache Kafka em planilhas Excel, confluence, páginas wiki, git etc.

Construído com

IU Bootstrap, Angular, Javascript, HTML, CSS
Maven - Gerenciamento de Dependências
- Um wrapper maven, mvnw está incluído no Klaw Git Repo
Java (Jdk 17, 21), Spring boot 3, Spring security, SQL, cliente Apache Kafka Admin
Fazer

Nova IU do React

Não é obrigatório, mas para obter a experiência mais recente, recomendamos também construir a UI do React. Mais recente:

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

Pré-20 de agosto de 2024

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

Em caso de dúvida sobre a versão que você precisa localmente, você pode ver as informações aqui em motores.

Formatação

A formatação pode ser complicada, portanto, para manter um formato de código Java consistente, usamos o plug-in spotless maven. Execute o comando abaixo para formatar as alterações do código.

mvn impecável: aplique

Versionamento

Para as versões disponíveis, consulte as tags neste repositório.

Arquitetura:

Arquitetura

Características:

Tópicos (aprovação): Criar, Atualizar, Excluir, Promover
- React UI agora está habilitado por padrão na configuração. Se os ativos baseados em reação já tiverem sido criados, a nova IU deverá estar visível.
- React UI - Nova aparência para Navegar por tópicos, Criar solicitação de tópico, Solicitação de Acl, Solicitação de esquema e Solicitação de conector
- React UI – Nova aparência para aprovação de tópicos, ACLs, esquemas e conectores
- React UI - Nova aparência para visualizar 'Solicitações da minha equipe' para tópicos, ACLs, esquemas e conectores
- As solicitações de tópico agora podem ser editadas após a criação e você pode alterá-las para corrigir quaisquer erros.
Acls (aprovação): Criar, Excluir
- React UI - Criar solicitação Acl
- As contas de serviço criadas para ACLs são atribuídas à equipe criadora
Conectores (aprovação): Criar
- Qualquer conector pode ser criado, desde que as bibliotecas de plug-ins necessárias estejam instaladas no servidor.
- A configuração do conector agora criptografa a configuração de senha para segurança.
Esquemas Avro (aprovação): Criar
- Veja todas as versões disponíveis dos assuntos por tópico
- React UI - Criar solicitação de esquema
- Pré-validação de compatibilidade de esquemas na criação de solicitação de esquema
Visão geral do tópico:
- React UI agora fornece uma visão geral do tópico redesenhada e todos os seus recursos para aprimorar a experiência do usuário.
- Configuração do tópico
- Promover
- Assinaturas literais e prefixadas
- Documentação do tópico
- Compensações/atraso do consumidor
- Ver conteúdo do tópico
Ver todas as solicitações de tópico criadas, concluídas, recusadas
Visualize todas as solicitações Acl criadas, concluídas, recusadas
Ver todas as solicitações do Connector criadas, concluídas e recusadas
Ver todas as solicitações de esquema Avro criadas, concluídas e recusadas
Sincronização (migração) de e para clusters Apache Kafka (Tópicos, Acls, Esquemas e Conectores)
Reconciliação e notificações por e-mail sobre diferenças entre Klaw e Clusters
Restaurar configuração (tópicos, acls)
Conecte-se
- Integração do Azure/Active Directory
- Logon único (OAuth2)
- Baseado em banco de dados
Configurar clusters e ambientes
- Clusters podem ser criados conectando-se a clusters Apache Kafka. (A API de gerenciamento de cluster deve ser configurada)
- Os ambientes são wrappers sobre clusters, impondo configurações flexíveis como prefixo, sufixo, etc.
- O Kafka Rest Proxy pode ser adicionado ao cluster para armazenar as informações de URL do proxy restante.
Usuários, equipes e autorizações
- Usuários e equipes configuráveis
- Mais de 35 permissões
- Funções configuráveis (as funções podem ser extraídas do AD para autorização)
- Capacidade de alternar entre equipes diferentes
Convenções de nomenclatura de tópicos
- Aplicar prefixo, sufixos e/ou regex por ambiente
Relatório Excel (para sua equipe e todas as equipes, dependendo da função)
- Tópicos por cluster (para equipes)
- Partições por cluster
- Tópicos gerais em todos os clusters
- Acls por cluster (para equipes)
- Produtor Acls (para equipes)
- Acls do consumidor (para equipes)
- Grupos de consumidores de todos os ambientes
- Solicitações por dia
Análise
- Visualize gráficos de tópicos, partições, ACLs, solicitações
Multilocação
- Cada locatário pode gerenciar seus tópicos com suas próprias equipes de forma isolada.
- Cada locatário pode ter seu próprio conjunto de ambientes Kafka, e os usuários de um locatário não podem visualizar/acessar tópicos, ACLs ou qualquer outro locatário.
- Ele fornece um isolamento evitando qualquer violação de segurança.
Conectividade Apache Kafka
- TEXTO SIMPLES, SSL, SASL
Auditoria
- Todas as solicitações de tópico, ACL, esquema e conector
Notificações por e-mail quando
- solicitações são criadas, aprovadas, recusadas
- usuários são criados, aprovados
Assistente de ajuda para configurar o Klaw

Veja os recursos do Klaw nos documentos

Documentação

Documentação do usuário: https://klaw-project.io/docs
Documentação técnica para contribuidores:
- documentação geral: ./docs
- documentação específica para o aplicativo React coral : ./coral/docs
Contribua para melhorar a documentação do Klaw aqui

Perguntas e Respostas

Encorajamos todos a fazer perguntas, se você tiver alguma dúvida, alguém definitivamente também terá.

Pergunte no fórum da comunidade Klaw
Leia no fórum da comunidade Klaw
Pergunte e leia nas discussões do Klaw GitHub

A equipe Klaw postará perguntas e respostas em ambos os fóruns. O fórum de suporte à comunidade Klaw, hospedado e apoiado diretamente pela Aiven, tem mais visibilidade para outras partes interessadas, por isso encorajamos perguntas a serem feitas lá. Responderemos e responderemos perguntas nas discussões do GitHub e no Fórum da Comunidade.

Instalar

Manual

Use o invólucro Maven

./mvnw instalação limpa

Use seu próprio Maven

instalação limpa mvn

Etapa opcional: para novos ativos de UI React, certifique-se de que o pnpm esteja pré-instalado, o que é necessário para construir ativos de coral.

Constrói dois artefatos core/target/klaw-.jar e cluster-api/target/cluster-api-.jar

e siga as etapas definidas em https://klaw-project.io/docs ou execute os binários como abaixo

java -jar núcleo/destino/klaw-.jar

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

Ou execute bin/run-klaw.sh para Mac/Linux

Com `make`

Clone este repositório contendo dois módulos maven (core e cluster-api): git clone [email protected]:aiven/klaw.git
Execute make para instalar dependências e configurar o Klaw Core e o Klaw-Cluster-Api
[Opcional] edite qualquer configuração usando make edit-core-config para Klaw Core ou make edit-cluster-api-config para Klaw-Cluster-API
Para executar, você pode usar make run-core e make run-cluster-api em diferentes janelas de terminal ou você pode executar make -j2 run-core run-cluster-api para executar ambos (NOTA: isso irá misturar a saída e tornar a depuração mais difícil )

Com `docker`

Docker Hub

Cada versão oficial está disponível no docker nos dois repositórios. A página klaw-core docker hub contém um exemplo de arquivo docker-compose que ajudará a baixar e implantar o Klaw. O cluster-api também pode ser encontrado separadamente no docker hub.

Localmente

Este projeto também tem a capacidade de construir e implantar imagens docker locais usando scripts fornecidos em Klaw/docker-scripts .

Licença

Klaw está licenciado sob a licença Apache, versão 2.0. O texto completo da licença está disponível no arquivo LICENSE.md.

Observe que o projeto explicitamente não exige um CLA (Contrato de Licença de Contribuinte) de seus contribuidores.

Contato

Relatórios de bugs e patches são muito bem-vindos. Publique-os como problemas do GitHub e solicitações pull em https://github.com/aiven/klaw. Quaisquer possíveis vulnerabilidades ou outros problemas sérios devem ser relatados diretamente aos mantenedores [email protected].

Marca registrada

Apache Kafka é uma marca registrada ou marca comercial da Apache Software Foundation nos Estados Unidos e/ou em outros países. Todos os nomes de produtos e serviços usados nesta página são apenas para fins de identificação e não implicam endosso.