Skip to content

Commit

Permalink
Adding features page (#84)
Browse files Browse the repository at this point in the history 
* Adding features page

Signed-off-by: muralibasani <[email protected]>

* Updated with hyperlinks where possible

Signed-off-by: muralibasani <[email protected]>

* Updated with hyperlinks where possible

Signed-off-by: muralibasani <[email protected]>

* Fix links

Signed-off-by: muralibasani <[email protected]>

* Updating index

Signed-off-by: muralibasani <[email protected]>

* Updated feature descriptions

* Re-ordered abit

Signed-off-by: muralibasani <[email protected]>

* Removing package-lock from gitignore

Signed-off-by: muralibasani <[email protected]>

---------

Signed-off-by: muralibasani <[email protected]>
Co-authored-by: muralibasani <[email protected]>
Co-authored-by: Harshini Rangaswamy <[email protected]>
  • Loading branch information
@muralibasani @harshini-rangaswamy
3 people authored Sep 21, 2023
1 parent e867a07 commit 00f9a4e
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 13 deletions.
11 changes: 9 additions & 2 deletions docs/HowTo/authentication/windows-ad.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,19 @@ Before you can proceed with using your Windows Active directory credentials, you
#spring.ad.filter=
```
3. If you have already signed up, you will be directed to the Klaw home
3. Configure an existing SUPERADMIN user from AD (which already exists) to approve new users
in the following property for username:
```
[email protected]
```
4. If you have already signed up, you will be directed to the Klaw home
page.
![image](../../../static/images/authentication/login.png)
4. If this is your first time logging in, you will be presented with a
5. If this is your first time logging in, you will be presented with a
signup form to fill in. On submission, a request will be created for
the Klaw Administrator to approve or decline.
Expand Down
3 changes: 2 additions & 1 deletion docs/HowTo/environments.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Manage environments

Environments in Klaw are similar to application environments that act as
a wrapper over clusters. Each environment in Klaw is associated with a
a wrapper over clusters. Prefix/Suffix or regex patterns on topic names can be defined for example. Each environment in
Klaw is associated with a
cluster and there are three types of environments available:

- Kafka
Expand Down
41 changes: 41 additions & 0 deletions docs/features.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 1.2
---

# Features of Klaw

Explore the comprehensive range of features Klaw offers to manage your Kafka ecosystem more efficiently.

| Feature | Description |
|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [_Topics creation_](HowTo/topics/Request-a-new-topic) | Easily request and approve Kafka Topics for your applications. |
| [_ACLs creation_](HowTo/subscriptions/Request-a-subscription) | Manage access control by requesting and approving Producer and Consumer access to Kafka Topics. |
| [_Schemas creation_](HowTo/schemas/Request-a-schema) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. |
| [_Connectors creation_](HowTo/connectors/Request-a-new-connector) | Request and approve Kafka Connectors for streamlined data integration. |
| [_Promote topics, schemas, connectors_](HowTo/topics/Promote-a-topic) | Define a hierarchy of environments and effortlessly promote entities to higher environments. |
| [_Topic naming conventions_](HowTo/environments) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. |
| [_Schema evolution_](HowTo/schemas/manage-schemas) | Manage multiple versions of schemas efficiently. |
| Reset consumer offsets | Gain the ability to reset consumer offsets for specific consumer groups per topic. |
| View kafka events | Easily view events on any Kafka topic for better monitoring and debugging. |
| View your own topics | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. |
| View consumer lag | Keep track of consumer offsets and view lags for a consumer group. |
| [_Sync topics to a cluster_](HowTo/kafka-cluster-migration/sync-topics-to-cluster) | Synchronize topics with any new or existing Kafka cluster seamlessly. |
| [_Sync topics from a cluster_](HowTo/kafka-cluster-migration/sync-topics-from-cluster) | Synchronize topics from any Kafka cluster to Klaw. |
| [_Sync ACLs to a cluster_](HowTo/kafka-cluster-migration/sync-acls-to-cluster) | Ensure access control by synchronizing access control lists with new or existing Kafka clusters. |
| [_Sync ACLs from a cluster_](HowTo/kafka-cluster-migration/sync-acls-from-cluster) | Ensure the security of your Kafka topics by synchronizing access control lists from any Kafka cluster with Klaw. |
| [_Sync schemas to a cluster_](HowTo/kafka-cluster-migration/sync-schemas-to-cluster) | Maintain consistency by synchronizing schemas, including all versions, to new or existing Schema Registry clusters. |
| [_Sync schemas from a cluster_](HowTo/kafka-cluster-migration/sync-schemas-from-cluster) | Ensure schema consistency by synchronizing schemas from any Schema Registry cluster to Klaw. |
| [_Sync connectors from a cluster_](HowTo/kafka-cluster-migration/sync-connectors-from-cluster) | Efficiently manage connectors by syncing them from any Kafka Connect cluster to Klaw. |
| [_Import / Export Klaw data_](HowTo/exportimport) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. |
| Secured kafka topics | Secure and protect Kafka topics, schemas, and access control lists with defined ownership and access control. |
| [_Controlled access to users_](HowTo/rolespermissions) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. |
| [_Kafka connectivity PLAINTEXT/SSL/SASL_](HowTo/clusterconnectivity) | Connect Klaw to Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. |
| [_Email Notifications_](HowTo/notifications) | Stay informed with email notifications for every request, approval, and Kafka cluster change. |
| [_Analytics / Reports_](HowTo/analytics) | Access and download reports on your requests, topics, consumer groups, and ACL ownership in Klaw. Data availability varies based on your role as USER or SUPERADMIN. |
| Audit history | Keep track of every request, approval, and change with a comprehensive audit history. |
| [_Kafka flavor support_](HowTo/clusters) | Klaw is compatible with multiple Kafka flavors, including Apache Kafka, Aiven Kafka, Confluent Kafka, and Confluent Cloud Kafka. |
| [_Klaw login AD/SSO/DB_](HowTo/authentication) | Users can log in to Klaw using Windows AD or SSO providers like Azure and Google. |

:::note
Klaw is continuously evolving, and many other minor features are also available that are not listed above.
:::
2 changes: 1 addition & 1 deletion docs/getstarted.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1.0
sidebar_position: 1.3
---

# Get started
Expand Down
13 changes: 5 additions & 8 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
---
sidebar_position: 2.0
sidebar_position: 1.0
---

# Klaw Documentation

Klaw consists of two components:

- The main application
- The Cluster API that handles the connections to the Apache Kafka,
Apache Kafka Connect and Schema Registry services.
- The main Klaw core application handling Governance, Security and meta storage.
- The Cluster API handling the connections to the Apache Kafka,
Apache Kafka Connect and Schema Registry servers.

## Quickstart

1. Get the source code and run the project:
[Run from Java source](HowTo/installation/run-source)
2. Once you are up and running, use the guide for next steps:
[Get Started](getstarted)
Copy the docker script and run. It installs Klaw, Kafka, and schema registry servers as docker processes. [**Go through this guide**](./quickstart)
2 changes: 2 additions & 0 deletions docs/quickstart.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_position: 1.1

# Quick Start

In this tutorial, we will install Klaw with docker, and request for a kafka topic and verify its existence on kafka cluster.

## 1. Run the docker script

```typescript copy-button
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ function HomepageHeader() {
<p className="hero__subtitle">{siteConfig.tagline}</p>
<Link
className="button button--secondary button--lg"
to="/docs/getstarted">
to="/docs/">
Go to docs
</Link>
</div>
Expand Down

0 comments on commit 00f9a4e

Please sign in to comment.