diff --git a/docs/guides/kafka/concepts/appbinding.md b/docs/guides/kafka/concepts/appbinding.md index 11618203e6..4cfcc77d09 100644 --- a/docs/guides/kafka/concepts/appbinding.md +++ b/docs/guides/kafka/concepts/appbinding.md @@ -5,7 +5,7 @@ menu: identifier: kf-appbinding-concepts name: AppBinding parent: kf-concepts-kafka - weight: 35 + weight: 60 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/connectcluster.md b/docs/guides/kafka/concepts/connectcluster.md index 9cc61000d0..855f60e50a 100644 --- a/docs/guides/kafka/concepts/connectcluster.md +++ b/docs/guides/kafka/concepts/connectcluster.md @@ -5,7 +5,7 @@ menu: identifier: kf-connectcluster-concepts name: ConnectCluster parent: kf-concepts-kafka - weight: 15 + weight: 25 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/connector.md b/docs/guides/kafka/concepts/connector.md index 23f5bfcb93..d4806d6121 100644 --- a/docs/guides/kafka/concepts/connector.md +++ b/docs/guides/kafka/concepts/connector.md @@ -5,7 +5,7 @@ menu: identifier: kf-connector-concepts name: Connector parent: kf-concepts-kafka - weight: 20 + weight: 30 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/kafkaautoscaler.md b/docs/guides/kafka/concepts/kafkaautoscaler.md index 21646baf00..576ceb15b1 100644 --- a/docs/guides/kafka/concepts/kafkaautoscaler.md +++ b/docs/guides/kafka/concepts/kafkaautoscaler.md @@ -5,7 +5,7 @@ menu: identifier: kf-autoscaler-concepts name: KafkaAutoscaler parent: kf-concepts-kafka - weight: 26 + weight: 20 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/kafkaconnectorversion.md b/docs/guides/kafka/concepts/kafkaconnectorversion.md index 7403eeb041..1bdc181e24 100644 --- a/docs/guides/kafka/concepts/kafkaconnectorversion.md +++ b/docs/guides/kafka/concepts/kafkaconnectorversion.md @@ -5,7 +5,7 @@ menu: identifier: kf-kafkaconnectorversion-concepts name: KafkaConnectorVersion parent: kf-concepts-kafka - weight: 30 + weight: 50 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/kafkaopsrequest.md b/docs/guides/kafka/concepts/kafkaopsrequest.md index 3b64ed0428..a5275cb57b 100644 --- a/docs/guides/kafka/concepts/kafkaopsrequest.md +++ b/docs/guides/kafka/concepts/kafkaopsrequest.md @@ -5,7 +5,7 @@ menu: identifier: kf-opsrequest-concepts name: KafkaOpsRequest parent: kf-concepts-kafka - weight: 10 + weight: 15 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/kafkaversion.md b/docs/guides/kafka/concepts/kafkaversion.md index 79e938558a..ffcf5ea27a 100644 --- a/docs/guides/kafka/concepts/kafkaversion.md +++ b/docs/guides/kafka/concepts/kafkaversion.md @@ -5,7 +5,7 @@ menu: identifier: kf-catalog-concepts name: KafkaVersion parent: kf-concepts-kafka - weight: 25 + weight: 45 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/restproxy.md b/docs/guides/kafka/concepts/restproxy.md index 3ec7b7af71..9f43a25ad0 100644 --- a/docs/guides/kafka/concepts/restproxy.md +++ b/docs/guides/kafka/concepts/restproxy.md @@ -5,7 +5,7 @@ menu: identifier: kf-restproxy-concepts name: RestProxy parent: kf-concepts-kafka - weight: 15 + weight: 35 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/schemaregistry.md b/docs/guides/kafka/concepts/schemaregistry.md index 9d79a8f68c..7d63ab3910 100644 --- a/docs/guides/kafka/concepts/schemaregistry.md +++ b/docs/guides/kafka/concepts/schemaregistry.md @@ -5,7 +5,7 @@ menu: identifier: kf-schemaregistry-concepts name: SchemaRegistry parent: kf-concepts-kafka - weight: 15 + weight: 40 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/concepts/schemaregistryversion.md b/docs/guides/kafka/concepts/schemaregistryversion.md index 54b2bb576d..d7833c7e9d 100644 --- a/docs/guides/kafka/concepts/schemaregistryversion.md +++ b/docs/guides/kafka/concepts/schemaregistryversion.md @@ -5,7 +5,7 @@ menu: identifier: kf-schemaregistryversion-concepts name: SchemaRegistryVersion parent: kf-concepts-kafka - weight: 30 + weight: 55 menu_name: docs_{{ .version }} section_menu_id: guides --- diff --git a/docs/guides/kafka/connectcluster/connectcluster.md b/docs/guides/kafka/connectcluster/connectcluster.md index 9448841cdb..2d31c26a0d 100644 --- a/docs/guides/kafka/connectcluster/connectcluster.md +++ b/docs/guides/kafka/connectcluster/connectcluster.md @@ -503,7 +503,7 @@ If you are just testing some basic functionalities, you might want to avoid addi ## Next Steps - [Quickstart Kafka](/docs/guides/kafka/quickstart/kafka/index.md) with KubeDB Operator. -- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/connectcluster/index.md) with KubeDB Operator. +- [Quickstart ConnectCluster](/docs/guides/kafka/connectcluster/overview.md) with KubeDB Operator. - Use [kubedb cli](/docs/guides/kafka/cli/cli.md) to manage databases like kubectl for Kubernetes. - Detail concepts of [ConnectCluster object](/docs/guides/kafka/concepts/connectcluster.md). - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/kafka/connectcluster/overview.md b/docs/guides/kafka/connectcluster/overview.md index 6a925185da..ef89b1ae1b 100644 --- a/docs/guides/kafka/connectcluster/overview.md +++ b/docs/guides/kafka/connectcluster/overview.md @@ -5,7 +5,7 @@ menu: identifier: kf-connectcluster-guides-quickstart name: Overview parent: kf-connectcluster-guides - weight: 15 + weight: 5 menu_name: docs_{{ .version }} section_menu_id: guides --- @@ -515,7 +515,7 @@ If you are just testing some basic functionalities, you might want to avoid addi ## Next Steps - [Quickstart Kafka](/docs/guides/kafka/quickstart/kafka/index.md) with KubeDB Operator. -- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/connectcluster/index.md) with KubeDB Operator. +- [Quickstart ConnectCluster](/docs/guides/kafka/connectcluster/overview.md) with KubeDB Operator. - Use [kubedb cli](/docs/guides/kafka/cli/cli.md) to manage databases like kubectl for Kubernetes. - Detail concepts of [ConnectCluster object](/docs/guides/kafka/concepts/connectcluster.md). - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/kafka/restproxy/overview.md b/docs/guides/kafka/restproxy/overview.md index ddde424305..91075b1fb3 100644 --- a/docs/guides/kafka/restproxy/overview.md +++ b/docs/guides/kafka/restproxy/overview.md @@ -54,7 +54,7 @@ NAME VERSION DISTRIBUTION REGISTRY_IMAGE 3.15.0 3.15.0 Aiven ghcr.io/aiven-open/karapace:3.15.0 3d ``` -> **Note**: Currently Schema is supported only for Apicurio distribution. Use distribution `Apicurio` to create Schema Registry. +> **Note**: Currently RestProxy is supported only for Aiven distribution. Use version with distribution `Aiven` to create Kafka Rest Proxy. Notice the `DEPRECATED` column. Here, `true` means that this SchemaRegistryVersion is deprecated for the current KubeDB version. KubeDB will not work for deprecated KafkaVersion. You can also use the short from `ksrversion` to check available SchemaRegistryVersion. @@ -402,7 +402,7 @@ If you are just testing some basic functionalities, you might want to avoid addi ## Next Steps - [Quickstart Kafka](/docs/guides/kafka/quickstart/kafka/index.md) with KubeDB Operator. -- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/connectcluster/index.md) with KubeDB Operator. +- [Quickstart ConnectCluster](/docs/guides/kafka/connectcluster/overview.md) with KubeDB Operator. - Use [kubedb cli](/docs/guides/kafka/cli/cli.md) to manage databases like kubectl for Kubernetes. - Detail concepts of [ConnectCluster object](/docs/guides/kafka/concepts/connectcluster.md). - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/kafka/schemaregistry/overview.md b/docs/guides/kafka/schemaregistry/overview.md index b9d0304696..9b2c62260a 100644 --- a/docs/guides/kafka/schemaregistry/overview.md +++ b/docs/guides/kafka/schemaregistry/overview.md @@ -12,7 +12,7 @@ section_menu_id: guides > New to KubeDB? Please start [here](/docs/README.md). -# ConnectCluster QuickStart +# SchemaRegistry QuickStart This tutorial will show you how to use KubeDB to run a [Schema Registry](https://www.apicur.io/registry/). @@ -54,7 +54,7 @@ NAME VERSION DISTRIBUTION REGISTRY_IMAGE 3.15.0 3.15.0 Aiven ghcr.io/aiven-open/karapace:3.15.0 3d ``` -> **Note**: Currently Schema Registry is supported only for Apicurio distribution. Use distribution `Apicurio` to create Schema Registry. +> **Note**: Currently Schema Registry is supported only for Apicurio distribution. Use version with distribution `Apicurio` to create Schema Registry. Notice the `DEPRECATED` column. Here, `true` means that this SchemaRegistryVersion is deprecated for the current KubeDB version. KubeDB will not work for deprecated KafkaVersion. You can also use the short from `ksrversion` to check available SchemaRegistryVersion. @@ -88,8 +88,7 @@ Here, - `spec.kafkaRef` specifies the Kafka instance that the SchemaRegistry will store its schema. Here, the SchemaRegistry will store schema to the Kafka instance named `kafka-quickstart` in the `demo` namespace. It is an appbinding reference of the Kafka instance. - `spec.deletionPolicy` specifies what KubeDB should do when a user try to delete SchemaRegistry CR. Deletion policy `WipeOut` will delete all the instances, secret when the SchemaRegistry CR is deleted. -## N.B: -1. If `spec.kafkaRef` is not provided, the SchemaRegistry will run in memory mode. SchemaRegistry will store schema to the memory. +> **Note**: If `spec.kafkaRef` is not provided, the SchemaRegistry will run `inMmemory` mode. SchemaRegistry will store schema to its memory. Before create SchemaRegistry, you have to deploy a `Kafka` cluster first. To deploy kafka cluster, follow the [Kafka Quickstart](/docs/guides/kafka/quickstart/kafka/index.md) guide. Let's assume `kafka-quickstart` is already deployed using KubeDB. Let's create the SchemaRegistry CR that is shown above: @@ -302,6 +301,8 @@ $ curl localhost:8080/apis/registry/v2/groups/quickstart-group/artifacts | jq } ``` +> **Note**: You can also use Schema Registry with Confluent 7 compatible REST APIs. To use confluent compatible REST APIs, you have to add `apis/ccompat/v7` after url address.(e.g. `localhost:8081/subjects` -> `localhost:8080/apis/ccompat/v7/subjects`) + ### Accessing Schema Registry(UI) You can also use the Schema Registry UI to interact with the Schema Registry. The Schema Registry UI is available at port `8080` of the Schema Registry service. @@ -314,9 +315,6 @@ You will see the following screen: From the UI, you can create, update, delete, and view the schema. Also add compatibility level, view the schema history, etc. -## Use Schema Registry with Kafka - - ## Cleaning up @@ -345,7 +343,7 @@ If you are just testing some basic functionalities, you might want to avoid addi ## Next Steps - [Quickstart Kafka](/docs/guides/kafka/quickstart/kafka/index.md) with KubeDB Operator. -- [Quickstart ConnectCluster](/docs/guides/kafka/quickstart/connectcluster/index.md) with KubeDB Operator. +- [Quickstart ConnectCluster](/docs/guides/kafka/connectcluster/overview.md) with KubeDB Operator. - Use [kubedb cli](/docs/guides/kafka/cli/cli.md) to manage databases like kubectl for Kubernetes. - Detail concepts of [ConnectCluster object](/docs/guides/kafka/concepts/connectcluster.md). - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).