add(api/kafkauser_types): description for SecretName (#1030)

Co-authored-by: Patrik Egyed <[email protected]>
banzaicloud · Aug 15, 2023 · 956d251 · 956d251
1 parent 4329189
commit 956d251
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/api/v1alpha1/kafkauser_types.go b/api/v1alpha1/kafkauser_types.go
@@ -34,6 +34,7 @@ const (
 // KafkaUserSpec defines the desired state of KafkaUser
 // +k8s:openapi-gen=true
 type KafkaUserSpec struct {
+	// secretName is used as the name of the K8S secret that contains the certificate of the KafkaUser. SecretName should be unique inside the namespace where KafkaUser is located.
 	SecretName string           `json:"secretName"`
 	ClusterRef ClusterReference `json:"clusterRef"`
 	// Annotations defines the annotations placed on the certificate or certificate signing request object

diff --git a/config/base/crds/kafka.banzaicloud.io_kafkausers.yaml b/config/base/crds/kafka.banzaicloud.io_kafkausers.yaml
@@ -99,6 +99,9 @@ spec:
                 - pkiBackend
                 type: object
               secretName:
+                description: secretName is used as the name of the K8S secret that
+                  contains the certificate of the KafkaUser. SecretName should be
+                  unique inside the namespace where KafkaUser is located.
                 type: string
               topicGrants:
                 items: