From 8e012c83a9896cb537ef2a4b9a3ef5821e518c50 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Thu, 1 Feb 2024 14:50:50 +0100 Subject: [PATCH 01/28] Add new category Getting started Signed-off-by: Mirjam Aulbach --- _redirects | 8 ++++- current-routes.json | 6 ++-- docs/features.md | 41 ------------------------ docs/getting-started/features.md | 41 ++++++++++++++++++++++++ docs/{ => getting-started}/getstarted.md | 4 +-- docs/{ => getting-started}/quickstart.md | 12 +++---- docs/index.md | 2 +- sidebars.js | 26 +++++++++++++-- 8 files changed, 83 insertions(+), 57 deletions(-) delete mode 100644 docs/features.md create mode 100644 docs/getting-started/features.md rename docs/{ => getting-started}/getstarted.md (96%) rename docs/{ => getting-started}/quickstart.md (88%) diff --git a/_redirects b/_redirects index 2a2f0697..939fa88a 100644 --- a/_redirects +++ b/_redirects @@ -2,4 +2,10 @@ /docs/category/Releases /docs/releases 301 /docs/category/concepts /docs/Concepts/clusters-environments 301 -/docs/category/howto /docs/HowTo/analytics 301 \ No newline at end of file +/docs/category/howto /docs/HowTo/analytics 301 + +/docs/features /docs/getting-started/features 301 +/docs/getstarted /docs/getting-started/getstarted 301 +/docs/quickstart /docs/getting-started/quickstart 301 + + diff --git a/current-routes.json b/current-routes.json index d609a8ce..17f5edc8 100644 --- a/current-routes.json +++ b/current-routes.json @@ -41,8 +41,9 @@ "/docs/Concepts/users-teams", "/docs/Concepts/workflows", "/docs/faq", - "/docs/features", - "/docs/getstarted", + "/docs/getting-started/features", + "/docs/getting-started/getstarted", + "/docs/getting-started/quickstart", "/docs/HowTo/analytics", "/docs/HowTo/authentication/", "/docs/HowTo/authentication/azure-ad", @@ -121,7 +122,6 @@ "/docs/HowTo/topics/View-topic-events", "/docs/HowTo/users", "/docs/HowTo/zothers", - "/docs/quickstart", "/docs/releases", "/docs/releases/release100", "/docs/releases/release110", diff --git a/docs/features.md b/docs/features.md deleted file mode 100644 index 290d0e4a..00000000 --- a/docs/features.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 1.2 ---- - -# Features of Klaw - -Explore the comprehensive range of features Klaw offers to manage your Apache Kafka® ecosystem more efficiently. - -| Feature | Description | -| ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [_Topics creation_](HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | -| [_ACLs creation_](HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | -| [_Schemas creation_](HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | -| [_Connectors creation_](HowTo/connectors/Request-a-new-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | -| [_Promote topics, schemas, connectors_](HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | -| [_Topic naming conventions_](HowTo/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | -| [_Schema evolution_](HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | -| [_Reset consumer offsets_](HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | -| [_View Apache Kafka events_](HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | -| [_Dashboard_](HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | -| [_View consumer lag_](HowTo/topics/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.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | -| [_Sync topics from a cluster_](HowTo/kafka-cluster-migration/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | -| [_Sync ACLs to a cluster_](HowTo/kafka-cluster-migration/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | -| [_Sync ACLs from a cluster_](HowTo/kafka-cluster-migration/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. | -| [_Sync schemas to a cluster_](HowTo/kafka-cluster-migration/sync-schemas-to-cluster.md) | 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.md) | 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.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | -| [_Import / Export Klaw data_](HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | -| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | -| [_Controlled access to users_](HowTo/rolespermissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | -| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | -| [_Email Notifications_](HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | -| [_Analytics / Reports_](HowTo/analytics.md) | 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. | -| [_Apache Kafka flavor support_](HowTo/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | -| [_Klaw login AD/SSO/DB_](HowTo/authentication/index.md) | 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. -::: diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md new file mode 100644 index 00000000..51f3e920 --- /dev/null +++ b/docs/getting-started/features.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 1 +--- + +# Features of Klaw + +Explore the comprehensive range of features Klaw offers to manage your Apache Kafka® ecosystem more efficiently. + +| Feature | Description | +| ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | +| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | +| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | +| [_Connectors creation_](../HowTo/connectors/Request-a-new-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | +| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | +| [_Topic naming conventions_](../HowTo/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | +| [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | +| [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | +| [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | +| [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | +| [_View consumer lag_](../HowTo/topics/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.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | +| [_Sync topics from a cluster_](../HowTo/kafka-cluster-migration/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | +| [_Sync ACLs to a cluster_](../HowTo/kafka-cluster-migration/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | +| [_Sync ACLs from a cluster_](../HowTo/kafka-cluster-migration/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. | +| [_Sync schemas to a cluster_](../HowTo/kafka-cluster-migration/sync-schemas-to-cluster.md) | 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.md) | 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.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | +| [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | +| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | +| [_Controlled access to users_](../HowTo/rolespermissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | +| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | +| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | +| [_Analytics / Reports_](../HowTo/analytics.md) | 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. | +| [_Apache Kafka flavor support_](../HowTo/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | +| [_Klaw login AD/SSO/DB_](../HowTo/authentication/index.md) | 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. +::: diff --git a/docs/getstarted.md b/docs/getting-started/getstarted.md similarity index 96% rename from docs/getstarted.md rename to docs/getting-started/getstarted.md index 847f85e7..1c765860 100644 --- a/docs/getstarted.md +++ b/docs/getting-started/getstarted.md @@ -1,12 +1,12 @@ --- -sidebar_position: 1.3 +sidebar_position: 3 --- # Get started ## With Klaw and Apache Kafka® -If you have not setup Klaw, see [Klaw installation](HowTo/installation). +If you have not setup Klaw, see [Klaw installation](../HowTo/installation). Once Klaw is up and running, the next step is to connect it to your Apache Kafka service. Whether you are running this locally, or using a hosted service, the steps below will get you started. diff --git a/docs/quickstart.md b/docs/getting-started/quickstart.md similarity index 88% rename from docs/quickstart.md rename to docs/getting-started/quickstart.md index b3eeda2a..1a964e04 100644 --- a/docs/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1.1 +sidebar_position: 2 --- # Quick Start @@ -26,7 +26,7 @@ After docker has started 5 processes, you may verify them by `docker ps`. Now you may log into Klaw on `http://localhost:9097` with credentials `william : welcome` -![Screenshot: Klaw's login page](../static/images/quickstart/QS_LoginScreen.png) +![Screenshot: Klaw's login page](../../static/images/quickstart/QS_LoginScreen.png) ## 3. Topics Catalog page @@ -35,11 +35,11 @@ After logging in you will be redirected to our brand-new feature rich React UI. You can "Request new Topic" from the top right corner, or you can select the dropdown "Request a new" to view all your options. -![Screenshot: Topic catalog page](../static/images/quickstart/AfterLogin.png) +![Screenshot: Topic catalog page](../../static/images/quickstart/AfterLogin.png) ## 4. Request for topic -![Screenshot: Form to request a new topic](../static/images/quickstart/RequestForTopic.png) +![Screenshot: Form to request a new topic](../../static/images/quickstart/RequestForTopic.png) Fill in the details @@ -55,7 +55,7 @@ This will create a topic request for your team member to approve. Newly created topic request is now visible in **My team's requests** menu on the sidebar -![Screenshot: "My team's requests" page](../static/images/quickstart/MyRequest.png) +![Screenshot: "My team's requests" page](../../static/images/quickstart/MyRequest.png) ## 6. Logout @@ -75,7 +75,7 @@ From the menu, click on "Approve requests" menu. Here there is a pending request to be approved or declined. Click on view to review and approve it. -![Screenshot: "Approve request" page](../static/images/quickstart/ApproveReq.png) +![Screenshot: "Approve request" page](../../static/images/quickstart/ApproveReq.png) ## 10. That's it. Topic is created on Apache Kafka cluster diff --git a/docs/index.md b/docs/index.md index e4801fd1..04e34d41 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,4 +13,4 @@ Klaw consists of two components: ## Quickstart Copy the docker script and run. It installs Klaw, Apache Kafka, and schema Schema Registry servers as docker processes. [**Go through -this guide**](./quickstart) +this guide**](./getting-started/quickstart) diff --git a/sidebars.js b/sidebars.js index b65ae49d..73e02371 100644 --- a/sidebars.js +++ b/sidebars.js @@ -11,13 +11,33 @@ // @ts-check +// + Getting started +// + Dashboard +// + Setup and configuration +// + User and team management +// + Authentication and authorization +// + Cluster management +// + Cluster connectivity setup +// + Connector management +// + Metadata management +// + Klaw workflows +// + Notifications +// + FAQs + /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { docs: [ "index", - "quickstart", - "features", - "getstarted", + { + type: "category", + label: "Getting started", + items: [ + { + type: "autogenerated", + dirName: "getting-started", // Generate sidebar slice from docs/getting-started + }, + ], + }, { type: "category", label: "Concepts", From c4d2b34439fec49689ea6a7c0a2016fd902697b2 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Thu, 1 Feb 2024 14:55:35 +0100 Subject: [PATCH 02/28] Add new category Dashboard Signed-off-by: Mirjam Aulbach --- _redirects | 2 +- current-routes.json | 2 +- docs/{HowTo => dashboard}/analytics.md | 0 docs/getting-started/features.md | 2 +- sidebars.js | 10 ++++++++++ 5 files changed, 13 insertions(+), 3 deletions(-) rename docs/{HowTo => dashboard}/analytics.md (100%) diff --git a/_redirects b/_redirects index 939fa88a..165b5220 100644 --- a/_redirects +++ b/_redirects @@ -8,4 +8,4 @@ /docs/getstarted /docs/getting-started/getstarted 301 /docs/quickstart /docs/getting-started/quickstart 301 - +/docs/HowTo/analytics /docs/dashboard/analytics 301 \ No newline at end of file diff --git a/current-routes.json b/current-routes.json index 17f5edc8..bd268e21 100644 --- a/current-routes.json +++ b/current-routes.json @@ -40,11 +40,11 @@ "/docs/Concepts/synchronize", "/docs/Concepts/users-teams", "/docs/Concepts/workflows", + "/docs/dashboard/analytics", "/docs/faq", "/docs/getting-started/features", "/docs/getting-started/getstarted", "/docs/getting-started/quickstart", - "/docs/HowTo/analytics", "/docs/HowTo/authentication/", "/docs/HowTo/authentication/azure-ad", "/docs/HowTo/authentication/google-account", diff --git a/docs/HowTo/analytics.md b/docs/dashboard/analytics.md similarity index 100% rename from docs/HowTo/analytics.md rename to docs/dashboard/analytics.md diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 51f3e920..182c213a 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -31,7 +31,7 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | [_Controlled access to users_](../HowTo/rolespermissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | | [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | | [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | -| [_Analytics / Reports_](../HowTo/analytics.md) | 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. | +| [_Analytics / Reports_](../dashboard/analytics.md) | 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. | | [_Apache Kafka flavor support_](../HowTo/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | | [_Klaw login AD/SSO/DB_](../HowTo/authentication/index.md) | Users can log in to Klaw using Windows AD or SSO providers like Azure and Google. | diff --git a/sidebars.js b/sidebars.js index 73e02371..5795b2e2 100644 --- a/sidebars.js +++ b/sidebars.js @@ -38,6 +38,16 @@ const sidebars = { }, ], }, + { + type: "category", + label: "Dashboard", + items: [ + { + type: "autogenerated", + dirName: "dashboard", // Generate sidebar slice from docs/dashboard + }, + ], + }, { type: "category", label: "Concepts", From cb7e2f29a1538d3b25d53763772fd8bca78163b0 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Fri, 2 Feb 2024 09:57:13 +0100 Subject: [PATCH 03/28] Add new category Setup and configuration Signed-off-by: Mirjam Aulbach --- _redirects | 27 ++++++++++++----- current-routes.json | 17 +++++------ docs/HowTo/kafka-cluster-migration/index.md | 2 +- .../sync-acls-from-cluster.md | 2 +- .../sync-acls-to-cluster.md | 2 +- .../sync-connectors-from-cluster.md | 2 +- .../sync-topics-from-cluster.md | 2 +- .../sync-topics-to-cluster.md | 2 +- docs/HowTo/tenant.md | 25 ---------------- docs/HowTo/topics/Request-a-new-topic.md | 2 +- docs/getting-started/getstarted.md | 2 +- .../high-availability.md | 0 .../klaw-api-ssl-with-kafka.md} | 2 +- .../configure-klaw-wizard.md | 0 .../klaw-installation}/index.md | 7 ++--- .../klaw-installation}/run-docker.md | 2 +- .../klaw-installation}/run-source.md | 0 .../settings.md | 2 +- .../tenant-configuration.md} | 30 +++++++++++++++---- sidebars.js | 20 +++++++++++++ 20 files changed, 85 insertions(+), 63 deletions(-) delete mode 100644 docs/HowTo/tenant.md rename docs/{Concepts => setup-configuration}/high-availability.md (100%) rename docs/{Concepts/config.md => setup-configuration/klaw-api-ssl-with-kafka.md} (98%) rename docs/{HowTo/installation => setup-configuration/klaw-installation}/configure-klaw-wizard.md (100%) rename docs/{HowTo/installation => setup-configuration/klaw-installation}/index.md (68%) rename docs/{HowTo/installation => setup-configuration/klaw-installation}/run-docker.md (98%) rename docs/{HowTo/installation => setup-configuration/klaw-installation}/run-source.md (100%) rename docs/{HowTo => setup-configuration}/settings.md (91%) rename docs/{HowTo/kafka-cluster-migration/tenant-config.md => setup-configuration/tenant-configuration.md} (77%) diff --git a/_redirects b/_redirects index 165b5220..bc1fddbf 100644 --- a/_redirects +++ b/_redirects @@ -1,11 +1,22 @@ -/docs/category/Releases/* /docs/releases/:splat 301 -/docs/category/Releases /docs/releases 301 +/docs/category/Releases/* /docs/releases/:splat 301 +/docs/category/Releases /docs/releases 301 -/docs/category/concepts /docs/Concepts/clusters-environments 301 -/docs/category/howto /docs/HowTo/analytics 301 +/docs/category/concepts /docs/Concepts/clusters-environments 301 +/docs/category/howto /docs/HowTo/analytics 301 -/docs/features /docs/getting-started/features 301 -/docs/getstarted /docs/getting-started/getstarted 301 -/docs/quickstart /docs/getting-started/quickstart 301 +/docs/features /docs/getting-started/features 301 +/docs/getstarted /docs/getting-started/getstarted 301 +/docs/quickstart /docs/getting-started/quickstart 301 -/docs/HowTo/analytics /docs/dashboard/analytics 301 \ No newline at end of file +/docs/HowTo/analytics /docs/dashboard/analytics 301 + +/docs/HowTo/installation /docs/setup-configuration/klaw-installation 301 +/docs/HowTo/installation/configure-klaw-wizard /docs/setup-configuration/klaw-installation/configure-klaw-wizard 301 +/docs/HowTo/installation/run-docker /docs/setup-configuration/klaw-installation/run-docker 301 +/docs/HowTo/installation/run-source /docs/setup-configuration/klaw-installation/run-source 301 +/docs/HowTo/kafka-cluster-migration/tenant-config /docs/setup-configuration/tenant-configuration 301 +/docs/HowTo/tenant /docs/setup-configuration/tenant-configuration 301 + +/docs/Concepts/config /docs/setup-configuration/klaw-api-ssl-with-kafka 301 +/docs/Concepts/high-availability /docs/setup-configuration/high-availability 310 +/docs/HowTo/settings /docs/setup-configuration/settings 310 \ No newline at end of file diff --git a/current-routes.json b/current-routes.json index bd268e21..b2051473 100644 --- a/current-routes.json +++ b/current-routes.json @@ -32,8 +32,6 @@ "/blog/tags/transparency", "/docs/", "/docs/Concepts/clusters-environments", - "/docs/Concepts/config", - "/docs/Concepts/high-availability", "/docs/Concepts/metastore", "/docs/Concepts/promotion", "/docs/Concepts/switch-teams", @@ -75,10 +73,6 @@ "/docs/HowTo/exportimport/", "/docs/HowTo/exportimport/exportdata", "/docs/HowTo/exportimport/importdata", - "/docs/HowTo/installation/", - "/docs/HowTo/installation/configure-klaw-wizard", - "/docs/HowTo/installation/run-docker", - "/docs/HowTo/installation/run-source", "/docs/HowTo/kafka-cluster-migration/", "/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster", "/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster", @@ -87,7 +81,6 @@ "/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster", "/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster", "/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster", - "/docs/HowTo/kafka-cluster-migration/tenant-config", "/docs/HowTo/notifications/", "/docs/HowTo/notifications/email-notification", "/docs/HowTo/notifications/slack-notification", @@ -99,7 +92,6 @@ "/docs/HowTo/schemas/My-schema-requests", "/docs/HowTo/schemas/Promote-a-schema", "/docs/HowTo/schemas/Request-a-schema", - "/docs/HowTo/settings", "/docs/HowTo/subscriptions/", "/docs/HowTo/subscriptions/Approve-a-subscription", "/docs/HowTo/subscriptions/Delete-a-subscription", @@ -108,7 +100,6 @@ "/docs/HowTo/teams/", "/docs/HowTo/teams/manage-teams", "/docs/HowTo/teams/switch-teams", - "/docs/HowTo/tenant", "/docs/HowTo/topics/", "/docs/HowTo/topics/Approve-a-topic", "/docs/HowTo/topics/Claim-a-topic", @@ -137,5 +128,13 @@ "/docs/releases/release260", "/docs/releases/release261", "/docs/releases/release270", + "/docs/setup-configuration/high-availability", + "/docs/setup-configuration/klaw-api-ssl-with-kafka", + "/docs/setup-configuration/klaw-installation/", + "/docs/setup-configuration/klaw-installation/configure-klaw-wizard", + "/docs/setup-configuration/klaw-installation/run-docker", + "/docs/setup-configuration/klaw-installation/run-source", + "/docs/setup-configuration/settings", + "/docs/setup-configuration/tenant-configuration", "/" ] diff --git a/docs/HowTo/kafka-cluster-migration/index.md b/docs/HowTo/kafka-cluster-migration/index.md index b0b6982d..e6d407b2 100644 --- a/docs/HowTo/kafka-cluster-migration/index.md +++ b/docs/HowTo/kafka-cluster-migration/index.md @@ -17,7 +17,7 @@ uninterrupted operations. ## Quick links -- [Tenant Configuration](tenant-config.md) +- [Tenant Configuration](../../setup-configuration/tenant-configuration.md) - [Synchronize topics from cluster](sync-topics-from-cluster.md) diff --git a/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md b/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md index 8a287bde..cc3bb786 100644 --- a/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md +++ b/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md @@ -8,7 +8,7 @@ in Klaw. ## Prerequisites 1. **Environment configuration**: Make sure that the `klaw.tenant.config` property is set up as described in - the [tenant configuration](tenant-config.md) documentation. + the [tenant configuration](../../setup-configuration/tenant-configuration.md) documentation. 2. **User permissions**: Log in with a user account with either `SUPERADMIN` or `SYNC_SUBSCRIPTIONS` permissions. ## Steps to synchronize ACLs diff --git a/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md b/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md index 603cb22b..7d61e632 100644 --- a/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md +++ b/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md @@ -7,7 +7,7 @@ them on the Apache Kafka cluster. ## Prerequisites 1. **Environment configuration**: Make sure the `klaw.tenant.config` property is correctly configured, as outlined in - the [tenant configuration](tenant-config.md) guide. + the [tenant configuration](../../setup-configuration/tenant-configuration.md) guide. 2. **User permissions**: Log in with a user account with either `SUPERADMIN` or a user granted the `SYNC_BACK_SUBSCRIPTIONS` permission. 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 fa0e7cb8..756339ff 100644 --- a/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md +++ b/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md @@ -8,7 +8,7 @@ them to a team in Klaw. ## Prerequisites 1. **Environment configuration**: Make sure to configure your environments and set the `klaw.tenant.config` property as - described in the [tenant configuration](tenant-config.md) guide. + described in the [tenant configuration](../../setup-configuration/tenant-configuration.md) guide. 2. **User permissions**: You need to be logged in as a `SUPERADMIN` or a user with the `SYNC_CONNECTORS` permission. ## Steps to synchronize connectors diff --git a/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster.md b/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster.md index 1d6b13da..53ec1ae7 100644 --- a/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster.md +++ b/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster.md @@ -6,7 +6,7 @@ topics from an existing Apache Kafka cluster and assigning them to a Klaw team. ## Prerequisites - **Configuration**: Ensure that your environments and the `klaw.tenant.config` property are configured as specified in - the [Tenant Configuration](tenant-config.md) documentation. + the [Tenant Configuration](../../setup-configuration/tenant-configuration.md) documentation. - **User Permissions**: Log in as either a `SUPERADMIN` or as a user with the `SYNC_TOPICS` permission. ## Steps to synchronize topics diff --git a/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster.md b/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster.md index aba82693..e5ecbb54 100644 --- a/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster.md +++ b/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster.md @@ -7,7 +7,7 @@ them on the Apache Kafka cluster. ## Prerequisites - **Configuration**: Make sure to configure the environments and the `klaw.tenant.config` property. Refer to - the [Tenant Configuration](tenant-config.md) documentation for more information. + the [Tenant Configuration](../../setup-configuration/tenant-configuration.md) documentation for more information. - **User Permissions**: Log in with a user account with either `SUPERADMIN` or as a user with the `SYNC_BACK_TOPICS` permission. diff --git a/docs/HowTo/tenant.md b/docs/HowTo/tenant.md deleted file mode 100644 index 8dabe6e0..00000000 --- a/docs/HowTo/tenant.md +++ /dev/null @@ -1,25 +0,0 @@ -# Tenant - -In Klaw, a tenant is an isolated Klaw environment with its own clusters, -environments, users, teams, and topics. Users within one tenant are -entirely separate from other tenants and cannot view topics or -information from other tenants, even if they share the same Klaw -instance. - -Each Klaw installation comes with a single default tenant. - -![image](../../static/images/Tenants.png) - -## Add new tenant - -To add a new tenant, a superadmin or user with the `ADD_TENANT` -permission can do so under the **Environments -\> Tenants** menu. - -:::note -If the application should be limited to only one tenant, you can -configure it with the below property in `application.properties` file. - - #maximum tenants can be created - klaw.max.tenants=200 - -::: diff --git a/docs/HowTo/topics/Request-a-new-topic.md b/docs/HowTo/topics/Request-a-new-topic.md index 27704004..bf22efae 100644 --- a/docs/HowTo/topics/Request-a-new-topic.md +++ b/docs/HowTo/topics/Request-a-new-topic.md @@ -14,7 +14,7 @@ List requests made against the topic. for the steps to configure the environments. - The Superadmin must also update the server configuration to include the environments, see - [Configure Klaw](../installation/configure-klaw-wizard.md) + [Configure Klaw](../../setup-configuration/klaw-installation/configure-klaw-wizard.md) for the steps to configure the server settings. ## Make a request diff --git a/docs/getting-started/getstarted.md b/docs/getting-started/getstarted.md index 1c765860..95686260 100644 --- a/docs/getting-started/getstarted.md +++ b/docs/getting-started/getstarted.md @@ -6,7 +6,7 @@ sidebar_position: 3 ## With Klaw and Apache Kafka® -If you have not setup Klaw, see [Klaw installation](../HowTo/installation). +If you have not setup Klaw, see [Klaw installation](../setup-configuration/klaw-installation). Once Klaw is up and running, the next step is to connect it to your Apache Kafka service. Whether you are running this locally, or using a hosted service, the steps below will get you started. diff --git a/docs/Concepts/high-availability.md b/docs/setup-configuration/high-availability.md similarity index 100% rename from docs/Concepts/high-availability.md rename to docs/setup-configuration/high-availability.md diff --git a/docs/Concepts/config.md b/docs/setup-configuration/klaw-api-ssl-with-kafka.md similarity index 98% rename from docs/Concepts/config.md rename to docs/setup-configuration/klaw-api-ssl-with-kafka.md index 680f0db3..f7c1eaf3 100644 --- a/docs/Concepts/config.md +++ b/docs/setup-configuration/klaw-api-ssl-with-kafka.md @@ -1,4 +1,4 @@ -# Advanced configuration +# Klaw API and SSL with Apache Kafka® To configure the API component of Klaw, supply an `application.properties` file when starting the service. We have diff --git a/docs/HowTo/installation/configure-klaw-wizard.md b/docs/setup-configuration/klaw-installation/configure-klaw-wizard.md similarity index 100% rename from docs/HowTo/installation/configure-klaw-wizard.md rename to docs/setup-configuration/klaw-installation/configure-klaw-wizard.md diff --git a/docs/HowTo/installation/index.md b/docs/setup-configuration/klaw-installation/index.md similarity index 68% rename from docs/HowTo/installation/index.md rename to docs/setup-configuration/klaw-installation/index.md index ffa96e26..bde6dbb8 100644 --- a/docs/HowTo/installation/index.md +++ b/docs/setup-configuration/klaw-installation/index.md @@ -2,11 +2,10 @@ Klaw can be installed and configured in two ways: -- [Run From Source](run-source.md) - [Run from Docker](run-docker.md) +- [Run From Source](run-source.md) Once Klaw is installed, you can use the [Configure Klaw Wizard](configure-klaw-wizard.md) to configure your Apache Kafka® -cluster -and start managing your Apache Kafka resources. +cluster and start managing your Apache Kafka resources. -Read [Deploying Klaw recommendations](../deployklaw.md) +Read [Deploying Klaw recommendations](../../HowTo/deployklaw.md) diff --git a/docs/HowTo/installation/run-docker.md b/docs/setup-configuration/klaw-installation/run-docker.md similarity index 98% rename from docs/HowTo/installation/run-docker.md rename to docs/setup-configuration/klaw-installation/run-docker.md index 0c483a09..03fe7de6 100644 --- a/docs/HowTo/installation/run-docker.md +++ b/docs/setup-configuration/klaw-installation/run-docker.md @@ -171,7 +171,7 @@ To verify the installation and access Klaw, follow the steps below: ### 5. Next Steps After successfully verifying your installation, -follow the documentation in [Configure Klaw with Wizard](../installation/configure-klaw-wizard.md). +follow the documentation in [Configure Klaw with Wizard](configure-klaw-wizard.md). ## Klaw Docker Scripts diff --git a/docs/HowTo/installation/run-source.md b/docs/setup-configuration/klaw-installation/run-source.md similarity index 100% rename from docs/HowTo/installation/run-source.md rename to docs/setup-configuration/klaw-installation/run-source.md diff --git a/docs/HowTo/settings.md b/docs/setup-configuration/settings.md similarity index 91% rename from docs/HowTo/settings.md rename to docs/setup-configuration/settings.md index 84d3dae0..0dbae384 100644 --- a/docs/HowTo/settings.md +++ b/docs/setup-configuration/settings.md @@ -16,7 +16,7 @@ notification templates and roles, under **Dashboard -\> Settings**. - **Tenant Configuration** A tenant is an isolated environment that has its own set of clusters, environments, users, teams, and topics. - For more information, see [Tenant configuration](./kafka-cluster-migration/tenant-config.md). You can change the hierarchy of environments and a few other configurations by updating the property + For more information, see [Tenant configuration](../setup-configuration/tenant-configuration.md). You can change the hierarchy of environments and a few other configurations by updating the property `klaw.tenant.config`. - **Environment names** When adding a new Environment, predefined diff --git a/docs/HowTo/kafka-cluster-migration/tenant-config.md b/docs/setup-configuration/tenant-configuration.md similarity index 77% rename from docs/HowTo/kafka-cluster-migration/tenant-config.md rename to docs/setup-configuration/tenant-configuration.md index 197b8b53..e683d3e0 100644 --- a/docs/HowTo/kafka-cluster-migration/tenant-config.md +++ b/docs/setup-configuration/tenant-configuration.md @@ -8,6 +8,24 @@ instance. Every installation of Klaw comes with a single (default) tenant. +![image](../../static/images/Tenants.png) + +## Add new tenant + +To add a new tenant, a superadmin or user with the `ADD_TENANT` +permission can do so under the **Environments -\> Tenants** menu. + +:::note +If the application should be limited to only one tenant, you can +configure it with the below property in `application.properties` file. + + #maximum tenants can be created + klaw.max.tenants=200 + +::: + +## Configure a tenant + You can configure the following in a tenant: - Base sync environment @@ -16,7 +34,7 @@ You can configure the following in a tenant: environments. Make sure this environment already exists under Environments (Apache Kafka). - Field: baseSyncEnvironment + Field: `baseSyncEnvironment` - Order of Apache Kafka topics promotion environments @@ -24,7 +42,7 @@ You can configure the following in a tenant: Apache Kafka topic. Ex: \[\"DEV\", \"TST\"\]. Make sure this environment already exists under Environments (Apache Kafka) - Field: orderOfTopicPromotionEnvsList + Field: `orderOfTopicPromotionEnvsList` - Request topics Environments List @@ -32,7 +50,7 @@ You can configure the following in a tenant: requested directly. Other environments cannot be requested directly, and topics can only be promoted to them. - Field: requestTopicsEnvironmentsList + Field: `requestTopicsEnvironmentsList` - Base sync environment Apache Kafka Connector @@ -40,7 +58,7 @@ You can configure the following in a tenant: environments. Make sure this environment already exists under Environments (Apache Kafka Connect). - Field: baseSyncKafkaConnectCluster + Field: `baseSyncKafkaConnectCluster` - Order of Apache Kafka Connect promotion environments @@ -48,7 +66,7 @@ You can configure the following in a tenant: Kafka connector. Ex: \[\"DEV\", \"TST\"\]. Make sure this environment already exists under Environments (Apache Kafka Connect) - Field: orderOfConnectorsPromotionEnvsList + Field: `orderOfConnectorsPromotionEnvsList` - Request Connectors Environments List @@ -56,7 +74,7 @@ You can configure the following in a tenant: requested directly. Other environments cannot be requested directly, and connectors can only be promoted to them. - Field: requestConnectorsEnvironmentsList + Field: `requestConnectorsEnvironmentsList` Sample Tenant configuration for Property: `klaw.tenant.config`: diff --git a/sidebars.js b/sidebars.js index 5795b2e2..761911d7 100644 --- a/sidebars.js +++ b/sidebars.js @@ -48,6 +48,26 @@ const sidebars = { }, ], }, + { + type: "category", + label: "Setup and configuration", + items: [ + { + type: "category", + label: "Klaw installation", + link: { + type: "doc", + id: "setup-configuration/klaw-installation/index", + }, + items: [ + "setup-configuration/klaw-installation/run-docker", + "setup-configuration/klaw-installation/run-source", + "setup-configuration/klaw-installation/configure-klaw-wizard", + ], + }, + "setup-configuration/tenant-configuration", + ], + }, { type: "category", label: "Concepts", From c654f1ff6ba9d71ca29fd2fc0fbba19216ff3727 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Fri, 2 Feb 2024 12:18:25 +0100 Subject: [PATCH 04/28] Add new category User and team management Signed-off-by: Mirjam Aulbach --- _redirects | 8 +++++++- current-routes.json | 10 +++++----- .../HowTo/notifications/slack-notification.md | 4 ++-- docs/HowTo/teams/index.md | 4 ++-- docs/getting-started/features.md | 2 +- docs/releases/release210.md | 2 +- .../manage-roles-permissions.md} | 2 +- .../manage-users.md} | 2 +- .../teams/manage-teams.md | 0 .../teams}/switch-teams.md | 2 +- .../users-roles-teams.md} | 0 sidebars.js | 20 +++++++++++++++++++ 12 files changed, 41 insertions(+), 15 deletions(-) rename docs/{HowTo/rolespermissions.md => user-team-management/manage-roles-permissions.md} (96%) rename docs/{HowTo/users.md => user-team-management/manage-users.md} (96%) rename docs/{HowTo => user-team-management}/teams/manage-teams.md (100%) rename docs/{Concepts => user-team-management/teams}/switch-teams.md (94%) rename docs/{Concepts/users-teams.md => user-team-management/users-roles-teams.md} (100%) diff --git a/_redirects b/_redirects index bc1fddbf..7766e847 100644 --- a/_redirects +++ b/_redirects @@ -19,4 +19,10 @@ /docs/Concepts/config /docs/setup-configuration/klaw-api-ssl-with-kafka 301 /docs/Concepts/high-availability /docs/setup-configuration/high-availability 310 -/docs/HowTo/settings /docs/setup-configuration/settings 310 \ No newline at end of file +/docs/HowTo/settings /docs/setup-configuration/settings 310 + +/docs/Concepts/switch-teams /docs/user-team-management/teams/switch-teams 301 +/docs/Concepts/users-teams /docs/user-team-management/users-roles-teams 301 +/docs/HowTo/rolespermissions /docs/user-team-management/manage-roles-permissions 301 +/docs/HowTo/teams/manage-teams /docs/user-team-management/teams/manage-teams 301 +/docs/HowTo/users /docs/user-team-management/manage-users 301 diff --git a/current-routes.json b/current-routes.json index b2051473..cd4a236a 100644 --- a/current-routes.json +++ b/current-routes.json @@ -34,9 +34,7 @@ "/docs/Concepts/clusters-environments", "/docs/Concepts/metastore", "/docs/Concepts/promotion", - "/docs/Concepts/switch-teams", "/docs/Concepts/synchronize", - "/docs/Concepts/users-teams", "/docs/Concepts/workflows", "/docs/dashboard/analytics", "/docs/faq", @@ -86,7 +84,6 @@ "/docs/HowTo/notifications/slack-notification", "/docs/HowTo/operational/", "/docs/HowTo/operational/Reset-Consumer-Offsets", - "/docs/HowTo/rolespermissions", "/docs/HowTo/schemas/", "/docs/HowTo/schemas/manage-schemas", "/docs/HowTo/schemas/My-schema-requests", @@ -98,7 +95,6 @@ "/docs/HowTo/subscriptions/My-subscription-requests", "/docs/HowTo/subscriptions/Request-a-subscription", "/docs/HowTo/teams/", - "/docs/HowTo/teams/manage-teams", "/docs/HowTo/teams/switch-teams", "/docs/HowTo/topics/", "/docs/HowTo/topics/Approve-a-topic", @@ -111,7 +107,6 @@ "/docs/HowTo/topics/Topic-overview", "/docs/HowTo/topics/View-consumer-lag", "/docs/HowTo/topics/View-topic-events", - "/docs/HowTo/users", "/docs/HowTo/zothers", "/docs/releases", "/docs/releases/release100", @@ -136,5 +131,10 @@ "/docs/setup-configuration/klaw-installation/run-source", "/docs/setup-configuration/settings", "/docs/setup-configuration/tenant-configuration", + "/docs/user-team-management/manage-roles-permissions", + "/docs/user-team-management/manage-users", + "/docs/user-team-management/teams/manage-teams", + "/docs/user-team-management/teams/switch-teams", + "/docs/user-team-management/users-roles-teams", "/" ] diff --git a/docs/HowTo/notifications/slack-notification.md b/docs/HowTo/notifications/slack-notification.md index 035cda92..3650f22e 100644 --- a/docs/HowTo/notifications/slack-notification.md +++ b/docs/HowTo/notifications/slack-notification.md @@ -9,5 +9,5 @@ Configuring Slack notifications in Klaw is straightforward. Follow the steps pro 1. Visit Slack's official guide on [sending emails to Slack](https://slack.com/intl/en-ie/help/articles/206819278-Send-emails-to-Slack#). 2. As part of the setup, Slack provides a unique email address. 3. Use this email address in Klaw: - - Replace a user's email address in the [User Configuration](../users.md) to send notifications directly to their DMs. - - Alternatively, replace the team email to forward notifications to a specific channel. For more information, see [Managing Teams](../teams/manage-teams.md). + - Replace a user's email address in the [User Configuration](../../user-team-management/manage-users.md) to send notifications directly to their DMs. + - Alternatively, replace the team email to forward notifications to a specific channel. For more information, see [Managing Teams](../../user-team-management/teams/manage-teams.md). diff --git a/docs/HowTo/teams/index.md b/docs/HowTo/teams/index.md index 799103f0..db0e3c9c 100644 --- a/docs/HowTo/teams/index.md +++ b/docs/HowTo/teams/index.md @@ -7,5 +7,5 @@ in a team makes a request, a peer from the same team is expected to approve. Teams can be managed by a user with `ADD_EDIT_DELETE_TEAMS` permission. -- [Switch Teams](switch-teams.md) -- [Manage Teams](manage-teams.md) +- [Switch Teams](../../user-team-management/teams/switch-teams.md) +- [Manage Teams](../../user-team-management/teams/manage-teams.md) diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 182c213a..d5ae48f6 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -28,7 +28,7 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | [_Sync connectors from a cluster_](../HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | | [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | | Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | -| [_Controlled access to users_](../HowTo/rolespermissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | +| [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | | [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | | [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | | [_Analytics / Reports_](../dashboard/analytics.md) | 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. | diff --git a/docs/releases/release210.md b/docs/releases/release210.md index 1c31adbc..98789cb2 100644 --- a/docs/releases/release210.md +++ b/docs/releases/release210.md @@ -69,7 +69,7 @@ from increased flexibility and efficiency when working within the Klaw platform, particularly when creating or approving requests. For more information, see [Switch -Teams](../../docs/Concepts/switch-teams). +Teams](../../docs/user-team-management/teams/switch-teams). :::note For a complete list of improvements, changelog, and to download the diff --git a/docs/HowTo/rolespermissions.md b/docs/user-team-management/manage-roles-permissions.md similarity index 96% rename from docs/HowTo/rolespermissions.md rename to docs/user-team-management/manage-roles-permissions.md index 895680ef..7e5c8304 100644 --- a/docs/HowTo/rolespermissions.md +++ b/docs/user-team-management/manage-roles-permissions.md @@ -1,4 +1,4 @@ -# Manage Roles and permissions +# Manage roles and permissions In Klaw, user permissions are determined by the roles they are assigned. Each role corresponds to a set of specific actions a user is authorized diff --git a/docs/HowTo/users.md b/docs/user-team-management/manage-users.md similarity index 96% rename from docs/HowTo/users.md rename to docs/user-team-management/manage-users.md index bee0a3a3..d98af1da 100644 --- a/docs/HowTo/users.md +++ b/docs/user-team-management/manage-users.md @@ -1,7 +1,7 @@ # Manage users Klaw stores user information in its metadata, and the method of -[authentication](./authentication) may +[authentication](../HowTo/authentication) may vary depending on the configuration. Each user is associated with a team and a role, and if the **Switch teams** flag is enabled, they can switch between multiple teams. diff --git a/docs/HowTo/teams/manage-teams.md b/docs/user-team-management/teams/manage-teams.md similarity index 100% rename from docs/HowTo/teams/manage-teams.md rename to docs/user-team-management/teams/manage-teams.md diff --git a/docs/Concepts/switch-teams.md b/docs/user-team-management/teams/switch-teams.md similarity index 94% rename from docs/Concepts/switch-teams.md rename to docs/user-team-management/teams/switch-teams.md index 1ba67362..9a07c6e5 100644 --- a/docs/Concepts/switch-teams.md +++ b/docs/user-team-management/teams/switch-teams.md @@ -12,7 +12,7 @@ To switch between teams in Klaw, - Users must have the switch teams option enabled in their profile. A user's profile must also include the user's base team and a list of available teams for switching. To learn how to enable switch - teams, see [details](../HowTo/teams/switch-teams.md) + teams, see [details](switch-teams.md) - Only superadmin or a user with `ADD_EDIT_DELETE_USERS` permission can enable a user profile to switch teams, - Once the option to switch teams is enabled, users can easily switch diff --git a/docs/Concepts/users-teams.md b/docs/user-team-management/users-roles-teams.md similarity index 100% rename from docs/Concepts/users-teams.md rename to docs/user-team-management/users-roles-teams.md diff --git a/sidebars.js b/sidebars.js index 761911d7..6956291f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -65,9 +65,29 @@ const sidebars = { "setup-configuration/klaw-installation/configure-klaw-wizard", ], }, + "setup-configuration/klaw-api-ssl-with-kafka", + "setup-configuration/high-availability", + "setup-configuration/settings", "setup-configuration/tenant-configuration", ], }, + { + type: "category", + label: "User and team management", + items: [ + "user-team-management/users-roles-teams", + "user-team-management/manage-users", + "user-team-management/manage-roles-permissions", + { + type: "category", + label: "Teams", + items: [ + "user-team-management/teams/manage-teams", + "user-team-management/teams/switch-teams", + ], + }, + ], + }, { type: "category", label: "Concepts", From aeb2f8601f8e728e07eab92f174f7571336d22bb Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Fri, 2 Feb 2024 13:31:03 +0100 Subject: [PATCH 05/28] Add new category Authentication and authorization Signed-off-by: Mirjam Aulbach --- _redirects | 8 +++ current-routes.json | 13 ++--- docs/HowTo/authentication/index.md | 9 --- .../authentication/azure-ad.md | 4 ++ .../authentication/google-account.md | 4 ++ .../authentication/third-party-account.md | 4 ++ .../authentication/userpwd-db.md | 4 ++ .../authentication/windows-ad.md | 4 ++ .../authorization.md | 0 docs/getting-started/features.md | 58 +++++++++---------- docs/releases/release200.md | 2 +- docs/user-team-management/manage-users.md | 5 +- sidebars.js | 17 ++++++ 13 files changed, 83 insertions(+), 49 deletions(-) delete mode 100644 docs/HowTo/authentication/index.md rename docs/{HowTo => authentication-authorization}/authentication/azure-ad.md (98%) rename docs/{HowTo => authentication-authorization}/authentication/google-account.md (98%) rename docs/{HowTo => authentication-authorization}/authentication/third-party-account.md (98%) rename docs/{HowTo => authentication-authorization}/authentication/userpwd-db.md (97%) rename docs/{HowTo => authentication-authorization}/authentication/windows-ad.md (98%) rename docs/{HowTo => authentication-authorization}/authorization.md (100%) diff --git a/_redirects b/_redirects index 7766e847..c6b9702d 100644 --- a/_redirects +++ b/_redirects @@ -26,3 +26,11 @@ /docs/HowTo/rolespermissions /docs/user-team-management/manage-roles-permissions 301 /docs/HowTo/teams/manage-teams /docs/user-team-management/teams/manage-teams 301 /docs/HowTo/users /docs/user-team-management/manage-users 301 + +/docs/HowTo/authentication/ /docs/authentication-authorization/authentication/azure-ad 301 +/docs/HowTo/authentication/azure-ad /docs/authentication-authorization/authentication/azure-ad 301 +/docs/HowTo/authentication/google-account /docs/authentication-authorization/authentication/google-account 301 +/docs/HowTo/authentication/third-party-account /docs/authentication-authorization/authentication/third-party-account 301 +/docs/HowTo/authentication/userpwd-db /docs/authentication-authorization/authentication/userpwd-db 301 +/docs/HowTo/authentication/windows-ad /docs/authentication-authorization/authentication/windows-ad 301 +/docs/HowTo/authorization /docs/authentication-authorization/authorization 301 301 \ No newline at end of file diff --git a/current-routes.json b/current-routes.json index cd4a236a..2a1862b1 100644 --- a/current-routes.json +++ b/current-routes.json @@ -31,6 +31,12 @@ "/blog/tags/topics", "/blog/tags/transparency", "/docs/", + "/docs/authentication-authorization/authentication/azure-ad", + "/docs/authentication-authorization/authentication/google-account", + "/docs/authentication-authorization/authentication/third-party-account", + "/docs/authentication-authorization/authentication/userpwd-db", + "/docs/authentication-authorization/authentication/windows-ad", + "/docs/authentication-authorization/authorization", "/docs/Concepts/clusters-environments", "/docs/Concepts/metastore", "/docs/Concepts/promotion", @@ -41,13 +47,6 @@ "/docs/getting-started/features", "/docs/getting-started/getstarted", "/docs/getting-started/quickstart", - "/docs/HowTo/authentication/", - "/docs/HowTo/authentication/azure-ad", - "/docs/HowTo/authentication/google-account", - "/docs/HowTo/authentication/third-party-account", - "/docs/HowTo/authentication/userpwd-db", - "/docs/HowTo/authentication/windows-ad", - "/docs/HowTo/authorization", "/docs/HowTo/clusterconnectivity/", "/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol", "/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol", diff --git a/docs/HowTo/authentication/index.md b/docs/HowTo/authentication/index.md deleted file mode 100644 index c4d231b6..00000000 --- a/docs/HowTo/authentication/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Authentication - -How to authenticate a user in Klaw. - -- [UserPwd](userpwd-db.md) -- [Windows AD](windows-ad.md) -- [Azure AD](azure-ad.md) -- [Google Account](google-account.md) -- [Third Party account](third-party-account.md) diff --git a/docs/HowTo/authentication/azure-ad.md b/docs/authentication-authorization/authentication/azure-ad.md similarity index 98% rename from docs/HowTo/authentication/azure-ad.md rename to docs/authentication-authorization/authentication/azure-ad.md index c35a3d4a..5c3bcf4f 100644 --- a/docs/HowTo/authentication/azure-ad.md +++ b/docs/authentication-authorization/authentication/azure-ad.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 1 +--- + # Login with Azure AD You can log in to Klaw with your credentials configured in the Azure diff --git a/docs/HowTo/authentication/google-account.md b/docs/authentication-authorization/authentication/google-account.md similarity index 98% rename from docs/HowTo/authentication/google-account.md rename to docs/authentication-authorization/authentication/google-account.md index 0c20d883..32a9bad0 100644 --- a/docs/HowTo/authentication/google-account.md +++ b/docs/authentication-authorization/authentication/google-account.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # Login with Google account You can log in to Klaw using your Google account credentials. On the diff --git a/docs/HowTo/authentication/third-party-account.md b/docs/authentication-authorization/authentication/third-party-account.md similarity index 98% rename from docs/HowTo/authentication/third-party-account.md rename to docs/authentication-authorization/authentication/third-party-account.md index e16f318d..0aa47725 100644 --- a/docs/HowTo/authentication/third-party-account.md +++ b/docs/authentication-authorization/authentication/third-party-account.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 3 +--- + # Login with Third-party accounts You have the option to configure any third-party login account to access diff --git a/docs/HowTo/authentication/userpwd-db.md b/docs/authentication-authorization/authentication/userpwd-db.md similarity index 97% rename from docs/HowTo/authentication/userpwd-db.md rename to docs/authentication-authorization/authentication/userpwd-db.md index 11d1fedb..c3509bcb 100644 --- a/docs/HowTo/authentication/userpwd-db.md +++ b/docs/authentication-authorization/authentication/userpwd-db.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 4 +--- + # Login with Klaw database account You can log in to Klaw using your username and password, which are securely stored in the database (encrypted). diff --git a/docs/HowTo/authentication/windows-ad.md b/docs/authentication-authorization/authentication/windows-ad.md similarity index 98% rename from docs/HowTo/authentication/windows-ad.md rename to docs/authentication-authorization/authentication/windows-ad.md index 58d38809..3180ec87 100644 --- a/docs/HowTo/authentication/windows-ad.md +++ b/docs/authentication-authorization/authentication/windows-ad.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 5 +--- + # Login with Windows active directory You can log in to Klaw using the Windows credentials configured in the Windows active directory. diff --git a/docs/HowTo/authorization.md b/docs/authentication-authorization/authorization.md similarity index 100% rename from docs/HowTo/authorization.md rename to docs/authentication-authorization/authorization.md diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index d5ae48f6..0a1582c3 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -6,35 +6,35 @@ sidebar_position: 1 Explore the comprehensive range of features Klaw offers to manage your Apache Kafka® ecosystem more efficiently. -| Feature | Description | -| ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | -| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | -| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | -| [_Connectors creation_](../HowTo/connectors/Request-a-new-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | -| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | -| [_Topic naming conventions_](../HowTo/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | -| [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | -| [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | -| [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | -| [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | -| [_View consumer lag_](../HowTo/topics/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.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | -| [_Sync topics from a cluster_](../HowTo/kafka-cluster-migration/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | -| [_Sync ACLs to a cluster_](../HowTo/kafka-cluster-migration/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | -| [_Sync ACLs from a cluster_](../HowTo/kafka-cluster-migration/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. | -| [_Sync schemas to a cluster_](../HowTo/kafka-cluster-migration/sync-schemas-to-cluster.md) | 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.md) | 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.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | -| [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | -| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | -| [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | -| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | -| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | -| [_Analytics / Reports_](../dashboard/analytics.md) | 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. | -| [_Apache Kafka flavor support_](../HowTo/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | -| [_Klaw login AD/SSO/DB_](../HowTo/authentication/index.md) | Users can log in to Klaw using Windows AD or SSO providers like Azure and Google. | +| Feature | Description | +| ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | +| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | +| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | +| [_Connectors creation_](../HowTo/connectors/Request-a-new-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | +| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | +| [_Topic naming conventions_](../HowTo/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | +| [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | +| [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | +| [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | +| [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | +| [_View consumer lag_](../HowTo/topics/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.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | +| [_Sync topics from a cluster_](../HowTo/kafka-cluster-migration/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | +| [_Sync ACLs to a cluster_](../HowTo/kafka-cluster-migration/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | +| [_Sync ACLs from a cluster_](../HowTo/kafka-cluster-migration/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. | +| [_Sync schemas to a cluster_](../HowTo/kafka-cluster-migration/sync-schemas-to-cluster.md) | 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.md) | 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.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | +| [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | +| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | +| [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | +| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | +| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | +| [_Analytics / Reports_](../dashboard/analytics.md) | 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. | +| [_Apache Kafka flavor support_](../HowTo/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | +| _Klaw login AD/SSO/DB_ | Users can log in to Klaw using [Windows AD](authentication-authorization/authentication/windows-ad.md), SSO providers like [Azure](authentication-authorization/authentication/azure-ad.md) and [Google](authentication-authorization/authentication/google-account.md). Klaw also offers the option to configure any [third-party login account](authentication-authorization/authentication/third-party-account.md) as well as using a [database account](authentication-authorization/authentication/userpwd-db.md). | :::note Klaw is continuously evolving, and many other minor features are also available that are not listed above. diff --git a/docs/releases/release200.md b/docs/releases/release200.md index f1cb9ab8..b10c398c 100644 --- a/docs/releases/release200.md +++ b/docs/releases/release200.md @@ -68,7 +68,7 @@ provider, such as grants in Azure Active Directory, and Klaw will validate and assign these roles to users during the sign-up process. For more information, see -[Authorization](../../docs/HowTo/authorization.md). +[Authorization](../../docs/authentication-authorization/authorization.md). To enable the authorization feature, set the below property to value `true` in the `application.properties` file: : diff --git a/docs/user-team-management/manage-users.md b/docs/user-team-management/manage-users.md index d98af1da..975839cf 100644 --- a/docs/user-team-management/manage-users.md +++ b/docs/user-team-management/manage-users.md @@ -1,8 +1,7 @@ # Manage users -Klaw stores user information in its metadata, and the method of -[authentication](../HowTo/authentication) may -vary depending on the configuration. Each user is associated with a team +Klaw stores user information in its metadata. The method of +authentication may vary depending on the configuration. Each user is associated with a team and a role, and if the **Switch teams** flag is enabled, they can switch between multiple teams. diff --git a/sidebars.js b/sidebars.js index 6956291f..3bfd7c2f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -88,6 +88,23 @@ const sidebars = { }, ], }, + { + type: "category", + label: "Authentication and authorization", + items: [ + { + type: "category", + label: "Authentication", + items: [ + { + type: "autogenerated", + dirName: "authentication-authorization/authentication", + }, + ], + }, + "authentication-authorization/authorization", + ], + }, { type: "category", label: "Concepts", From fa666f3e1d2e2a04c9f738947762988228de6ab5 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Fri, 2 Feb 2024 13:55:39 +0100 Subject: [PATCH 06/28] Add new category Cluster management Signed-off-by: Mirjam Aulbach --- _redirects | 14 ++++- ...ma-management-disaster-recovery-in-klaw.md | 6 +- current-routes.json | 22 +++---- .../connectors/Request-a-new-connector.md | 2 +- docs/HowTo/schemas/Request-a-schema.md | 2 +- .../subscriptions/Request-a-subscription.md | 2 +- docs/HowTo/topics/Request-a-new-topic.md | 2 +- .../clusters-environments}/clusters.md | 6 +- .../clusters-environments}/environments.md | 6 +- .../clusters-environments/index.md} | 0 .../kafka-cluster-sync}/index.md | 0 .../sync-acls-from-cluster.md | 0 .../sync-acls-to-cluster.md | 0 .../sync-connectors-from-cluster.md | 0 .../sync-schemas-from-cluster.md | 0 .../sync-schemas-to-cluster.md | 0 .../sync-topics-from-cluster.md | 0 .../sync-topics-to-cluster.md | 0 docs/getting-started/features.md | 58 +++++++++---------- sidebars.js | 36 ++++++++++++ 20 files changed, 102 insertions(+), 54 deletions(-) rename docs/{HowTo => cluster-management/clusters-environments}/clusters.md (94%) rename docs/{HowTo => cluster-management/clusters-environments}/environments.md (95%) rename docs/{Concepts/clusters-environments.md => cluster-management/clusters-environments/index.md} (100%) rename docs/{HowTo/kafka-cluster-migration => cluster-management/kafka-cluster-sync}/index.md (100%) rename docs/{HowTo/kafka-cluster-migration => cluster-management/kafka-cluster-sync}/sync-acls-from-cluster.md (100%) rename docs/{HowTo/kafka-cluster-migration => cluster-management/kafka-cluster-sync}/sync-acls-to-cluster.md (100%) rename docs/{HowTo/kafka-cluster-migration => cluster-management/kafka-cluster-sync}/sync-connectors-from-cluster.md (100%) rename docs/{HowTo/kafka-cluster-migration => cluster-management/kafka-cluster-sync}/sync-schemas-from-cluster.md (100%) rename docs/{HowTo/kafka-cluster-migration => cluster-management/kafka-cluster-sync}/sync-schemas-to-cluster.md (100%) rename docs/{HowTo/kafka-cluster-migration => cluster-management/kafka-cluster-sync}/sync-topics-from-cluster.md (100%) rename docs/{HowTo/kafka-cluster-migration => cluster-management/kafka-cluster-sync}/sync-topics-to-cluster.md (100%) diff --git a/_redirects b/_redirects index c6b9702d..92eadfb2 100644 --- a/_redirects +++ b/_redirects @@ -33,4 +33,16 @@ /docs/HowTo/authentication/third-party-account /docs/authentication-authorization/authentication/third-party-account 301 /docs/HowTo/authentication/userpwd-db /docs/authentication-authorization/authentication/userpwd-db 301 /docs/HowTo/authentication/windows-ad /docs/authentication-authorization/authentication/windows-ad 301 -/docs/HowTo/authorization /docs/authentication-authorization/authorization 301 301 \ No newline at end of file +/docs/HowTo/authorization /docs/authentication-authorization/authorization 301 301 + +/docs/Concepts/clusters-environments /docs/cluster-management/clusters-environments/ 301 +/docs/HowTo/clusters /docs/cluster-management/clusters-environments/clusters 301 +/docs/HowTo/environments /docs/cluster-management/clusters-environments/environments 301 +/docs/HowTo/kafka-cluster-migration /docs/cluster-management/kafka-cluster-sync 301 +/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-acls-from-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-acls-to-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-connectors-from-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster 301 diff --git a/blog/2023/09/schema-management-disaster-recovery-in-klaw.md b/blog/2023/09/schema-management-disaster-recovery-in-klaw.md index ed6f56b5..e647404c 100644 --- a/blog/2023/09/schema-management-disaster-recovery-in-klaw.md +++ b/blog/2023/09/schema-management-disaster-recovery-in-klaw.md @@ -140,7 +140,7 @@ As the topic owner, you have the authority to approve, initiate, or reject any s ![image](../../../static/images/blogimages/SchemaRequest-Workflow.png) -For more information on registering a schema **[see here](../../../docs/HowTo/schemas/Request-a-schema)** +For more information on registering a schema **[see here](/docs/HowTo/schemas/Request-a-schema)** Watch the video below for a step-by-step demonstration of registering a schema in Klaw. @@ -158,7 +158,7 @@ with topics, and integrating them into its metastore. This backup process is str clicks, regardless of the volume of schemas or topics. For more information on synchronizing schemas from the schema registry to Klaw, refer to -**[sync-schemas-from-cluster](../../../docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster)** +**[sync-schemas-from-cluster](/docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster)** The following video demonstrates how schemas are synchronized to Klaw for a selection of topics already present in Karapace. @@ -176,7 +176,7 @@ Select the schemas you want to sync with the cluster. Once you submit your choic schemas directly into your designated schema registry environment. For more information on this synchronization process, refer to -**[sync-schemas-to-cluster](/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster)** +**[sync-schemas-to-cluster](/docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster)** The following video demonstrates migrating schemas to a Schema Registry, specifically focusing on a couple of subjects already stored in Klaw. diff --git a/current-routes.json b/current-routes.json index 2a1862b1..fde9032f 100644 --- a/current-routes.json +++ b/current-routes.json @@ -37,7 +37,17 @@ "/docs/authentication-authorization/authentication/userpwd-db", "/docs/authentication-authorization/authentication/windows-ad", "/docs/authentication-authorization/authorization", - "/docs/Concepts/clusters-environments", + "/docs/cluster-management/clusters-environments/", + "/docs/cluster-management/clusters-environments/clusters", + "/docs/cluster-management/clusters-environments/environments", + "/docs/cluster-management/kafka-cluster-sync/", + "/docs/cluster-management/kafka-cluster-sync/sync-acls-from-cluster", + "/docs/cluster-management/kafka-cluster-sync/sync-acls-to-cluster", + "/docs/cluster-management/kafka-cluster-sync/sync-connectors-from-cluster", + "/docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster", + "/docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster", + "/docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster", + "/docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster", "/docs/Concepts/metastore", "/docs/Concepts/promotion", "/docs/Concepts/synchronize", @@ -58,7 +68,6 @@ "/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi", "/docs/HowTo/clusterconnectivity/klaw-db-connection", "/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol", - "/docs/HowTo/clusters", "/docs/HowTo/connectors/", "/docs/HowTo/connectors/Approve-a-connector", "/docs/HowTo/connectors/manage-connectors", @@ -66,18 +75,9 @@ "/docs/HowTo/connectors/Request-a-new-connector", "/docs/HowTo/dashboard", "/docs/HowTo/deployklaw", - "/docs/HowTo/environments", "/docs/HowTo/exportimport/", "/docs/HowTo/exportimport/exportdata", "/docs/HowTo/exportimport/importdata", - "/docs/HowTo/kafka-cluster-migration/", - "/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster", - "/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster", - "/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster", - "/docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster", - "/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster", - "/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster", - "/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster", "/docs/HowTo/notifications/", "/docs/HowTo/notifications/email-notification", "/docs/HowTo/notifications/slack-notification", diff --git a/docs/HowTo/connectors/Request-a-new-connector.md b/docs/HowTo/connectors/Request-a-new-connector.md index a3fb7d65..270c1d38 100644 --- a/docs/HowTo/connectors/Request-a-new-connector.md +++ b/docs/HowTo/connectors/Request-a-new-connector.md @@ -8,7 +8,7 @@ Apache Kafka Connector. ## Prerequisites - The Superadmin must configure the environment within Klaw. See - [Environments](../../Concepts/clusters-environments.md) for the steps to configure the environments. + [Environments](../../cluster-management/clusters-environments/index.md) for the steps to configure the environments. ## Make a connector request diff --git a/docs/HowTo/schemas/Request-a-schema.md b/docs/HowTo/schemas/Request-a-schema.md index 6083f044..f6cf7cf6 100644 --- a/docs/HowTo/schemas/Request-a-schema.md +++ b/docs/HowTo/schemas/Request-a-schema.md @@ -8,7 +8,7 @@ decline any schema request. ## Prerequisites - The Superadmin must configure the environment within Klaw. See - [Environments](../../Concepts/clusters-environments.md) for the steps to configure the environments. + [Environments](../../cluster-management/clusters-environments/index.md) for the steps to configure the environments. ## Make a schema request diff --git a/docs/HowTo/subscriptions/Request-a-subscription.md b/docs/HowTo/subscriptions/Request-a-subscription.md index 7453143d..b0af2d1c 100644 --- a/docs/HowTo/subscriptions/Request-a-subscription.md +++ b/docs/HowTo/subscriptions/Request-a-subscription.md @@ -7,7 +7,7 @@ responsible for approving or declining subscription requests. ## Prerequisites - The Superadmin must configure the environment within Klaw. See - [Environments](../../Concepts/clusters-environments.md) for the steps to configure the environments. + [Environments](../../cluster-management/clusters-environments/index.md) for the steps to configure the environments. ## Make a subscription request diff --git a/docs/HowTo/topics/Request-a-new-topic.md b/docs/HowTo/topics/Request-a-new-topic.md index bf22efae..4b9ad8b3 100644 --- a/docs/HowTo/topics/Request-a-new-topic.md +++ b/docs/HowTo/topics/Request-a-new-topic.md @@ -10,7 +10,7 @@ List requests made against the topic. ## Prerequisites - The Superadmin must configure the environment within Klaw, see - [Environments](../../Concepts/clusters-environments.md) + [Environments](../../cluster-management/clusters-environments/index.md) for the steps to configure the environments. - The Superadmin must also update the server configuration to include the environments, see diff --git a/docs/HowTo/clusters.md b/docs/cluster-management/clusters-environments/clusters.md similarity index 94% rename from docs/HowTo/clusters.md rename to docs/cluster-management/clusters-environments/clusters.md index 26ac4a55..8d258731 100644 --- a/docs/HowTo/clusters.md +++ b/docs/cluster-management/clusters-environments/clusters.md @@ -49,7 +49,7 @@ To add a new cluster in Klaw, follow these steps: 5. Select **Save** to create the new cluster. A new cluster is now created. -![image](../../static/images/clusters/NewCluster.png) +![image](../../../static/images/clusters/NewCluster.png) ## Update cluster @@ -63,7 +63,7 @@ To update a cluster, follow these steps: 5. Select **Save** to confirm your changes. The cluster is updated with the new information. -![image](../../static/images/clusters/UpdateCluster.png) +![image](../../../static/images/clusters/UpdateCluster.png) ## Delete Cluster @@ -80,4 +80,4 @@ To delete a cluster, follow these steps: 4. On the confirmation screen, select **delete** to confirm the deletion of the cluster. The selected cluster is deleted. -![image](../../static/images/clusters/Clusters.png) +![image](../../../static/images/clusters/Clusters.png) diff --git a/docs/HowTo/environments.md b/docs/cluster-management/clusters-environments/environments.md similarity index 95% rename from docs/HowTo/environments.md rename to docs/cluster-management/clusters-environments/environments.md index 59c03ced..fce12bf2 100644 --- a/docs/HowTo/environments.md +++ b/docs/cluster-management/clusters-environments/environments.md @@ -77,7 +77,7 @@ To add a **Kafka Connect environment**, enter the following details in the **Add - Select **Save** to add a new Apache Kafka Connect environment. -![image](../../static/images/environments/NewEnvironment.png) +![image](../../../static/images/environments/NewEnvironment.png) ## Update environment @@ -95,7 +95,7 @@ To update/modify an existing environment in Klaw, follow these steps: edit them in the corresponding clusters. ::: -![image](../../static/images/environments/UpdateEnvironment.png) +![image](../../../static/images/environments/UpdateEnvironment.png) ## Delete environment @@ -109,4 +109,4 @@ To delete an existing environment in Klaw, follow these steps: deletion of the environment. Once confirmed, the selected environment will be deleted. -![image](../../static/images/environments/Environments.png) +![image](../../../static/images/environments/Environments.png) diff --git a/docs/Concepts/clusters-environments.md b/docs/cluster-management/clusters-environments/index.md similarity index 100% rename from docs/Concepts/clusters-environments.md rename to docs/cluster-management/clusters-environments/index.md diff --git a/docs/HowTo/kafka-cluster-migration/index.md b/docs/cluster-management/kafka-cluster-sync/index.md similarity index 100% rename from docs/HowTo/kafka-cluster-migration/index.md rename to docs/cluster-management/kafka-cluster-sync/index.md diff --git a/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md b/docs/cluster-management/kafka-cluster-sync/sync-acls-from-cluster.md similarity index 100% rename from docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md rename to docs/cluster-management/kafka-cluster-sync/sync-acls-from-cluster.md diff --git a/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md b/docs/cluster-management/kafka-cluster-sync/sync-acls-to-cluster.md similarity index 100% rename from docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md rename to docs/cluster-management/kafka-cluster-sync/sync-acls-to-cluster.md diff --git a/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md b/docs/cluster-management/kafka-cluster-sync/sync-connectors-from-cluster.md similarity index 100% rename from docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md rename to docs/cluster-management/kafka-cluster-sync/sync-connectors-from-cluster.md diff --git a/docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster.md b/docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster.md similarity index 100% rename from docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster.md rename to docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster.md diff --git a/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster.md b/docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster.md similarity index 100% rename from docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster.md rename to docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster.md diff --git a/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster.md b/docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster.md similarity index 100% rename from docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster.md rename to docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster.md diff --git a/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster.md b/docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster.md similarity index 100% rename from docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster.md rename to docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster.md diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 0a1582c3..1e66ea41 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -6,35 +6,35 @@ sidebar_position: 1 Explore the comprehensive range of features Klaw offers to manage your Apache Kafka® ecosystem more efficiently. -| Feature | Description | -| ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | -| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | -| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | -| [_Connectors creation_](../HowTo/connectors/Request-a-new-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | -| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | -| [_Topic naming conventions_](../HowTo/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | -| [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | -| [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | -| [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | -| [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | -| [_View consumer lag_](../HowTo/topics/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.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | -| [_Sync topics from a cluster_](../HowTo/kafka-cluster-migration/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | -| [_Sync ACLs to a cluster_](../HowTo/kafka-cluster-migration/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | -| [_Sync ACLs from a cluster_](../HowTo/kafka-cluster-migration/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. | -| [_Sync schemas to a cluster_](../HowTo/kafka-cluster-migration/sync-schemas-to-cluster.md) | 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.md) | 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.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | -| [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | -| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | -| [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | -| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | -| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | -| [_Analytics / Reports_](../dashboard/analytics.md) | 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. | -| [_Apache Kafka flavor support_](../HowTo/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | -| _Klaw login AD/SSO/DB_ | Users can log in to Klaw using [Windows AD](authentication-authorization/authentication/windows-ad.md), SSO providers like [Azure](authentication-authorization/authentication/azure-ad.md) and [Google](authentication-authorization/authentication/google-account.md). Klaw also offers the option to configure any [third-party login account](authentication-authorization/authentication/third-party-account.md) as well as using a [database account](authentication-authorization/authentication/userpwd-db.md). | +| Feature | Description | +| ------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | +| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | +| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | +| [_Connectors creation_](../HowTo/connectors/Request-a-new-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | +| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | +| [_Topic naming conventions_](../cluster-management/clusters-environments/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | +| [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | +| [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | +| [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | +| [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | +| [_View consumer lag_](../HowTo/topics/View-consumer-lag) | Keep track of consumer offsets and view lags for a consumer group. | +| [_Sync topics to a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-to-cluster.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | +| [_Sync topics from a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | +| [_Sync ACLs to a cluster_](../cluster-management/kafka-cluster-sync/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | +| [_Sync ACLs from a cluster_](../cluster-management/kafka-cluster-sync/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. | +| [_Sync schemas to a cluster_](../cluster-management/kafka-cluster-sync/sync-schemas-to-cluster.md) | Maintain consistency by synchronizing schemas, including all versions, to new or existing Schema Registry clusters. | +| [_Sync schemas from a cluster_](../cluster-management/kafka-cluster-sync/sync-schemas-from-cluster.md) | Ensure schema consistency by synchronizing schemas from any Schema Registry cluster to Klaw. | +| [_Sync connectors from a cluster_](../cluster-management/kafka-cluster-sync/sync-connectors-from-cluster.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | +| [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | +| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | +| [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | +| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | +| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | +| [_Analytics / Reports_](../dashboard/analytics.md) | 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. | +| [_Apache Kafka flavor support_](../cluster-management/clusters-environments/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | +| _Klaw login AD/SSO/DB_ | Users can log in to Klaw using [Windows AD](authentication-authorization/authentication/windows-ad.md), SSO providers like [Azure](authentication-authorization/authentication/azure-ad.md) and [Google](authentication-authorization/authentication/google-account.md). Klaw also offers the option to configure any [third-party login account](authentication-authorization/authentication/third-party-account.md) as well as using a [database account](authentication-authorization/authentication/userpwd-db.md). | :::note Klaw is continuously evolving, and many other minor features are also available that are not listed above. diff --git a/sidebars.js b/sidebars.js index 3bfd7c2f..49c3b44e 100644 --- a/sidebars.js +++ b/sidebars.js @@ -105,6 +105,42 @@ const sidebars = { "authentication-authorization/authorization", ], }, + { + type: "category", + label: "Cluster management", + items: [ + { + type: "category", + label: "Clusters and environments", + link: { + type: "doc", + id: "cluster-management/clusters-environments/index", + }, + items: [ + "cluster-management/clusters-environments/clusters", + "cluster-management/clusters-environments/environments", + ], + }, + { + type: "category", + label: "Kafka cluster synchronization", + link: { + type: "doc", + id: "cluster-management/kafka-cluster-sync/index", + }, + items: [ + "cluster-management/kafka-cluster-sync/sync-acls-from-cluster", + "cluster-management/kafka-cluster-sync/sync-acls-to-cluster", + "cluster-management/kafka-cluster-sync/sync-connectors-from-cluster", + "cluster-management/kafka-cluster-sync/sync-schemas-from-cluster", + "cluster-management/kafka-cluster-sync/sync-schemas-to-cluster", + "cluster-management/kafka-cluster-sync/sync-topics-from-cluster", + "cluster-management/kafka-cluster-sync/sync-topics-to-cluster", + ], + }, + ], + }, + { type: "category", label: "Concepts", From 16d907002da0b153163f2c5f03fcd68d0dec092e Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Fri, 2 Feb 2024 14:46:38 +0100 Subject: [PATCH 07/28] Add new category Cluster connectivity Signed-off-by: Mirjam Aulbach --- _redirects | 12 +++++++ current-routes.json | 22 ++++++------- .../aiven-kafka-cluster-sasl-protocol.md} | 0 .../aiven-kafka-cluster-ssl-protocol.md | 0 ...iven-kafka-connect-cluster-ssl-protocol.md | 0 .../aiven-karapace-cluster-ssl-protocol.md | 0 ...fluent-cloud-kafka-cluster-ssl-protocol.md | 0 .../index.md | 31 +++++++------------ .../kafka-cluster-sasl-protocol.md} | 0 .../kafka-cluster-ssl-protocol.md | 0 .../klaw-core-with-clusterapi.md | 0 .../klaw-db-connection.md | 2 +- .../sr-cluster-ssl-protocol.md | 0 docs/getting-started/features.md | 2 +- docs/releases/release210.md | 2 +- sidebars.js | 21 ++++++++++++- 16 files changed, 57 insertions(+), 35 deletions(-) rename docs/{HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol.md => cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol.md} (100%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/aiven-kafka-cluster-ssl-protocol.md (100%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/aiven-kafka-connect-cluster-ssl-protocol.md (100%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/aiven-karapace-cluster-ssl-protocol.md (100%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/confluent-cloud-kafka-cluster-ssl-protocol.md (100%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/index.md (77%) rename docs/{HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md => cluster-connectivity-setup/kafka-cluster-sasl-protocol.md} (100%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/kafka-cluster-ssl-protocol.md (100%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/klaw-core-with-clusterapi.md (100%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/klaw-db-connection.md (98%) rename docs/{HowTo/clusterconnectivity => cluster-connectivity-setup}/sr-cluster-ssl-protocol.md (100%) diff --git a/_redirects b/_redirects index 92eadfb2..ec3d06b7 100644 --- a/_redirects +++ b/_redirects @@ -46,3 +46,15 @@ /docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster 301 /docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster 301 /docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster 301 + +/docs/HowTo/clusterconnectivity/ /docs/cluster-connectivity-setup/ 301 +/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol 301 +/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-connect-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-karapace-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-sasl-protocol 301 +/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi /docs/cluster-connectivity-setup/klaw-core-with-clusterapi 301 +/docs/HowTo/clusterconnectivity/klaw-db-connection /docs/cluster-connectivity-setup/klaw-db-connection 301 +/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol /docs/cluster-connectivity-setup/sr-cluster-ssl-protocol 301 \ No newline at end of file diff --git a/current-routes.json b/current-routes.json index fde9032f..2d8a9a65 100644 --- a/current-routes.json +++ b/current-routes.json @@ -37,6 +37,17 @@ "/docs/authentication-authorization/authentication/userpwd-db", "/docs/authentication-authorization/authentication/windows-ad", "/docs/authentication-authorization/authorization", + "/docs/cluster-connectivity-setup/", + "/docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol", + "/docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol", + "/docs/cluster-connectivity-setup/aiven-kafka-connect-cluster-ssl-protocol", + "/docs/cluster-connectivity-setup/aiven-karapace-cluster-ssl-protocol", + "/docs/cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol", + "/docs/cluster-connectivity-setup/kafka-cluster-sasl-protocol", + "/docs/cluster-connectivity-setup/kafka-cluster-ssl-protocol", + "/docs/cluster-connectivity-setup/klaw-core-with-clusterapi", + "/docs/cluster-connectivity-setup/klaw-db-connection", + "/docs/cluster-connectivity-setup/sr-cluster-ssl-protocol", "/docs/cluster-management/clusters-environments/", "/docs/cluster-management/clusters-environments/clusters", "/docs/cluster-management/clusters-environments/environments", @@ -57,17 +68,6 @@ "/docs/getting-started/features", "/docs/getting-started/getstarted", "/docs/getting-started/quickstart", - "/docs/HowTo/clusterconnectivity/", - "/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol", - "/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol", - "/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol", - "/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol", - "/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol", - "/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol", - "/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol", - "/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi", - "/docs/HowTo/clusterconnectivity/klaw-db-connection", - "/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol", "/docs/HowTo/connectors/", "/docs/HowTo/connectors/Approve-a-connector", "/docs/HowTo/connectors/manage-connectors", diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol.md b/docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol.md similarity index 100% rename from docs/HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol.md rename to docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol.md diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md b/docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol.md similarity index 100% rename from docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md rename to docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol.md diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md b/docs/cluster-connectivity-setup/aiven-kafka-connect-cluster-ssl-protocol.md similarity index 100% rename from docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md rename to docs/cluster-connectivity-setup/aiven-kafka-connect-cluster-ssl-protocol.md diff --git a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md b/docs/cluster-connectivity-setup/aiven-karapace-cluster-ssl-protocol.md similarity index 100% rename from docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md rename to docs/cluster-connectivity-setup/aiven-karapace-cluster-ssl-protocol.md diff --git a/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md b/docs/cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol.md similarity index 100% rename from docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md rename to docs/cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol.md diff --git a/docs/HowTo/clusterconnectivity/index.md b/docs/cluster-connectivity-setup/index.md similarity index 77% rename from docs/HowTo/clusterconnectivity/index.md rename to docs/cluster-connectivity-setup/index.md index 3d24559f..8130a00f 100644 --- a/docs/HowTo/clusterconnectivity/index.md +++ b/docs/cluster-connectivity-setup/index.md @@ -1,30 +1,21 @@ -# Manage connections in Klaw +# Cluster connectivity setup -Efficiently manage connections between Klaw and various Apache Kafka® cluster types. +Klaw supports the following Apache Kafka® flavors: -- [Klaw database connection](klaw-db-connection.md) +- Apache Kafka +- Aiven for Apache Kafka +- Confluent +- Confluent Cloud -- [Connect Klaw Core and Klaw Cluster APIs](klaw-core-with-clusterapi.md) +## Manage connections in Klaw +- [Klaw database connection](klaw-db-connection.md) +- [Connect Klaw Core and Klaw Cluster APIs](klaw-core-with-clusterapi.md) - [Connect to Apache Kafka cluster using SSL protocol](kafka-cluster-ssl-protocol.md) - -- [Connect to Apache Kafka cluster using SASL protocol](kafka-cluster-sasl-ssl-protocol.md) - +- [Connect to Apache Kafka cluster using SASL protocol](kafka-cluster-sasl-protocol.md) - [Connect to Schema Registry cluster](sr-cluster-ssl-protocol.md) - - [Connect with Aiven for Apache Kafka cluster using SSL protocol](aiven-kafka-cluster-ssl-protocol.md) - -- [Connect with Aiven For Apache Kafka cluster using SASL protocol](aiven-kafka-cluster-sasl-ssl-protocol.md) - +- [Connect with Aiven For Apache Kafka cluster using SASL protocol](aiven-kafka-cluster-sasl-protocol.md) - [Connect to Karapace schema registry](aiven-karapace-cluster-ssl-protocol.md) - - [Aiven For Apache Kafka Connect cluster](aiven-kafka-connect-cluster-ssl-protocol.md) - - [Connect with Confluent Cloud Kafka cluster using SSL protocol](confluent-cloud-kafka-cluster-ssl-protocol.md) - -Klaw supports the following Apache Kafka flavors: - -- Apache Kafka -- Aiven for Apache Kafka -- Confluent -- Confluent Cloud diff --git a/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md b/docs/cluster-connectivity-setup/kafka-cluster-sasl-protocol.md similarity index 100% rename from docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md rename to docs/cluster-connectivity-setup/kafka-cluster-sasl-protocol.md diff --git a/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md b/docs/cluster-connectivity-setup/kafka-cluster-ssl-protocol.md similarity index 100% rename from docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md rename to docs/cluster-connectivity-setup/kafka-cluster-ssl-protocol.md diff --git a/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md b/docs/cluster-connectivity-setup/klaw-core-with-clusterapi.md similarity index 100% rename from docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md rename to docs/cluster-connectivity-setup/klaw-core-with-clusterapi.md diff --git a/docs/HowTo/clusterconnectivity/klaw-db-connection.md b/docs/cluster-connectivity-setup/klaw-db-connection.md similarity index 98% rename from docs/HowTo/clusterconnectivity/klaw-db-connection.md rename to docs/cluster-connectivity-setup/klaw-db-connection.md index ab048573..8144ec13 100644 --- a/docs/HowTo/clusterconnectivity/klaw-db-connection.md +++ b/docs/cluster-connectivity-setup/klaw-db-connection.md @@ -1,4 +1,4 @@ -# Configure database connection for Klaw +# Klaw database connection Klaw uses a database to store metadata, such as information about users, teams, and owners. This allows the system to track and manage access to diff --git a/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md b/docs/cluster-connectivity-setup/sr-cluster-ssl-protocol.md similarity index 100% rename from docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md rename to docs/cluster-connectivity-setup/sr-cluster-ssl-protocol.md diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 1e66ea41..7dab7fa3 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -29,7 +29,7 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | | Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | | [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | -| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | +| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../cluster-connectivity-setup/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | | [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | | [_Analytics / Reports_](../dashboard/analytics.md) | 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. | diff --git a/docs/releases/release210.md b/docs/releases/release210.md index 98789cb2..e2deb7c0 100644 --- a/docs/releases/release210.md +++ b/docs/releases/release210.md @@ -57,7 +57,7 @@ includes the implementation of the following APIs: (v3)]() For more information, see [Confluent -Cloud](../../docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol). +Cloud](../../docs/cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol). ### Switch Teams diff --git a/sidebars.js b/sidebars.js index 49c3b44e..c6b01215 100644 --- a/sidebars.js +++ b/sidebars.js @@ -140,7 +140,26 @@ const sidebars = { }, ], }, - + { + type: "category", + label: "Cluster connectivity setup", + link: { + type: "doc", + id: "cluster-connectivity-setup/index", + }, + items: [ + "cluster-connectivity-setup/klaw-db-connection", + "cluster-connectivity-setup/klaw-core-with-clusterapi", + "cluster-connectivity-setup/kafka-cluster-ssl-protocol", + "cluster-connectivity-setup/kafka-cluster-sasl-protocol", + "cluster-connectivity-setup/sr-cluster-ssl-protocol", + "cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol", + "cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol", + "cluster-connectivity-setup/aiven-karapace-cluster-ssl-protocol", + "cluster-connectivity-setup/aiven-kafka-connect-cluster-ssl-protocol", + "cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol", + ], + }, { type: "category", label: "Concepts", From ef940e1dc58562577d445658af7bb4e7cba47784 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Fri, 2 Feb 2024 15:22:02 +0100 Subject: [PATCH 08/28] Add new category Connector management Signed-off-by: Mirjam Aulbach --- _redirects | 8 +++++++- current-routes.json | 10 +++++----- .../approve-connector.md} | 2 +- .../connectors => connector-management}/index.md | 13 +++++-------- .../manage-connectors.md | 2 +- .../my-connector-requests.md} | 2 +- .../request-connector.md} | 0 docs/getting-started/features.md | 2 +- sidebars.js | 14 ++++++++++++++ 9 files changed, 35 insertions(+), 18 deletions(-) rename docs/{HowTo/connectors/Approve-a-connector.md => connector-management/approve-connector.md} (98%) rename docs/{HowTo/connectors => connector-management}/index.md (86%) rename docs/{HowTo/connectors => connector-management}/manage-connectors.md (91%) rename docs/{HowTo/connectors/My-connector-requests.md => connector-management/my-connector-requests.md} (98%) rename docs/{HowTo/connectors/Request-a-new-connector.md => connector-management/request-connector.md} (100%) diff --git a/_redirects b/_redirects index ec3d06b7..6daacd4a 100644 --- a/_redirects +++ b/_redirects @@ -57,4 +57,10 @@ /docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-ssl-protocol 301 /docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi /docs/cluster-connectivity-setup/klaw-core-with-clusterapi 301 /docs/HowTo/clusterconnectivity/klaw-db-connection /docs/cluster-connectivity-setup/klaw-db-connection 301 -/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol /docs/cluster-connectivity-setup/sr-cluster-ssl-protocol 301 \ No newline at end of file +/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol /docs/cluster-connectivity-setup/sr-cluster-ssl-protocol 301 + +/docs/HowTo/connectors /docs/connector-management 301 +/docs/HowTo/connectors/Approve-a-connector /docs/connector-management/approve-connector 301 +/docs/HowTo/connectors/manage-connectors /docs/connector-management/manage-connectors 301 +/docs/HowTo/connectors/My-connector-requests /docs/connector-management/my-connector-requests 301 +/docs/HowTo/connectors/Request-a-new-connector /docs/connector-management/request-connector 301 diff --git a/current-routes.json b/current-routes.json index 2d8a9a65..d43b488b 100644 --- a/current-routes.json +++ b/current-routes.json @@ -63,16 +63,16 @@ "/docs/Concepts/promotion", "/docs/Concepts/synchronize", "/docs/Concepts/workflows", + "/docs/connector-management/", + "/docs/connector-management/approve-connector", + "/docs/connector-management/manage-connectors", + "/docs/connector-management/my-connector-requests", + "/docs/connector-management/request-connector", "/docs/dashboard/analytics", "/docs/faq", "/docs/getting-started/features", "/docs/getting-started/getstarted", "/docs/getting-started/quickstart", - "/docs/HowTo/connectors/", - "/docs/HowTo/connectors/Approve-a-connector", - "/docs/HowTo/connectors/manage-connectors", - "/docs/HowTo/connectors/My-connector-requests", - "/docs/HowTo/connectors/Request-a-new-connector", "/docs/HowTo/dashboard", "/docs/HowTo/deployklaw", "/docs/HowTo/exportimport/", diff --git a/docs/HowTo/connectors/Approve-a-connector.md b/docs/connector-management/approve-connector.md similarity index 98% rename from docs/HowTo/connectors/Approve-a-connector.md rename to docs/connector-management/approve-connector.md index 8363fc25..1ab71c88 100644 --- a/docs/HowTo/connectors/Approve-a-connector.md +++ b/docs/connector-management/approve-connector.md @@ -1,4 +1,4 @@ -# Approve connectors +# Approve a connector When a connector request is made, a team member, other than the creator of the request, can review and either approve or decline it. diff --git a/docs/HowTo/connectors/index.md b/docs/connector-management/index.md similarity index 86% rename from docs/HowTo/connectors/index.md rename to docs/connector-management/index.md index 1dd868ed..ea7c80fe 100644 --- a/docs/HowTo/connectors/index.md +++ b/docs/connector-management/index.md @@ -1,4 +1,4 @@ -# Connectors +# Connector management Apache Kafka® Connect is a tool that allows scalable and reliable data streaming between Apache Kafka and other systems. For more information, see [Apache Kafka @@ -28,10 +28,7 @@ them to other environments, including production. The team that owns the connector is responsible for making the final decision related to any requests, such as approving or declining them. -- [Request a new Connector](Request-a-new-connector.md) - -- [Approve a Connector](Approve-a-connector.md) - -- [My Connector Requests](My-connector-requests.md) - -- [Manage Connectors](manage-connectors.md) +- [Request a new connector](request-connector.md) +- [Approve a connector](approve-connector.md) +- [Manage connectors](manage-connectors.md) +- [My connector requests](my-connector-requests.md) diff --git a/docs/HowTo/connectors/manage-connectors.md b/docs/connector-management/manage-connectors.md similarity index 91% rename from docs/HowTo/connectors/manage-connectors.md rename to docs/connector-management/manage-connectors.md index a8280959..9de20673 100644 --- a/docs/HowTo/connectors/manage-connectors.md +++ b/docs/connector-management/manage-connectors.md @@ -14,4 +14,4 @@ failures. connectors and their tasks. 4. To restart a connector, you can choose to restart all tasks, including the failed ones, or only the failed tasks. -![image](../../../static/images/sync/ConnectorStatus.png) +![image](../../static/images/sync/ConnectorStatus.png) diff --git a/docs/HowTo/connectors/My-connector-requests.md b/docs/connector-management/my-connector-requests.md similarity index 98% rename from docs/HowTo/connectors/My-connector-requests.md rename to docs/connector-management/my-connector-requests.md index bae03cdb..48aa4903 100644 --- a/docs/HowTo/connectors/My-connector-requests.md +++ b/docs/connector-management/my-connector-requests.md @@ -1,4 +1,4 @@ -# My Connector Requests +# My connector requests You can access the **My Connector Requests** page by navigating to **Requests -\> My Connector Requests**. On this page, you can view all diff --git a/docs/HowTo/connectors/Request-a-new-connector.md b/docs/connector-management/request-connector.md similarity index 100% rename from docs/HowTo/connectors/Request-a-new-connector.md rename to docs/connector-management/request-connector.md diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 7dab7fa3..8bcb5130 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -11,7 +11,7 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | | [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | | [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | -| [_Connectors creation_](../HowTo/connectors/Request-a-new-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | +| [_Connectors creation_](../connector-management/approve-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | | [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | | [_Topic naming conventions_](../cluster-management/clusters-environments/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | | [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | diff --git a/sidebars.js b/sidebars.js index c6b01215..c032ce7b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -160,6 +160,20 @@ const sidebars = { "cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol", ], }, + { + type: "category", + label: "Connector management", + link: { + type: "doc", + id: "connector-management/index", + }, + items: [ + "connector-management/request-connector", + "connector-management/approve-connector", + "connector-management/manage-connectors", + "connector-management/my-connector-requests", + ], + }, { type: "category", label: "Concepts", From ffa391be82de94ca17efbe000208e7f61beb356f Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Fri, 2 Feb 2024 15:53:45 +0100 Subject: [PATCH 09/28] Add new category Metadata management Signed-off-by: Mirjam Aulbach --- _redirects | 5 ++ current-routes.json | 8 +-- .../connector-management/request-connector.md | 2 +- docs/getting-started/features.md | 58 +++++++++---------- .../import-export}/exportdata.md | 0 .../import-export}/importdata.md | 0 .../import-export}/index.md | 5 +- .../metastore.md | 0 docs/releases/release220.md | 2 +- sidebars.js | 19 ++++++ 10 files changed, 61 insertions(+), 38 deletions(-) rename docs/{HowTo/exportimport => metadata-management/import-export}/exportdata.md (100%) rename docs/{HowTo/exportimport => metadata-management/import-export}/importdata.md (100%) rename docs/{HowTo/exportimport => metadata-management/import-export}/index.md (91%) rename docs/{Concepts => metadata-management}/metastore.md (100%) diff --git a/_redirects b/_redirects index 6daacd4a..7ed6eecd 100644 --- a/_redirects +++ b/_redirects @@ -64,3 +64,8 @@ /docs/HowTo/connectors/manage-connectors /docs/connector-management/manage-connectors 301 /docs/HowTo/connectors/My-connector-requests /docs/connector-management/my-connector-requests 301 /docs/HowTo/connectors/Request-a-new-connector /docs/connector-management/request-connector 301 + +/docs/Concepts/metastore /docs/metadata-management/metastore 301 +/docs/HowTo/exportimport/ /docs/metadata-management/import-export 301 +/docs/HowTo/exportimport/exportdata /docs/metadata-management/import-export/exportdata 301 +/docs/HowTo/exportimport/importdata //docs/metadata-management/import-export/importdata 301 \ No newline at end of file diff --git a/current-routes.json b/current-routes.json index d43b488b..89279436 100644 --- a/current-routes.json +++ b/current-routes.json @@ -59,7 +59,6 @@ "/docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster", "/docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster", "/docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster", - "/docs/Concepts/metastore", "/docs/Concepts/promotion", "/docs/Concepts/synchronize", "/docs/Concepts/workflows", @@ -75,9 +74,6 @@ "/docs/getting-started/quickstart", "/docs/HowTo/dashboard", "/docs/HowTo/deployklaw", - "/docs/HowTo/exportimport/", - "/docs/HowTo/exportimport/exportdata", - "/docs/HowTo/exportimport/importdata", "/docs/HowTo/notifications/", "/docs/HowTo/notifications/email-notification", "/docs/HowTo/notifications/slack-notification", @@ -107,6 +103,10 @@ "/docs/HowTo/topics/View-consumer-lag", "/docs/HowTo/topics/View-topic-events", "/docs/HowTo/zothers", + "/docs/metadata-management/import-export/", + "/docs/metadata-management/import-export/exportdata", + "/docs/metadata-management/import-export/importdata", + "/docs/metadata-management/metastore", "/docs/releases", "/docs/releases/release100", "/docs/releases/release110", diff --git a/docs/connector-management/request-connector.md b/docs/connector-management/request-connector.md index 270c1d38..fd6299a4 100644 --- a/docs/connector-management/request-connector.md +++ b/docs/connector-management/request-connector.md @@ -8,7 +8,7 @@ Apache Kafka Connector. ## Prerequisites - The Superadmin must configure the environment within Klaw. See - [Environments](../../cluster-management/clusters-environments/index.md) for the steps to configure the environments. + [Environments](../cluster-management/clusters-environments/index.md) for the steps to configure the environments. ## Make a connector request diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 8bcb5130..b2db43ee 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -6,35 +6,35 @@ sidebar_position: 1 Explore the comprehensive range of features Klaw offers to manage your Apache Kafka® ecosystem more efficiently. -| Feature | Description | -| ------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | -| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | -| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | -| [_Connectors creation_](../connector-management/approve-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | -| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | -| [_Topic naming conventions_](../cluster-management/clusters-environments/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | -| [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | -| [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | -| [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | -| [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | -| [_View consumer lag_](../HowTo/topics/View-consumer-lag) | Keep track of consumer offsets and view lags for a consumer group. | -| [_Sync topics to a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-to-cluster.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | -| [_Sync topics from a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | -| [_Sync ACLs to a cluster_](../cluster-management/kafka-cluster-sync/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | -| [_Sync ACLs from a cluster_](../cluster-management/kafka-cluster-sync/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. | -| [_Sync schemas to a cluster_](../cluster-management/kafka-cluster-sync/sync-schemas-to-cluster.md) | Maintain consistency by synchronizing schemas, including all versions, to new or existing Schema Registry clusters. | -| [_Sync schemas from a cluster_](../cluster-management/kafka-cluster-sync/sync-schemas-from-cluster.md) | Ensure schema consistency by synchronizing schemas from any Schema Registry cluster to Klaw. | -| [_Sync connectors from a cluster_](../cluster-management/kafka-cluster-sync/sync-connectors-from-cluster.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | -| [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | -| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | -| [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | -| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../cluster-connectivity-setup/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | -| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | -| [_Analytics / Reports_](../dashboard/analytics.md) | 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. | -| [_Apache Kafka flavor support_](../cluster-management/clusters-environments/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | -| _Klaw login AD/SSO/DB_ | Users can log in to Klaw using [Windows AD](authentication-authorization/authentication/windows-ad.md), SSO providers like [Azure](authentication-authorization/authentication/azure-ad.md) and [Google](authentication-authorization/authentication/google-account.md). Klaw also offers the option to configure any [third-party login account](authentication-authorization/authentication/third-party-account.md) as well as using a [database account](authentication-authorization/authentication/userpwd-db.md). | +| Feature | Description | +| ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | +| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | +| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | +| [_Connectors creation_](../connector-management/approve-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | +| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | +| [_Topic naming conventions_](../cluster-management/clusters-environments/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | +| [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | +| [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | +| [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | +| [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | +| [_View consumer lag_](../HowTo/topics/View-consumer-lag) | Keep track of consumer offsets and view lags for a consumer group. | +| [_Sync topics to a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-to-cluster.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | +| [_Sync topics from a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | +| [_Sync ACLs to a cluster_](../cluster-management/kafka-cluster-sync/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | +| [_Sync ACLs from a cluster_](../cluster-management/kafka-cluster-sync/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. | +| [_Sync schemas to a cluster_](../cluster-management/kafka-cluster-sync/sync-schemas-to-cluster.md) | Maintain consistency by synchronizing schemas, including all versions, to new or existing Schema Registry clusters. | +| [_Sync schemas from a cluster_](../cluster-management/kafka-cluster-sync/sync-schemas-from-cluster.md) | Ensure schema consistency by synchronizing schemas from any Schema Registry cluster to Klaw. | +| [_Sync connectors from a cluster_](../cluster-management/kafka-cluster-sync/sync-connectors-from-cluster.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. | +| [_Import / Export Klaw data_](../metadata-management/import-export/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. | +| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | +| [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | +| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../cluster-connectivity-setup/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | +| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | +| [_Analytics / Reports_](../dashboard/analytics.md) | 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. | +| [_Apache Kafka flavor support_](../cluster-management/clusters-environments/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | +| _Klaw login AD/SSO/DB_ | Users can log in to Klaw using [Windows AD](../authentication-authorization/authentication/windows-ad.md), SSO providers like [Azure](../authentication-authorization/authentication/azure-ad.md) and [Google](../authentication-authorization/authentication/google-account.md). Klaw also offers the option to configure any [third-party login account](../authentication-authorization/authentication/third-party-account.md) as well as using a [database account](../authentication-authorization/authentication/userpwd-db.md). | :::note Klaw is continuously evolving, and many other minor features are also available that are not listed above. diff --git a/docs/HowTo/exportimport/exportdata.md b/docs/metadata-management/import-export/exportdata.md similarity index 100% rename from docs/HowTo/exportimport/exportdata.md rename to docs/metadata-management/import-export/exportdata.md diff --git a/docs/HowTo/exportimport/importdata.md b/docs/metadata-management/import-export/importdata.md similarity index 100% rename from docs/HowTo/exportimport/importdata.md rename to docs/metadata-management/import-export/importdata.md diff --git a/docs/HowTo/exportimport/index.md b/docs/metadata-management/import-export/index.md similarity index 91% rename from docs/HowTo/exportimport/index.md rename to docs/metadata-management/import-export/index.md index e7aaa3dc..90e5c170 100644 --- a/docs/HowTo/exportimport/index.md +++ b/docs/metadata-management/import-export/index.md @@ -1,10 +1,9 @@ -# Export Import Klaw Data +# Metadata Import/Export Taking backups of Klaw metadata and importing it into another Klaw instance are important operations. These features provided by Klaw serve the purpose of disaster recovery and migrations, ensuring data security and smooth transitions. -- [Export Klaw data](exportdata.md) - - [Import Klaw data](importdata.md) +- [Export Klaw data](exportdata.md) diff --git a/docs/Concepts/metastore.md b/docs/metadata-management/metastore.md similarity index 100% rename from docs/Concepts/metastore.md rename to docs/metadata-management/metastore.md diff --git a/docs/releases/release220.md b/docs/releases/release220.md index 1905457a..7744c12d 100644 --- a/docs/releases/release220.md +++ b/docs/releases/release220.md @@ -67,7 +67,7 @@ feature provides administrators with additional backup and recovery options, enabling them to manage the system more effectively. For more information, see [Export Klaw -data](../../docs/HowTo/exportimport/exportdata). +data](../../docs/metadata-management/import-export/exportdata). :::note For a complete list of improvements, changelog, and to download the diff --git a/sidebars.js b/sidebars.js index c032ce7b..beb8a26a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -174,6 +174,25 @@ const sidebars = { "connector-management/my-connector-requests", ], }, + { + type: "category", + label: "Metadata management", + items: [ + "metadata-management/metastore", + { + type: "category", + label: "Metadata Import/Export", + link: { + type: "doc", + id: "metadata-management/import-export/index", + }, + items: [ + "metadata-management/import-export/importdata", + "metadata-management/import-export/exportdata", + ], + }, + ], + }, { type: "category", label: "Concepts", From 179f7722cc2ecf699b173b53362a2115391aae5b Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Fri, 2 Feb 2024 17:15:34 +0100 Subject: [PATCH 10/28] Add new category Klaw workflows Signed-off-by: Mirjam Aulbach --- _redirects | 23 +++++++- ...ma-management-disaster-recovery-in-klaw.md | 2 +- current-routes.json | 40 +++++++------- docs/getting-started/features.md | 10 ++-- docs/releases/release200.md | 2 +- docs/{Concepts => workflows}/promotion.md | 4 +- .../schemas => workflows/schema}/index.md | 11 ++-- .../schema/manage-schema-requests.md} | 2 +- .../schema/my-schema-requests.md} | 2 +- .../schema/promote-schema.md} | 4 +- .../schema/request-schema.md} | 0 .../subscription/delete-subscription.md} | 0 .../subscription}/index.md | 11 ++-- .../manage-subscription-requests.md} | 2 +- .../subscription/my-subscription-requests.md} | 2 +- .../subscription/request-subscription.md} | 2 +- .../topic/claim-topic.md} | 0 .../topic/delete-topic.md} | 0 .../topic/edit-topic.md} | 0 .../topics => workflows/topic}/index.md | 21 +++----- .../topic/manage-topic-requests.md} | 2 +- .../topic/my-topic-requests.md} | 2 +- .../topic/promote-topic.md} | 4 +- .../topic/request-topic.md} | 0 .../topic/topic-overview.md} | 0 sidebars.js | 53 +++++++++++++++++++ 26 files changed, 131 insertions(+), 68 deletions(-) rename docs/{Concepts => workflows}/promotion.md (95%) rename docs/{HowTo/schemas => workflows/schema}/index.md (89%) rename docs/{HowTo/schemas/manage-schemas.md => workflows/schema/manage-schema-requests.md} (98%) rename docs/{HowTo/schemas/My-schema-requests.md => workflows/schema/my-schema-requests.md} (98%) rename docs/{HowTo/schemas/Promote-a-schema.md => workflows/schema/promote-schema.md} (97%) rename docs/{HowTo/schemas/Request-a-schema.md => workflows/schema/request-schema.md} (100%) rename docs/{HowTo/subscriptions/Delete-a-subscription.md => workflows/subscription/delete-subscription.md} (100%) rename docs/{HowTo/subscriptions => workflows/subscription}/index.md (91%) rename docs/{HowTo/subscriptions/Approve-a-subscription.md => workflows/subscription/manage-subscription-requests.md} (98%) rename docs/{HowTo/subscriptions/My-subscription-requests.md => workflows/subscription/my-subscription-requests.md} (97%) rename docs/{HowTo/subscriptions/Request-a-subscription.md => workflows/subscription/request-subscription.md} (98%) rename docs/{HowTo/topics/Claim-a-topic.md => workflows/topic/claim-topic.md} (100%) rename docs/{HowTo/topics/Delete-a-topic.md => workflows/topic/delete-topic.md} (100%) rename docs/{HowTo/topics/Edit-topic-request.md => workflows/topic/edit-topic.md} (100%) rename docs/{HowTo/topics => workflows/topic}/index.md (88%) rename docs/{HowTo/topics/Approve-a-topic.md => workflows/topic/manage-topic-requests.md} (99%) rename docs/{HowTo/topics/My-topic-requests.md => workflows/topic/my-topic-requests.md} (98%) rename docs/{HowTo/topics/Promote-a-topic.md => workflows/topic/promote-topic.md} (92%) rename docs/{HowTo/topics/Request-a-new-topic.md => workflows/topic/request-topic.md} (100%) rename docs/{HowTo/topics/Topic-overview.md => workflows/topic/topic-overview.md} (100%) diff --git a/_redirects b/_redirects index 7ed6eecd..4012f12e 100644 --- a/_redirects +++ b/_redirects @@ -68,4 +68,25 @@ /docs/Concepts/metastore /docs/metadata-management/metastore 301 /docs/HowTo/exportimport/ /docs/metadata-management/import-export 301 /docs/HowTo/exportimport/exportdata /docs/metadata-management/import-export/exportdata 301 -/docs/HowTo/exportimport/importdata //docs/metadata-management/import-export/importdata 301 \ No newline at end of file +/docs/HowTo/exportimport/importdata /docs/metadata-management/import-export/importdata 301 + +/docs/Concepts/promotion /docs/workflows/promotion 301 +/docs/HowTo/schemas /docs/workflows/schema 301 +/docs/HowTo/schemas/manage-schemas /docs/workflows/schema/manage-schema-requests 301 +/docs/HowTo/schemas/My-schema-requests /docs/workflows/schema/my-schema-requests 301 +/docs/HowTo/schemas/Promote-a-schema /docs/workflows/schema/promote-schema 301 +/docs/HowTo/schemas/Request-a-schema /docs/workflows/schema/request-schema 301 +/docs/HowTo/subscriptions /docs/workflows/subscription 301 +/docs/HowTo/subscriptions/Approve-a-subscription /docs/workflows/subscription/manage-subscription-requests 301 +/docs/HowTo/subscriptions/Delete-a-subscription /docs/workflows/subscription/delete-subscription 301 +/docs/HowTo/subscriptions/My-subscription-requests /docs/workflows/subscription/my-subscription-requests 301 +/docs/HowTo/subscriptions/Request-a-subscription /docs/workflows/subscription/request-subscription 301 +/docs/HowTo/topics/ /docs/workflows/topic 301 +/docs/HowTo/topics/Approve-a-topic /docs/workflows/topic/manage-topic-requests 301 +/docs/HowTo/topics/Claim-a-topic /docs/workflows/topic/claim-topic 301 +/docs/HowTo/topics/Delete-a-topic /docs/workflows/topic/delete-topic 301 +/docs/HowTo/topics/Edit-topic-request /docs/workflows/topic/edit-topic 301 +/docs/HowTo/topics/My-topic-requests /docs/workflows/topic/my-topic-requests 301 +/docs/HowTo/topics/Promote-a-topic /docs/workflows/topic/promote-topic 301 +/docs/HowTo/topics/Request-a-new-topic /docs/workflows/topic/request-topic 301 +/docs/HowTo/topics/Topic-overview /docs/workflows/topic/topic-overview 301 diff --git a/blog/2023/09/schema-management-disaster-recovery-in-klaw.md b/blog/2023/09/schema-management-disaster-recovery-in-klaw.md index e647404c..d7385e74 100644 --- a/blog/2023/09/schema-management-disaster-recovery-in-klaw.md +++ b/blog/2023/09/schema-management-disaster-recovery-in-klaw.md @@ -140,7 +140,7 @@ As the topic owner, you have the authority to approve, initiate, or reject any s ![image](../../../static/images/blogimages/SchemaRequest-Workflow.png) -For more information on registering a schema **[see here](/docs/HowTo/schemas/Request-a-schema)** +For more information on registering a schema **[see here](/docs/workflows/schema/request-schema)** Watch the video below for a step-by-step demonstration of registering a schema in Klaw. diff --git a/current-routes.json b/current-routes.json index 89279436..4792b7dd 100644 --- a/current-routes.json +++ b/current-routes.json @@ -59,7 +59,6 @@ "/docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster", "/docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster", "/docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster", - "/docs/Concepts/promotion", "/docs/Concepts/synchronize", "/docs/Concepts/workflows", "/docs/connector-management/", @@ -79,27 +78,8 @@ "/docs/HowTo/notifications/slack-notification", "/docs/HowTo/operational/", "/docs/HowTo/operational/Reset-Consumer-Offsets", - "/docs/HowTo/schemas/", - "/docs/HowTo/schemas/manage-schemas", - "/docs/HowTo/schemas/My-schema-requests", - "/docs/HowTo/schemas/Promote-a-schema", - "/docs/HowTo/schemas/Request-a-schema", - "/docs/HowTo/subscriptions/", - "/docs/HowTo/subscriptions/Approve-a-subscription", - "/docs/HowTo/subscriptions/Delete-a-subscription", - "/docs/HowTo/subscriptions/My-subscription-requests", - "/docs/HowTo/subscriptions/Request-a-subscription", "/docs/HowTo/teams/", "/docs/HowTo/teams/switch-teams", - "/docs/HowTo/topics/", - "/docs/HowTo/topics/Approve-a-topic", - "/docs/HowTo/topics/Claim-a-topic", - "/docs/HowTo/topics/Delete-a-topic", - "/docs/HowTo/topics/Edit-topic-request", - "/docs/HowTo/topics/My-topic-requests", - "/docs/HowTo/topics/Promote-a-topic", - "/docs/HowTo/topics/Request-a-new-topic", - "/docs/HowTo/topics/Topic-overview", "/docs/HowTo/topics/View-consumer-lag", "/docs/HowTo/topics/View-topic-events", "/docs/HowTo/zothers", @@ -135,5 +115,25 @@ "/docs/user-team-management/teams/manage-teams", "/docs/user-team-management/teams/switch-teams", "/docs/user-team-management/users-roles-teams", + "/docs/workflows/promotion", + "/docs/workflows/schema/", + "/docs/workflows/schema/manage-schema-requests", + "/docs/workflows/schema/my-schema-requests", + "/docs/workflows/schema/promote-schema", + "/docs/workflows/schema/request-schema", + "/docs/workflows/subscription/", + "/docs/workflows/subscription/delete-subscription", + "/docs/workflows/subscription/manage-subscription-requests", + "/docs/workflows/subscription/my-subscription-requests", + "/docs/workflows/subscription/request-subscription", + "/docs/workflows/topic/", + "/docs/workflows/topic/claim-topic", + "/docs/workflows/topic/delete-topic", + "/docs/workflows/topic/edit-topic", + "/docs/workflows/topic/manage-topic-requests", + "/docs/workflows/topic/my-topic-requests", + "/docs/workflows/topic/promote-topic", + "/docs/workflows/topic/request-topic", + "/docs/workflows/topic/topic-overview", "/" ] diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index b2db43ee..724eb7b7 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -8,13 +8,13 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | Feature | Description | | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md) | Easily request and approve Apache Kafka topics for your applications. | -| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | -| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | +| [_Topics creation_](../workflows/topic/request-topic.md) | Easily request and approve Apache Kafka topics for your applications. | +| [_ACLs creation_](../workflows/subscription/request-subscription.md) | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics. | +| [_Schemas creation_](../workflows/schema/request-schema.md) | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry. | | [_Connectors creation_](../connector-management/approve-connector.md) | Request and approve Apache Kafka Connectors for streamlined data integration. | -| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | +| [_Promote topics, schemas, connectors_](../workflows/topic/promote-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | | [_Topic naming conventions_](../cluster-management/clusters-environments/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | -| [_Schema evolution_](../HowTo/schemas/manage-schemas.md) | Manage multiple versions of schemas efficiently. | +| [_Schema evolution_](../workflows/schema/manage-schema-requests.md) | Manage multiple versions of schemas efficiently. | | [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | | [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | | [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | diff --git a/docs/releases/release200.md b/docs/releases/release200.md index b10c398c..a1e6336a 100644 --- a/docs/releases/release200.md +++ b/docs/releases/release200.md @@ -58,7 +58,7 @@ force-register the schema in case of any compatibility issues during registration. For more information, see [Schema -Promotion](../../docs/HowTo/schemas/Promote-a-schema). +Promotion](../../docs/workflows/schema/promote-schema). ### Authorization from OAuth2 Provider/Active Directory diff --git a/docs/Concepts/promotion.md b/docs/workflows/promotion.md similarity index 95% rename from docs/Concepts/promotion.md rename to docs/workflows/promotion.md index 60a43838..510ddfb5 100644 --- a/docs/Concepts/promotion.md +++ b/docs/workflows/promotion.md @@ -49,5 +49,5 @@ promotion defined in `orderOfTopicPromotionEnvsList`. ## How to promote topics and schemas -- [Promote a topic](../HowTo/topics/Promote-a-topic.md) -- [Promote a schema](../HowTo/schemas/Promote-a-schema.md) +- [Promote a topic](../workflows/topic/promote-topic.md) +- [Promote a schema](../workflows/schema/promote-schema.md) diff --git a/docs/HowTo/schemas/index.md b/docs/workflows/schema/index.md similarity index 89% rename from docs/HowTo/schemas/index.md rename to docs/workflows/schema/index.md index a90c3eb7..e1863b4b 100644 --- a/docs/HowTo/schemas/index.md +++ b/docs/workflows/schema/index.md @@ -35,10 +35,7 @@ Schema management in Klaw is structured around the following: ## Learn how to -- [Request a schema](Request-a-schema.md) - -- [Promote a schema](Promote-a-schema.md) - -- [Approve a schema](manage-schemas.md) - -- [My Schema Requests](My-schema-requests.md) +- [Request a new schema](request-schema.md) +- [Promote a schema](promote-schema.md) +- [Manage schema requests](manage-schema-requests.md) +- [My schema requests](my-schema-requests.md) diff --git a/docs/HowTo/schemas/manage-schemas.md b/docs/workflows/schema/manage-schema-requests.md similarity index 98% rename from docs/HowTo/schemas/manage-schemas.md rename to docs/workflows/schema/manage-schema-requests.md index 49880858..611e44fd 100644 --- a/docs/HowTo/schemas/manage-schemas.md +++ b/docs/workflows/schema/manage-schema-requests.md @@ -1,4 +1,4 @@ -# Manage schema +# Manage schema requests When a schema request is made, a team member other than the request creator can review, approve, or decline the request. Schema requests can diff --git a/docs/HowTo/schemas/My-schema-requests.md b/docs/workflows/schema/my-schema-requests.md similarity index 98% rename from docs/HowTo/schemas/My-schema-requests.md rename to docs/workflows/schema/my-schema-requests.md index 1ba95005..b182da67 100644 --- a/docs/HowTo/schemas/My-schema-requests.md +++ b/docs/workflows/schema/my-schema-requests.md @@ -1,4 +1,4 @@ -# My Schema Requests +# My schema requests To access the **My Schema Requests** page, navigate to the **Requests -\> My Schema Requests** section. On this page, you can view all the diff --git a/docs/HowTo/schemas/Promote-a-schema.md b/docs/workflows/schema/promote-schema.md similarity index 97% rename from docs/HowTo/schemas/Promote-a-schema.md rename to docs/workflows/schema/promote-schema.md index 1965f651..cc6098cb 100644 --- a/docs/HowTo/schemas/Promote-a-schema.md +++ b/docs/workflows/schema/promote-schema.md @@ -5,13 +5,13 @@ administration, and control of schemas. With schema promotion, a schema can be initially created in the lowest environment and then promoted to higher environments as needed. -Learn more: [Concepts—Promotion](../../Concepts/promotion.md) +Learn more: [Concepts—Promotion](../../workflows/promotion.md) ## Prerequisites Before using this functionality, the Superadmin must ensure that all prerequisites are met. For more information, see -[Promotion](../../Concepts/promotion.md). +[Promotion](../../workflows/promotion.md). ## Schema promotion step by step diff --git a/docs/HowTo/schemas/Request-a-schema.md b/docs/workflows/schema/request-schema.md similarity index 100% rename from docs/HowTo/schemas/Request-a-schema.md rename to docs/workflows/schema/request-schema.md diff --git a/docs/HowTo/subscriptions/Delete-a-subscription.md b/docs/workflows/subscription/delete-subscription.md similarity index 100% rename from docs/HowTo/subscriptions/Delete-a-subscription.md rename to docs/workflows/subscription/delete-subscription.md diff --git a/docs/HowTo/subscriptions/index.md b/docs/workflows/subscription/index.md similarity index 91% rename from docs/HowTo/subscriptions/index.md rename to docs/workflows/subscription/index.md index a86ea490..12060128 100644 --- a/docs/HowTo/subscriptions/index.md +++ b/docs/workflows/subscription/index.md @@ -43,10 +43,7 @@ subscription, the team that owns the topic is responsible for making the final decision, such as approving or declining a request from the same team or another team to produce/consume events from the topic. -- [Request a subscription](Request-a-subscription.md) - -- [Approve a subscription](Approve-a-subscription.md) - -- [Delete a subscription](Delete-a-subscription.md) - -- [My Subscription Requests](My-subscription-requests.md) +- [Request a new subscription](request-subscription.md) +- [Manage subscription requests](manage-subscription-requests.md) +- [Delete a subscription](delete-subscription.md) +- [My subscription requests](my-subscription-requests.md) diff --git a/docs/HowTo/subscriptions/Approve-a-subscription.md b/docs/workflows/subscription/manage-subscription-requests.md similarity index 98% rename from docs/HowTo/subscriptions/Approve-a-subscription.md rename to docs/workflows/subscription/manage-subscription-requests.md index 72a6cbd4..6a2aa288 100644 --- a/docs/HowTo/subscriptions/Approve-a-subscription.md +++ b/docs/workflows/subscription/manage-subscription-requests.md @@ -1,4 +1,4 @@ -# Manage subscriptions +# Manage subscription requests When a team member makes a subscription request, it must be reviewed and approved or declined by another team member. This applies to producer diff --git a/docs/HowTo/subscriptions/My-subscription-requests.md b/docs/workflows/subscription/my-subscription-requests.md similarity index 97% rename from docs/HowTo/subscriptions/My-subscription-requests.md rename to docs/workflows/subscription/my-subscription-requests.md index d804311f..93cca21d 100644 --- a/docs/HowTo/subscriptions/My-subscription-requests.md +++ b/docs/workflows/subscription/my-subscription-requests.md @@ -1,4 +1,4 @@ -# My Subscription Requests +# My subscription requests To access the **My ACL Requests** page, navigate to the **Requests -\> My ACL Requests**. On this page, you can see all the requests created by diff --git a/docs/HowTo/subscriptions/Request-a-subscription.md b/docs/workflows/subscription/request-subscription.md similarity index 98% rename from docs/HowTo/subscriptions/Request-a-subscription.md rename to docs/workflows/subscription/request-subscription.md index b0af2d1c..7a24e75e 100644 --- a/docs/HowTo/subscriptions/Request-a-subscription.md +++ b/docs/workflows/subscription/request-subscription.md @@ -1,4 +1,4 @@ -# Request a new Subscription +# Request a new subscription The process for requesting a new subscription to be created in Apache Kafka® is straightforward and efficient. The team that owns the relevant topic is diff --git a/docs/HowTo/topics/Claim-a-topic.md b/docs/workflows/topic/claim-topic.md similarity index 100% rename from docs/HowTo/topics/Claim-a-topic.md rename to docs/workflows/topic/claim-topic.md diff --git a/docs/HowTo/topics/Delete-a-topic.md b/docs/workflows/topic/delete-topic.md similarity index 100% rename from docs/HowTo/topics/Delete-a-topic.md rename to docs/workflows/topic/delete-topic.md diff --git a/docs/HowTo/topics/Edit-topic-request.md b/docs/workflows/topic/edit-topic.md similarity index 100% rename from docs/HowTo/topics/Edit-topic-request.md rename to docs/workflows/topic/edit-topic.md diff --git a/docs/HowTo/topics/index.md b/docs/workflows/topic/index.md similarity index 88% rename from docs/HowTo/topics/index.md rename to docs/workflows/topic/index.md index 0e060870..99e34c89 100644 --- a/docs/HowTo/topics/index.md +++ b/docs/workflows/topic/index.md @@ -45,16 +45,11 @@ from the topic. Similarly, if the team wants to enforce a schema on the topic, the team submits a request, and another team member reviews and approves or declines it. -- [Request a new topic](Request-a-new-topic.md) - -- [Approve a topic](Approve-a-topic.md) - -- [Promote a topic](Promote-a-topic.md) - -- [Claim a topic](Claim-a-topic.md) - -- [Edit topic request](Edit-topic-request.md) - -- [Delete a topic](Delete-a-topic.md) - -- [My topic requests](My-topic-requests.md) +- [Topic overview](topic-overview.md) +- [Request a new topic](request-topic.md) +- [Claim a topic](claim-topic.md) +- [Edit a topic](edit-topic.md) +- [Promote a topic](promote-topic.md) +- [Delete a topic](delete-topic.md) +- [Mange topic requests](manage-topic-requests.md) +- [My topic requests](my-topic-requests.md) diff --git a/docs/HowTo/topics/Approve-a-topic.md b/docs/workflows/topic/manage-topic-requests.md similarity index 99% rename from docs/HowTo/topics/Approve-a-topic.md rename to docs/workflows/topic/manage-topic-requests.md index f143e174..0675da75 100644 --- a/docs/HowTo/topics/Approve-a-topic.md +++ b/docs/workflows/topic/manage-topic-requests.md @@ -1,4 +1,4 @@ -# Approve topic +# Manage topic requests When a topic request is made, a team member other than the request creator can review and approve or decline the request. diff --git a/docs/HowTo/topics/My-topic-requests.md b/docs/workflows/topic/my-topic-requests.md similarity index 98% rename from docs/HowTo/topics/My-topic-requests.md rename to docs/workflows/topic/my-topic-requests.md index 6bf91839..33f48f83 100644 --- a/docs/HowTo/topics/My-topic-requests.md +++ b/docs/workflows/topic/my-topic-requests.md @@ -1,4 +1,4 @@ -# My Topic Requests +# My topic requests The **My Topic Requests** page can be accessed through the **Requests -\> My Topic Requests** navigation bar. You can view all requests diff --git a/docs/HowTo/topics/Promote-a-topic.md b/docs/workflows/topic/promote-topic.md similarity index 92% rename from docs/HowTo/topics/Promote-a-topic.md rename to docs/workflows/topic/promote-topic.md index 583efc69..aeac9d68 100644 --- a/docs/HowTo/topics/Promote-a-topic.md +++ b/docs/workflows/topic/promote-topic.md @@ -5,13 +5,13 @@ administration, and control of topics. With topic promotion, a topic can be initially created in the lowest environment and then promoted to higher environments as needed. -Learn more: [Concepts—Promotion](../../Concepts/promotion.md) +Learn more: [Concepts—Promotion](../../workflows/promotion.md) ## Prerequisites The Superadmin must ensure all prerequisites are met before this functionality is used see -[Concepts—Promotion](../../Concepts/promotion.md) +[Concepts—Promotion](../../workflows/promotion.md) ## Topic promotion diff --git a/docs/HowTo/topics/Request-a-new-topic.md b/docs/workflows/topic/request-topic.md similarity index 100% rename from docs/HowTo/topics/Request-a-new-topic.md rename to docs/workflows/topic/request-topic.md diff --git a/docs/HowTo/topics/Topic-overview.md b/docs/workflows/topic/topic-overview.md similarity index 100% rename from docs/HowTo/topics/Topic-overview.md rename to docs/workflows/topic/topic-overview.md diff --git a/sidebars.js b/sidebars.js index beb8a26a..c0573b78 100644 --- a/sidebars.js +++ b/sidebars.js @@ -193,6 +193,59 @@ const sidebars = { }, ], }, + { + type: "category", + label: "Klaw workflows", + items: [ + "workflows/promotion", + { + type: "category", + label: "Manage schema", + link: { + type: "doc", + id: "workflows/schema/index", + }, + items: [ + "workflows/schema/request-schema", + "workflows/schema/promote-schema", + "workflows/schema/manage-schema-requests", + "workflows/schema/my-schema-requests", + ], + }, + { + type: "category", + label: "Manage subscription", + link: { + type: "doc", + id: "workflows/subscription/index", + }, + items: [ + "workflows/subscription/request-subscription", + "workflows/subscription/delete-subscription", + "workflows/subscription/manage-subscription-requests", + "workflows/subscription/my-subscription-requests", + ], + }, + { + type: "category", + label: "Manage topics", + link: { + type: "doc", + id: "workflows/topic/index", + }, + items: [ + "workflows/topic/topic-overview", + "workflows/topic/request-topic", + "workflows/topic/claim-topic", + "workflows/topic/edit-topic", + "workflows/topic/promote-topic", + "workflows/topic/delete-topic", + "workflows/topic/manage-topic-requests", + "workflows/topic/my-topic-requests", + ], + }, + ], + }, { type: "category", label: "Concepts", From 9de7c363d77b0650581db7e5a5bbfe393c6b6a6f Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 08:11:54 +0100 Subject: [PATCH 11/28] Add new category Notifications Signed-off-by: Mirjam Aulbach --- _redirects | 4 ++++ current-routes.json | 5 ++--- docs/HowTo/notifications/index.md | 6 ------ docs/getting-started/features.md | 2 +- .../notifications/email-notification.md | 0 .../notifications/slack-notification.md | 6 +++--- sidebars.js | 14 ++------------ 7 files changed, 12 insertions(+), 25 deletions(-) delete mode 100644 docs/HowTo/notifications/index.md rename docs/{HowTo => }/notifications/email-notification.md (100%) rename docs/{HowTo => }/notifications/slack-notification.md (82%) diff --git a/_redirects b/_redirects index 4012f12e..73017f63 100644 --- a/_redirects +++ b/_redirects @@ -90,3 +90,7 @@ /docs/HowTo/topics/Promote-a-topic /docs/workflows/topic/promote-topic 301 /docs/HowTo/topics/Request-a-new-topic /docs/workflows/topic/request-topic 301 /docs/HowTo/topics/Topic-overview /docs/workflows/topic/topic-overview 301 + +/docs/HowTo/notifications/ /docs/notifications/email-notification 301 +/docs/HowTo/notifications/email-notification /docs/notifications/email-notification 301 +/docs/HowTo/notifications/slack-notification /docs/notifications/slack-notification 301 \ No newline at end of file diff --git a/current-routes.json b/current-routes.json index 4792b7dd..d6ad08b9 100644 --- a/current-routes.json +++ b/current-routes.json @@ -73,9 +73,6 @@ "/docs/getting-started/quickstart", "/docs/HowTo/dashboard", "/docs/HowTo/deployklaw", - "/docs/HowTo/notifications/", - "/docs/HowTo/notifications/email-notification", - "/docs/HowTo/notifications/slack-notification", "/docs/HowTo/operational/", "/docs/HowTo/operational/Reset-Consumer-Offsets", "/docs/HowTo/teams/", @@ -87,6 +84,8 @@ "/docs/metadata-management/import-export/exportdata", "/docs/metadata-management/import-export/importdata", "/docs/metadata-management/metastore", + "/docs/notifications/email-notification", + "/docs/notifications/slack-notification", "/docs/releases", "/docs/releases/release100", "/docs/releases/release110", diff --git a/docs/HowTo/notifications/index.md b/docs/HowTo/notifications/index.md deleted file mode 100644 index 59589ed5..00000000 --- a/docs/HowTo/notifications/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# Notifications - -What notifications are available in Klaw how to configure them and how -they work. - -[Email Notification](email-notification.md) diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 724eb7b7..2af2a082 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -30,7 +30,7 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. | | [_Controlled access to users_](../user-team-management/manage-roles-permissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. | | [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../cluster-connectivity-setup/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. | -| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | +| [_Email Notifications_](../notifications/email-notification.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. | | [_Analytics / Reports_](../dashboard/analytics.md) | 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. | | [_Apache Kafka flavor support_](../cluster-management/clusters-environments/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | diff --git a/docs/HowTo/notifications/email-notification.md b/docs/notifications/email-notification.md similarity index 100% rename from docs/HowTo/notifications/email-notification.md rename to docs/notifications/email-notification.md diff --git a/docs/HowTo/notifications/slack-notification.md b/docs/notifications/slack-notification.md similarity index 82% rename from docs/HowTo/notifications/slack-notification.md rename to docs/notifications/slack-notification.md index 3650f22e..606d216d 100644 --- a/docs/HowTo/notifications/slack-notification.md +++ b/docs/notifications/slack-notification.md @@ -1,4 +1,4 @@ -# Slack notifications in Klaw +# Slack notifications Stay updated with Slack notifications in Klaw. Instead of traditional email alerts, receive timely notifications directly in your Slack channels or direct messages (DMs). @@ -9,5 +9,5 @@ Configuring Slack notifications in Klaw is straightforward. Follow the steps pro 1. Visit Slack's official guide on [sending emails to Slack](https://slack.com/intl/en-ie/help/articles/206819278-Send-emails-to-Slack#). 2. As part of the setup, Slack provides a unique email address. 3. Use this email address in Klaw: - - Replace a user's email address in the [User Configuration](../../user-team-management/manage-users.md) to send notifications directly to their DMs. - - Alternatively, replace the team email to forward notifications to a specific channel. For more information, see [Managing Teams](../../user-team-management/teams/manage-teams.md). + - Replace a user's email address in the [User Configuration](../user-team-management/manage-users.md) to send notifications directly to their DMs. + - Alternatively, replace the team email to forward notifications to a specific channel. For more information, see [Managing Teams](../user-team-management/teams/manage-teams.md). diff --git a/sidebars.js b/sidebars.js index c0573b78..599f2e05 100644 --- a/sidebars.js +++ b/sidebars.js @@ -248,21 +248,11 @@ const sidebars = { }, { type: "category", - label: "Concepts", + label: "Notifications", items: [ { type: "autogenerated", - dirName: "Concepts", // Generate sidebar slice from docs/concepts - }, - ], - }, - { - type: "category", - label: "HowTo", - items: [ - { - type: "autogenerated", - dirName: "HowTo", // Generate sidebar slice from docs/howTo + dirName: "notifications", }, ], }, From b5e058bc7f2398cb37393c6fcfda6ca93b485877 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 08:14:12 +0100 Subject: [PATCH 12/28] Remove unused directories. Signed-off-by: Mirjam Aulbach --- current-routes.json | 2 -- docs/HowTo/teams/index.md | 11 ------ docs/HowTo/teams/switch-teams.md | 58 -------------------------------- 3 files changed, 71 deletions(-) delete mode 100644 docs/HowTo/teams/index.md delete mode 100644 docs/HowTo/teams/switch-teams.md diff --git a/current-routes.json b/current-routes.json index d6ad08b9..10458496 100644 --- a/current-routes.json +++ b/current-routes.json @@ -75,8 +75,6 @@ "/docs/HowTo/deployklaw", "/docs/HowTo/operational/", "/docs/HowTo/operational/Reset-Consumer-Offsets", - "/docs/HowTo/teams/", - "/docs/HowTo/teams/switch-teams", "/docs/HowTo/topics/View-consumer-lag", "/docs/HowTo/topics/View-topic-events", "/docs/HowTo/zothers", diff --git a/docs/HowTo/teams/index.md b/docs/HowTo/teams/index.md deleted file mode 100644 index db0e3c9c..00000000 --- a/docs/HowTo/teams/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Teams - -Klaw has concepts of users, roles, and teams. - -Team A collection of users. Teams also `own` topics and when one user -in a team makes a request, a peer from the same team is expected to -approve. Teams can be managed by a user with `ADD_EDIT_DELETE_TEAMS` -permission. - -- [Switch Teams](../../user-team-management/teams/switch-teams.md) -- [Manage Teams](../../user-team-management/teams/manage-teams.md) diff --git a/docs/HowTo/teams/switch-teams.md b/docs/HowTo/teams/switch-teams.md deleted file mode 100644 index c502f823..00000000 --- a/docs/HowTo/teams/switch-teams.md +++ /dev/null @@ -1,58 +0,0 @@ -# Switch Teams - -This section provides information on enabling the switch teams option -for user profiles in Klaw and key considerations to keep in mind. - -- You can enable the switch team option in a user's profile by - logging in as a superadmin or a user with `ADD_EDIT_DELETE_USERS` - permissions. -- To switch between teams, users must have a list of available teams - in their profile, including their base team and any other teams they - can switch to. -- Once the option to switch teams is enabled, users can easily switch - between teams using the dropdown menu located in the header section - of the Klaw portal. - - :::note - A user who raises a request cannot approve the same request. - ::: - -## Enable switch Teams for a user - -To enable the switch teams functionality for a user profile, follow -these steps: - -1. Log in to Klaw as a superadmin or a user with the - `ADD_EDIT_DELETE_USERS` permission. -2. Go to **Users**, and select the **Edit** option for the user whose - profile you want to modify. -3. Check the **Enable Switching Teams** checkbox. -4. Select at least two teams from the **Switch between Teams** multiple select -5. Click **Save** to save your changes. - -![image](../../../static/images/teams/SwitchTeams.png) - -This enables the user to switch teams. - -## Switch between Teams in Klaw - -To switch between teams, follow these steps: - -1. Log in to Klaw using the credentials of a user whose profile has the - **Enable switching Teams** option enabled. -2. Locate the **Switch Teams** dropdown in the header section of the - Klaw portal. -3. Select a different team from the list of available teams in the - dropdown. -4. The base team of the user's profile will be updated automatically - to reflect the selected team. - -When you switch between teams, you can access various dashboards, -analytics, activity logs, and other relevant views associated with the -selected team. This enhances your flexibility when creating or approving -requests on Klaw. - -:::note -Even after switching teams, the behavior of requests for topics, ACLs, -schemas, and connectors remains the same. Additionally, users are not -allowed to approve their own requests at any point. From a0f7781542a3e4d4eb0f624c8dba0d83f267db22 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 08:18:48 +0100 Subject: [PATCH 13/28] Move workflows.md as index page for workflows category. Signed-off-by: Mirjam Aulbach --- _redirects | 4 +++- current-routes.json | 2 +- docs/releases/release240.md | 2 +- docs/{Concepts/workflows.md => workflows/index.md} | 0 sidebars.js | 4 ++++ 5 files changed, 9 insertions(+), 3 deletions(-) rename docs/{Concepts/workflows.md => workflows/index.md} (100%) diff --git a/_redirects b/_redirects index 73017f63..83158685 100644 --- a/_redirects +++ b/_redirects @@ -93,4 +93,6 @@ /docs/HowTo/notifications/ /docs/notifications/email-notification 301 /docs/HowTo/notifications/email-notification /docs/notifications/email-notification 301 -/docs/HowTo/notifications/slack-notification /docs/notifications/slack-notification 301 \ No newline at end of file +/docs/HowTo/notifications/slack-notification /docs/notifications/slack-notification 301 + +/docs/Concepts/workflows /docs/workflows/ 301 \ No newline at end of file diff --git a/current-routes.json b/current-routes.json index 10458496..0582c395 100644 --- a/current-routes.json +++ b/current-routes.json @@ -60,7 +60,6 @@ "/docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster", "/docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster", "/docs/Concepts/synchronize", - "/docs/Concepts/workflows", "/docs/connector-management/", "/docs/connector-management/approve-connector", "/docs/connector-management/manage-connectors", @@ -112,6 +111,7 @@ "/docs/user-team-management/teams/manage-teams", "/docs/user-team-management/teams/switch-teams", "/docs/user-team-management/users-roles-teams", + "/docs/workflows/", "/docs/workflows/promotion", "/docs/workflows/schema/", "/docs/workflows/schema/manage-schema-requests", diff --git a/docs/releases/release240.md b/docs/releases/release240.md index 8b313f49..b90e2aa7 100644 --- a/docs/releases/release240.md +++ b/docs/releases/release240.md @@ -88,7 +88,7 @@ improved security and prompting users to update their passwords promptly. This release introduces significant improvements to the email notifications functionality. Emails are now sent in accordance with the defined email matrix, ensuring consistency. For more detailed -information, refer to the [Workflows](../../docs/Concepts/workflows.md#approval-process) documentation. +information, refer to the [Workflows](../../docs/workflows/index.md#approval-process) documentation. ### Improved error responses to UI diff --git a/docs/Concepts/workflows.md b/docs/workflows/index.md similarity index 100% rename from docs/Concepts/workflows.md rename to docs/workflows/index.md diff --git a/sidebars.js b/sidebars.js index 599f2e05..5efac9d5 100644 --- a/sidebars.js +++ b/sidebars.js @@ -196,6 +196,10 @@ const sidebars = { { type: "category", label: "Klaw workflows", + link: { + type: "doc", + id: "workflows/index", + }, items: [ "workflows/promotion", { From 5d38fa19b34e39f7427bc8dd6642933a6b4fd5dd Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 08:21:30 +0100 Subject: [PATCH 14/28] Remove unnecessary doc synchronize.md Signed-off-by: Mirjam Aulbach --- _redirects | 4 +++- current-routes.json | 1 - docs/Concepts/_category_.json | 7 ------- docs/Concepts/synchronize.md | 10 ---------- 4 files changed, 3 insertions(+), 19 deletions(-) delete mode 100644 docs/Concepts/_category_.json delete mode 100644 docs/Concepts/synchronize.md diff --git a/_redirects b/_redirects index 83158685..633c4546 100644 --- a/_redirects +++ b/_redirects @@ -95,4 +95,6 @@ /docs/HowTo/notifications/email-notification /docs/notifications/email-notification 301 /docs/HowTo/notifications/slack-notification /docs/notifications/slack-notification 301 -/docs/Concepts/workflows /docs/workflows/ 301 \ No newline at end of file +/docs/Concepts/workflows /docs/workflows/ 301 + +/docs/Concepts/synchronize /docs/cluster-management/kafka-cluster-sync/kafka-cluster-sync 301 \ No newline at end of file diff --git a/current-routes.json b/current-routes.json index 0582c395..7328f756 100644 --- a/current-routes.json +++ b/current-routes.json @@ -59,7 +59,6 @@ "/docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster", "/docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster", "/docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster", - "/docs/Concepts/synchronize", "/docs/connector-management/", "/docs/connector-management/approve-connector", "/docs/connector-management/manage-connectors", diff --git a/docs/Concepts/_category_.json b/docs/Concepts/_category_.json deleted file mode 100644 index 0b835cb2..00000000 --- a/docs/Concepts/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Concepts", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/Concepts/synchronize.md b/docs/Concepts/synchronize.md deleted file mode 100644 index 3a67a23a..00000000 --- a/docs/Concepts/synchronize.md +++ /dev/null @@ -1,10 +0,0 @@ -# Synchronize metadata - -Klaw supports synchronization to and from Klaw and the Apache Kafka® and -other clusters. This is found under the **Synchronize** menu item. - -- Synchronize either topics or ACLs **from** the cluster to Klaw if - you have a new Klaw setup with existing data platforms. -- Synchronize **to** the clusters if your Klaw setup is in place (for - example, restored from backup, or unaffected by a cluster outage), - this will reinstate the topics and/or ACLs on the clusters. From 0ce5e5b7687050ea06fa564decb61376e13cf959 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 08:29:33 +0100 Subject: [PATCH 15/28] Move doc deployklaw.md Signed-off-by: Mirjam Aulbach --- _redirects | 1 + current-routes.json | 2 +- .../klaw-installation}/deployklaw.md | 11 +++++------ docs/setup-configuration/klaw-installation/index.md | 2 +- sidebars.js | 1 + 5 files changed, 9 insertions(+), 8 deletions(-) rename docs/{HowTo => setup-configuration/klaw-installation}/deployklaw.md (82%) diff --git a/_redirects b/_redirects index 633c4546..b1e4e3ef 100644 --- a/_redirects +++ b/_redirects @@ -14,6 +14,7 @@ /docs/HowTo/installation/configure-klaw-wizard /docs/setup-configuration/klaw-installation/configure-klaw-wizard 301 /docs/HowTo/installation/run-docker /docs/setup-configuration/klaw-installation/run-docker 301 /docs/HowTo/installation/run-source /docs/setup-configuration/klaw-installation/run-source 301 +/docs/HowTo/deployklaw /docs/setup-configuration/klaw-installation/deployklaw 301 /docs/HowTo/kafka-cluster-migration/tenant-config /docs/setup-configuration/tenant-configuration 301 /docs/HowTo/tenant /docs/setup-configuration/tenant-configuration 301 diff --git a/current-routes.json b/current-routes.json index 7328f756..6eeb4a81 100644 --- a/current-routes.json +++ b/current-routes.json @@ -70,7 +70,6 @@ "/docs/getting-started/getstarted", "/docs/getting-started/quickstart", "/docs/HowTo/dashboard", - "/docs/HowTo/deployklaw", "/docs/HowTo/operational/", "/docs/HowTo/operational/Reset-Consumer-Offsets", "/docs/HowTo/topics/View-consumer-lag", @@ -101,6 +100,7 @@ "/docs/setup-configuration/klaw-api-ssl-with-kafka", "/docs/setup-configuration/klaw-installation/", "/docs/setup-configuration/klaw-installation/configure-klaw-wizard", + "/docs/setup-configuration/klaw-installation/deployklaw", "/docs/setup-configuration/klaw-installation/run-docker", "/docs/setup-configuration/klaw-installation/run-source", "/docs/setup-configuration/settings", diff --git a/docs/HowTo/deployklaw.md b/docs/setup-configuration/klaw-installation/deployklaw.md similarity index 82% rename from docs/HowTo/deployklaw.md rename to docs/setup-configuration/klaw-installation/deployklaw.md index 10d2e7c7..63310f27 100644 --- a/docs/HowTo/deployklaw.md +++ b/docs/setup-configuration/klaw-installation/deployklaw.md @@ -5,8 +5,7 @@ Learn how to deploy Klaw with an outline of steps and key points for a smooth up ## Klaw releases cycle Our team, along with Klaw's contributors, is committed to enhancing the functionality and efficiency of Klaw, aiming -to deliver new updates approximately every 1.5 months. You can access all past and the most recent releases [here](.. -/../docs/releases). Highlighted updates include versions such as 2.4.0, 2.5.0, among others. +to deliver new updates approximately every 1.5 months. You can access all past and the most recent releases [here](../../../docs/releases). Highlighted updates include versions such as 2.4.0, 2.5.0, among others. ## Deployment strategy @@ -16,7 +15,7 @@ Follow these recommended steps for deploying each new release: Begin by deploying the latest version of Klaw to a staging environment. Here, you should conduct thorough sanity tests to ensure all the functionalities critical to your organization are working as expected. - ![Screenshot: Staging](../../static/images/deployklaw/staging.png) + ![Screenshot: Staging](../../../static/images/deployklaw/staging.png) Ensure to proceed to the next phase only after verifying that the staging evaluation meets your standards. @@ -32,7 +31,7 @@ Your choice of deployment scenario will depend on your organization's specific p Klaw simplifies the process of promoting Apache Kafka® topics, schemas, and connectors across different stages of your environment, making it straightforward to move from development to production. If this feature aligns with your operational requirements, begin by setting up Klaw and integrating it into your Apache Kafka ecosystems, as detailed in the illustration below. -![Screenshot: Staging](../../static/images/deployklaw/dtap.png) +![Screenshot: Staging](../../../static/images/deployklaw/dtap.png) ### Scenario 2: Select environment promotion @@ -40,8 +39,8 @@ If your process requires restricting promotions to specific environments, or you - Set up a Klaw instance to connect Development (Dev), Testing (Tst), and Acceptance (Acc) environments for controlled and sequential promotions. - ![Screenshot: Staging](../../static/images/deployklaw/dta.png) + ![Screenshot: Staging](../../../static/images/deployklaw/dta.png) - Use a dedicated Klaw instance exclusively for your Production (Prod) environment to ensure secure and independent management. - ![Screenshot: Staging](../../static/images/deployklaw/prd.png) + ![Screenshot: Staging](../../../static/images/deployklaw/prd.png) diff --git a/docs/setup-configuration/klaw-installation/index.md b/docs/setup-configuration/klaw-installation/index.md index bde6dbb8..dc1ebef6 100644 --- a/docs/setup-configuration/klaw-installation/index.md +++ b/docs/setup-configuration/klaw-installation/index.md @@ -8,4 +8,4 @@ Klaw can be installed and configured in two ways: Once Klaw is installed, you can use the [Configure Klaw Wizard](configure-klaw-wizard.md) to configure your Apache Kafka® cluster and start managing your Apache Kafka resources. -Read [Deploying Klaw recommendations](../../HowTo/deployklaw.md) +Read [Deploying Klaw recommendations](deployklaw.md) diff --git a/sidebars.js b/sidebars.js index 5efac9d5..e2d73ddd 100644 --- a/sidebars.js +++ b/sidebars.js @@ -63,6 +63,7 @@ const sidebars = { "setup-configuration/klaw-installation/run-docker", "setup-configuration/klaw-installation/run-source", "setup-configuration/klaw-installation/configure-klaw-wizard", + "setup-configuration/klaw-installation/deployklaw", ], }, "setup-configuration/klaw-api-ssl-with-kafka", From 4c09d21d180cd6066b2c4892bd1e9eeab24083d2 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 08:40:02 +0100 Subject: [PATCH 16/28] Move dashboard view page. Signed-off-by: Mirjam Aulbach --- _redirects | 1 + current-routes.json | 2 +- docs/{HowTo => dashboard}/dashboard.md | 2 +- docs/getting-started/features.md | 2 +- sidebars.js | 7 +------ 5 files changed, 5 insertions(+), 9 deletions(-) rename docs/{HowTo => dashboard}/dashboard.md (96%) diff --git a/_redirects b/_redirects index b1e4e3ef..d8e28aa1 100644 --- a/_redirects +++ b/_redirects @@ -9,6 +9,7 @@ /docs/quickstart /docs/getting-started/quickstart 301 /docs/HowTo/analytics /docs/dashboard/analytics 301 +/docs/HowTo/dashboard /docs/dashboard/dashboard 301 /docs/HowTo/installation /docs/setup-configuration/klaw-installation 301 /docs/HowTo/installation/configure-klaw-wizard /docs/setup-configuration/klaw-installation/configure-klaw-wizard 301 diff --git a/current-routes.json b/current-routes.json index 6eeb4a81..6bcf3573 100644 --- a/current-routes.json +++ b/current-routes.json @@ -64,12 +64,12 @@ "/docs/connector-management/manage-connectors", "/docs/connector-management/my-connector-requests", "/docs/connector-management/request-connector", + "/docs/dashboard/", "/docs/dashboard/analytics", "/docs/faq", "/docs/getting-started/features", "/docs/getting-started/getstarted", "/docs/getting-started/quickstart", - "/docs/HowTo/dashboard", "/docs/HowTo/operational/", "/docs/HowTo/operational/Reset-Consumer-Offsets", "/docs/HowTo/topics/View-consumer-lag", diff --git a/docs/HowTo/dashboard.md b/docs/dashboard/dashboard.md similarity index 96% rename from docs/HowTo/dashboard.md rename to docs/dashboard/dashboard.md index f00123b7..43499453 100644 --- a/docs/HowTo/dashboard.md +++ b/docs/dashboard/dashboard.md @@ -1,4 +1,4 @@ -# Dashboard +# Dashboard view Klaw dashboard displays the below (in old UI) diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 2af2a082..62f3eafe 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -17,7 +17,7 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | [_Schema evolution_](../workflows/schema/manage-schema-requests.md) | Manage multiple versions of schemas efficiently. | | [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | | [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | -| [_Dashboard_](../HowTo/dashboard) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | +| [_Dashboard_](../dashboard/dashboard.md) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | | [_View consumer lag_](../HowTo/topics/View-consumer-lag) | Keep track of consumer offsets and view lags for a consumer group. | | [_Sync topics to a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-to-cluster.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | | [_Sync topics from a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | diff --git a/sidebars.js b/sidebars.js index e2d73ddd..391117ef 100644 --- a/sidebars.js +++ b/sidebars.js @@ -41,12 +41,7 @@ const sidebars = { { type: "category", label: "Dashboard", - items: [ - { - type: "autogenerated", - dirName: "dashboard", // Generate sidebar slice from docs/dashboard - }, - ], + items: ["dashboard/dashboard", "dashboard/analytics"], }, { type: "category", From bc25454c265a6145cdaff8b3d5a21d0077794c16 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 08:41:49 +0100 Subject: [PATCH 17/28] Clean up sidebar.js Signed-off-by: Mirjam Aulbach --- sidebars.js | 30 ++---------------------------- 1 file changed, 2 insertions(+), 28 deletions(-) diff --git a/sidebars.js b/sidebars.js index 391117ef..07eb3eb2 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,29 +1,3 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - -// @ts-check - -// + Getting started -// + Dashboard -// + Setup and configuration -// + User and team management -// + Authentication and authorization -// + Cluster management -// + Cluster connectivity setup -// + Connector management -// + Metadata management -// + Klaw workflows -// + Notifications -// + FAQs - /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { docs: [ @@ -34,7 +8,7 @@ const sidebars = { items: [ { type: "autogenerated", - dirName: "getting-started", // Generate sidebar slice from docs/getting-started + dirName: "getting-started", }, ], }, @@ -268,7 +242,7 @@ const sidebars = { items: [ { type: "autogenerated", - dirName: "releases", // Generate sidebar slices from docs/releases + dirName: "releases", }, ], }, From c60111881f9616165c4e26bd6a854724679b2277 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 09:04:27 +0100 Subject: [PATCH 18/28] Rename dashboard page to not match category name. Signed-off-by: Mirjam Aulbach --- _redirects | 2 +- current-routes.json | 2 +- docs/dashboard/{dashboard.md => dashboard-view.md} | 0 docs/getting-started/features.md | 2 +- 4 files changed, 3 insertions(+), 3 deletions(-) rename docs/dashboard/{dashboard.md => dashboard-view.md} (100%) diff --git a/_redirects b/_redirects index d8e28aa1..45669c3c 100644 --- a/_redirects +++ b/_redirects @@ -9,7 +9,7 @@ /docs/quickstart /docs/getting-started/quickstart 301 /docs/HowTo/analytics /docs/dashboard/analytics 301 -/docs/HowTo/dashboard /docs/dashboard/dashboard 301 +/docs/HowTo/dashboard /docs/dashboard/dashboard-view 301 /docs/HowTo/installation /docs/setup-configuration/klaw-installation 301 /docs/HowTo/installation/configure-klaw-wizard /docs/setup-configuration/klaw-installation/configure-klaw-wizard 301 diff --git a/current-routes.json b/current-routes.json index 6bcf3573..66bafced 100644 --- a/current-routes.json +++ b/current-routes.json @@ -64,8 +64,8 @@ "/docs/connector-management/manage-connectors", "/docs/connector-management/my-connector-requests", "/docs/connector-management/request-connector", - "/docs/dashboard/", "/docs/dashboard/analytics", + "/docs/dashboard/dashboard-view", "/docs/faq", "/docs/getting-started/features", "/docs/getting-started/getstarted", diff --git a/docs/dashboard/dashboard.md b/docs/dashboard/dashboard-view.md similarity index 100% rename from docs/dashboard/dashboard.md rename to docs/dashboard/dashboard-view.md diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 62f3eafe..39a60989 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -17,7 +17,7 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | [_Schema evolution_](../workflows/schema/manage-schema-requests.md) | Manage multiple versions of schemas efficiently. | | [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | | [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | -| [_Dashboard_](../dashboard/dashboard.md) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | +| [_Dashboard_](../dashboard/dashboard-view.md) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | | [_View consumer lag_](../HowTo/topics/View-consumer-lag) | Keep track of consumer offsets and view lags for a consumer group. | | [_Sync topics to a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-to-cluster.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | | [_Sync topics from a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | From 78019efdbe47427eaa6876964be5978df8b3141c Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 09:29:51 +0100 Subject: [PATCH 19/28] Remove unneeded sidebar positions. Signed-off-by: Mirjam Aulbach --- docs/faq.md | 4 ---- docs/index.md | 4 ---- 2 files changed, 8 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 827c6db4..661898b8 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 6.0 ---- - # FAQ 1\. Is Klaw open source? Yes, Klaw is fully open source, and it remains diff --git a/docs/index.md b/docs/index.md index 04e34d41..1440e0ad 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 1.0 ---- - # Klaw Documentation Klaw consists of two components: From 43e3e92183158c45f9a97a8aeab7d6d0d3ef538a Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 11:43:20 +0100 Subject: [PATCH 20/28] Remove autogenerated indexes from docs. Signed-off-by: Mirjam Aulbach --- .../authentication/azure-ad.md | 4 ---- .../authentication/google-account.md | 4 ---- .../authentication/third-party-account.md | 4 ---- .../authentication/userpwd-db.md | 4 ---- .../authentication/windows-ad.md | 4 ---- sidebars.js | 24 +++++++++---------- 6 files changed, 11 insertions(+), 33 deletions(-) diff --git a/docs/authentication-authorization/authentication/azure-ad.md b/docs/authentication-authorization/authentication/azure-ad.md index 5c3bcf4f..c35a3d4a 100644 --- a/docs/authentication-authorization/authentication/azure-ad.md +++ b/docs/authentication-authorization/authentication/azure-ad.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 1 ---- - # Login with Azure AD You can log in to Klaw with your credentials configured in the Azure diff --git a/docs/authentication-authorization/authentication/google-account.md b/docs/authentication-authorization/authentication/google-account.md index 32a9bad0..0c20d883 100644 --- a/docs/authentication-authorization/authentication/google-account.md +++ b/docs/authentication-authorization/authentication/google-account.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 2 ---- - # Login with Google account You can log in to Klaw using your Google account credentials. On the diff --git a/docs/authentication-authorization/authentication/third-party-account.md b/docs/authentication-authorization/authentication/third-party-account.md index 0aa47725..e16f318d 100644 --- a/docs/authentication-authorization/authentication/third-party-account.md +++ b/docs/authentication-authorization/authentication/third-party-account.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 3 ---- - # Login with Third-party accounts You have the option to configure any third-party login account to access diff --git a/docs/authentication-authorization/authentication/userpwd-db.md b/docs/authentication-authorization/authentication/userpwd-db.md index c3509bcb..11d1fedb 100644 --- a/docs/authentication-authorization/authentication/userpwd-db.md +++ b/docs/authentication-authorization/authentication/userpwd-db.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 4 ---- - # Login with Klaw database account You can log in to Klaw using your username and password, which are securely stored in the database (encrypted). diff --git a/docs/authentication-authorization/authentication/windows-ad.md b/docs/authentication-authorization/authentication/windows-ad.md index 3180ec87..58d38809 100644 --- a/docs/authentication-authorization/authentication/windows-ad.md +++ b/docs/authentication-authorization/authentication/windows-ad.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 5 ---- - # Login with Windows active directory You can log in to Klaw using the Windows credentials configured in the Windows active directory. diff --git a/sidebars.js b/sidebars.js index 07eb3eb2..11194cad 100644 --- a/sidebars.js +++ b/sidebars.js @@ -6,16 +6,15 @@ const sidebars = { type: "category", label: "Getting started", items: [ - { - type: "autogenerated", - dirName: "getting-started", - }, + "getting-started/features", + "getting-started/quickstart", + "getting-started/getstarted", ], }, { type: "category", label: "Dashboard", - items: ["dashboard/dashboard", "dashboard/analytics"], + items: ["dashboard/dashboard-view", "dashboard/analytics"], }, { type: "category", @@ -66,10 +65,11 @@ const sidebars = { type: "category", label: "Authentication", items: [ - { - type: "autogenerated", - dirName: "authentication-authorization/authentication", - }, + "authentication-authorization/authentication/azure-ad", + "authentication-authorization/authentication/google-account", + "authentication-authorization/authentication/third-party/account", + "authentication-authorization/authentication/third-party/userpwd-db", + "authentication-authorization/authentication/third-party/windows-ad", ], }, "authentication-authorization/authorization", @@ -224,10 +224,8 @@ const sidebars = { type: "category", label: "Notifications", items: [ - { - type: "autogenerated", - dirName: "notifications", - }, + "notifications/email-notification", + "notifications/slack-notification", ], }, "faq", From 27e4dbab2e4dde8a25c6b900a237a2f7e2201596 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 13:31:16 +0100 Subject: [PATCH 21/28] Add script to check sidebar is complete. Signed-off-by: Mirjam Aulbach --- check-sidebar/index.js | 82 ++++++++++++++++++++++++++++++++++++++++++ package.json | 1 + sidebars.js | 6 ++-- 3 files changed, 86 insertions(+), 3 deletions(-) create mode 100644 check-sidebar/index.js diff --git a/check-sidebar/index.js b/check-sidebar/index.js new file mode 100644 index 00000000..df674382 --- /dev/null +++ b/check-sidebar/index.js @@ -0,0 +1,82 @@ +const fs = require("fs"); +const path = require("path"); +const sidebars = require("../sidebars"); + +function checkAllMarkdownFilesAreInSidebar(basePath, allListedFiles) { + const files = fs.readdirSync(basePath); + + files.forEach((file) => { + const filePath = path.join(basePath, file); + const stat = fs.statSync(filePath); + + // docs/releases is a autogenerated index, does not need to be checked here + if (stat.isDirectory() && !filePath.includes("docs/releases")) { + checkAllMarkdownFilesAreInSidebar(filePath, allListedFiles); + } else if (path.extname(file) === ".md" && !file.startsWith("DRAFT_")) { + const isInList = allListedFiles.includes(filePath); + + if (!isInList) { + console.error(` +\n ⚠️ file: ${filePath} is not listed in sidebar.js + If you have a markdown file that is not yet to be published + use DRAFT_ as prefix, then it will not show up in this warning.`); + } + } + }); +} + +function checkListedFileIsInFileSystem(fileToCheck) { + if (!fs.existsSync(fileToCheck)) { + console.error(`⛔️ File ${fileToCheck} is missing.`); + } else { + console.log(`✅ File ${fileToCheck} is correctly linked in sidebar.`); + } +} +function checkSidebarItems(sidebarConfig, basePath, callback) { + if (!sidebarConfig || !basePath) return; + + // track listed files to compare to all markdown files later + const allListedFiles = []; + + // track remaining calls to determine when process is finished + let remainingCalls = 0; + + if (Array.isArray(sidebarConfig)) { + // set length to known length of sidebar.docs array + remainingCalls = sidebarConfig.length; + + sidebarConfig.forEach((item) => { + if (item?.link?.id !== undefined) { + // item?.link?.id is not part of sidebarConfig.length, so + // we don't increase the counter or check for callback + const fileToCheck = path.join(basePath, `${item?.link?.id}.md`); + checkListedFileIsInFileSystem(fileToCheck); + allListedFiles.push(fileToCheck); + } + + if (typeof item === "string") { + const fileToCheck = path.join(basePath, `${item}.md`); + checkListedFileIsInFileSystem(fileToCheck); + allListedFiles.push(fileToCheck); + // decrease the count when processing a string item + remainingCalls--; + checkCallback(); + } else + checkSidebarItems(item.items, path.join(basePath), (files) => { + allListedFiles.push(...files); // Concatenate files from nested callback + // decrease the count when processing a string item + remainingCalls--; + checkCallback(); + }); + }); + } + function checkCallback() { + if (remainingCalls === 0) { + callback(allListedFiles); // pass allListedFiles array to the callback + } + } +} + +checkSidebarItems(sidebars.docs, "docs", (allListedFiles) => { + checkAllMarkdownFilesAreInSidebar("docs", allListedFiles); +}); diff --git a/package.json b/package.json index 325a6a63..82debeb2 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,7 @@ "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", + "check-sidebar": "node check-sidebar/index.js", "lint:code": "eslint . && prettier --check .", "lint:markdown": "markdownlint \"**/*.md\" --ignore '**/.github/vale/styles/**' --ignore '**/node_modules/**'", "lint": "pnpm lint:code && pnpm lint:markdown", diff --git a/sidebars.js b/sidebars.js index 11194cad..51b923cf 100644 --- a/sidebars.js +++ b/sidebars.js @@ -67,9 +67,9 @@ const sidebars = { items: [ "authentication-authorization/authentication/azure-ad", "authentication-authorization/authentication/google-account", - "authentication-authorization/authentication/third-party/account", - "authentication-authorization/authentication/third-party/userpwd-db", - "authentication-authorization/authentication/third-party/windows-ad", + "authentication-authorization/authentication/third-party-account", + "authentication-authorization/authentication/userpwd-db", + "authentication-authorization/authentication/windows-ad", ], }, "authentication-authorization/authorization", From 9b63dcdf4df869c2610242d22b4ed57c14ef75bf Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 13:33:38 +0100 Subject: [PATCH 22/28] Move all scripts in one directory. Signed-off-by: Mirjam Aulbach --- docusaurus.config.js | 9 ++++++--- package.json | 4 ++-- {check-sidebar => scripts/check-sidebar}/index.js | 2 +- .../markdown-link-check-blog-config.json | 0 .../markdown-link-check-offline-config.json | 0 .../markdown-link-check-other-files-config.json | 0 .../markdown-link-check-script}/markdown-link-check.md | 0 .../markdown-link-check-script}/markdown-link-check.sh | 4 ++-- .../post-build-plugins}/add-redirects-file.js | 0 .../post-build-plugins}/create-link-file.js | 0 10 files changed, 11 insertions(+), 8 deletions(-) rename {check-sidebar => scripts/check-sidebar}/index.js (98%) rename {markdown-link-check-script => scripts/markdown-link-check-script}/markdown-link-check-blog-config.json (100%) rename {markdown-link-check-script => scripts/markdown-link-check-script}/markdown-link-check-offline-config.json (100%) rename {markdown-link-check-script => scripts/markdown-link-check-script}/markdown-link-check-other-files-config.json (100%) rename {markdown-link-check-script => scripts/markdown-link-check-script}/markdown-link-check.md (100%) rename {markdown-link-check-script => scripts/markdown-link-check-script}/markdown-link-check.sh (94%) rename {plugins => scripts/post-build-plugins}/add-redirects-file.js (100%) rename {plugins => scripts/post-build-plugins}/create-link-file.js (100%) diff --git a/docusaurus.config.js b/docusaurus.config.js index cd6bf4cb..b421bd26 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,8 +1,11 @@ // @ts-check // Note: type annotations allow type checking and IDEs autocompletion -const { addRedirectsFile } = require("./plugins/add-redirects-file"); -const { createLinkFile } = require("./plugins/create-link-file"); - +const { + addRedirectsFile, +} = require("./scripts/post-build-plugins/add-redirects-file"); +const { + createLinkFile, +} = require("./scripts/post-build-plugins/create-link-file"); const lightCodeTheme = require("prism-react-renderer").themes.github; const darkCodeTheme = require("prism-react-renderer").themes.dracula; diff --git a/package.json b/package.json index 82debeb2..ec199910 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", - "check-sidebar": "node check-sidebar/index.js", + "check-sidebar": "node scripts/check-sidebar/index.js", "lint:code": "eslint . && prettier --check .", "lint:markdown": "markdownlint \"**/*.md\" --ignore '**/.github/vale/styles/**' --ignore '**/node_modules/**'", "lint": "pnpm lint:code && pnpm lint:markdown", @@ -20,7 +20,7 @@ "reformat:markdown": "markdownlint \"**/*.md\" --ignore node_modules --fix", "reformat": "pnpm reformat:code && pnpm reformat:markdown", "lint-staged": "lint-staged", - "markdown-link-check": "markdown-link-check-script/markdown-link-check.sh", + "markdown-link-check": "scripts/markdown-link-check-script/markdown-link-check.sh", "spell:error": "vale --glob='!.github/vale/styles/*' . --minAlertLevel=error", "spell:warn": "vale --glob='!.github/vale/styles/*' . --minAlertLevel=warning", "spell:all": "vale --glob='!.github/vale/styles/*' . --minAlertLevel=suggestion" diff --git a/check-sidebar/index.js b/scripts/check-sidebar/index.js similarity index 98% rename from check-sidebar/index.js rename to scripts/check-sidebar/index.js index df674382..77143758 100644 --- a/check-sidebar/index.js +++ b/scripts/check-sidebar/index.js @@ -1,6 +1,6 @@ const fs = require("fs"); const path = require("path"); -const sidebars = require("../sidebars"); +const sidebars = require("../../sidebars"); function checkAllMarkdownFilesAreInSidebar(basePath, allListedFiles) { const files = fs.readdirSync(basePath); diff --git a/markdown-link-check-script/markdown-link-check-blog-config.json b/scripts/markdown-link-check-script/markdown-link-check-blog-config.json similarity index 100% rename from markdown-link-check-script/markdown-link-check-blog-config.json rename to scripts/markdown-link-check-script/markdown-link-check-blog-config.json diff --git a/markdown-link-check-script/markdown-link-check-offline-config.json b/scripts/markdown-link-check-script/markdown-link-check-offline-config.json similarity index 100% rename from markdown-link-check-script/markdown-link-check-offline-config.json rename to scripts/markdown-link-check-script/markdown-link-check-offline-config.json diff --git a/markdown-link-check-script/markdown-link-check-other-files-config.json b/scripts/markdown-link-check-script/markdown-link-check-other-files-config.json similarity index 100% rename from markdown-link-check-script/markdown-link-check-other-files-config.json rename to scripts/markdown-link-check-script/markdown-link-check-other-files-config.json diff --git a/markdown-link-check-script/markdown-link-check.md b/scripts/markdown-link-check-script/markdown-link-check.md similarity index 100% rename from markdown-link-check-script/markdown-link-check.md rename to scripts/markdown-link-check-script/markdown-link-check.md diff --git a/markdown-link-check-script/markdown-link-check.sh b/scripts/markdown-link-check-script/markdown-link-check.sh similarity index 94% rename from markdown-link-check-script/markdown-link-check.sh rename to scripts/markdown-link-check-script/markdown-link-check.sh index aee1a069..912438dd 100755 --- a/markdown-link-check-script/markdown-link-check.sh +++ b/scripts/markdown-link-check-script/markdown-link-check.sh @@ -17,7 +17,7 @@ while getopts "f:qo" opt; do QUIET_MODE="-q" ;; o) - OFFLINE_MODE="--config=./markdown-link-check-script/markdown-link-check-offline-config.json" + OFFLINE_MODE="--config=./scripts/markdown-link-check-script/markdown-link-check-offline-config.json" ;; \?) echo "Usage: $0 [-f file] [-q]" @@ -60,7 +60,7 @@ else # Use "find" to locate all Markdown files in blog, excluding those in node_modules # Apply ignore pattern to not check links that are not starting with http/https AND # are not located in "blog" - IGNORE_PATTERN_BLOG="--config=./markdown-link-check-script/markdown-link-check-blog-config.json" + IGNORE_PATTERN_BLOG="--config=./scripts/markdown-link-check-script/markdown-link-check-blog-config.json" # shellcheck disable=SC2046 markdown-link-check \ $(find "blog" -type f -name '*.md' ! -path '*/node_modules/*' ! -path '*/.github/vale/styles/*' -print) \ diff --git a/plugins/add-redirects-file.js b/scripts/post-build-plugins/add-redirects-file.js similarity index 100% rename from plugins/add-redirects-file.js rename to scripts/post-build-plugins/add-redirects-file.js diff --git a/plugins/create-link-file.js b/scripts/post-build-plugins/create-link-file.js similarity index 100% rename from plugins/create-link-file.js rename to scripts/post-build-plugins/create-link-file.js From 74381025f99796cb9e83a319d5e6cad358092e0e Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 14:27:18 +0100 Subject: [PATCH 23/28] Document script to check sidebar. Signed-off-by: Mirjam Aulbach --- README.md | 1 + scripts/check-sidebar/index.js | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 334a275e..c4e9b681 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,7 @@ Here are the important ones you're likely to use: - Run `pnpm markdown-link-check -- -o` to only check for internal links (offline mode). - Run `pnpm markdown-link-check -- -q` to only log errors. - Run `pnpm markdown-link-check -- -q /path/your-file.md` to run checks for only one file. +- `pnpm check-sidbar`: checks that the file linked in sidebar do exist and that all markdown files in `docs` are listed in sidebar.js. It does not warn for files that start with the prefix `DRAFT_`. For these scripts, you need to have Vale installed (see [Requirements](#requirements)): diff --git a/scripts/check-sidebar/index.js b/scripts/check-sidebar/index.js index 77143758..0fee98da 100644 --- a/scripts/check-sidebar/index.js +++ b/scripts/check-sidebar/index.js @@ -27,9 +27,9 @@ function checkAllMarkdownFilesAreInSidebar(basePath, allListedFiles) { function checkListedFileIsInFileSystem(fileToCheck) { if (!fs.existsSync(fileToCheck)) { - console.error(`⛔️ File ${fileToCheck} is missing.`); + console.error(`⛔️ File ${fileToCheck} does not exist.`); } else { - console.log(`✅ File ${fileToCheck} is correctly linked in sidebar.`); + console.log(`✅ File ${fileToCheck} does exist and is linked.`); } } function checkSidebarItems(sidebarConfig, basePath, callback) { From 6d1c0b670481e4f6511fe680f051918f1319c65c Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 14:34:47 +0100 Subject: [PATCH 24/28] Move consumer lag, topic event and reset consumer offsets docs to workflows/topic. Delete unneeded files/dirs. Signed-off-by: Mirjam Aulbach --- _redirects | 4 ++++ current-routes.json | 7 +++---- docs/HowTo/_category_.json | 7 ------- docs/HowTo/operational/index.md | 5 ----- docs/getting-started/features.md | 6 +++--- .../topic/reset-consumer-offsets.md} | 0 .../topic/view-consumer-lag.md} | 0 .../topic/view-topic-events.md} | 0 sidebars.js | 3 +++ 9 files changed, 13 insertions(+), 19 deletions(-) delete mode 100644 docs/HowTo/_category_.json delete mode 100644 docs/HowTo/operational/index.md rename docs/{HowTo/operational/Reset-Consumer-Offsets.md => workflows/topic/reset-consumer-offsets.md} (100%) rename docs/{HowTo/topics/View-consumer-lag.md => workflows/topic/view-consumer-lag.md} (100%) rename docs/{HowTo/topics/View-topic-events.md => workflows/topic/view-topic-events.md} (100%) diff --git a/_redirects b/_redirects index 45669c3c..f2000a98 100644 --- a/_redirects +++ b/_redirects @@ -92,6 +92,10 @@ /docs/HowTo/topics/Promote-a-topic /docs/workflows/topic/promote-topic 301 /docs/HowTo/topics/Request-a-new-topic /docs/workflows/topic/request-topic 301 /docs/HowTo/topics/Topic-overview /docs/workflows/topic/topic-overview 301 +/docs/HowTo/topics/View-consumer-lag /docs/workflows/topic/view-consumer-lag 301 +/docs/HowTo/topics/View-topic-events /docs/workflows/topic/view-topic-events 301 +/docs/HowTo/operational/ /docs/workflows/topic/reset-consumer-offsets 301 +/docs/HowTo/operational/Reset-Consumer-Offsets /docs/workflows/topic/reset-consumer-offsets 301 /docs/HowTo/notifications/ /docs/notifications/email-notification 301 /docs/HowTo/notifications/email-notification /docs/notifications/email-notification 301 diff --git a/current-routes.json b/current-routes.json index 66bafced..b942471e 100644 --- a/current-routes.json +++ b/current-routes.json @@ -70,10 +70,6 @@ "/docs/getting-started/features", "/docs/getting-started/getstarted", "/docs/getting-started/quickstart", - "/docs/HowTo/operational/", - "/docs/HowTo/operational/Reset-Consumer-Offsets", - "/docs/HowTo/topics/View-consumer-lag", - "/docs/HowTo/topics/View-topic-events", "/docs/HowTo/zothers", "/docs/metadata-management/import-export/", "/docs/metadata-management/import-export/exportdata", @@ -130,6 +126,9 @@ "/docs/workflows/topic/my-topic-requests", "/docs/workflows/topic/promote-topic", "/docs/workflows/topic/request-topic", + "/docs/workflows/topic/reset-consumer-offsets", "/docs/workflows/topic/topic-overview", + "/docs/workflows/topic/view-consumer-lag", + "/docs/workflows/topic/view-topic-events", "/" ] diff --git a/docs/HowTo/_category_.json b/docs/HowTo/_category_.json deleted file mode 100644 index 798cf6e9..00000000 --- a/docs/HowTo/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "HowTo", - "position": 4, - "link": { - "type": "generated-index" - } -} diff --git a/docs/HowTo/operational/index.md b/docs/HowTo/operational/index.md deleted file mode 100644 index 1ad565e7..00000000 --- a/docs/HowTo/operational/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Operational requests - -Klaw simplifies various administrative tasks by consolidating them into operational requests. These requests handle modifications or actions that influence the system's operations. - -- [Reset Consumer group offsets](Reset-Consumer-Offsets.md) diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 39a60989..cb1a7190 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -15,10 +15,10 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | [_Promote topics, schemas, connectors_](../workflows/topic/promote-topic.md) | Define a hierarchy of environments and effortlessly promote entities to higher environments. | | [_Topic naming conventions_](../cluster-management/clusters-environments/environments.md) | Enforce naming conventions using prefixes, suffixes, or regex on topic names. | | [_Schema evolution_](../workflows/schema/manage-schema-requests.md) | Manage multiple versions of schemas efficiently. | -| [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | -| [_View Apache Kafka events_](../HowTo/topics/View-topic-events) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | +| [_Reset consumer offsets_](../workflows/topic/reset-consumer-offsets.md) | Gain the ability to reset consumer offsets for specific consumer groups per topic. | +| [_View Apache Kafka events_](../workflows/topic/view-topic-events.md) | Easily view events on any Apache Kafka topic for better monitoring and debugging. | | [_Dashboard_](../dashboard/dashboard-view.md) | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer. | -| [_View consumer lag_](../HowTo/topics/View-consumer-lag) | Keep track of consumer offsets and view lags for a consumer group. | +| [_View consumer lag_](../workflows/topic/view-consumer-lag.md) | Keep track of consumer offsets and view lags for a consumer group. | | [_Sync topics to a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-to-cluster.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. | | [_Sync topics from a cluster_](../cluster-management/kafka-cluster-sync/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. | | [_Sync ACLs to a cluster_](../cluster-management/kafka-cluster-sync/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. | diff --git a/docs/HowTo/operational/Reset-Consumer-Offsets.md b/docs/workflows/topic/reset-consumer-offsets.md similarity index 100% rename from docs/HowTo/operational/Reset-Consumer-Offsets.md rename to docs/workflows/topic/reset-consumer-offsets.md diff --git a/docs/HowTo/topics/View-consumer-lag.md b/docs/workflows/topic/view-consumer-lag.md similarity index 100% rename from docs/HowTo/topics/View-consumer-lag.md rename to docs/workflows/topic/view-consumer-lag.md diff --git a/docs/HowTo/topics/View-topic-events.md b/docs/workflows/topic/view-topic-events.md similarity index 100% rename from docs/HowTo/topics/View-topic-events.md rename to docs/workflows/topic/view-topic-events.md diff --git a/sidebars.js b/sidebars.js index 51b923cf..5ad948c2 100644 --- a/sidebars.js +++ b/sidebars.js @@ -216,6 +216,9 @@ const sidebars = { "workflows/topic/delete-topic", "workflows/topic/manage-topic-requests", "workflows/topic/my-topic-requests", + "workflows/topic/view-consumer-lag", + "workflows/topic/view-topic-events", + "workflows/topic/reset-consumer-offsets", ], }, ], From 931849f0fd197b75c6ea47f17e9524f62022aac0 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 15:16:24 +0100 Subject: [PATCH 25/28] Add zothers text to features.md Signed-off-by: Mirjam Aulbach --- _redirects | 1 + current-routes.json | 1 - docs/HowTo/zothers.md | 13 ------------- docs/getting-started/features.md | 11 +++++++++++ 4 files changed, 12 insertions(+), 14 deletions(-) delete mode 100644 docs/HowTo/zothers.md diff --git a/_redirects b/_redirects index f2000a98..634b2bf9 100644 --- a/_redirects +++ b/_redirects @@ -7,6 +7,7 @@ /docs/features /docs/getting-started/features 301 /docs/getstarted /docs/getting-started/getstarted 301 /docs/quickstart /docs/getting-started/quickstart 301 +/docs/HowTo/zothers /docs/getting-started/features 301 /docs/HowTo/analytics /docs/dashboard/analytics 301 /docs/HowTo/dashboard /docs/dashboard/dashboard-view 301 diff --git a/current-routes.json b/current-routes.json index b942471e..8e4ca37d 100644 --- a/current-routes.json +++ b/current-routes.json @@ -70,7 +70,6 @@ "/docs/getting-started/features", "/docs/getting-started/getstarted", "/docs/getting-started/quickstart", - "/docs/HowTo/zothers", "/docs/metadata-management/import-export/", "/docs/metadata-management/import-export/exportdata", "/docs/metadata-management/import-export/importdata", diff --git a/docs/HowTo/zothers.md b/docs/HowTo/zothers.md deleted file mode 100644 index ae7c6ce8..00000000 --- a/docs/HowTo/zothers.md +++ /dev/null @@ -1,13 +0,0 @@ -# Other features - -- Contact Administrator: It is possible to send a message to the - Administrator of Klaw by clicking the help button on the top right - of the screen. - -![image](../../static/images/ContactAdmin.png) - -- Raise a GitHub Issue: If you find any issue with the project or have a - suggestion or improvement, we recommend you submit an issue to the - project. You can do this by clicking on help and selecting **Raise - a git issue** option, or you can directly open an issue by accessing - this link: [GitHub issues](https://github.com/aiven/klaw/issues) diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index cb1a7190..189b32a0 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -36,6 +36,17 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka | [_Apache Kafka flavor support_](../cluster-management/clusters-environments/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. | | _Klaw login AD/SSO/DB_ | Users can log in to Klaw using [Windows AD](../authentication-authorization/authentication/windows-ad.md), SSO providers like [Azure](../authentication-authorization/authentication/azure-ad.md) and [Google](../authentication-authorization/authentication/google-account.md). Klaw also offers the option to configure any [third-party login account](../authentication-authorization/authentication/third-party-account.md) as well as using a [database account](../authentication-authorization/authentication/userpwd-db.md). | +## Contact administrator + +It is possible to send a message to the administrator of Klaw by clicking the help button on the top right of the screen. + +![image](../../static/images/ContactAdmin.png) + +## Contact us + +If you find any issue with the project or have a suggestion or improvement, we recommend you submit an issue to the +project. You can do this by clicking on help and selecting **Raise a git issue** option, or you can directly open an issue by accessing this link: [GitHub issues](https://github.com/aiven/klaw/issues) + :::note Klaw is continuously evolving, and many other minor features are also available that are not listed above. ::: From 74b724e2483c787c6b0de4dc264c6aeda9755663 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 15:25:18 +0100 Subject: [PATCH 26/28] Format and update redirects file Signed-off-by: Mirjam Aulbach --- _redirects | 216 ++++++++++++++++++++++++++++------------------------- 1 file changed, 114 insertions(+), 102 deletions(-) diff --git a/_redirects b/_redirects index 634b2bf9..25c57adf 100644 --- a/_redirects +++ b/_redirects @@ -1,107 +1,119 @@ -/docs/category/Releases/* /docs/releases/:splat 301 -/docs/category/Releases /docs/releases 301 - -/docs/category/concepts /docs/Concepts/clusters-environments 301 -/docs/category/howto /docs/HowTo/analytics 301 - -/docs/features /docs/getting-started/features 301 -/docs/getstarted /docs/getting-started/getstarted 301 -/docs/quickstart /docs/getting-started/quickstart 301 -/docs/HowTo/zothers /docs/getting-started/features 301 - -/docs/HowTo/analytics /docs/dashboard/analytics 301 -/docs/HowTo/dashboard /docs/dashboard/dashboard-view 301 - -/docs/HowTo/installation /docs/setup-configuration/klaw-installation 301 -/docs/HowTo/installation/configure-klaw-wizard /docs/setup-configuration/klaw-installation/configure-klaw-wizard 301 -/docs/HowTo/installation/run-docker /docs/setup-configuration/klaw-installation/run-docker 301 -/docs/HowTo/installation/run-source /docs/setup-configuration/klaw-installation/run-source 301 -/docs/HowTo/deployklaw /docs/setup-configuration/klaw-installation/deployklaw 301 -/docs/HowTo/kafka-cluster-migration/tenant-config /docs/setup-configuration/tenant-configuration 301 -/docs/HowTo/tenant /docs/setup-configuration/tenant-configuration 301 - -/docs/Concepts/config /docs/setup-configuration/klaw-api-ssl-with-kafka 301 -/docs/Concepts/high-availability /docs/setup-configuration/high-availability 310 -/docs/HowTo/settings /docs/setup-configuration/settings 310 - -/docs/Concepts/switch-teams /docs/user-team-management/teams/switch-teams 301 -/docs/Concepts/users-teams /docs/user-team-management/users-roles-teams 301 -/docs/HowTo/rolespermissions /docs/user-team-management/manage-roles-permissions 301 -/docs/HowTo/teams/manage-teams /docs/user-team-management/teams/manage-teams 301 -/docs/HowTo/users /docs/user-team-management/manage-users 301 - -/docs/HowTo/authentication/ /docs/authentication-authorization/authentication/azure-ad 301 -/docs/HowTo/authentication/azure-ad /docs/authentication-authorization/authentication/azure-ad 301 -/docs/HowTo/authentication/google-account /docs/authentication-authorization/authentication/google-account 301 -/docs/HowTo/authentication/third-party-account /docs/authentication-authorization/authentication/third-party-account 301 -/docs/HowTo/authentication/userpwd-db /docs/authentication-authorization/authentication/userpwd-db 301 -/docs/HowTo/authentication/windows-ad /docs/authentication-authorization/authentication/windows-ad 301 -/docs/HowTo/authorization /docs/authentication-authorization/authorization 301 301 - -/docs/Concepts/clusters-environments /docs/cluster-management/clusters-environments/ 301 -/docs/HowTo/clusters /docs/cluster-management/clusters-environments/clusters 301 -/docs/HowTo/environments /docs/cluster-management/clusters-environments/environments 301 -/docs/HowTo/kafka-cluster-migration /docs/cluster-management/kafka-cluster-sync 301 -/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-acls-from-cluster 301 -/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-acls-to-cluster 301 -/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-connectors-from-cluster 301 -/docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster 301 -/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster 301 -/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster 301 -/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster 301 - -/docs/HowTo/clusterconnectivity/ /docs/cluster-connectivity-setup/ 301 -/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol 301 -/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol 301 -/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-connect-cluster-ssl-protocol 301 -/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-karapace-cluster-ssl-protocol 301 -/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol 301 -/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-sasl-protocol 301 -/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-ssl-protocol 301 -/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi /docs/cluster-connectivity-setup/klaw-core-with-clusterapi 301 -/docs/HowTo/clusterconnectivity/klaw-db-connection /docs/cluster-connectivity-setup/klaw-db-connection 301 -/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol /docs/cluster-connectivity-setup/sr-cluster-ssl-protocol 301 - -/docs/HowTo/connectors /docs/connector-management 301 -/docs/HowTo/connectors/Approve-a-connector /docs/connector-management/approve-connector 301 -/docs/HowTo/connectors/manage-connectors /docs/connector-management/manage-connectors 301 -/docs/HowTo/connectors/My-connector-requests /docs/connector-management/my-connector-requests 301 -/docs/HowTo/connectors/Request-a-new-connector /docs/connector-management/request-connector 301 - -/docs/Concepts/metastore /docs/metadata-management/metastore 301 -/docs/HowTo/exportimport/ /docs/metadata-management/import-export 301 -/docs/HowTo/exportimport/exportdata /docs/metadata-management/import-export/exportdata 301 -/docs/HowTo/exportimport/importdata /docs/metadata-management/import-export/importdata 301 - -/docs/Concepts/promotion /docs/workflows/promotion 301 -/docs/HowTo/schemas /docs/workflows/schema 301 -/docs/HowTo/schemas/manage-schemas /docs/workflows/schema/manage-schema-requests 301 -/docs/HowTo/schemas/My-schema-requests /docs/workflows/schema/my-schema-requests 301 -/docs/HowTo/schemas/Promote-a-schema /docs/workflows/schema/promote-schema 301 -/docs/HowTo/schemas/Request-a-schema /docs/workflows/schema/request-schema 301 -/docs/HowTo/subscriptions /docs/workflows/subscription 301 -/docs/HowTo/subscriptions/Approve-a-subscription /docs/workflows/subscription/manage-subscription-requests 301 -/docs/HowTo/subscriptions/Delete-a-subscription /docs/workflows/subscription/delete-subscription 301 -/docs/HowTo/subscriptions/My-subscription-requests /docs/workflows/subscription/my-subscription-requests 301 -/docs/HowTo/subscriptions/Request-a-subscription /docs/workflows/subscription/request-subscription 301 -/docs/HowTo/topics/ /docs/workflows/topic 301 -/docs/HowTo/topics/Approve-a-topic /docs/workflows/topic/manage-topic-requests 301 -/docs/HowTo/topics/Claim-a-topic /docs/workflows/topic/claim-topic 301 -/docs/HowTo/topics/Delete-a-topic /docs/workflows/topic/delete-topic 301 -/docs/HowTo/topics/Edit-topic-request /docs/workflows/topic/edit-topic 301 -/docs/HowTo/topics/My-topic-requests /docs/workflows/topic/my-topic-requests 301 -/docs/HowTo/topics/Promote-a-topic /docs/workflows/topic/promote-topic 301 -/docs/HowTo/topics/Request-a-new-topic /docs/workflows/topic/request-topic 301 -/docs/HowTo/topics/Topic-overview /docs/workflows/topic/topic-overview 301 -/docs/HowTo/topics/View-consumer-lag /docs/workflows/topic/view-consumer-lag 301 -/docs/HowTo/topics/View-topic-events /docs/workflows/topic/view-topic-events 301 -/docs/HowTo/operational/ /docs/workflows/topic/reset-consumer-offsets 301 -/docs/HowTo/operational/Reset-Consumer-Offsets /docs/workflows/topic/reset-consumer-offsets 301 +/docs/category/Releases/* /docs/releases/:splat 301 +/docs/category/Releases /docs/releases 301 + + +/docs/category/concepts /docs/Concepts/clusters-environments 301 +/docs/category/howto /docs/HowTo/analytics 301 + + +/docs/features /docs/getting-started/features 301 +/docs/getstarted /docs/getting-started/getstarted 301 +/docs/quickstart /docs/getting-started/quickstart 301 +/docs/HowTo/zothers /docs/getting-started/features 301 + + +/docs/HowTo/analytics /docs/dashboard/analytics 301 +/docs/HowTo/dashboard /docs/dashboard/dashboard-view 301 + + +/docs/HowTo/installation /docs/setup-configuration/klaw-installation 301 +/docs/HowTo/installation/configure-klaw-wizard /docs/setup-configuration/klaw-installation/configure-klaw-wizard 301 +/docs/HowTo/installation/run-docker /docs/setup-configuration/klaw-installation/run-docker 301 +/docs/HowTo/installation/run-source /docs/setup-configuration/klaw-installation/run-source 301 +/docs/HowTo/deployklaw /docs/setup-configuration/klaw-installation/deployklaw 301 +/docs/HowTo/kafka-cluster-migration/tenant-config /docs/setup-configuration/tenant-configuration 301 +/docs/HowTo/tenant /docs/setup-configuration/tenant-configuration 301 + + +/docs/Concepts/config /docs/setup-configuration/klaw-api-ssl-with-kafka 301 +/docs/Concepts/high-availability /docs/setup-configuration/high-availability 310 +/docs/HowTo/settings /docs/setup-configuration/settings 310 + + +/docs/Concepts/switch-teams /docs/user-team-management/teams/switch-teams 301 +/docs/Concepts/users-teams /docs/user-team-management/users-roles-teams 301 +/docs/HowTo/rolespermissions /docs/user-team-management/manage-roles-permissions 301 +/docs/HowTo/teams/manage-teams /docs/user-team-management/teams/manage-teams 301 +/docs/HowTo/users /docs/user-team-management/manage-users 301 + + +/docs/HowTo/authentication/ /docs/authentication-authorization/authentication/azure-ad 301 +/docs/HowTo/authentication/azure-ad /docs/authentication-authorization/authentication/azure-ad 301 +/docs/HowTo/authentication/google-account /docs/authentication-authorization/authentication/google-account 301 +/docs/HowTo/authentication/third-party-account /docs/authentication-authorization/authentication/third-party-account 301 +/docs/HowTo/authentication/userpwd-db /docs/authentication-authorization/authentication/userpwd-db 301 +/docs/HowTo/authentication/windows-ad /docs/authentication-authorization/authentication/windows-ad 301 +/docs/HowTo/authorization /docs/authentication-authorization/authorization 301 301 + + +/docs/Concepts/clusters-environments /docs/cluster-management/clusters-environments/ 301 +/docs/HowTo/clusters /docs/cluster-management/clusters-environments/clusters 301 +/docs/HowTo/environments /docs/cluster-management/clusters-environments/environments 301 +/docs/HowTo/kafka-cluster-migration /docs/cluster-management/kafka-cluster-sync 301 +/docs/Concepts/synchronize /docs/cluster-management/kafka-cluster-sync 301 +/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-acls-from-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-acls-to-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-connectors-from-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster 301 +/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster 301 + + +/docs/HowTo/clusterconnectivity/ /docs/cluster-connectivity-setup/ 301 +/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol 301 +/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-connect-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-karapace-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-sasl-protocol 301 +/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-ssl-protocol 301 +/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi /docs/cluster-connectivity-setup/klaw-core-with-clusterapi 301 +/docs/HowTo/clusterconnectivity/klaw-db-connection /docs/cluster-connectivity-setup/klaw-db-connection 301 +/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol /docs/cluster-connectivity-setup/sr-cluster-ssl-protocol 301 + + +/docs/HowTo/connectors /docs/connector-management 301 +/docs/HowTo/connectors/Approve-a-connector /docs/connector-management/approve-connector 301 +/docs/HowTo/connectors/manage-connectors /docs/connector-management/manage-connectors 301 +/docs/HowTo/connectors/My-connector-requests /docs/connector-management/my-connector-requests 301 +/docs/HowTo/connectors/Request-a-new-connector /docs/connector-management/request-connector 301 + + +/docs/Concepts/metastore /docs/metadata-management/metastore 301 +/docs/HowTo/exportimport/ /docs/metadata-management/import-export 301 +/docs/HowTo/exportimport/exportdata /docs/metadata-management/import-export/exportdata 301 +/docs/HowTo/exportimport/importdata /docs/metadata-management/import-export/importdata 301 + + +/docs/Concepts/workflows /docs/workflows/ 301 +/docs/Concepts/promotion /docs/workflows/promotion 301 +/docs/HowTo/schemas /docs/workflows/schema 301 +/docs/HowTo/schemas/manage-schemas /docs/workflows/schema/manage-schema-requests 301 +/docs/HowTo/schemas/My-schema-requests /docs/workflows/schema/my-schema-requests 301 +/docs/HowTo/schemas/Promote-a-schema /docs/workflows/schema/promote-schema 301 +/docs/HowTo/schemas/Request-a-schema /docs/workflows/schema/request-schema 301 +/docs/HowTo/subscriptions /docs/workflows/subscription 301 +/docs/HowTo/subscriptions/Approve-a-subscription /docs/workflows/subscription/manage-subscription-requests 301 +/docs/HowTo/subscriptions/Delete-a-subscription /docs/workflows/subscription/delete-subscription 301 +/docs/HowTo/subscriptions/My-subscription-requests /docs/workflows/subscription/my-subscription-requests 301 +/docs/HowTo/subscriptions/Request-a-subscription /docs/workflows/subscription/request-subscription 301 +/docs/HowTo/topics/ /docs/workflows/topic 301 +/docs/HowTo/topics/Approve-a-topic /docs/workflows/topic/manage-topic-requests 301 +/docs/HowTo/topics/Claim-a-topic /docs/workflows/topic/claim-topic 301 +/docs/HowTo/topics/Delete-a-topic /docs/workflows/topic/delete-topic 301 +/docs/HowTo/topics/Edit-topic-request /docs/workflows/topic/edit-topic 301 +/docs/HowTo/topics/My-topic-requests /docs/workflows/topic/my-topic-requests 301 +/docs/HowTo/topics/Promote-a-topic /docs/workflows/topic/promote-topic 301 +/docs/HowTo/topics/Request-a-new-topic /docs/workflows/topic/request-topic 301 +/docs/HowTo/topics/Topic-overview /docs/workflows/topic/topic-overview 301 +/docs/HowTo/topics/View-consumer-lag /docs/workflows/topic/view-consumer-lag 301 +/docs/HowTo/topics/View-topic-events /docs/workflows/topic/view-topic-events 301 +/docs/HowTo/operational/ /docs/workflows/topic/reset-consumer-offsets 301 +/docs/HowTo/operational/Reset-Consumer-Offsets /docs/workflows/topic/reset-consumer-offsets 301 + /docs/HowTo/notifications/ /docs/notifications/email-notification 301 /docs/HowTo/notifications/email-notification /docs/notifications/email-notification 301 /docs/HowTo/notifications/slack-notification /docs/notifications/slack-notification 301 -/docs/Concepts/workflows /docs/workflows/ 301 - -/docs/Concepts/synchronize /docs/cluster-management/kafka-cluster-sync/kafka-cluster-sync 301 \ No newline at end of file From 6def9fc1e78254baf69840169e80cdbfd34c63ef Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 21:01:58 +0100 Subject: [PATCH 27/28] Update script for markdown-link-checker Signed-off-by: Mirjam Aulbach --- .github/workflows/link-check.yaml | 2 +- package.json | 2 +- ...kdown-link-check-blog-config-offline.json} | 3 + .../markdown-link-check-divers-config.json | 7 ++ ...down-link-check-divers-offline-config.json | 10 +++ ...wn-link-check-releases-config-offline.json | 10 +++ .../markdown-link-check-releases-config.json | 7 ++ .../markdown-link-check.md | 2 +- .../markdown-link-check.sh | 83 ++++++++++++++----- 9 files changed, 101 insertions(+), 25 deletions(-) rename scripts/markdown-link-check-script/{markdown-link-check-other-files-config.json => markdown-link-check-blog-config-offline.json} (68%) create mode 100644 scripts/markdown-link-check-script/markdown-link-check-divers-config.json create mode 100644 scripts/markdown-link-check-script/markdown-link-check-divers-offline-config.json create mode 100644 scripts/markdown-link-check-script/markdown-link-check-releases-config-offline.json create mode 100644 scripts/markdown-link-check-script/markdown-link-check-releases-config.json diff --git a/.github/workflows/link-check.yaml b/.github/workflows/link-check.yaml index 138eba90..006d4fc8 100644 --- a/.github/workflows/link-check.yaml +++ b/.github/workflows/link-check.yaml @@ -58,4 +58,4 @@ jobs: run: pnpm install - name: Run markdown link check - run: pnpm markdown-link-check -- -q -o + run: pnpm markdown-link-check -q -o diff --git a/package.json b/package.json index ec199910..5dc2a1cc 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "reformat:markdown": "markdownlint \"**/*.md\" --ignore node_modules --fix", "reformat": "pnpm reformat:code && pnpm reformat:markdown", "lint-staged": "lint-staged", - "markdown-link-check": "scripts/markdown-link-check-script/markdown-link-check.sh", + "markdown-link-check": "bash scripts/markdown-link-check-script/markdown-link-check.sh \"$@\"", "spell:error": "vale --glob='!.github/vale/styles/*' . --minAlertLevel=error", "spell:warn": "vale --glob='!.github/vale/styles/*' . --minAlertLevel=warning", "spell:all": "vale --glob='!.github/vale/styles/*' . --minAlertLevel=suggestion" diff --git a/scripts/markdown-link-check-script/markdown-link-check-other-files-config.json b/scripts/markdown-link-check-script/markdown-link-check-blog-config-offline.json similarity index 68% rename from scripts/markdown-link-check-script/markdown-link-check-other-files-config.json rename to scripts/markdown-link-check-script/markdown-link-check-blog-config-offline.json index 9ae5ecf1..40bdbeb5 100644 --- a/scripts/markdown-link-check-script/markdown-link-check-other-files-config.json +++ b/scripts/markdown-link-check-script/markdown-link-check-blog-config-offline.json @@ -2,6 +2,9 @@ "ignorePatterns": [ { "pattern": "^(?!(http://|https://)|[^/]*/blog/).+" + }, + { + "pattern": "^https?://.*" } ] } diff --git a/scripts/markdown-link-check-script/markdown-link-check-divers-config.json b/scripts/markdown-link-check-script/markdown-link-check-divers-config.json new file mode 100644 index 00000000..f1762d41 --- /dev/null +++ b/scripts/markdown-link-check-script/markdown-link-check-divers-config.json @@ -0,0 +1,7 @@ +{ + "ignorePatterns": [ + { + "pattern": "^#-.*" + } + ] +} diff --git a/scripts/markdown-link-check-script/markdown-link-check-divers-offline-config.json b/scripts/markdown-link-check-script/markdown-link-check-divers-offline-config.json new file mode 100644 index 00000000..754e8225 --- /dev/null +++ b/scripts/markdown-link-check-script/markdown-link-check-divers-offline-config.json @@ -0,0 +1,10 @@ +{ + "ignorePatterns": [ + { + "pattern": "^https?://.*" + }, + { + "pattern": "^#-.*" + } + ] +} diff --git a/scripts/markdown-link-check-script/markdown-link-check-releases-config-offline.json b/scripts/markdown-link-check-script/markdown-link-check-releases-config-offline.json new file mode 100644 index 00000000..5c103bec --- /dev/null +++ b/scripts/markdown-link-check-script/markdown-link-check-releases-config-offline.json @@ -0,0 +1,10 @@ +{ + "ignorePatterns": [ + { + "pattern": "^(?!(http://|https://)|[^/]*/docs/releases/).+" + }, + { + "pattern": "^https?://.*" + } + ] +} diff --git a/scripts/markdown-link-check-script/markdown-link-check-releases-config.json b/scripts/markdown-link-check-script/markdown-link-check-releases-config.json new file mode 100644 index 00000000..59b50941 --- /dev/null +++ b/scripts/markdown-link-check-script/markdown-link-check-releases-config.json @@ -0,0 +1,7 @@ +{ + "ignorePatterns": [ + { + "pattern": "^(?!(http://|https://)|[^/]*/docs/releases/).+" + } + ] +} diff --git a/scripts/markdown-link-check-script/markdown-link-check.md b/scripts/markdown-link-check-script/markdown-link-check.md index bebd9bf4..c466a2f8 100644 --- a/scripts/markdown-link-check-script/markdown-link-check.md +++ b/scripts/markdown-link-check-script/markdown-link-check.md @@ -5,7 +5,7 @@ Uses [markdown-link-check](https://github.com/tcort/markdown-link-check) to chec ## Scripts you can use Note: All scripts need to be run from root and you have to set up -your [local development](../README.md#installation-and-usage) in +your [local development](../../README.md#installation-and-usage) in order to use them. ### ➡️ `pnpm markdown-link-check` diff --git a/scripts/markdown-link-check-script/markdown-link-check.sh b/scripts/markdown-link-check-script/markdown-link-check.sh index 912438dd..745d01c3 100755 --- a/scripts/markdown-link-check-script/markdown-link-check.sh +++ b/scripts/markdown-link-check-script/markdown-link-check.sh @@ -1,9 +1,8 @@ #!/bin/bash - FILES_TO_CHECK="" QUIET_MODE="" -OFFLINE_MODE="" +OFFLINE_MODE=false BROKEN_LINK=false EXIT_CODES=() @@ -17,7 +16,7 @@ while getopts "f:qo" opt; do QUIET_MODE="-q" ;; o) - OFFLINE_MODE="--config=./scripts/markdown-link-check-script/markdown-link-check-offline-config.json" + OFFLINE_MODE=true ;; \?) echo "Usage: $0 [-f file] [-q]" @@ -27,63 +26,103 @@ while getopts "f:qo" opt; do done - if [ -n "$FILES_TO_CHECK" ]; then # Check the specified file echo "🔍 Checking links in $FILES_TO_CHECK." # shellcheck disable=SC2046 markdown-link-check \ - $(find "docs" -type f -name '*.md' ! -path '*/node_modules/*' ! -path '*/.github/vale/styles/*' -print) \ + "$FILES_TO_CHECK" \ $QUIET_MODE \ $OFFLINE_MODE EXIT_CODES+=("$?") else - - - # @TODO without offline mode, this returns an exist code 1 # even though there is no error. I've not found out why, # needs further investigation. + + ########### CHECK LINKS IN /DOCS echo "🔍 Checking links in all markdown files in /docs" - # Use "find" to locate all Markdown files in docs, excluding those in node_modules + + DOCS_IGNORE_PATTERN="" + if [ $OFFLINE_MODE == true ]; then + DOCS_IGNORE_PATTERN="--config=./scripts/markdown-link-check-script/markdown-link-check-offline-config.json" + fi + + # Use "find" to locate all Markdown files in /docs, excluding the category + # docs/release and the file docs/index.md as Docusaurus does resolve those links differently + # shellcheck disable=SC2046 + markdown-link-check \ + $(find "docs" -type f -name '*.md' ! -path 'docs/releases/*' ! -path 'docs/index.md' -print) \ + $QUIET_MODE \ + $DOCS_IGNORE_PATTERN + + EXIT_CODES+=("$?") + + + ########### CHECK LINKS IN /DOCS/RELEASE + echo "🔍 Checking links in all markdown files in /releases" + + RELEASE_IGNORE_PATTERN="" + if [ $OFFLINE_MODE == true ]; then + RELEASE_IGNORE_PATTERN="--config=./scripts/markdown-link-check-script/markdown-link-check-releases-config-offline.json" + else + RELEASE_IGNORE_PATTERN="--config=./scripts/markdown-link-check-script/markdown-link-check-releases-config.json" + fi + + # Use "find" to locate all Markdown files in /docs/releases/ # shellcheck disable=SC2046 markdown-link-check \ - $(find "docs" -type f -name '*.md' ! -path '*/node_modules/*' ! -path '*/.github/vale/styles/*' -print) \ + $(find "docs/releases" -type f -name '*.md' -print) \ $QUIET_MODE \ - $OFFLINE_MODE + $RELEASE_IGNORE_PATTERN EXIT_CODES+=("$?") + + ########### CHECK LINKS IN /BLOG echo "🔍 Checking links in all markdown files in /blog" - # Use "find" to locate all Markdown files in blog, excluding those in node_modules - # Apply ignore pattern to not check links that are not starting with http/https AND - # are not located in "blog" - IGNORE_PATTERN_BLOG="--config=./scripts/markdown-link-check-script/markdown-link-check-blog-config.json" + + BLOG_IGNORE_PATTERN="" + if [ $OFFLINE_MODE == true ]; then + BLOG_IGNORE_PATTERN="--config=./scripts/markdown-link-check-script/markdown-link-check-blog-config-offline.json" + else + BLOG_IGNORE_PATTERN="--config=./scripts/markdown-link-check-script/markdown-link-check-blog-config.json" + fi + + # Use "find" to locate all Markdown files in /blogs # shellcheck disable=SC2046 markdown-link-check \ - $(find "blog" -type f -name '*.md' ! -path '*/node_modules/*' ! -path '*/.github/vale/styles/*' -print) \ + $(find "blog" -type f -name '*.md' -print) \ $QUIET_MODE \ - $OFFLINE_MODE \ - $IGNORE_PATTERN_BLOG + $BLOG_IGNORE_PATTERN EXIT_CODES+=("$?") + ########### CHECK LINKS IN OTHER DIRECTORIES echo "🔍 Checking links in other markdown files" - # Use "find" to locate all Markdown files excluding those in node_modules, docs or blog + + OTHER_IGNORE_PATTERN="" + if [ $OFFLINE_MODE == true ]; then + OTHER_IGNORE_PATTERN="--config=./scripts/markdown-link-check-script/markdown-link-check-blog-config-offline.json" + else + OTHER_IGNORE_PATTERN="--config=./scripts/markdown-link-check-script/markdown-link-check-blog-config.json" + fi + + # Use "find" to locate all Markdown files in /docs/releases/ # shellcheck disable=SC2046 markdown-link-check \ - $(find . -type f -name '*.md' ! -path './docs/*' ! -path './blog/*' ! -path '*/node_modules/*' ! -path ' - */.github/vale/styles/*' -print) \ + $(find . -type f -name '*.md' ! -path './docs/*' ! -path './blog/*' ! -path '*/node_modules/*' ! -path '*/.github/vale/styles/*' -print) \ $QUIET_MODE \ - $OFFLINE_MODE + $OTHER_IGNORE_PATTERN EXIT_CODES+=("$?") fi + # Check if an error occurred for link checking for code in "${EXIT_CODES[@]}"; do if [ -n "$code" ] && [ "$code" -ne 0 ]; then From 26ea9e64a96c281ad320d3539d7bb59bb278ae4a Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Mon, 5 Feb 2024 21:09:42 +0100 Subject: [PATCH 28/28] Fix broken links. Signed-off-by: Mirjam Aulbach --- .../aiven-kafka-cluster-sasl-protocol.md | 2 +- .../aiven-kafka-cluster-ssl-protocol.md | 2 +- docs/releases/release240.md | 2 +- docs/releases/release270.md | 6 +++--- docs/setup-configuration/klaw-api-ssl-with-kafka.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol.md b/docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol.md index c6f3b68c..be72f30e 100644 --- a/docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol.md +++ b/docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol.md @@ -11,7 +11,7 @@ Apache Kafka cluster with Klaw using the SASL_SSL authentication protocol. communicate. - A running Aiven for Apache Kafka service. See [Getting started with Aiven for Apache Kafka for more - information](https://docs.aiven.io/docs/products/kafka/getting-started.html). + information](https://aiven.io/docs/products/kafka#get-started-with-aiven-for-apache-kafka). - Configured [Java keystore and truststore containing the service SSL certificates](https://docs.aiven.io/docs/products/kafka/howto/keystore-truststore.html) to access Apache Kafka. diff --git a/docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol.md b/docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol.md index 8ff4b855..8c0881a8 100644 --- a/docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol.md +++ b/docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol.md @@ -13,7 +13,7 @@ cluster with Klaw using SSL authentication protocol. communicate. - A running Aiven for Apache Kafka service. See [Getting started with Aiven for Apache Kafka for more - information](https://docs.aiven.io/docs/products/kafka/getting-started.html). + information](https://aiven.io/docs/products/kafka#get-started-with-aiven-for-apache-kafka). - Configured [Java keystore and truststore containing the service SSL certificates](https://docs.aiven.io/docs/products/kafka/howto/keystore-truststore.html) to access Apache Kafka. diff --git a/docs/releases/release240.md b/docs/releases/release240.md index b90e2aa7..3ea772ac 100644 --- a/docs/releases/release240.md +++ b/docs/releases/release240.md @@ -98,4 +98,4 @@ frontend. :::note For a complete list of improvements, changelog, and to download the -release, see [GitHub release tag v2.4.0](https://github.com/aiven/klaw/releases/tagv2.4.0) +release, see [GitHub release tag v2.4.0](https://github.com/Aiven-Open/klaw/releases/tag/v2.4.0) diff --git a/docs/releases/release270.md b/docs/releases/release270.md index 8d4c4698..578d3aa9 100644 --- a/docs/releases/release270.md +++ b/docs/releases/release270.md @@ -16,13 +16,13 @@ kafka clients on schema changes ### Binaries -[`klaw-2.7.0.jar` ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v.2.7.0/klaw-2.7.0.jar) +[`klaw-2.7.0.jar` ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.7.0/klaw-2.7.0.jar) -[`cluster-api-2.7.0.jar` ⬇](https://github.com/Aiven-Open/klaw/releases/download/v.2.7.0/cluster-api-2.7.0.jar) +[`cluster-api-2.7.0.jar` ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.7.0/cluster-api-2.7.0.jar) ### Sources -[`klaw-2.7.0.zip` ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v.2.7.0.zip) +[`klaw-2.7.0.zip` ⬇](https://github.com/Aiven-Open/klaw/archive/refs/tags/v2.7.0.zip) ### Docker diff --git a/docs/setup-configuration/klaw-api-ssl-with-kafka.md b/docs/setup-configuration/klaw-api-ssl-with-kafka.md index f7c1eaf3..fa6b73c9 100644 --- a/docs/setup-configuration/klaw-api-ssl-with-kafka.md +++ b/docs/setup-configuration/klaw-api-ssl-with-kafka.md @@ -32,7 +32,7 @@ example, here's how to easily configure Klaw for use with an Aiven for Apache Ka first install the [Aiven client](https://github.com/aiven/aiven-client) CLI tool. 1. Start or navigate to your Aiven for Apache Kafka service. If you're doing this for the first time, you can find more - information [in the Aiven documentation](https://docs.aiven.io/docs/products/kafka/getting-started.html). + information [in the Aiven documentation](https://aiven.io/docs/products/kafka#get-started-with-aiven-for-apache-kafka). 2. Make a directory to store the certificates in, for example, `certs/`.