Get started for free on Confluent Cloud

Confluent for Kubernetes API Reference (latest)

Download OpenAPI specification:Download

CMFRestClass

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

object (io.confluent.platform.api.v1beta1.CMFRestClassSpec)

CMFRestClassSpec defines the client configuration to access CMF Rest APIs. This resource is referenced by other CFK resources (ex FlinkEnvironment, FlinkApplication) to access CMF Rest APIs.

object (io.confluent.platform.api.v1beta1.CMFRestClassStatus)

CMFRestClassStatus defines the observed state of CMFRestClass

apiVersion: platform.confluent.io/v1beta1 kind: CMFRestClass metadata: labels: app.kubernetes.io/name: confluent-for-kubernetes app.kubernetes.io/managed-by: kustomize name: cmfrestclass-sample spec: # TODO(user): Add fields here

ConfluentRolebinding

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

required
object (io.confluent.platform.api.v1beta1.ConfluentRolebindingSpec)

ConfluentRolebindingSpec defines the desired state of the rolebinding for the Confluent component when RBAC is enabled. More info: https://docs.confluent.io/operator/current/co-manage-rbac.html

object (io.confluent.platform.api.v1beta1.ConfluentRolebindingStatus)

ConfluentRolebindingStatus defines the observed state of the ConfluentRolebinding.

apiVersion: platform.confluent.io/v1beta1 kind: ConfluentRolebinding metadata: name: cfrb-example namespace: confluent spec: principal: type: user name: user-example clustersScopeByIds: schemaRegistryClusterId: id_schemaregistry_confluent role: SecurityAdmin kafkaRestClassRef: name: default

Connector

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

required
object (io.confluent.platform.api.v1beta1.ConnectorSpec)

ConnectorSpec defines the desired state of the Connector application resource. More info: https://docs.confluent.io/operator/current/co-manage-connectors.html

object (io.confluent.platform.api.v1beta1.ConnectorStatus)

ConnectorStatus defines the observed state of the Connector application resource.

apiVersion: platform.confluent.io/v1beta1 kind: Connector metadata: name: connector-example namespace: confluent spec: class: "org.apache.kafka.connect.file.FileStreamSinkConnector" taskMax: 4 connectClusterRef: name: connect namespace: confluent connectRest: authentication: type: basic secretRef: basic-credential-example configs: topics: "test-topic" file: "/tmp/test.txt" restartPolicy: type: OnFailure maxRetry: 20

Connect

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

required
object (io.confluent.platform.api.v1beta1.ConnectSpec)

ConnectSpec defines the desired state of the Connect cluster.

object (io.confluent.platform.api.v1beta1.ConnectStatus)

ConnectStatus defines the observed state of the Connect cluster.

apiVersion: platform.confluent.io/v1beta1 kind: Connect metadata: name: connect-example namespace: confluent spec: replicas: 2 image: application: confluentinc/cp-server-connect init: confluentinc/confluent-init-container-operator authentication: type: basic basic: secretRef: connect-basic-example tls: autoGeneratedCerts: true dependencies: kafka: bootstrapEndpoint: kafka.confluent.svc.cluster.local:9071 authentication: type: plain jaasConfig: secretRef: credential-example tls: enabled: true

ControlCenter

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

required
object (io.confluent.platform.api.v1beta1.ControlCenterSpec)

ControlCenterSpec defines the desired state of the Control Center cluster.

object (io.confluent.platform.api.v1beta1.ControlCenterStatus)

ControlCenterStatus defines the observed state of the Control Center cluster.

apiVersion: platform.confluent.io/v1beta1 kind: ControlCenter metadata: name: controlcenter-ng-example namespace: confluent spec: replicas: 1 image: application: confluentinc/cp-enterprise-control-center-next-gen init: confluentinc/confluent-init-container dataVolumeCapacity: 10Gi tls: autoGeneratedCerts: true authentication: type: basic basic: secretRef: controlcenter-basic-example dependencies: kafka: bootstrapEndpoint: kafka.confluent.svc.cluster.local:9071 authentication: type: plain jaasConfig: secretRef: credential-example prometheusClient: url: http://controlcenter-next-gen.confluent.svc.cluster.local:9090 alertManagerClient: url: http://controlcenter-next-gen.confluent.svc.cluster.local:9093 services: prometheus: image: confluentinc/cp-enterprise-prometheus pvc: dataVolumeCapacity: 10Gi alertmanager: image: confluentinc/cp-enterprise-alertmanager

FlinkApplication

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.FlinkApplicationSpec)

FlinkApplicationSpec defines the desired state of FlinkApplication.

The embedded FlinkApplicationAutogenSpec is mirrored from cp-flink-cmf's tools/cr/flinkapplication-spec.yaml (apispec-v1.yml declares FlinkApplication spec as opaque). flinkEnvironment is intentionally CFK-only: CMF treats it as a path-param at the REST layer ([CF-592]), so the upstream spec doesn't carry it as a body field. Like the sibling Flink day-2 CRs, flinkEnvironment is immutable once set: re-pointing an application at a different CMF environment is not supported.

object (io.confluent.platform.api.v1beta1.FlinkApplicationStatus)

FlinkApplicationStatus defines the observed state of FlinkApplication.

observedGeneration is excluded from the embedded autogen (upstream emits it as *int, but every other CFK CR uses int64); the wrapper keeps the CFK-standard form.

apiVersion: platform.confluent.io/v1beta1 kind: FlinkApplication metadata: labels: app.kubernetes.io/name: confluent-for-kubernetes app.kubernetes.io/managed-by: kustomize name: flinkapplication-sample spec: # TODO(user): Add fields here

FlinkComputePool

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.FlinkComputePoolSpec)

FlinkComputePoolSpec defines the desired state of FlinkComputePool.

XValidation rules live at the struct level rather than on individual fields: spec.type is defined on the embedded autogen struct which we cannot annotate without violating the no-autogen-edits rule, so for symmetry we keep all wrapper-level rules here too.

object (io.confluent.platform.api.v1beta1.FlinkComputePoolStatus)

FlinkComputePoolStatus defines the observed state of FlinkComputePool.

"$v1beta1/flinkcomputepool"

FlinkEnvironment

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.FlinkEnvironmentSpec)

FlinkEnvironmentSpec defines the desired state of FlinkEnvironment.

The embedded FlinkEnvironmentAutogenSpec is mirrored from the CMF Environment schema by build/flink-sql-types/. The kubernetesNamespace immutability check is applied as a struct-level CEL rule because the field lives on the embedded autogen struct and field-level markers can't be attached to embedded members from the wrapper.

object (io.confluent.platform.api.v1beta1.FlinkEnvironmentStatus)

FlinkEnvironmentStatus defines the observed state of FlinkEnvironment.

Wraps the CMF-mirrored FlinkEnvironmentAutogenStatus with CFK-owned status fields (cmfSync, cfkInternalState, conditions, observedGeneration).

apiVersion: platform.confluent.io/v1beta1 kind: FlinkEnvironment metadata: labels: app.kubernetes.io/name: confluent-for-kubernetes app.kubernetes.io/managed-by: kustomize name: flinkenvironment-sample spec: # TODO(user): Add fields here

FlinkEnvironmentSecretMapping

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.FlinkEnvironmentSecretMappingSpec)

FlinkEnvironmentSecretMappingSpec defines the desired state of FlinkEnvironmentSecretMapping. The CFK CR's metadata.name is used as the CMF-side connection-secret-id (the value Flink statements reference); SecretRef points at the FlinkSecret CR whose CMF-side payload is the source of credentials. Inlines FlinkEnvironmentSecretMappingAutogenSpec so future CMF-side spec additions surface automatically; today the autogen adds only secretName, which the executor sets from the resolved SecretRef.

object (io.confluent.platform.api.v1beta1.FlinkEnvironmentSecretMappingStatus)

FlinkEnvironmentSecretMappingStatus defines the observed state of FlinkEnvironmentSecretMapping.

"$v1beta1/flinkenvironmentsecretmapping"

FlinkKafkaCatalog

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.FlinkKafkaCatalogSpec)

FlinkKafkaCatalogSpec defines the desired state of FlinkKafkaCatalog.

object (io.confluent.platform.api.v1beta1.FlinkKafkaCatalogStatus)

FlinkKafkaCatalogStatus defines the observed state of FlinkKafkaCatalog.

"$v1beta1/flinkkafkacatalog"

FlinkKafkaDatabase

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.FlinkKafkaDatabaseSpec)

FlinkKafkaDatabaseSpec defines the desired state of FlinkKafkaDatabase.

object (io.confluent.platform.api.v1beta1.FlinkKafkaDatabaseStatus)

FlinkKafkaDatabaseStatus defines the observed state of FlinkKafkaDatabase.

"$v1beta1/flinkkafkadatabase"

FlinkSecret

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.FlinkSecretSpec)

FlinkSecretSpec defines the desired state of FlinkSecret.

object (io.confluent.platform.api.v1beta1.FlinkSecretStatus)

FlinkSecretStatus defines the observed state of FlinkSecret.

"$v1beta1/flinksecret"

FlinkStatement

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.FlinkStatementSpec)

FlinkStatementSpec defines the desired state of FlinkStatement.

The autogen StatementSpec is inlined here via json:",inline" (same pattern as FlinkApplicationSpec / FlinkApplicationAutogenSpec) so the CFK CR mirrors the CMF Statement REST shape one-for-one.

spec.statement is immutable after the resource has been admitted: once the statement has been seen by CMF its plan and state cannot be re-parsed in place. The CEL rule is attached at the spec level (rather than on the inlined embedded field) because controller-gen flattens the embedded struct into the spec schema, so field-level markers on the embed do not survive.

object (io.confluent.platform.api.v1beta1.FlinkStatementStatus)

FlinkStatementStatus defines the observed state of FlinkStatement.

"$v1beta1/flinkstatement"

Gateway

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.GatewaySpec)

GatewaySpec defines the desired state of Gateway.

object (io.confluent.platform.api.v1beta1.GatewayStatus)

GatewayStatus defines the observed state of Gateway

"$v1beta1/gateway"

KafkaRestClass

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

required
object (io.confluent.platform.api.v1beta1.KafkaRestClassSpec)

KafkaRestClassSpec defines the client configurations to access Kafka Rest API. This resource is referenced by other CFK resources to access Kafka Rest APIs.

object (io.confluent.platform.api.v1beta1.KafkaRestClassStatus)

KafkaRestClassStatus defines the observed state of the KafkaRestClass.

apiVersion: platform.confluent.io/v1beta1 kind: KafkaRestClass metadata: name: krc-example namespace: confluent spec: kafkaClusterRef: name: kafka namespace: confluent kafkaRest: authentication: type: bearer bearer: secretRef: rest-credential-example

KafkaRestProxy

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

required
object (io.confluent.platform.api.v1beta1.KafkaRestProxySpec)

KafkaRestProxySpec defines the desired state of the KafkaRestProxy cluster.

object (io.confluent.platform.api.v1beta1.KafkaRestProxyStatus)

KafkaRestProxyStatus defines the observed state of the KafkaRestProxy.

apiVersion: platform.confluent.io/v1beta1 kind: KafkaRestProxy metadata: name: krp-example namespace: confluent spec: image: application: confluentinc/cp-kafka-rest init: confluentinc/confluent-init-container replicas: 3 tls: autoGeneratedCerts: true dependencies: kafka: bootstrapEndpoint: kafka.confluent.svc.cluster.local:9071 authentication: type: plain jaasConfig: secretRef: credential-example tls: enabled: true

Kafka

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

required
object (io.confluent.platform.api.v1beta1.KafkaSpec)

KafkaSpec defines the desired state of the Kafka cluster.

object (io.confluent.platform.api.v1beta1.KafkaStatus)

KafkaStatus defines the observed state of the Kafka cluster.

apiVersion: platform.confluent.io/v1beta1 kind: Kafka metadata: name: kafka-example namespace: confluent spec: replicas: 3 image: application: confluentinc/cp-server init: confluentinc/confluent-init-container dataVolumeCapacity: 10Gi tls: autoGeneratedCerts: true listeners: internal: authentication: type: plain jaasConfig: secretRef: credential-example tls: enabled: true dependencies: zookeeper: endpoint: zookeeper.confluent.svc.cluster.local:2181

KafkaTopic

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

object (io.confluent.platform.api.v1beta1.KafkaTopicSpec)

KafkaTopicSpec defines the desired state of the KafkaTopic application resource. More info: https://docs.confluent.io/operator/current/co-manage-topics.html

object (io.confluent.platform.api.v1beta1.KafkaTopicStatus)

KafkaTopicStatus defines the observed state of the KafkaTopic.

apiVersion: platform.confluent.io/v1beta1 kind: KafkaTopic metadata: name: topic-example namespace: confluent spec: replicas: 1 partitionCount: 12 kafkaClusterRef: name: kafka namespace: confluent configs: cleanup.policy: "compact"

KRaftController

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

required
object (io.confluent.platform.api.v1beta1.KRaftControllerSpec)

KRaftControllerSpec defines the desired state of the KRaft Controller cluster.

object (io.confluent.platform.api.v1beta1.KRaftControllerStatus)

KRaftControllerStatus defines the observed state of the KRaft Controller cluster.

apiVersion: platform.confluent.io/v1beta1 kind: KRaftController metadata: name: kraftcontroller-example namespace: confluent spec: dataVolumeCapacity: 10G image: application: confluentinc/cp-server init: confluentinc/confluent-init-container listeners: controller: tls: enabled: true authentication: type: plain jaasConfig: secretRef: credential tls: autoGeneratedCerts: true replicas: 3

KRaftMigrationJob

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

required
object (io.confluent.platform.api.v1beta1.KRaftMigrationJobSpec)

KRaftMigrationJobSpec defines the desired state of the KRaftMigrationJob.

object (io.confluent.platform.api.v1beta1.KRaftMigrationJobStatus)

KRaftMigrationJobStatus defines the observed state of the KRaftMigrationJob.

apiVersion: platform.confluent.io/v1beta1 kind: KRaftMigrationJob metadata: name: kraft-migration-job namespace: confluent spec: dependencies: kafka: name: kafka namespace: confluent zookeeper: name: zookeeper namespace: confluent kRaftController: name: kraftcontroller namespace: confluent

KsqlDB

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

required
object (io.confluent.platform.api.v1beta1.KsqlDBSpec)

KsqlDBSpec defines the desired state of the ksqlDB cluster.

object (io.confluent.platform.api.v1beta1.KsqlDBStatus)

KsqlDBStatus defines the observed state of the ksqlDB cluster.

apiVersion: platform.confluent.io/v1beta1 kind: KsqlDB metadata: name: ksqldb-example namespace: confluent spec: replicas: 2 image: application: confluentinc/cp-ksqldb-server init: confluentinc/confluent-init-container dataVolumeCapacity: 10Gi tls: autoGeneratedCerts: true authentication: type: basic basic: secretRef: ksqldb-basic-example dependencies: kafka: bootstrapEndpoint: kafka.confluent.svc.cluster.local:9071 authentication: type: plain jaasConfig: secretRef: credential-example tls: enabled: true

SchemaExporter

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

object (io.confluent.platform.api.v1beta1.SchemaExporterSpec)

SchemaExporterSpec specifies the desired state of the SchemaExporter application resource.

object (io.confluent.platform.api.v1beta1.SchemaExporterStatus)

SchemaExporterStatus defines the observed state of the schema exporter.

apiVersion: platform.confluent.io/v1beta1 kind: SchemaExporter metadata: name: schemaexporter-example namespace: confluent spec: sourceCluster: schemaRegistryClusterRef: name: schemaregistry namespace: source destinationCluster: schemaRegistryClusterRef: name: schemaregistry namespace: destination contextName: mycustom

SchemaImporter

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

object (io.confluent.platform.api.v1beta1.SchemaImporterSpec)

SchemaImporterSpec specifies the desired state of the SchemaImporter application resource.

object (io.confluent.platform.api.v1beta1.SchemaImporterStatus)

SchemaImporterStatus defines the observed state of the schema importer.

"$v1beta1/schemaimporter"

SchemaRegistry

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

required
object (io.confluent.platform.api.v1beta1.SchemaRegistrySpec)

SchemaRegistrySpec defines the desired state of the Schema Registry cluster.

object (io.confluent.platform.api.v1beta1.SchemaRegistryStatus)

SchemaRegistryStatus defines the observed state of the Schema Registry cluster.

apiVersion: platform.confluent.io/v1beta1 kind: SchemaRegistry metadata: name: schemaregistry-example namespace: confluent spec: replicas: 1 image: application: confluentinc/cp-schema-registry init: confluentinc/confluent-init-container tls: autoGeneratedCerts: true dependencies: kafka: bootstrapEndpoint: kafka.confluent.svc.cluster.local:9071 authentication: type: plain jaasConfig: secretRef: credential-example tls: enabled: true

Schema

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

required
object (io.confluent.platform.api.v1beta1.SchemaSpec)

SchemaSpec specifies the desired state of the Schema application resource. More info: https://docs.confluent.io/operator/current/co-manage-schemas.html

object (io.confluent.platform.api.v1beta1.SchemaStatus)

SchemaStatus defines the observed state of the Schema.

apiVersion: v1 kind: ConfigMap metadata: name: schema-config namespace: confluent data: schema: | { "namespace": "io.confluent.examples.clients.basicavro", "type": "record", "name": "Payment", "fields": [ {"name": "id", "type": "string"} ] } --- apiVersion: platform.confluent.io/v1beta1 kind: Schema metadata: name: schema-example namespace: confluent spec: data: format: avro configRef: schema-config

USMAgent

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

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (io.confluent.platform.api.v1beta1.USMAgentSpec)

USMAgentSpec defines the desired state of USMAgent

object (io.confluent.platform.api.v1beta1.USMAgentStatus)

USMAgentStatus defines the observed state of USMAgent

"$v1beta1/usmagent"

Zookeeper

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

required
object (io.confluent.platform.api.v1beta1.ZookeeperSpec)

ZookeeperSpec defines the desired state of the Zookeeper cluster.

object (io.confluent.platform.api.v1beta1.ZookeeperStatus)

ZookeeperStatus defines the observed state of the Zookeeper cluster.

"$v1beta1/zookeeper"