klaw

Кло ·

Klaw имеет полностью открытый исходный код. ?

Klaw — это инструмент/портал самообслуживания Apache Kafka® для управления темами. Это веб-приложение, которое автоматизирует процесс создания и просмотра тем Apache Kafka, ACL, схем avro, коннекторов путем введения ролей/авторизаций для пользователей различных команд организации.

Благодаря нескольким загрузкам каждую неделю многие другие компании, которые не приняли решение, могут с радостью отказаться от управления конфигурациями Apache Kafka в таблицах Excel, Confluence, вики-страницах, git и т. д.

Построен с

• Bootstrap UI, Angular, Javascript, HTML, CSS
• Maven — Управление зависимостями
  • Оболочка maven mvnw включена в репозиторий Klaw Git.
• Java (Jdk 17, 21), Spring boot 3, Spring Security, SQL, клиент администратора Apache Kafka
• Делать

Новый пользовательский интерфейс React

Не обязательно, но чтобы получить новейший опыт, мы рекомендуем также создать пользовательский интерфейс React. Последний:

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

До 20 августа 2024 г.

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

Если вы сомневаетесь в том, какая версия вам нужна локально, вы можете просмотреть информацию здесь, в разделе «Двигатели».

Форматирование

Форматирование может быть непростым, поэтому для поддержания единообразного формата кода Java мы используем безупречный плагин maven. Запустите приведенную ниже команду, чтобы отформатировать изменения кода.

• МВН безупречно: применить

Управление версиями

Доступные версии см. в тегах этого репозитория.

Архитектура:

Функции:

• Темы (одобрения): Создание, Обновление, Удаление, Продвижение

  • Пользовательский интерфейс React теперь по умолчанию включен в конфигурации. Если ресурсы на основе реагирования уже созданы, должен быть виден новый пользовательский интерфейс.
  • Пользовательский интерфейс React — новый внешний вид для просмотра тем, запроса создания темы, запроса Acl, запроса схемы и запроса соединителя.
  • React UI — новый внешний вид для утверждения тем, списков ACL, схем и соединителей.
  • Пользовательский интерфейс React — новый внешний вид для просмотра «Запросов моей команды» по темам, спискам управления доступом, схемам и соединителям.
  • Запросы на темы теперь доступны для редактирования после создания, поэтому вы можете изменить их, чтобы исправить любые ошибки.

• ACL (утверждение): Создать, Удалить

  • Пользовательский интерфейс React — создание запроса Acl
  • Учетные записи служб, созданные для списков ACL, назначаются создающей команде.

• Соединители (утверждение): Создать

  • Можно создать любой соединитель, если на сервере установлены необходимые библиотеки плагинов.
  • Конфигурация соединителя теперь шифрует конфигурацию пароля в целях безопасности.

• Схемы Avro (утверждение): Создать

  • Просмотреть все доступные версии предметов по теме
  • React UI — создание запроса схемы
  • Предварительная проверка совместимости схем при создании запроса схемы

• Обзор темы:

  • Пользовательский интерфейс React теперь предоставляет обновленный обзор тем и все его возможности для улучшения пользовательского опыта.
  • Конфигурация темы
  • Продвигать
  • Литеральные и префиксные подписки
  • Документация по теме
  • Потребительские компенсации/отставание
  • Посмотреть содержание темы

• Просмотр созданных, выполненных, отклоненных всех запросов тем

• Просмотр созданных, завершенных, отклоненных всех запросов ACL

• Просмотр созданных, завершенных, отклоненных всех запросов соединителя

• Просмотр созданных, завершенных, отклоненных всех запросов схемы Avro

• Синхронизация (миграция) из и в кластеры Apache Kafka (темы, ACL, схемы и соединители)

• Согласование и уведомления по электронной почте о различиях между Klaw и Clusters

• Восстановление конфигурации (темы, ACL)

• Авторизоваться

  • Интеграция Azure/Active Directory
  • Единый вход (OAuth2)
  • На основе базы данных

• Настройка кластеров и сред

  • Кластеры можно создавать, подключаясь к кластерам Apache Kafka. (Необходимо настроить API управления кластером)
  • Среды представляют собой оболочки над кластерами, обеспечивающие гибкие конфигурации, такие как префикс, суффикс и т. д.
  • Kafka Rest Proxy можно добавить в кластер для хранения информации об URL-адресах остальных прокси-серверов.

• Пользователи, команды и авторизации

  • Настраиваемые пользователи, команды
  • Более 35 разрешений
  • Настраиваемые роли (роли можно извлечь из AD для авторизации)
  • Возможность переключения между разными командами.

• Соглашения об именах тем

  • Применять префикс, суффиксы и/или регулярное выражение для каждой среды

• Отчет Excel (для вашей команды и всех команд в зависимости от роли)

  • Темы в кластере (для команд)
  • Разделов на кластер
  • Общие темы во всех кластерах
  • ACL на кластер (для команд)
  • Продюсер Acls (для команд)
  • Потребительские ACL (для команд)
  • Группы потребителей всех сред
  • Запросов в день

• Аналитика

  • Просмотр диаграмм тем, разделов, ACL, запросов

• Мульти аренда

  • Каждый арендатор может управлять своими темами со своими командами изолированно.
  • Каждый арендатор может иметь свой собственный набор сред Kafka, и пользователи одного арендатора не могут просматривать и получать доступ к темам, спискам доступа или любым другим арендаторам.
  • Это обеспечивает изоляцию, позволяющую избежать каких-либо нарушений безопасности.

• Возможности подключения Apache Kafka

  • ПЛАНТЕКСТ, 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 убедитесь, что предварительно установлен pnpm, который необходим для создания коралловых ресурсов.

Создает два артефакта: core/target/klaw-.jar и кластер-api/target/cluster-api-.jar.

и следуйте инструкциям, указанным на странице https://klaw-project.io/docs, или запустите двоичные файлы, как показано ниже.

java -jar ядро/цель/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. Клонируйте этот репозиторий, содержащий два модуля maven (ядро и кластер-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

Докерхаб

Каждый официальный выпуск доступен в докере в двух репозиториях. Страница Docker Hub klaw-core содержит пример файла docker-compose, который поможет загрузить и развернуть Klaw. Кластер-api также можно найти отдельно в Docker Hub.

Локально

Этот проект также имеет возможность создавать и развертывать локальные образы докеров с помощью сценариев, представленных в 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) принадлежат компании Aiven Oy и участникам проекта klaw, 2024 г.