From f00a66b76155cfabb3c790951a72edf835150efa Mon Sep 17 00:00:00 2001 From: Raushan Sharma Date: Fri, 6 Oct 2023 12:03:12 +0530 Subject: [PATCH] update-klaw-core --- README.md | 2 +- docs/Concepts/high-availability.md | 2 +- docs/HowTo/authentication/google-account.md | 2 +- docs/HowTo/authentication/userpwd-db.md | 2 +- .../clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md | 2 +- .../aiven-kafka-connect-cluster-ssl-protocol.md | 2 +- .../aiven-karapace-cluster-ssl-protocol.md | 2 +- .../confluent-cloud-kafka-cluster-ssl-protocol.md | 2 +- docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md | 2 +- docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md | 4 ++-- docs/HowTo/clusterconnectivity/klaw-db-connection.md | 4 ++-- docs/HowTo/installation/configure-klaw-wizard.md | 2 +- docs/HowTo/installation/run-source.md | 2 +- .../kafka-cluster-migration/sync-connectors-from-cluster.md | 2 +- docs/Releases/release100.md | 2 +- docs/Releases/release110.md | 2 +- docs/Releases/release240.md | 4 ++-- docs/Releases/release250.md | 4 ++-- docs/Releases/release251.md | 4 ++-- 19 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index a2e21ded..8a976652 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## About This is the Klaw documentation repository. Welcome 👋 🎉 -You can find source code and all content for our ([klaw-project.io](https://www.klaw-project.io/) site here. +You can find source code and all content for our ([Klaw-project.io](https://www.klaw-project.io/) site here. We're using [Docusaurus](https://docusaurus.io/docs) to build our documentation, an optimized site generator in React. diff --git a/docs/Concepts/high-availability.md b/docs/Concepts/high-availability.md index 19692ca7..44bcc153 100644 --- a/docs/Concepts/high-availability.md +++ b/docs/Concepts/high-availability.md @@ -31,7 +31,7 @@ software architecture that surpasses hardware limitations. ## How High Availability Works -In the Klaw core module, configure the below property, which is a +In the Klaw Core module, configure the below property, which is a comma-separated list of Klaw instances. klaw.uiapi.servers=https://klawhost1:9097,https://klawhost2:9097 diff --git a/docs/HowTo/authentication/google-account.md b/docs/HowTo/authentication/google-account.md index 90832d30..489691c8 100644 --- a/docs/HowTo/authentication/google-account.md +++ b/docs/HowTo/authentication/google-account.md @@ -36,7 +36,7 @@ in the Klaw-core module to enable the use of Google account login. 5. Configure an existing SUPERADMIN user from AD to approve new users in the following property for username: - + 6. If you have already signed up with Google, you will be redirected to the Klaw home page. diff --git a/docs/HowTo/authentication/userpwd-db.md b/docs/HowTo/authentication/userpwd-db.md index fce6120f..af13ec79 100644 --- a/docs/HowTo/authentication/userpwd-db.md +++ b/docs/HowTo/authentication/userpwd-db.md @@ -17,7 +17,7 @@ To enable authentication with the Klaw database, follow these steps: encryption key to encrypt your password before it is stored in the database. The encryption key is used to secure and protect your password. - klaw.jasypt.encryptor.secretkey=kw2021secretkey + Klaw.jasypt.encryptor.secretkey=kw2021secretkey 3. **Decrypt password:** The password stored in the database can be decrypted with the following java code. diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md index c06ff83d..fc147e82 100644 --- a/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md +++ b/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md @@ -50,7 +50,7 @@ Kafka® and Klaw using SSL protocol: icon that is available on the right-hand side of each cluster row. 9. Open the `application.properties` file located in the - [klaw/cluster-api/src/main/resources] directory. + [Klaw/cluster-api/src/main/resources] directory. 10. Configure the SSL properties to connect to Aiven for Apache Kafka® clusters by copying and editing the following lines. diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md index 72c04597..25b2f690 100644 --- a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md +++ b/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md @@ -52,7 +52,7 @@ Kafka Connect service with Klaw using SSL protocol: the copy icon that is available on the right-hand side of each cluster row. -8. In the `application.properties` file for [cluster-api] (klaw/cluster-api/src/main/resources) module, configure Aiven for Apache Kafka Connect credentials copied from Aiven console: +8. In the `application.properties` file for [cluster-api] (Klaw/cluster-api/src/main/resources) module, configure Aiven for Apache Kafka Connect credentials copied from Aiven console: `clusterid.klaw.kafkaconnect.credentials=username:password` diff --git a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md index 4df7b3ff..b5a8d1d4 100644 --- a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md +++ b/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md @@ -45,7 +45,7 @@ registry cluster with Klaw using SSL protocol: Environment** and enter the details to add your schema registry environment. Click **Save**. 7. Open the `application.properties` file for [cluster-api] - (klaw/cluster-api/src/main/resources) modules. + (Klaw/cluster-api/src/main/resources) modules. 8. Copy the **Cluster ID** from the **Clusters** page using the copy icon that is available on the right-hand side of each cluster row. diff --git a/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md index 5c5ff992..b8bab095 100644 --- a/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md +++ b/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md @@ -57,7 +57,7 @@ Follow the steps below to configure and connect to a Confluent Cloud Kafka and K icon that is available on the right-hand side of each cluster row. 9. Open the `application.properties` file located in the - [klaw/cluster-api/src/main/resources] directory. + [Klaw/cluster-api/src/main/resources] directory. 10. Configure the API key, API secret, URIs to connect to Confluent Cloud Kafka clusters by copying and editing the following lines: diff --git a/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md index 7399e72c..0a2969a4 100644 --- a/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md +++ b/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md @@ -43,7 +43,7 @@ cluster in Klaw using SSL protocol: icon that is available on the right-hand side of each cluster row. 9. Open the `application.properties` file located in the - [klaw/cluster-api/src/main/resources] directory. + [Klaw/cluster-api/src/main/resources] directory. 10. Configure the SSL properties to connect to Apache Kafka clusters by copying and editing the following lines: diff --git a/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md b/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md index f1bf3265..4a445fd5 100644 --- a/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md +++ b/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md @@ -6,8 +6,8 @@ respective `application.properties` files and verifying the connectivity between You can find the `application.properties` file located in the following paths: -- Core: [klaw/core/src/main/resources] -- Cluster-api: [klaw/cluster-api/src/main/resources] +- Core: [Klaw/core/src/main/resources] +- Cluster-api: [Klaw/cluster-api/src/main/resources] ## Configure Klaw application.properties file diff --git a/docs/HowTo/clusterconnectivity/klaw-db-connection.md b/docs/HowTo/clusterconnectivity/klaw-db-connection.md index 242edca3..272a7dbf 100644 --- a/docs/HowTo/clusterconnectivity/klaw-db-connection.md +++ b/docs/HowTo/clusterconnectivity/klaw-db-connection.md @@ -8,7 +8,7 @@ RDBMS, such as MySQL, Oracle, or PostgreSQL. The configuration for the default file-based database in Klaw is specified in the `application.properties` file in the core -(klaw/core/src/main/resources) module. For example, your configuration +(Klaw/core/src/main/resources) module. For example, your configuration might look something similar to this: ```java @@ -30,7 +30,7 @@ MySQL, Oracle, or PostgreSQL. To configure a connection to a relational database management system (RDBMS) such as Postgres, Oracle, or MySQL, you need to edit the `application.properties` file location in the -core(klaw/core/src/main/resources) module, with the connection details +core(Klaw/core/src/main/resources) module, with the connection details for your database. Below is a sample configuration for MySQL: diff --git a/docs/HowTo/installation/configure-klaw-wizard.md b/docs/HowTo/installation/configure-klaw-wizard.md index bbaa6584..09ab33bd 100644 --- a/docs/HowTo/installation/configure-klaw-wizard.md +++ b/docs/HowTo/installation/configure-klaw-wizard.md @@ -56,7 +56,7 @@ URL: [https://host:port/helpwizard] Klaw is multi-tenant by default. Every tenant has its own set of Kafka environments, and users of one tenant cannot view/access topics, or ACLs from other tenants. To configure tenants, navigate to **Dashboard -\> - Settings**, and look for [klaw.tenant.config]. + Settings**, and look for [Klaw.tenant.config]. Example : diff --git a/docs/HowTo/installation/run-source.md b/docs/HowTo/installation/run-source.md index b3f94042..06657508 100644 --- a/docs/HowTo/installation/run-source.md +++ b/docs/HowTo/installation/run-source.md @@ -74,4 +74,4 @@ the source. ## Next Steps Once you have finished verifying your installation, we recommend you follow the documentation -in [configure-klaw-wizard](configure-klaw-wizard.md). +in [configure-klaw-wizard](configure-Klaw-wizard.md). diff --git a/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md b/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md index 3044804a..a4279d22 100644 --- a/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md +++ b/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md @@ -26,4 +26,4 @@ them to a team in Klaw. In case a connector is deleted from the cluster but still exists in Klaw metadata, you can remove it by selecting -**REMOVE FROM KLAW** at the end of the corresponding record. +**REMOVE FROM Klaw** at the end of the corresponding record. diff --git a/docs/Releases/release100.md b/docs/Releases/release100.md index e95961f1..97e0bbba 100644 --- a/docs/Releases/release100.md +++ b/docs/Releases/release100.md @@ -13,7 +13,7 @@ Klaw version 1.0.0 is a first major release. - Klaw (formerly Kafkawize) Initial Release 1.0.0 - This release is cloned from main branch of -- Package renamed to io.aiven.klaw +- Package renamed to io.aiven.Klaw - Introduced 'Kafka flavor' in the configuration of clusters - Changes to manage Aiven ACLs - All occurrences of Kafkawize renamed to Klaw diff --git a/docs/Releases/release110.md b/docs/Releases/release110.md index 561101cd..bf3450f7 100644 --- a/docs/Releases/release110.md +++ b/docs/Releases/release110.md @@ -18,7 +18,7 @@ improvements. connect to Apache Kafka clusters. - Enabled JWT-based authentication: Enabled JWT-based authentication to connect to Klaw Cluster API. You can configure - klaw.clusterapi.access.base64.secret in both core and cluster-api + Klaw.clusterapi.access.base64.secret in both core and cluster-api modules to enable this authentication between APIs. - Connect to multiple clusters using SSL: This release includes the functionality to configure Klaw to connect to multiple Apache Kafka diff --git a/docs/Releases/release240.md b/docs/Releases/release240.md index 28d02d8b..8219fb71 100644 --- a/docs/Releases/release240.md +++ b/docs/Releases/release240.md @@ -16,13 +16,13 @@ schemas from schema registry to Klaw, and vice versa. ### Binaries -[klaw-2.4.0.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/klaw-2.4.0.jar) +[Klaw-2.4.0.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/klaw-2.4.0.jar) [cluster-api-2.4.0.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/cluster-api-2.4.0.jar) ### Sources -[klaw-2.4.0.zip ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v2.4.0.zip) +[Klaw-2.4.0.zip ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v2.4.0.zip) ## What's new in Klaw 2.4.0 diff --git a/docs/Releases/release250.md b/docs/Releases/release250.md index f4cc7da0..e9c5f783 100644 --- a/docs/Releases/release250.md +++ b/docs/Releases/release250.md @@ -16,13 +16,13 @@ schemas from schema registry to Klaw, and vice versa. ### Binaries -[klaw-2.5.0.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/klaw-2.5.0.jar) +[Klaw-2.5.0.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/klaw-2.5.0.jar) [cluster-api-2.5.0.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/cluster-api-2.5.0.jar) ### Sources -[klaw-2.5.0.zip ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v2.5.0.zip) +[Klaw-2.5.0.zip ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v2.5.0.zip) ### Docker diff --git a/docs/Releases/release251.md b/docs/Releases/release251.md index eca65e7c..269c11d4 100644 --- a/docs/Releases/release251.md +++ b/docs/Releases/release251.md @@ -14,13 +14,13 @@ Klaw version 2.5.1 is a patch release primarily aimed at enhancing MySQL support ### Binaries -- [klaw-2.5.1.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/klaw-2.5.1.jar) +- [Klaw-2.5.1.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/klaw-2.5.1.jar) - [cluster-api-2.5.1.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/cluster-api-2.5.1.jar) ### Sources -- [klaw-2.5.1.zip ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v2.5.1.zip) +- [Klaw-2.5.1.zip ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v2.5.1.zip) ### Docker