Kafkawize : A Web application which automates the process of creating and browsing Kafka components, by introducing roles/authorizations to users of various teams of an organization
About the Application
Automate the process of creating and browsing Kafka components, by introducing roles, teams and users. Objective :
User Interface API directly communicates between users and Cluster API.
Front end is built with AngularJs, HTML, and Java script.
Cluster API acts as middle layer between Kafka brokers and UserInterface API.
Cluster API creates Kafka Admin Client and executes the requests for Topic, Acls or Schema registry.
Apache Cassandra datastore stores all users, teams, topics, request and execution data from all the users., and to maintain source of truth.
Spring Security, Spring Boot frameworks are used to develop this application.
(Broadly divided into two categories based on user roles.)
ROLE : USER can request for creation of kafka components, and browse kafka components.
ROLE : ADMIN can approve and execute the requests of users to create kafka components.
ROLE : SUPERUSER can synchronize topics meta information with Cassandra Datastore from Kafka Brokers (Source of Truth.)
Browse: (ROLE : USER, ADMIN, SUPERUSER)
All users can Browse Topics
All users can Browse Acls
All users can view the producers and consumers of all topics.
Requests:(ROLE : USER)
Users can request for Kafka Topics
Users can request for Kafka Acl
Users can request for Schemas to be registered on Confluent Schema registry.
Users can view all the requests from his team.
Environments:(ROLE : USER)
Users can view the available environments
Approve - Execute :(ROLE : ADMIN)
Users can appprove requests for creating Kafka Topics
Users can appprove requests for creating Kafka Acls
Users can appprove requests for uploading schemas on topics
Users :(ROLE : ADMIN)
Users can view all user details
Users can add new users
Teams :(ROLE : ADMIN, SUPERUSER)
Users can view all team details
Users can add new team
Environments:(ROLE : SUPERUSER)
Users can add a new environment environments
Synchronize Metadata :(ROLE : SUPERUSER)
Users can synchronize topic information from Brokers with Cassandra datastore. (Update team info.)
Users can synchronize acls information from Brokers with Cassandra datastore. (Update team info.)
My Profile :(ROLE : USER, ADMIN)
Users can view their profile.
Change Password :(ROLE : USER, ADMIN)
Users can change their passwords.
Logout :(ROLE : USER, ADMIN)
Users can logout.
How to Run the application
KafkaWize needs the following applications to be up and running.
- Spring boot application KafkaWize https://github.com/kafkawize/kafkawize
- Spring boot application KafkaWize ClusterApi https://github.com/kafkawize/kafkawizeclusterapi
- Apache Cassandra
Steps to run:
- Install Apache Cassandra
- Setup project KafkawizeClusterApi and update server.port if necessary in application properties
- Start KafkaClusterApi
- Setup project KafkaWize, and configure Cassandra running host, Cluster api host, in application properties
- Start KafkaWize
- Cassandra db setup will be done on the startup of the application. We do not have to create manually.
By default KafkaWize runs on port 9097. Access it by http://localhost:9097
Default Teams Team1 Team2 Team3
Default Users(with pwds)
uiuser1/user from Team1 uiuser2/user from Team2 uiuser4/user from Team1 Admin uiuser5/user from Team2 Admin superuser/user from Team2 Superuser