Confluent for Kubernetes Blueprints Apps API Reference (latest)

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.cpc.api.apps.v1beta1.ClusterLinkSpec) ClusterLinkSpec defines the desired state of ClusterLink application resource.
	object (io.confluent.platform.cpc.api.apps.v1beta1.ClusterLinkStatus) ClusterLinkStatus defines the observed state of ClusterLink

apiVersion: apps.cpc.platform.confluent.io/v1beta1
kind: ClusterLink
metadata:
  name: clusterlink-example
spec:
  destination:
    kafkaClusterRef:
      name: kafka-destination
  source:
    kafkaClusterRef:
      name: kafka-source

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.cpc.api.apps.v1beta1.ConfluentRolebindingSpec) ConfluentRolebindingSpec defines the desired state of ConfluentRolebinding
	object (io.confluent.platform.cpc.api.apps.v1beta1.ConfluentRolebindingStatus) ConfluentRolebindingStatus defines the observed state of ConfluentRolebinding

apiVersion: apps.cpc.platform.confluent.io/v1beta1
kind: ConfluentRolebinding
metadata:
  name: confluentrolebinding-example
spec:
  principal:
    type: user
    name: kafka
  role: SystemAdmin
  kafkaClusterRef:
    name: kafka

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.cpc.api.apps.v1beta1.ConnectorSpec) ConnectorSpec defines the desired state of Connector application resource.
	object (io.confluent.platform.cpc.api.apps.v1beta1.ConnectorStatus) ConnectorStatus defines the observed state of Connector.

apiVersion: apps.cpc.platform.confluent.io/v1beta1
kind: Connector
metadata:
  name: datagen-connector-example
spec:
  connectClusterRef:
    name: connect
  connectorConfigs:
    class: "io.confluent.kafka.connect.datagen.DatagenConnector"
    taskMax: 4
    configs:
      kafka.topic: "pageviews"
      quickstart: "pageviews"
      key.converter: "org.apache.kafka.connect.storage.StringConverter"
      value.converter: "org.apache.kafka.connect.json.JsonConverter"
      value.converter.schemas.enable: "false"
      max.interval: "100"
      iterations: "10000000"

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
required	object (io.confluent.platform.cpc.api.apps.v1beta1.KafkaTopicSpec) KafkaTopicSpec defines the desired state of KafkaTopic application resource.
	object (io.confluent.platform.cpc.api.apps.v1beta1.KafkaTopicStatus) KafkaTopicStatus defines the observed state of KafkaTopic

apiVersion: apps.cpc.platform.confluent.io/v1beta1
kind: KafkaTopic
metadata:
  name: topic-example
spec:
  kafkaClusterRefs:
    - name: kafka
    - name: kafka-other
  parameters:
    replicationFactor: 1
    partitions: 12

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
required	object (io.confluent.platform.cpc.api.apps.v1beta1.SchemaExporterSpec) SchemaExporterSpec defines the desired state of SchemaExporter application resource.
	object (io.confluent.platform.cpc.api.apps.v1beta1.SchemaExporterStatus) SchemaExporterStatus defines the observed state of SchemaExporter

apiVersion: apps.cpc.platform.confluent.io/v1beta1
kind: SchemaExporter
metadata:
  name: schema-exporter-example
spec:
  source:
    schemaRegistryClusterRef:
      name: schemaregistry-source
  destination:
    schemaRegistryClusterRef:
      name: schemaregistry-destination
  contextName: mycustom

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.cpc.api.apps.v1beta1.SchemaSpec) SchemaSpec defines the desired state of Schema
	object (io.confluent.platform.cpc.api.apps.v1beta1.SchemaStatus) SchemaStatus defines the observed state of Schema

apiVersion: apps.cpc.platform.confluent.io/v1beta1
kind: Schema
metadata:
  name: schema-example
spec:
  data:
    format: avro
    configRef: schema-config
  schemaRegistryClusterRef:
    name: schemaregistry