Adds crd reference

banzaicloud · Oct 20, 2023 · 7f90588 · 7f90588
1 parent a4b39b7
commit 7f90588
Show file tree

Hide file tree

Showing 8 changed files with 34,962 additions and 30 deletions.
diff --git a/content/docs/configurations/_index.md b/content/docs/configurations/_index.md
@@ -6,12 +6,13 @@ weight: 250
 
 Koperator provides convenient ways of configuring Kafka resources through [Kubernetes custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
 
-List of our custom resources:
-
-- [KafkaCluster]({{< relref "kafkacluster-cr/_index.md" >}})
-- [KafkaTopic]({{< relref "../topics.md" >}})
-- KafkaUser
-
 
+## Overview
 
+The **KafkaCluster** custom resource is the main configuration resource for the Kafka clusters.  
+It defines the Apache Kafka cluster properties, like Kafka brokers and listeners configurations.
+By deploying the KafkaCluster custom resource, Koperator sets up your Kafka cluster.  
+You can change your Kafka cluster properties by updating the KafkaCluster custom resource.
+The **KafkaCluster** custom resource always reflects to your Kafka cluster: when something has changed in your KafkaCluster custom resource, Koperator reconciles the changes to your Kafka cluster.
 
+For the CRD reference, see {{% xref "/docs/configurations/crd/_index.md" %}}.
diff --git a/content/docs/configurations/crd/_index.md b/content/docs/configurations/crd/_index.md
@@ -0,0 +1,8 @@
+---
+title: CRD
+weight: 990
+---
+
+The following sections contain the reference documentation of the various custom resource definitions (CRDs) that are specific to Koperator.
+
+For sample YAML files, see the [samples directory in the GitHub project](https://github.com/banzaicloud/koperator/tree/master/config/samples).