diff --git a/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt b/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt index f57d6502..fb629fe2 100644 --- a/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt +++ b/.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt @@ -77,4 +77,6 @@ uncomment cluster-api gtag UI -unencrypted \ No newline at end of file +unencrypted +kwregisterusers +Json \ No newline at end of file diff --git a/docs/releases/release280.md b/docs/releases/release280.md index dfc875fc..fa772d3a 100644 --- a/docs/releases/release280.md +++ b/docs/releases/release280.md @@ -55,7 +55,7 @@ is true by default): ```properties #Enable new Klaw user interface - klaw.coral.enabled=false +klaw.coral.enabled=false ``` :::note diff --git a/docs/releases/release290.md b/docs/releases/release290.md new file mode 100644 index 00000000..c1860789 --- /dev/null +++ b/docs/releases/release290.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 99.86 +--- + +# Release 2.9.0 + +Date: 8th of April, 2024 + +## Overview + +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 + +### 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: + +- 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 +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 + +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 feature + +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 + +### Bug fixes + +- 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 + +### Database upgrade + +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 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..67026ddf --- /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 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. +::: + +## About claim subscription + +Subscription claims can currently only be initiated through the Angular (old) UI. However, transfer approval is possible through any user interface (old and new). + +Klaw has introduced a new workflow requiring approval from multiple parties: + +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. + +:::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. +::: + +## Create a claim subscription request + +Once a subscription is created in an environment, another team can claim the subscription associated with a topic. + +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. + + :::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. + ::: + +4. Confirm that you want to claim the subscription. +5. This action creates a subscription claim request. + +## Limitations + +The current implementation of the subscription claim process has the following limitations: + +- **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. 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", ], }, {