1.2.0

[muralibasani]

Release Notes: Klaw 1.2.0

Date: 15th Dec, 2022

Overview

Klaw version 1.2.0 is a minor release with a couple of new features and improvements.

Breaking changes

There are no breaking changes in this release.

New features

• Introducing React UI - React is a popular open-source JavaScript library that simplifies the development of front-end applications and provides a great alternative to large, complex front-end frameworks like AngularJS. Klaw’s current user interface is built with AngularJS, which is no longer officially supported by Google. As an older framework, it does not leverage modern or component-based development.
  React, on the other hand, provides greater flexibility and modularity, making it easier to design reusable components and scale an application. Furthermore, React makes it easier to create consistent and cohesive user experiences.
  Moving to React for Klaw’s UI provides numerous benefits in terms of performance, scalability, ease of development, and support by a large community of developers. We’ve tested React with our current interface, and it looks amazing - we’re excited to start this new journey.

• New look and feel for Browse topics:
  With the switch to React for UI, this release also introduces the redesigned user interface for Browse topics, providing a more user-friendly and intuitive interface for managing Kafka topics in Klaw. It consists of changes to the layout, styling, and overall appearance of the interface, as well as improvements to make browsing and working topics easier, more efficient, and more accessible.

Enable new Klaw user interface

To preview the new Klaw user user interface, open the application.properties file on the Klaw core module, and set the value of the following property to true:

klaw.coral.enabled=false

Login to Klaw and under Topics, and click the banner with the preview link.

• Klaw now supports Azure AD Authentication:
  Klaw now supports Azure Active Directory (Azure AD) authentication. Azure AD is an identity and access management service provided by Microsoft. It allows organizations to manage user access to applications and resources securely. By using Azure AD authentication, organizations can leverage their existing Azure AD infrastructure to manage access to Klaw.

To enable Azure AD authentication for a Klaw user, configure the spring.cloud. Azure.active-directory.* properties in the application.properties file on the Klaw core module with the Azure AD properties. This configuration allows Klaw to integrate with Azure AD authentication enabling users to log in to Klaw using their Azure AD credentials.

A sample configuration of Azure AD based authentication for Klaw is as shown below:

klaw.sso.server.loginurl=/oauth2/authorization/azure
spring.cloud.azure.active-directory.enabled=true
spring.cloud.azure.active-directory.profile.tenant-id=tenantid
spring.cloud.azure.active-directory.credential.client-id=clientid
spring.cloud.azure.active-directory.credential.client-secret=client-secret

• Advanced configurations for topics:
  The Request new topic function in Klaw now includes an advanced topic configuration section, where you can configure all the supported topic-level configurations available in Kafka.
  From the advanced topic configuration section, you can specify additional configuration options for Kafka topics, such as the cleanup policy, retention period, flush interval, and more.

Improvements

This release focused on improving the quality, readability, reusability, and maintainability of the Klaw codebase. Some of the key improvements include:

• Unit tests were added for the ACLs, Topics, Users, and Teams features to achieve 90% coverage. The tests cover at least 90% of the code for these features, ensuring that a significant portion of Klaw has been thoroughly tested.
• Custom validator for validating new topic requests in the Klaw. This custom validation can improve the modularity and maintainability of Klaw, allowing the validation logic to be isolated and easily managed.
• Improvements to the Klaw documentation include a new Release section for easy access to all release information.
• Refactoring the codebase of Klaw to help improve usability and readability while also making it easier for developers to work with and maintain the code.
• You can now rename the default username for the superadmin account. Klaw includes a new property klaw.superadmin.default.username, in the appilcation.properties file on the Klaw core module that allows you to rename the superadmin user name from the default "superadmin" to a username of your choice. You can change the superadmin username during the initial setup of Klaw or at any time from the application.properties file on the Klaw core module.
• The superadmin password property is now renamed to klaw.superadmin.default.password in the application.properties file on Klaw core module.
• The database table 'kwtopicrequests' includes a new column 'jsonparams' to accommodate any new parameters as a part of the Advanced topic configurations. The Liquibase database migration framework will take care of adding the column while upgrading Klaw.

Bugs

A restriction in the front-end of Klaw prevents users from approving their own requests. In this case, the request is not even being sent to the backend, despite the fact that there is a validation in the backend to prevent this from happening.

Upgrade

To upgrade to this release, download the package from https://github.com/aiven/klaw/releases/tag/1.2.0 and follow the instructions on Klaw documentation to upgrade. You can also refer to the README file for information.

• application.properties :

  • React based UI - New property is introduced in core module to enable new interface based on React

klaw.coral.enabled=true

• Azure AD - Below configuration (in core module) is required to configure Klaw for Azure AD based Authentication

  klaw.sso.server.loginurl=/oauth2/authorization/azure
  spring.cloud.azure.active-directory.enabled=true
  spring.cloud.azure.active-directory.profile.tenant-id=tenantid
  spring.cloud.azure.active-directory.credential.client-id=clientid
  spring.cloud.azure.active-directory.credential.client-secret=client-secret

• Default superadmin account - New property is introduced for the username of superadmin for first time installation

	klaw.superadmin.default.username=superadmin

klaw.superadmin.default.password Property is renamed to klaw.superadmin.default.password

       klaw.superadmin.default.password=kwsuperadmin123$$

• Database : To accommodate any new parameters in topic requests, a new column introduced in kwtopicrequests/jsonparams Liquibase database migration framework will take care of adding the column while upgrading.

Change log

Full Changelog: 1.1.0...1.2.0

Contributors

The below contributors have contributed to this release.

Mirjam Aulbach
Samuli Suortti
Mathieu Anderson
Murali Basani
Sergey Nuyanzin
Josep Prat
Harshini Rangaswamy

---

This discussion was created from the release 1.2.0.