From 4042b0132fe620149b55024ca5186cd22fd89d7f Mon Sep 17 00:00:00 2001 From: Aindriu Lavelle Date: Tue, 6 Feb 2024 10:39:12 +0000 Subject: [PATCH 1/9] Adding the initial updates to the documentation for release 2.8.0 Signed-off-by: Aindriu Lavelle --- docs/releases/release280.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/releases/release280.md b/docs/releases/release280.md index dfc875fc..76a5bb76 100644 --- a/docs/releases/release280.md +++ b/docs/releases/release280.md @@ -1,6 +1,6 @@ --- + sidebar_position: 99.88 ---- # Release 2.8.0 @@ -16,6 +16,7 @@ kafka clients on schema changes ### Binaries + [`klaw-2.8.0.jar` ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.8.0/klaw-2.8.0.jar) [`cluster-api-2.8.0.jar` ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.8.0/cluster-api-2.8.0.jar) @@ -37,6 +38,7 @@ In this release, we have redesigned the user interface using React to enhance th Key updates in the new React UI include: + - Topic catalog - Filter by Topic type ![image](../../static/images/release280/Filter-by.png) - Activity log @@ -87,6 +89,7 @@ The documentation website has an updated navigation to improve usability. ### DB upgrade + In this release, there is a migration utility to add a new fine-grain permission. :::note From 8af6d4d5c767173aaa11bccbd4c88602b68c171a Mon Sep 17 00:00:00 2001 From: Aindriu Lavelle Date: Thu, 4 Apr 2024 16:00:46 +0100 Subject: [PATCH 2/9] Add initial commit for relesae 2.9.0 Signed-off-by: Aindriu Lavelle --- docs/releases/release280.md | 7 +- docs/releases/release290.md | 95 +++++++++++++++++++ .../subscription/claim-subscription.md | 44 +++++++++ 3 files changed, 141 insertions(+), 5 deletions(-) create mode 100644 docs/releases/release290.md create mode 100644 docs/workflows/subscription/claim-subscription.md diff --git a/docs/releases/release280.md b/docs/releases/release280.md index 76a5bb76..fa772d3a 100644 --- a/docs/releases/release280.md +++ b/docs/releases/release280.md @@ -1,6 +1,6 @@ --- - sidebar_position: 99.88 +--- # Release 2.8.0 @@ -16,7 +16,6 @@ kafka clients on schema changes ### Binaries - [`klaw-2.8.0.jar` ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.8.0/klaw-2.8.0.jar) [`cluster-api-2.8.0.jar` ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.8.0/cluster-api-2.8.0.jar) @@ -38,7 +37,6 @@ In this release, we have redesigned the user interface using React to enhance th Key updates in the new React UI include: - - Topic catalog - Filter by Topic type ![image](../../static/images/release280/Filter-by.png) - Activity log @@ -57,7 +55,7 @@ is true by default): ```properties #Enable new Klaw user interface - klaw.coral.enabled=false +klaw.coral.enabled=false ``` :::note @@ -89,7 +87,6 @@ The documentation website has an updated navigation to improve usability. ### DB upgrade - In this release, there is a migration utility to add a new fine-grain permission. :::note diff --git a/docs/releases/release290.md b/docs/releases/release290.md new file mode 100644 index 00000000..13882004 --- /dev/null +++ b/docs/releases/release290.md @@ -0,0 +1,95 @@ +--- +sidebar_position: 99.87 +--- + +# Release 2.9.0 + +Date: 8th of April, 2024 + +## Overview + +Overview +Klaw version 2.9.0 is a patch release which fixes an issue introduced in 2.9.0 with some minor bug fixes and improvements. + +## Download + +### Binaries + +[`klaw-2.9.0.jar` ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.9.0/klaw-2.9.0.jar) + +[`cluster-api-2.9.0.jar` ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.9.0/cluster-api-2.9.0.jar) + +### Sources + +[`klaw-2.9.0.zip` ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v2.9.0.zip) + +### Docker + +- [Klaw Core](https://hub.docker.com/r/aivenoy/klaw-core) +- [Klaw Cluster API](https://hub.docker.com/r/aivenoy/klaw-cluster-api) + +## What's new in Klaw 2.9.0 + +### Redesigned screens with React UI + +In this release, we have redesigned the user interface using React to enhance the user experience and provide a more intuitive design. + +Key updates in the new React UI include: + +- Topic catalog - Filter by Topic type + ![image](../../static/images/release280/Filter-by.png) +- Activity log + ![image](../../static/images/release280/Activity-Log.png) +- Dashboard landing page + ![image](../../static/images/release280/Dashboard.png) +- View clusters + ![image](../../static/images/release280/view-clusters.png) +- View environments + ![image](../../static/images/release280/view-envs.png) + +To disable the preview for the new Klaw user interface, open the +`application.properties` file on the Klaw **core** module, and set the +value of the following property to `false` (Effective from version 2.4.0, it +is true by default): + +```properties + #Enable new Klaw user interface + klaw.coral.enabled=false +``` + +:::note +We are taking an incremental, feedback-driven approach in rolling out +the new Klaw interfaces. By providing the feature flag to preview the user +interfaces, we would like you to share your valuable +[feedback](https://github.com/aiven/klaw/issues/new?assignees=&labels=&template=03_feature.md). +::: + +### JSON Schema support in Coral and Angular UIs + +Klaw now supports provisioning Json Schemas through both the Angular and React UI. Previously only Schemas of type Avro were supported. + +### BETA Release of ACL Claim functionality + +We are pleased to announce the Beta release of Claim ACL/Subscription functionality. This functionality still has some limitations that we will be improving in upcoming releases. +Please see the ACL Claim page for more information on these limitations. + +### Improvements + +- Admin Guards on all APIs for roles for enhanced security and enhanced user feedback +- Delete Service Users when ACLs are deleted +- Declined User requests can be reused + +### Bug fixes + +- Allow creating new users with an email address as a username +- Fix the default schema version on promote to be an informational message in angular UI +- Fix unused script and unsafe links +- Fix target=blank vulnerability + +### DB upgrade + +In this release, there is a new primary key added to the kwregisterusers table to allow previously denied usernames to be re-used in future requests. + +:::note +For a complete list of improvements, changelog, and to download the +release, see [GitHub release tag v2.9.0](https://github.com/aiven/klaw/releases/tag/v2.9.0) diff --git a/docs/workflows/subscription/claim-subscription.md b/docs/workflows/subscription/claim-subscription.md new file mode 100644 index 00000000..9edac07d --- /dev/null +++ b/docs/workflows/subscription/claim-subscription.md @@ -0,0 +1,44 @@ +# Claim a subscription + +To claim an existing subscription in Klaw, from another team. +:::note +This functionality is in Beta as of Klaw release 2.9.0 and we are working to improve it in upcoming releases. +At the moment this functionality is only available through the older angular user interface. +::: + +## Create a claim subscription request + +Once a subscription is created in an environment, it is possible to +claim the subscription from the topic if you are another team. + +1. In Klaw, select **Topics** on the navigation bar. +2. Choose the specific Apache Kafka® topic where the subscription you wish to + claim is located. +3. Select the blue **Claim** on the right-hand side of the subscriptions table at the bottom of the topic overview. + + :::note + This request can be raised by any team that does not currently own the subscription. + On Approval it requires two approvals, one from the topic owner who needs to approve a team accessing their data + and secondly by the current subscription owner. + ::: + +4. Confirm that you are sure you wish to claim the subscription. +5. A claim subscription request is created. + +## Notes on Claim Subscription + +Claim functionality is currently only available to be initiated through the Angular(old) UI. Although approvals can be made through either UI. + +This is the first time Klaw has introduced the need for more than one approver for a request. +The Topic owner needs to approve the request as the data owner, and the existing owner needs to approve the transfer of the subscription to the new team. + +The Service User will not transfer over to the new team until all subscriptions owned by the original team for that service user are transferred to the new team. + +The topic owner must be the first approval, this is not reflected well in the UI and this user experience is planned to be improved as we move forward. + +## Limitations to the current implementation + +Currently when looking at the subscription table if a team has multiple service users for a topic it will not be possible to see if you have correctly selected the desired service account until after the claim request is created. +Once created you can see htis information on the "My Teams Requests" page along with the two teams who are required to approve the claim. + +We do not currently recommend using this functionality with IP based subscriptions support for these will be part of Klaw 2.10.0 From a08fb7825c9f42272b8783c8aa5de3bf8dbbeb6c Mon Sep 17 00:00:00 2001 From: Aindriu Lavelle Date: Thu, 4 Apr 2024 16:04:22 +0100 Subject: [PATCH 3/9] Add vale update commit for relesae 2.9.0 Signed-off-by: Aindriu Lavelle --- docs/releases/release290.md | 6 +++--- docs/workflows/subscription/claim-subscription.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/releases/release290.md b/docs/releases/release290.md index 13882004..e1eb2548 100644 --- a/docs/releases/release290.md +++ b/docs/releases/release290.md @@ -64,9 +64,9 @@ interfaces, we would like you to share your valuable [feedback](https://github.com/aiven/klaw/issues/new?assignees=&labels=&template=03_feature.md). ::: -### JSON Schema support in Coral and Angular UIs +### JSON Schema support in Coral and Angular -Klaw now supports provisioning Json Schemas through both the Angular and React UI. Previously only Schemas of type Avro were supported. +Klaw now supports provisioning JSON Schemas through both the Angular and React UI. Previously only Schemas of type Avro were supported. ### BETA Release of ACL Claim functionality @@ -88,7 +88,7 @@ Please see the ACL Claim page for more information on these limitations. ### DB upgrade -In this release, there is a new primary key added to the kwregisterusers table to allow previously denied usernames to be re-used in future requests. +In this release, there is a new primary key added to the "kwregisterusers" table to allow previously denied usernames to be re-used in future requests. :::note For a complete list of improvements, changelog, and to download the diff --git a/docs/workflows/subscription/claim-subscription.md b/docs/workflows/subscription/claim-subscription.md index 9edac07d..bab2a052 100644 --- a/docs/workflows/subscription/claim-subscription.md +++ b/docs/workflows/subscription/claim-subscription.md @@ -39,6 +39,6 @@ The topic owner must be the first approval, this is not reflected well in the UI ## Limitations to the current implementation Currently when looking at the subscription table if a team has multiple service users for a topic it will not be possible to see if you have correctly selected the desired service account until after the claim request is created. -Once created you can see htis information on the "My Teams Requests" page along with the two teams who are required to approve the claim. +Once created you can see this information on the "My Teams Requests" page along with the two teams who are required to approve the claim. We do not currently recommend using this functionality with IP based subscriptions support for these will be part of Klaw 2.10.0 From f3fcdbfd14fb47221bf237a931158cfc1beeae81 Mon Sep 17 00:00:00 2001 From: Aindriu Lavelle Date: Thu, 4 Apr 2024 16:05:19 +0100 Subject: [PATCH 4/9] Add release update commit for relesae 2.9.0 Signed-off-by: Aindriu Lavelle --- docs/releases/release290.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/release290.md b/docs/releases/release290.md index e1eb2548..8261dcad 100644 --- a/docs/releases/release290.md +++ b/docs/releases/release290.md @@ -1,5 +1,5 @@ --- -sidebar_position: 99.87 +sidebar_position: 99.86 --- # Release 2.9.0 From 12afec2ab7d0a0c5a15d690121a6c7e3eeec78c7 Mon Sep 17 00:00:00 2001 From: Aindriu Lavelle Date: Thu, 4 Apr 2024 16:06:21 +0100 Subject: [PATCH 5/9] Add release update commit for relesae 2.9.0 Signed-off-by: Aindriu Lavelle --- docs/releases/release290.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/release290.md b/docs/releases/release290.md index 8261dcad..4a50017c 100644 --- a/docs/releases/release290.md +++ b/docs/releases/release290.md @@ -9,7 +9,7 @@ Date: 8th of April, 2024 ## Overview Overview -Klaw version 2.9.0 is a patch release which fixes an issue introduced in 2.9.0 with some minor bug fixes and improvements. +Klaw version 2.9.0 is a patch release which fixes an issue introduced in 2.8.0 with some minor bug fixes and improvements. ## Download From 70c937efb9d66d3e80216cffea517b38d67af430 Mon Sep 17 00:00:00 2001 From: Aindriu Lavelle Date: Thu, 4 Apr 2024 16:11:18 +0100 Subject: [PATCH 6/9] Updating klaw vocab with a table name Signed-off-by: Aindriu Lavelle --- .github/vale/styles/Klaw/spelling-klaw-vocabulary.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt b/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt index f57d6502..f4f0b99a 100644 --- a/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt +++ b/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt @@ -77,4 +77,5 @@ uncomment cluster-api gtag UI -unencrypted \ No newline at end of file +unencrypted +kwregisterusers \ No newline at end of file From aea4958c32213ccfeb98ea08f23977a9470b5545 Mon Sep 17 00:00:00 2001 From: Harshini Rangaswamy Date: Fri, 5 Apr 2024 10:42:56 +0200 Subject: [PATCH 7/9] reviewed and updated content Signed-off-by: Harshini Rangaswamy --- docs/releases/release290.md | 37 ++++++------- .../subscription/claim-subscription.md | 54 +++++++++---------- 2 files changed, 46 insertions(+), 45 deletions(-) diff --git a/docs/releases/release290.md b/docs/releases/release290.md index 4a50017c..f84ef49b 100644 --- a/docs/releases/release290.md +++ b/docs/releases/release290.md @@ -8,8 +8,7 @@ Date: 8th of April, 2024 ## Overview -Overview -Klaw version 2.9.0 is a patch release which fixes an issue introduced in 2.8.0 with some minor bug fixes and improvements. +Klaw version 2.9.0 is a patch release that fixes an issue introduced in 2.8.0 and includes minor bug fixes and improvements. ## Download @@ -47,7 +46,7 @@ Key updates in the new React UI include: - View environments ![image](../../static/images/release280/view-envs.png) -To disable the preview for the new Klaw user interface, open the +To turn off the preview for the new Klaw user interface, open the `application.properties` file on the Klaw **core** module, and set the value of the following property to `false` (Effective from version 2.4.0, it is true by default): @@ -64,32 +63,34 @@ interfaces, we would like you to share your valuable [feedback](https://github.com/aiven/klaw/issues/new?assignees=&labels=&template=03_feature.md). ::: -### JSON Schema support in Coral and Angular +### JSON schema support in Coral and Angular -Klaw now supports provisioning JSON Schemas through both the Angular and React UI. Previously only Schemas of type Avro were supported. +Klaw now supports provisioning JSON schemas through both the Angular and React UI. Previously, only Schemes of type Avro were supported. -### BETA Release of ACL Claim functionality +### Beta release of ACL claim feature -We are pleased to announce the Beta release of Claim ACL/Subscription functionality. This functionality still has some limitations that we will be improving in upcoming releases. -Please see the ACL Claim page for more information on these limitations. +We are excited to announce that the beta version of Claim ACL/Subscription feature has been released. However, some limitations will be addressed in the upcoming releases. For more information about these limitations, see ACL Claim. ### Improvements -- Admin Guards on all APIs for roles for enhanced security and enhanced user feedback -- Delete Service Users when ACLs are deleted -- Declined User requests can be reused +- Admin guards on all APIs for roles for enhanced security and enhanced user feedback +- Delete service users when ACLs are deleted +- Declined user requests can be reused ### Bug fixes -- Allow creating new users with an email address as a username -- Fix the default schema version on promote to be an informational message in angular UI -- Fix unused script and unsafe links -- Fix target=blank vulnerability +- Allowed creating new users with an email address as a username +- Fixed the default schema version on promote to be an informational message in angular UI +- Fixed unused scripts and unsafe links +- Fixed `target=blank` vulnerability -### DB upgrade +### Database upgrade -In this release, there is a new primary key added to the "kwregisterusers" table to allow previously denied usernames to be re-used in future requests. +This release adds a new primary key to the `kwregisterusers` table, allowing previously denied usernames to be reused in future requests. :::note -For a complete list of improvements, changelog, and to download the + +For a complete list of improvements, changelog, and download the release, see [GitHub release tag v2.9.0](https://github.com/aiven/klaw/releases/tag/v2.9.0) + +::: diff --git a/docs/workflows/subscription/claim-subscription.md b/docs/workflows/subscription/claim-subscription.md index bab2a052..67026ddf 100644 --- a/docs/workflows/subscription/claim-subscription.md +++ b/docs/workflows/subscription/claim-subscription.md @@ -1,44 +1,44 @@ # Claim a subscription -To claim an existing subscription in Klaw, from another team. +To claim an existing subscription in Klaw from another team. + :::note -This functionality is in Beta as of Klaw release 2.9.0 and we are working to improve it in upcoming releases. -At the moment this functionality is only available through the older angular user interface. +This feature is in beta as of Klaw release 2.9.0, with improvements planned for upcoming releases. Currently, it is available only through the older Angular user interface. ::: -## Create a claim subscription request +## About claim subscription -Once a subscription is created in an environment, it is possible to -claim the subscription from the topic if you are another team. +Subscription claims can currently only be initiated through the Angular (old) UI. However, transfer approval is possible through any user interface (old and new). -1. In Klaw, select **Topics** on the navigation bar. -2. Choose the specific Apache Kafka® topic where the subscription you wish to - claim is located. -3. Select the blue **Claim** on the right-hand side of the subscriptions table at the bottom of the topic overview. +Klaw has introduced a new workflow requiring approval from multiple parties: - :::note - This request can be raised by any team that does not currently own the subscription. - On Approval it requires two approvals, one from the topic owner who needs to approve a team accessing their data - and secondly by the current subscription owner. - ::: +1. **Topic owner approval (data owner)**: The topic (data) owner, as the data owner, must approve the request first. +2. **Existing owner approval (subscription transfer)**: The current subscription owner must approve the transfer to the new team. + +The **Service User** associated with the subscription won't be transferred until **all** subscriptions owned by the original team for that user are transferred to the new team. -4. Confirm that you are sure you wish to claim the subscription. -5. A claim subscription request is created. +:::note +While the UI might not explicitly state it, the topic owner's approval is always required first. We're actively working on improving the UI clarity in future updates. +::: -## Notes on Claim Subscription +## Create a claim subscription request -Claim functionality is currently only available to be initiated through the Angular(old) UI. Although approvals can be made through either UI. +Once a subscription is created in an environment, another team can claim the subscription associated with a topic. -This is the first time Klaw has introduced the need for more than one approver for a request. -The Topic owner needs to approve the request as the data owner, and the existing owner needs to approve the transfer of the subscription to the new team. +1. In Klaw, click **Topics** on the navigation bar. +2. Select the Apache Kafka® topic that has the subscription you want to claim. +3. Click **Claim** from the subscriptions table on the topic overview. -The Service User will not transfer over to the new team until all subscriptions owned by the original team for that service user are transferred to the new team. + :::note + Any team other than the current subscription owner can initiate this claim. The process requires two approvals: one from the topic owner for allowing another team access to their data and another from the current subscription holder. + ::: -The topic owner must be the first approval, this is not reflected well in the UI and this user experience is planned to be improved as we move forward. +4. Confirm that you want to claim the subscription. +5. This action creates a subscription claim request. -## Limitations to the current implementation +## Limitations -Currently when looking at the subscription table if a team has multiple service users for a topic it will not be possible to see if you have correctly selected the desired service account until after the claim request is created. -Once created you can see this information on the "My Teams Requests" page along with the two teams who are required to approve the claim. +The current implementation of the subscription claim process has the following limitations: -We do not currently recommend using this functionality with IP based subscriptions support for these will be part of Klaw 2.10.0 +- **Service user selection visibility**: The interface does not provide immediate confirmation of the selected service user when claiming a subscription. The selection details and the approval workflow become visible after submitting the claim and are available on the **My Teams Requests** page, indicating the necessary approvals. +- **IP-based subscription support**:Claims for IP-based subscriptions are not yet supported. It is advisable to avoid using this feature for IP-based subscriptions until Klaw version 2.10.0 provides the necessary support. From 60aa9bb3b42f38de14dc9ca4d17eb5cd7ada7473 Mon Sep 17 00:00:00 2001 From: Aindriu Lavelle Date: Mon, 8 Apr 2024 08:26:03 +0100 Subject: [PATCH 8/9] Add Claim Subscriptions to the Nav bar, also remove features added for react in 2.8.0 Signed-off-by: Aindriu Lavelle --- docs/releases/release290.md | 11 +---------- sidebars.js | 1 + 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/releases/release290.md b/docs/releases/release290.md index f84ef49b..c1860789 100644 --- a/docs/releases/release290.md +++ b/docs/releases/release290.md @@ -35,16 +35,7 @@ In this release, we have redesigned the user interface using React to enhance th Key updates in the new React UI include: -- Topic catalog - Filter by Topic type - ![image](../../static/images/release280/Filter-by.png) -- Activity log - ![image](../../static/images/release280/Activity-Log.png) -- Dashboard landing page - ![image](../../static/images/release280/Dashboard.png) -- View clusters - ![image](../../static/images/release280/view-clusters.png) -- View environments - ![image](../../static/images/release280/view-envs.png) +- Support for Json Schemas To turn off the preview for the new Klaw user interface, open the `application.properties` file on the Klaw **core** module, and set the diff --git a/sidebars.js b/sidebars.js index 21058c97..e11dcca0 100644 --- a/sidebars.js +++ b/sidebars.js @@ -198,6 +198,7 @@ const sidebars = { "workflows/subscription/delete-subscription", "workflows/subscription/manage-subscription-requests", "workflows/subscription/my-subscription-requests", + "workflows/subscription/claim-subscription", ], }, { From 20ef0f51305bd6177ccfe0adce9e871410477b97 Mon Sep 17 00:00:00 2001 From: Aindriu Lavelle Date: Mon, 8 Apr 2024 08:47:31 +0100 Subject: [PATCH 9/9] Fix vale spell check Signed-off-by: Aindriu Lavelle --- .github/vale/styles/Klaw/spelling-klaw-vocabulary.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt b/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt index f4f0b99a..fb629fe2 100644 --- a/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt +++ b/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt @@ -78,4 +78,5 @@ cluster-api gtag UI unencrypted -kwregisterusers \ No newline at end of file +kwregisterusers +Json \ No newline at end of file