diff --git a/_redirects b/_redirects index aa25a808..f531dddf 100644 --- a/_redirects +++ b/_redirects @@ -45,3 +45,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 e4c0555b..3ea771bf 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/clusters", "/docs/cluster-management/clusters-environments/environments", "/docs/cluster-management/kafka-cluster-sync/", @@ -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 759be983..be48fc30 100644 --- a/sidebars.js +++ b/sidebars.js @@ -136,7 +136,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",