Confluent for Kubernetes API Reference (2.9)

Download OpenAPI specification:Download

ClusterLink

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.ClusterLinkSpec) ClusterLinkSpec defines the desired state of the ClusterLink application resource. More info: https://docs.confluent.io/operator/current/co-link-clusters.html
	object (io.confluent.platform.api.v1beta1.ClusterLinkStatus) ClusterLinkStatus defines the observed state of the cluster link.

apiVersion: platform.confluent.io/v1beta1
kind: ClusterLink
metadata:
  name: clusterlink-example
  namespace: confluent
spec:
  destinationKafkaCluster:
    kafkaRestClassRef:
      name: krc-example
  sourceKafkaCluster:
    bootstrapEndpoint: example.com:9092
    clusterID: test_kafka_cluster_id
  consumerGroupFilters:
    - name: filter-example
      patternType: LITERAL
      filterType: INCLUDE
  aclFilters:
      - resourceFilter:
          resourceType: topic
          name: coffee
          patternType: prefixed
        accessFilter:
          principal: User:Bob
          host: example.com
          operation: read
          permissionType: allow
  configs:
    connections.max.idle.ms: "620000"

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-example
  namespace: confluent
spec:
  replicas: 1
  image:
    application: confluentinc/cp-enterprise-control-center
    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

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

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

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.

apiVersion: platform.confluent.io/v1beta1
kind: Zookeeper
metadata:
  name: zookeeper-example
  namespace: confluent
spec:
  replicas: 3
  image:
    application: confluentinc/cp-zookeeper
    init: confluentinc/confluent-init-container
  dataVolumeCapacity: 10Gi
  logVolumeCapacity: 10Gi