Skip to content

Commit

Permalink
Merge pull request #31 from muralibasani/4.4
Browse files Browse the repository at this point in the history
Update for 4.4 changes
  • Loading branch information
muralibasani committed Nov 14, 2020
2 parents 912a6e5 + f6b23eb commit b4b4205
Show file tree
Hide file tree
Showing 32 changed files with 216 additions and 69 deletions.
38 changes: 32 additions & 6 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified 3.1/docs/_static/images/ActivityLog.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/AddCluster.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/AddTeam.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/AddUser.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/ApproveACL.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/ApproveTopics.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/BrowseTopics.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/Dashboard.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/Environments.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/Logout.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/MyAclRequests.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/MyTopicRequests.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/RequestACL.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/RequestSchema.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/RequestTopic.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/ServerConfig.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/SynchronizeAcls.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/SynchronizeTopics.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/ViewAcls.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/ViewTeams.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/ViewUsers.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 3.1/docs/_static/images/login.JPG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions 3.1/docs/conf.py
Expand Up @@ -51,9 +51,9 @@
# built documents.
#
# The short X.Y version.
version = '4.3'
version = '4.4'
# The full version, including alpha/beta/rc tags.
release = '4.3'
release = '4.4'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 0 additions & 4 deletions 3.1/docs/contactme.rst
Expand Up @@ -5,10 +5,6 @@ If you have any issues with kafkawize, please raise it in::

https://github.com/muralibasani/kafkawize/issues

If you want to post a topic or question, either you can post it in Stackoverflow or ::

https://kafkawize.com/community/

You can also send me an email at info@kafkawize.com or kafkawize@gmail.com

You can also use the form https://kafkawize.com/contact-me/
Expand Down
2 changes: 1 addition & 1 deletion 3.1/docs/docker/docker.rst
@@ -1,7 +1,7 @@
On Docker
=========

Kafkawize can be run with Docker from version 4.3. You can download the docker images from https://hub.docker.com/u/kafkawize
Kafkawize can be run with Docker from version 4.4. You can download the docker images from https://hub.docker.com/u/kafkawize

Step 1 (Docker installation)
----------------------------
Expand Down
25 changes: 0 additions & 25 deletions 3.1/docs/features/features.rst
Expand Up @@ -275,31 +275,6 @@ With this form a new team can be added by a SuperUser.
:align: center


Synchronize Metadata
--------------------

A situation where Kafka cluster already exists and would like to adapt Kafkawize in your organization, all the topics and acls need to have their teams/owners.

This feature is possible with Synchronization of Topics or Acls.

Topics
~~~~~~
After a environment is selected, topics are displayed, and a team can be assigned to it. And this action, team becomes the Owner team.

.. image:: _static/images/SynchronizeTopics.JPG
:width: 500px
:align: center

It is required to synchronize the topic team first with Base sync cluster first. Base sync cluster can be configured with property custom.syncdata.cluster in application properties.

Acls
~~~~
After a environment is selected, Producer and Consumer Acls are displayed, and a team can be assigned to it. After this action, team becomes the Owner of that subscription (producer or consumer).

.. image:: _static/images/SynchronizeAcls.JPG
:width: 500px
:align: center


Admin
-----
Expand Down
14 changes: 7 additions & 7 deletions 3.1/docs/getting_started/getting_started.rst
Expand Up @@ -19,7 +19,7 @@ Prerequisites

1 Download Kafkawize
--------------------
Download the latest version (4.3). https://kafkawize.com/download/
Download the latest version (4.4). https://kafkawize.com/download/

This bundle includes customized packages of both the apis kafkawizeuapi and kafkawizeclusterapi

Expand Down Expand Up @@ -57,7 +57,7 @@ Configure the application properties (src/main/resources) if port has to be chan

mvn clean package

This should create a jar (kafkawizeclusterapi-4.3.jar) in target dir.
This should create a jar (kafkawizeclusterapi-4.4.jar) in target dir.

Kafka connectivity between ClusterApi application and Kafka cluster, if SSL connection needs to be configured,
configure "environment".connect_with_ssl_kafkacluster in application properties to true and configure the other keystore properties even.
Expand Down Expand Up @@ -152,7 +152,7 @@ If the custom.dbscripts.execution property is set to manual, all the scripts sho

/kafkawize/kafkawize-web/src/main/resources/scripts/base/cassandra/insertdata.sql

(Scripts available in kafkawize-4.3.zip)
(Scripts available in kafkawize-4.4.zip)

- Above scripts will create tables and insert initial set of Environments, Teams and Users which you can delete anytime from UI.

Expand All @@ -179,27 +179,27 @@ If the custom.dbscripts.execution property is set to manual, all the scripts sho

/kafkawize/kafkawize-web/src/main/resources/scripts/base/rdbms/insertdata.sql

(Scripts available in kafkawize-4.3.zip)
(Scripts available in kafkawize-4.4.zip)

- Above scripts will create tables and insert initial set of Environments, Teams and Users which you can delete anytime from UI.

Run maven command to create a runnable jar::

mvn clean package

This should create a jar in target dir (/kafkawize/target/kafkawize-4.3.jar).
This should create a jar in target dir (/kafkawize/target/kafkawize-4.4.jar).

7 Run KW and KWClusterApi
-------------------------

Run::

java -jar kafkawizeclusterapi-4.3.jar
java -jar kafkawizeclusterapi-4.4.jar


Run::

java -jar spring.config.location=classpath:/application.properties kafkawize-4.3.jar
java -jar spring.config.location=classpath:/application.properties kafkawize-4.4.jar

If application is running, you can access UI from http://[host]:[port]/kafkawize

Expand Down
22 changes: 2 additions & 20 deletions 3.1/docs/migrate.rst
@@ -1,22 +1,4 @@
Migration Kafkawize from 4.2 to 4.3
Migration Kafkawize from 4.3 to 4.4
===================================

There are few major changes in 4.3 which you need to look at.

1. application.properties includes couple of new parameters.

# default cluster to synchronize data
custom.syncdata.cluster=DEV

# order of envs
custom.envs.order=DEV,TST,ACC,PRD
custom.request.topics.envs=DEV,TST,ACC,PRD


2.insertdata.sql is updated.

partition parameter value changed from default.paritions to default.partitions.

3. superuser cannot submit new topic requests and acl/subscription requests.

4. clusterapi is updated. Make sure you clone the latest clusterapi https://github.com/muralibasani/kafkawizeclusterapi
There are no database changes to migrate to 4.4.
27 changes: 27 additions & 0 deletions 3.1/docs/profeatures/profeatures.rst
Expand Up @@ -99,6 +99,33 @@ SSL parameters should also be configured, when ssl encryption is enabled.
SASL mechanism can be PLAIN or GSSAPI(Kerberos)


Synchronize Metadata
--------------------

A situation where Kafka cluster already exists and would like to adapt Kafkawize in your organization, all the topics and acls need to have their teams/owners.

This feature is possible with Synchronization of Topics or Acls.

Topics
~~~~~~
After a environment is selected, topics are displayed, and a team can be assigned to it. And this action, team becomes the Owner team.

.. image:: _static/images/SynchronizeTopics.JPG
:width: 500px
:align: center

It is required to synchronize the topic team first with Base sync cluster first. Base sync cluster can be configured with property custom.syncdata.cluster in application properties.

Acls
~~~~
After a environment is selected, Producer and Consumer Acls are displayed, and a team can be assigned to it. After this action, team becomes the Owner of that subscription (producer or consumer).

.. image:: _static/images/SynchronizeAcls.JPG
:width: 500px
:align: center



User Registration
-----------------

Expand Down
147 changes: 145 additions & 2 deletions 3.1/docs/releasenotes.rst
@@ -1,6 +1,149 @@
Release Notes
=============

Kafkawize 4.3 release notes
Kafkawize 4.4

Changes include UI and BE code improvements.
1. Changes include improved User interface and few bug fixes.
2. Metadata Synchronize option has been removed
3. SSL connectivity to Kafka cluster has been removed
4. Dashboard updated to show logged in Username, Team and Role
5. Users can now only 4 environments DEV, TST, ACC and PRD. Hierarchy is defined in properties file.
6. New model for UserInfo class is introduced to fix a password bug
7. Password is not stored as encrypted text
8. Validations bug in acls and topics requests
9. Connect to Kafka clusters during start of Kafkawize

----------------------------------------------------------------

Kafkawize 4.3

Changes include improved User interface and few bug fixes.

----------------------------------------------------------------


Kafkawize 4.2

Changes include
1. Critical bug fix - concurrent user access
1. Ability to have environments DEV, TST, ACC and PRD
2. Ability to request for topics in DTAP environments
3. Ability to view topic overview and subscriptions in one page
4. Ability to view topic partitions and replication factor of all environments in topic overview page
5. Ability to view topics and their existence in all environments
6. Updated dashboard to view your team topics

----------------------------------------------------------------

Kafkawize 4.1

Changes include
1. New Bootstrap 4 User interface with new appealing look and feel
2. New UI/UX - for great user experience
3. Few bug fixes
1. Critical bug fix - concurrent user access

----------------------------------------------------------------

Kafkawize 4.0


Changes include
1. About 320 Unit tests. Above 85% code coverage.
2. Integration tests for both stores Cassandra and Rdbms, with EmbeddedCassandra and Embedded H2 sql database
3. New UI for viewing topics
4. New UI for viewing acls of topic
5. New UI for approving topics
6. New UI for approving acls
7. New UI for login screen
8. New UI for Dashboard, showing cluster api status and kafka cluster statuses
9. Added License key validation
10. Bug fixes and code enhancements

There are several other changes and upgraded dependencies which improved the code quality and efficiency.
1. New Bootstrap 4 User interface with new appealing look and feel
2. New UX - for great user experience
3. Few bug fixes


----------------------------------------------------------------

Kafkawize 3.5

Changes include
1. New page (Admin-ServerConfig) to display server configuration - application properties
2. Default replication factor, default partitions and default max partitions can be configured from Clusters page.
3. Couple of minor bug fixes
1. About 320 Unit tests. Above 85% code coverage.
2. Integration tests for both stores Cassandra and Rdbms, with EmbeddedCassandra and Embedded H2 sql database
3. New UI for viewing topics
4. New UI for viewing acls of topic
5. New UI for approving topics
6. New UI for approving acls
7. New UI for login screen
8. New UI for Dashboard, showing cluster api status and kafka cluster statuses
9. Added License key validation
10. Bug fixes and code enhancements

There are several other changes and upgraded dependencies which improved the code quality and efficiency.


----------------------------------------------------------------

Kafkawize 3.4

Changes include

1. Decline Topic requests
2. Decline Acl requests
3. Bug fix in creating topic request
1. New page (Admin-ServerConfig) to display server configuration - application properties
2. Default replication factor, default partitions and default max partitions can be configured from Clusters page.
3. Couple of minor bug fixes


----------------------------------------------------------------

Kafkawize 3.3

Changes include search features in almost all screens, bug fixes and code improvements.
Changes include
1. Decline Topic requests
2. Decline Acl requests
3. Bug fix in creating topic request

----------------------------------------------------------------

Kafkawize 3.2

Changes include search features in almost all screens, bug fixes and code improvements.

----------------------------------------------------------------

Kafkawize 3.1

New features:
1. Support for RDBMS store like MySql to store meta information. 1.0 only supports Apache Cassandra. It is one of the important feature which will support many customers who already have an SQL based solution.
Changing property db.storetype=rdbms/cassandra will make the difference.

Bug fixes:

There are few bugs which are fixed in Topic requests, acls and schema registry modules.

Changes include search features in almost all screens, bug fixes and code improvements.

----------------------------------------------------------------

Kafkawize 2.0

Kafkawize is a Kafka Topic management tool (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

Changes include new feature Rdbms support for metastore, package restructuring, jpa/hibernate implementation, improved code quality and bug fixes.

New features:
1. Support for RDBMS store like MySql to store meta information. 1.0 only supports Apache Cassandra. It is one of the important feature which will support many customers who already have an SQL based solution.
Changing property db.storetype=rdbms/cassandra will make the difference.

Bug fixes:

There are few bugs which are fixed in Topic requests, acls and schema registry modules.
2 changes: 0 additions & 2 deletions 3.1/docs/usecases/usecases.rst
Expand Up @@ -7,8 +7,6 @@ Functionalities
- Search Topics with a User Interface
- View Acls of a topic
- View Producer and Consumer Teams of a topic
- Synchronize Kafka topics with Teams
- Synchronize Kafka acls with Teams
- Users, Teams and Roles based authorizations on features
- View server configuration (application properties)
- Audit of activities performed by users
Expand Down

0 comments on commit b4b4205

Please sign in to comment.