Confluent for Kubernetes Blueprints Core API Reference (2.7)

Download OpenAPI specification:Download

CertificateStoreConfig

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.core.v1beta1.CertificateStoreConfigSpec) CertificateStoreConfigSpec defines the desired state of CertificateStoreConfig resource.
	object (io.confluent.platform.cpc.api.core.v1beta1.CertificateStoreConfigStatus) CertificateStoreConfigStatus defines the observed state of CertificateStoreConfig

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: CertificateStoreConfig
metadata:
  name: certificatestoreconfig-example
spec:
  sourceType: kubernetes
  kubernetes:
    type: secret
    secret:
      name: secret-example

ConfluentCloudSet

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.core.v1beta1.ConfluentCloudSetSpec) ConfluentCloudSetSpec defines the desired state of ConfluentCloudSet
	object (io.confluent.platform.cpc.api.core.v1beta1.ConfluentCloudSetStatus) ConfluentCloudSetStatus defines the observed state of ConfluentCloudSet

ConfluentPlatformBlueprint

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.core.v1beta1.ConfluentPlatformBlueprintSpec) ConfluentPlatformBlueprintSpec defines the desired state of ConfluentPlatformBlueprint resource.
	object (io.confluent.platform.cpc.api.core.v1beta1.ConfluentPlatformBlueprintStatus) ConfluentPlatformBlueprintStatus defines the observed state of ConfluentPlatformBlueprint

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: ConfluentPlatformBlueprint
metadata:
  name: blueprint-example
spec:
  dockerImages:
    - registry: docker.io
  confluentPlatform:
    version: 7.4.0
  components:
    connectCluster:
      classRef:
        name: ccc-example
    controlCenterCluster:
      classRef:
        name: c3cc-example
    kafkaCluster:
      classRef:
        name: kcc-example
    kafkaRestProxyCluster:
      classRef:
        name: krpc-example
    ksqlDBCluster:
      classRef:
        name: ksqldbcc-example
    schemaRegistryCluster:
      classRef:
        name: srcc-example
    zookeeperCluster:
      classRef:
        name: zkcc-example

ConnectClusterClass

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.core.v1beta1.ConnectClusterClassSpec) ConnectClusterClassSpec defines the desired state of ConnectClusterClass

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: ConnectClusterClass
metadata:
  name: ccc-example
spec:
  provisioner:
    type: cfk
    cfk:
      replicas: 3
      k8s:
        podTemplate:
          resources:
            requests:
              cpu: "1"
              memory: "2Gi"
            limits:
              cpu: "2"
              memory: "4Gi"
      connectorPlugins:
        confluentHubPlugins:
          - name: kafka-connect-datagen
            owner: confluentinc
            version: 0.5.2

ControlCenterClusterClass

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.core.v1beta1.ControlCenterClusterClassSpec) ControlCenterClusterClassSpec defines the desired state of ControlCenterClusterClass

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: ControlCenterClusterClass
metadata:
  name: c3cc-example
spec:
  provisioner:
    type: cfk
    cfk:
      replicas: 1
      volume:
        data:
          capacity: 10Gi

CPCHealthCheck

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.cpc.api.core.v1beta1.CPCHealthCheckSpec) CPCHealthCheckSpec defines the desired state of CPCHealthCheck
	object (io.confluent.platform.cpc.api.core.v1beta1.CPCHealthCheckStatus) CPCHealthCheckStatus defines the observed state of CPCHealthCheck

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: CPCHealthCheck
metadata:
  name: cpchealthcheck-example
spec:
  k8sClusterRef:
    name: k8scluster-example

CredentialStoreConfig

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.core.v1beta1.CredentialStoreConfigSpec) CredentialStoreConfigSpec defines the desired state of CredentialStoreConfig
	object (io.confluent.platform.cpc.api.core.v1beta1.CredentialStoreConfigStatus) CredentialStoreConfigStatus defines the observed state of CredentialStoreConfig

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: CredentialStoreConfig
metadata:
  name: credentialstoreconfig-example
spec:
  kubernetes:
    secret:
      name: secret-example
    type: secret
  sourceType: kubernetes

KafkaClusterClass

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.core.v1beta1.KafkaClusterClassSpec) KafkaClusterClassSpec defines the desired state of KafkaClusterClass

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: KafkaClusterClass
metadata:
  name: kcc-example
spec:
  provisioner:
    type: cfk
    cfk:
      replicas: 3
      volume:
        data:
          capacity: 10Gi

KafkaRestProxyClusterClass

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.core.v1beta1.KafkaRestProxyClusterClassSpec) KafkaRestProxyClusterClassSpec defines the desired state of KafkaRestProxyClusterClass

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: KafkaRestProxyClusterClass
metadata:
  name: krpc-example
spec:
  provisioner:
    type: cfk
    cfk:
      replicas: 3

KsqlDBClusterClass

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.core.v1beta1.KsqlDBClusterClassSpec) KsqlDBClusterClassSpec defines the desired state of KsqlDBClusterClass

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: KsqlDBClusterClass
metadata:
  name: ksqldbcc-example
spec:
  provisioner:
    type: cfk
    cfk:
      replicas: 3
      volume:
        data:
          capacity: 10Gi

KubernetesCluster

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.
required	object (io.confluent.platform.cpc.api.core.v1beta1.KubernetesClusterSpec) KubernetesClusterSpec defines the desired state of KubernetesCluster
	object (io.confluent.platform.cpc.api.core.v1beta1.KubernetesClusterStatus) KubernetesClusterStatus defines the observed state of KubernetesCluster

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: KubernetesCluster
metadata:
  name: k8scluster-example
spec:
  k8sID: k8sId
  topology:
    region: us-central1
    zones:
      - us-central1-a
      - us-central1-b
      - us-central1-c
  k8sClusterDomain: cluster.local

SchemaRegistryClusterClass

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.core.v1beta1.SchemaRegistryClusterClassSpec) SchemaRegistryClusterClassSpec defines the desired state of SchemaRegistryClusterClass

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: SchemaRegistryClusterClass
metadata:
  name: srcc-example
spec:
  provisioner:
    type: cfk
    cfk:
      replicas: 3
      enableSchemaExporter: true

ZookeeperClusterClass

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.core.v1beta1.ZookeeperClusterClassSpec) ZookeeperClusterClassSpec defines the desired state of ZookeeperClusterClass

apiVersion: core.cpc.platform.confluent.io/v1beta1
kind: ZookeeperClusterClass
metadata:
  name: zkcc-example
spec:
  provisioner:
    type: cfk
    cfk:
      replicas: 3
      volume:
        data:
          capacity: 10Gi
        log:
          capacity: 10Gi