KafkaUser CRD schema reference (group kafka.banzaicloud.io)

KafkaUser is the Schema for the kafka users API

KafkaUser

KafkaUser is the Schema for the kafka users API

Full name:
kafkausers.kafka.banzaicloud.io
Group:
kafka.banzaicloud.io
Singular name:
kafkauser
Plural name:
kafkausers
Scope:
Namespaced
Versions:
v1alpha1

Version v1alpha1

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object

KafkaUserSpec defines the desired state of KafkaUser

.spec.annotations

object

Annotations defines the annotations placed on the certificate or certificate signing request object

.spec.clusterRef

object Required

ClusterReference states a reference to a cluster for topic/user provisioning

.spec.clusterRef.name

string Required

.spec.clusterRef.namespace

string

.spec.createCert

boolean

.spec.dnsNames

array

.spec.dnsNames[*]

string

.spec.includeJKS

boolean

.spec.pkiBackendSpec

object

.spec.pkiBackendSpec.issuerRef

object

ObjectReference is a reference to an object with a given name, kind and group.

.spec.pkiBackendSpec.issuerRef.group

string

Group of the resource being referred to.

.spec.pkiBackendSpec.issuerRef.kind

string

Kind of the resource being referred to.

.spec.pkiBackendSpec.issuerRef.name

string Required

Name of the resource being referred to.

.spec.pkiBackendSpec.pkiBackend

string Required

.spec.pkiBackendSpec.signerName

string

SignerName indicates requested signer, and is a qualified name.

.spec.secretName

string Required

.spec.topicGrants

array

.spec.topicGrants[*]

object

UserTopicGrant is the desired permissions for the KafkaUser

.spec.topicGrants[*].accessType

string Required

KafkaAccessType hold info about Kafka ACL

.spec.topicGrants[*].patternType

string

KafkaPatternType hold the Resource Pattern Type of kafka ACL

.spec.topicGrants[*].topicName

string Required

.status

object

KafkaUserStatus defines the observed state of KafkaUser

.status.acls

array

.status.acls[*]

string

.status.state

string Required

UserState defines the state of a KafkaUser

Last modified October 26, 2023: Standalone site (#125) (6eafe48)