Broker

v1alpha1

Auto generated from CRD spec

Version: v1alpha1

Namespace: pulsar.oss.datastax.com

Broker

Field

Description

spec

Spec

status

Status

Spec

Complete namespace: Broker.Spec

Field

Description

broker

Broker

global

Global

Broker

Complete namespace: Broker.Spec.Broker

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker: {}

Field

Description

additionalVolumes

AdditionalVolumes

annotations

[]key/value

Annotations to add to each resource (except pods).

antiAffinity

AntiAffinity

autoscaler

Autoscaler

config

any

Configuration.

env

[]Env

Additional container env variables.

functionsWorkerEnabled

boolean

Enable functions worker embedded in the broker.

gracePeriod

integer

Termination grace period in seconds.

image

string

Override Pulsar image.

imagePullPolicy

string

Override image pull policy.

imagePullSecrets

[]ImagePullSecrets

Image pull secrets.

initContainers

[]InitContainers

Init containers

kafka

Kafka

labels

[]key/value

Labels to add to each resource (except pods).

matchLabels

[]key/value

Match labels selectors to add to each pod.

nodeAffinity

NodeAffinity

nodeSelectors

[]key/value

Additional node selectors.

overrideResourceName

string

Override the resource names generated by the operator.

pdb

Pdb

podAnnotations

[]key/value

Annotations to add to pod.

podLabels

[]key/value

Labels to add to each pod.

podManagementPolicy

string

Pod management policy.

probes

Probes

replicas

integer

Number of desired replicas.

resources

Resources

service

Service

serviceAccountName

string

Service account name for the Broker StatefulSet.

sets

[]

Broker sets.

setsUpdateStrategy

string

Sets update strategy. 'RollingUpdate' or 'Parallel'. Default is 'RollingUpdate'.

sidecars

[]Sidecars

Sidecar containers

tolerations

[]Tolerations

Pod tolerations.

transactions

Transactions

updateStrategy

UpdateStrategy

Additionalvolumes

Complete namespace: Broker.Spec.Broker.Additionalvolumes

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes: {}

Field

Description

mounts

[]Mounts

Mount points for the additional volumes

volumes

[]Volumes

Additional volumes to be mounted to the pod

Mounts

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Mounts

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      mounts: {}

Field

Description

mountPath

string

mountPropagation

string

name

string

readOnly

boolean

subPath

string

subPathExpr

string

Volumes

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes: {}

Field

Description

awsElasticBlockStore

AwsElasticBlockStore

azureDisk

AzureDisk

azureFile

AzureFile

cephfs

Cephfs

cinder

Cinder

configMap

ConfigMap

csi

Csi

downwardAPI

DownwardAPI

emptyDir

EmptyDir

ephemeral

Ephemeral

fc

Fc

flexVolume

FlexVolume

flocker

Flocker

gcePersistentDisk

GcePersistentDisk

gitRepo

GitRepo

glusterfs

Glusterfs

hostPath

HostPath

iscsi

Iscsi

name

string

nfs

Nfs

persistentVolumeClaim

PersistentVolumeClaim

photonPersistentDisk

PhotonPersistentDisk

portworxVolume

PortworxVolume

projected

Projected

quobyte

Quobyte

rbd

Rbd

scaleIO

ScaleIO

secret

Secret

storageos

Storageos

vsphereVolume

VsphereVolume

Awselasticblockstore

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Awselasticblockstore

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        awselasticblockstore: {}

Field

Description

fsType

string

partition

integer

readOnly

boolean

volumeID

string

Azuredisk

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Azuredisk

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        azuredisk: {}

Field

Description

cachingMode

string

diskName

string

diskURI

string

fsType

string

kind

string

readOnly

boolean

Azurefile

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Azurefile

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        azurefile: {}

Field

Description

readOnly

boolean

secretName

string

shareName

string

Cephfs

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Cephfs

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        cephfs: {}

Field

Description

monitors

[]

string

path

string

readOnly

boolean

secretFile

string

secretRef

SecretRef

user

string

Secretref

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Cephfs.Secretref

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        cephfs:
          secretref: {}

Field

Description

name

string

Cinder

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Cinder

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        cinder: {}

Field

Description

fsType

string

readOnly

boolean

secretRef

SecretRef

volumeID

string

Configmap

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Configmap

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        configmap: {}

Field

Description

defaultMode

integer

items

[]Items

name

string

optional

boolean

Items

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Configmap.Items

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        configmap:
          items: {}

Field

Description

key

string

mode

integer

path

string

Csi

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Csi

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        csi: {}

Field

Description

driver

string

fsType

string

nodePublishSecretRef

NodePublishSecretRef

readOnly

boolean

volumeAttributes

[]key/value

Downwardapi

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Downwardapi

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        downwardapi: {}

Field

Description

defaultMode

integer

items

[]Items

Items

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Downwardapi.Items

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        downwardapi:
          items: {}

Field

Description

fieldRef

FieldRef

mode

integer

path

string

resourceFieldRef

ResourceFieldRef

Fieldref

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Downwardapi.Items.Fieldref

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        downwardapi:
          items:
            fieldref: {}

Field

Description

apiVersion

string

fieldPath

string

Resourcefieldref

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Downwardapi.Items.Resourcefieldref

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        downwardapi:
          items:
            resourcefieldref: {}

Field

Description

containerName

string

divisor

integer or string

resource

string

Emptydir

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Emptydir

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        emptydir: {}

Field

Description

medium

string

sizeLimit

integer or string

Ephemeral

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral: {}

Field

Description

volumeClaimTemplate

VolumeClaimTemplate

Volumeclaimtemplate

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate: {}

Field

Description

metadata

Metadata

spec

Spec

Metadata

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Metadata

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate:
            metadata: {}

Managedfields

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Metadata.Managedfields

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate:
            metadata:
              managedfields: {}

Field

Description

apiVersion

string

fieldsType

string

fieldsV1

manager

string

operation

string

subresource

string

time

string

Ownerreferences

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Metadata.Ownerreferences

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate:
            metadata:
              ownerreferences: {}

Field

Description

apiVersion

string

blockOwnerDeletion

boolean

controller

boolean

kind

string

name

string

uid

string

Spec

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate:
            spec: {}

Field

Description

accessModes

[]

string

dataSource

DataSource

dataSourceRef

DataSourceRef

resources

Resources

selector

Selector

storageClassName

string

volumeMode

string

volumeName

string

Datasource

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec.Datasource

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate:
            spec:
              datasource: {}

Field

Description

apiGroup

string

kind

string

name

string

Resources

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec.Resources

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate:
            spec:
              resources: {}

Field

Description

limits

[]

integer or string

requests

[]

integer or string

Selector

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec.Selector

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate:
            spec:
              selector: {}

Field

Description

matchExpressions

[]MatchExpressions

matchLabels

[]key/value

Matchexpressions

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec.Selector.Matchexpressions

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        ephemeral:
          volumeclaimtemplate:
            spec:
              selector:
                matchexpressions: {}

Field

Description

key

string

operator

string

values

[]

string

Fc

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Fc

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        fc: {}

Field

Description

fsType

string

lun

integer

readOnly

boolean

targetWWNs

[]

string

wwids

[]

string

Flexvolume

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Flexvolume

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        flexvolume: {}

Field

Description

driver

string

fsType

string

options

[]key/value

readOnly

boolean

secretRef

SecretRef

Flocker

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Flocker

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        flocker: {}

Field

Description

datasetName

string

datasetUUID

string

Gcepersistentdisk

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Gcepersistentdisk

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        gcepersistentdisk: {}

Field

Description

fsType

string

partition

integer

pdName

string

readOnly

boolean

Gitrepo

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Gitrepo

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        gitrepo: {}

Field

Description

directory

string

repository

string

revision

string

Glusterfs

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Glusterfs

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        glusterfs: {}

Field

Description

endpoints

string

path

string

readOnly

boolean

Hostpath

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Hostpath

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        hostpath: {}

Field

Description

path

string

type

string

Iscsi

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Iscsi

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        iscsi: {}

Field

Description

chapAuthDiscovery

boolean

chapAuthSession

boolean

fsType

string

initiatorName

string

iqn

string

iscsiInterface

string

lun

integer

portals

[]

string

readOnly

boolean

secretRef

SecretRef

targetPortal

string

Nfs

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Nfs

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        nfs: {}

Field

Description

path

string

readOnly

boolean

server

string

Persistentvolumeclaim

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Persistentvolumeclaim

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        persistentvolumeclaim: {}

Field

Description

claimName

string

readOnly

boolean

Photonpersistentdisk

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Photonpersistentdisk

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        photonpersistentdisk: {}

Field

Description

fsType

string

pdID

string

Portworxvolume

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Portworxvolume

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        portworxvolume: {}

Field

Description

fsType

string

readOnly

boolean

volumeID

string

Projected

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Projected

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        projected: {}

Field

Description

defaultMode

integer

sources

[]Sources

Sources

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Projected.Sources

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        projected:
          sources: {}

Field

Description

configMap

ConfigMap

downwardAPI

DownwardAPI

secret

Secret

serviceAccountToken

ServiceAccountToken

Configmap

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Projected.Sources.Configmap

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        projected:
          sources:
            configmap: {}

Field

Description

items

[]Items

name

string

optional

boolean

Downwardapi

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Projected.Sources.Downwardapi

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        projected:
          sources:
            downwardapi: {}

Field

Description

items

[]Items

Serviceaccounttoken

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Projected.Sources.Serviceaccounttoken

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        projected:
          sources:
            serviceaccounttoken: {}

Field

Description

audience

string

expirationSeconds

integer

path

string

Quobyte

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Quobyte

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        quobyte: {}

Field

Description

group

string

readOnly

boolean

registry

string

tenant

string

user

string

volume

string

Rbd

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Rbd

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        rbd: {}

Field

Description

fsType

string

image

string

keyring

string

monitors

[]

string

pool

string

readOnly

boolean

secretRef

SecretRef

user

string

Scaleio

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Scaleio

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        scaleio: {}

Field

Description

fsType

string

gateway

string

protectionDomain

string

readOnly

boolean

secretRef

SecretRef

sslEnabled

boolean

storageMode

string

storagePool

string

system

string

volumeName

string

Secret

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Secret

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        secret: {}

Field

Description

defaultMode

integer

items

[]Items

optional

boolean

secretName

string

Storageos

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Storageos

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        storageos: {}

Field

Description

fsType

string

readOnly

boolean

secretRef

SecretRef

volumeName

string

volumeNamespace

string

Vspherevolume

Complete namespace: Broker.Spec.Broker.Additionalvolumes.Volumes.Vspherevolume

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    additionalvolumes:
      volumes:
        vspherevolume: {}

Field

Description

fsType

string

storagePolicyID

string

storagePolicyName

string

volumePath

string

Antiaffinity

Complete namespace: Broker.Spec.Broker.Antiaffinity

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    antiaffinity: {}

Field

Description

host

Host

zone

Zone

Host

Complete namespace: Broker.Spec.Broker.Antiaffinity.Host

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    antiaffinity:
      host: {}

Field

Description

enabled

boolean

Indicates the reclaimPolicy property for the StorageClass.

required

boolean

Indicates the reclaimPolicy property for the StorageClass.

Zone

Complete namespace: Broker.Spec.Broker.Antiaffinity.Zone

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    antiaffinity:
      zone: {}

Field

Description

enabled

boolean

Indicates the reclaimPolicy property for the StorageClass.

required

boolean

Indicates the reclaimPolicy property for the StorageClass.

Autoscaler

Complete namespace: Broker.Spec.Broker.Autoscaler

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    autoscaler: {}

Field

Description

enabled

boolean

Enable autoscaling for brokers.

higherCpuThreshold

bigdecimal

The threshold to trigger a scale up. The autoscaler will scale up if all the brokers cpu usage is higher than this threshold. Default is '0.8'

lowerCpuThreshold

bigdecimal

The threshold to trigger a scale down. The autoscaler will scale down if all the brokers cpu usage is lower than this threshold. Default is '0.4'

max

integer

Max number of brokers. If the number of brokers is equals to this value, the autoscaler will never scale up.

min

integer

Min number of brokers. If the number of brokers is equals to this value, the autoscaler will never scale down.

periodMs

integer

The interval in milliseconds between two consecutive autoscaling checks.

resourcesUsageSource

string

Source for getting the brokers resources usage. Possible values are 'PulsarLBReport' and 'K8SMetrics'. Default is 'PulsarLBReport'

scaleDownBy

integer

The number of brokers to remove at each scale down. Default is '1'

scaleUpBy

integer

The number of brokers to add at each scale up. Default is '1'

stabilizationWindowMs

integer

The stabilization window is used to restrict the flapping of replica count when the metrics used for scaling keep fluctuating. The autoscaling algorithm uses this window to infer a previous desired state and avoid unwanted changes to workload scale.Default value is 5 minutes after the pod readiness.

Env

Complete namespace: Broker.Spec.Broker.Env

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    env: {}

Field

Description

name

string

value

string

valueFrom

ValueFrom

Valuefrom

Complete namespace: Broker.Spec.Broker.Env.Valuefrom

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    env:
      valuefrom: {}

Field

Description

configMapKeyRef

ConfigMapKeyRef

fieldRef

FieldRef

resourceFieldRef

ResourceFieldRef

secretKeyRef

SecretKeyRef

Configmapkeyref

Complete namespace: Broker.Spec.Broker.Env.Valuefrom.Configmapkeyref

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    env:
      valuefrom:
        configmapkeyref: {}

Field

Description

key

string

name

string

optional

boolean

Initcontainers

Complete namespace: Broker.Spec.Broker.Initcontainers

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers: {}

Field

Description

args

[]

string

command

[]

string

env

[]Env

envFrom

[]EnvFrom

image

string

imagePullPolicy

string

lifecycle

Lifecycle

livenessProbe

LivenessProbe

name

string

ports

[]Ports

readinessProbe

ReadinessProbe

resources

Resources

securityContext

SecurityContext

startupProbe

StartupProbe

stdin

boolean

stdinOnce

boolean

terminationMessagePath

string

terminationMessagePolicy

string

tty

boolean

volumeDevices

[]VolumeDevices

volumeMounts

[]VolumeMounts

workingDir

string

Envfrom

Complete namespace: Broker.Spec.Broker.Initcontainers.Envfrom

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      envfrom: {}

Field

Description

configMapRef

ConfigMapRef

prefix

string

secretRef

SecretRef

Configmapref

Complete namespace: Broker.Spec.Broker.Initcontainers.Envfrom.Configmapref

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      envfrom:
        configmapref: {}

Field

Description

name

string

optional

boolean

Lifecycle

Complete namespace: Broker.Spec.Broker.Initcontainers.Lifecycle

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      lifecycle: {}

Field

Description

postStart

PostStart

preStop

PreStop

Poststart

Complete namespace: Broker.Spec.Broker.Initcontainers.Lifecycle.Poststart

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      lifecycle:
        poststart: {}

Field

Description

exec

Exec

httpGet

HttpGet

tcpSocket

TcpSocket

Exec

Complete namespace: Broker.Spec.Broker.Initcontainers.Lifecycle.Poststart.Exec

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      lifecycle:
        poststart:
          exec: {}

Field

Description

command

[]

string

Httpget

Complete namespace: Broker.Spec.Broker.Initcontainers.Lifecycle.Poststart.Httpget

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      lifecycle:
        poststart:
          httpget: {}

Field

Description

host

string

httpHeaders

[]HttpHeaders

path

string

port

integer or string

scheme

string

Httpheaders

Complete namespace: Broker.Spec.Broker.Initcontainers.Lifecycle.Poststart.Httpget.Httpheaders

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      lifecycle:
        poststart:
          httpget:
            httpheaders: {}

Field

Description

name

string

value

string

Tcpsocket

Complete namespace: Broker.Spec.Broker.Initcontainers.Lifecycle.Poststart.Tcpsocket

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      lifecycle:
        poststart:
          tcpsocket: {}

Field

Description

host

string

port

integer or string

Livenessprobe

Complete namespace: Broker.Spec.Broker.Initcontainers.Livenessprobe

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      livenessprobe: {}

Field

Description

exec

Exec

failureThreshold

integer

grpc

Grpc

httpGet

HttpGet

initialDelaySeconds

integer

periodSeconds

integer

successThreshold

integer

tcpSocket

TcpSocket

terminationGracePeriodSeconds

integer

timeoutSeconds

integer

Grpc

Complete namespace: Broker.Spec.Broker.Initcontainers.Livenessprobe.Grpc

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      livenessprobe:
        grpc: {}

Field

Description

port

integer

service

string

Ports

Complete namespace: Broker.Spec.Broker.Initcontainers.Ports

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      ports: {}

Field

Description

containerPort

integer

hostIP

string

hostPort

integer

name

string

protocol

string

Securitycontext

Complete namespace: Broker.Spec.Broker.Initcontainers.Securitycontext

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      securitycontext: {}

Field

Description

allowPrivilegeEscalation

boolean

capabilities

Capabilities

privileged

boolean

procMount

string

readOnlyRootFilesystem

boolean

runAsGroup

integer

runAsNonRoot

boolean

runAsUser

integer

seLinuxOptions

SeLinuxOptions

seccompProfile

SeccompProfile

windowsOptions

WindowsOptions

Capabilities

Complete namespace: Broker.Spec.Broker.Initcontainers.Securitycontext.Capabilities

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      securitycontext:
        capabilities: {}

Field

Description

add

[]

string

drop

[]

string

Selinuxoptions

Complete namespace: Broker.Spec.Broker.Initcontainers.Securitycontext.Selinuxoptions

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      securitycontext:
        selinuxoptions: {}

Field

Description

level

string

role

string

type

string

user

string

Seccompprofile

Complete namespace: Broker.Spec.Broker.Initcontainers.Securitycontext.Seccompprofile

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      securitycontext:
        seccompprofile: {}

Field

Description

localhostProfile

string

type

string

Windowsoptions

Complete namespace: Broker.Spec.Broker.Initcontainers.Securitycontext.Windowsoptions

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      securitycontext:
        windowsoptions: {}

Field

Description

gmsaCredentialSpec

string

gmsaCredentialSpecName

string

hostProcess

boolean

runAsUserName

string

Volumedevices

Complete namespace: Broker.Spec.Broker.Initcontainers.Volumedevices

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    initcontainers:
      volumedevices: {}

Field

Description

devicePath

string

name

string

Kafka

Complete namespace: Broker.Spec.Broker.Kafka

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    kafka: {}

Field

Description

enabled

boolean

Allow the cluster to accept Kafka protocol. Default is 'false'.

exposePorts

boolean

Expose the kafka protocol port.

Nodeaffinity

Complete namespace: Broker.Spec.Broker.Nodeaffinity

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    nodeaffinity: {}

Field

Description

preferredDuringSchedulingIgnoredDuringExecution

[]PreferredDuringSchedulingIgnoredDuringExecution

requiredDuringSchedulingIgnoredDuringExecution

RequiredDuringSchedulingIgnoredDuringExecution

Preferredduringschedulingignoredduringexecution

Complete namespace: Broker.Spec.Broker.Nodeaffinity.Preferredduringschedulingignoredduringexecution

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    nodeaffinity:
      preferredduringschedulingignoredduringexecution: {}

Field

Description

preference

Preference

weight

integer

Preference

Complete namespace: Broker.Spec.Broker.Nodeaffinity.Preferredduringschedulingignoredduringexecution.Preference

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    nodeaffinity:
      preferredduringschedulingignoredduringexecution:
        preference: {}

Field

Description

matchExpressions

[]MatchExpressions

matchFields

[]MatchFields

Requiredduringschedulingignoredduringexecution

Complete namespace: Broker.Spec.Broker.Nodeaffinity.Requiredduringschedulingignoredduringexecution

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    nodeaffinity:
      requiredduringschedulingignoredduringexecution: {}

Field

Description

nodeSelectorTerms

[]NodeSelectorTerms

Pdb

Complete namespace: Broker.Spec.Broker.Pdb

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    pdb: {}

Field

Description

enabled

boolean

Enable Pdb policy.

maxUnavailable

integer

Number of maxUnavailable pods.

Probes

Complete namespace: Broker.Spec.Broker.Probes

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    probes: {}

Field

Description

liveness

Liveness

readiness

Readiness

useHealthCheckForLiveness

boolean

Use healthcheck for the liveness probe. If false, the /metrics endpoint will be used.

useHealthCheckForReadiness

boolean

Use healthcheck for the readiness probe. If false, the /metrics endpoint will be used.

Liveness

Complete namespace: Broker.Spec.Broker.Probes.Liveness

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    probes:
      liveness: {}

Field

Description

enabled

boolean

Enables the probe.

failureThreshold

integer

Failure threshold.

initialDelaySeconds

integer

Indicates the initial delay (in seconds) for the probe.

periodSeconds

integer

Indicates the period (in seconds) for the probe.

successThreshold

integer

Success threshold.

terminationGracePeriodSeconds

integer

Indicates the termination grace period (in seconds) for the probe.

timeoutSeconds

integer

Indicates the timeout (in seconds) for the probe.

Readiness

Complete namespace: Broker.Spec.Broker.Probes.Readiness

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    probes:
      readiness: {}

Field

Description

enabled

boolean

Enables the probe.

failureThreshold

integer

Failure threshold.

initialDelaySeconds

integer

Indicates the initial delay (in seconds) for the probe.

periodSeconds

integer

Indicates the period (in seconds) for the probe.

successThreshold

integer

Success threshold.

terminationGracePeriodSeconds

integer

Indicates the termination grace period (in seconds) for the probe.

timeoutSeconds

integer

Indicates the timeout (in seconds) for the probe.

Resources

Complete namespace: Broker.Spec.Broker.Resources

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    resources: {}

Field

Description

limits

[]

integer or string

requests

[]

integer or string

Service

Complete namespace: Broker.Spec.Broker.Service

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    service: {}

Field

Description

additionalPorts

[]AdditionalPorts

Additional ports to add to the Service.

annotations

[]key/value

Additional annotations to add to the Service.

type

string

Service type. Default value is 'ClusterIP'

Additionalports

Complete namespace: Broker.Spec.Broker.Service.Additionalports

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    service:
      additionalports: {}

Field

Description

appProtocol

string

name

string

nodePort

integer

port

integer

protocol

string

targetPort

integer or string

Sets

Complete namespace: Broker.Spec.Broker.Sets

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    sets: {}

Field

Description

additionalVolumes

AdditionalVolumes

annotations

[]key/value

Annotations to add to each resource (except pods).

antiAffinity

AntiAffinity

autoscaler

Autoscaler

config

any

Configuration.

env

[]Env

Additional container env variables.

functionsWorkerEnabled

boolean

Enable functions worker embedded in the broker.

gracePeriod

integer

Termination grace period in seconds.

image

string

Override Pulsar image.

imagePullPolicy

string

Override image pull policy.

imagePullSecrets

[]ImagePullSecrets

Image pull secrets.

initContainers

[]InitContainers

Init containers

kafka

Kafka

labels

[]key/value

Labels to add to each resource (except pods).

matchLabels

[]key/value

Match labels selectors to add to each pod.

nodeAffinity

NodeAffinity

nodeSelectors

[]key/value

Additional node selectors.

overrideResourceName

string

Override the resource names generated by the operator.

pdb

Pdb

podAnnotations

[]key/value

Annotations to add to pod.

podLabels

[]key/value

Labels to add to each pod.

podManagementPolicy

string

Pod management policy.

probes

Probes

replicas

integer

Number of desired replicas.

resources

Resources

service

Service

serviceAccountName

string

Service account name for the Broker StatefulSet.

sidecars

[]Sidecars

Sidecar containers

tolerations

[]Tolerations

Pod tolerations.

transactions

Transactions

updateStrategy

UpdateStrategy

Tolerations

Complete namespace: Broker.Spec.Broker.Sets.Tolerations

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    sets:
      tolerations: {}

Field

Description

effect

string

key

string

operator

string

tolerationSeconds

integer

value

string

Transactions

Complete namespace: Broker.Spec.Broker.Sets.Transactions

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    sets:
      transactions: {}

Field

Description

enabled

boolean

Initialize the transaction coordinator if it's not yet and configure the broker to accept transactions.

initJob

InitJob

partitions

integer

Number of coordinators to create.

Initjob

Complete namespace: Broker.Spec.Broker.Sets.Transactions.Initjob

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    sets:
      transactions:
        initjob: {}

Field

Description

resources

Resources

Updatestrategy

Complete namespace: Broker.Spec.Broker.Sets.Updatestrategy

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    sets:
      updatestrategy: {}

Field

Description

rollingUpdate

RollingUpdate

type

string

Rollingupdate

Complete namespace: Broker.Spec.Broker.Sets.Updatestrategy.Rollingupdate

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  broker:
    sets:
      updatestrategy:
        rollingupdate: {}

Field

Description

maxUnavailable

integer or string

partition

integer

Global

Complete namespace: Broker.Spec.Global

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global: {}

Field

Description

name

string

(Optional)

Pulsar cluster name.

antiAffinity

AntiAffinity

auth

Auth

components

Components

dnsConfig

DnsConfig

dnsName

string

Public dns name for the cluster's load balancer.

image

string

Default Pulsar image to use. Any components can be configured to use a different image.

imagePullPolicy

string

Default Pulsar image pull policy to use. Any components can be configured to use a different image pull policy. Default value is 'IfNotPresent'.

kubernetesClusterDomain

string

The domain name for your kubernetes cluster. This domain is documented here: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#a-aaaa-records-1 . It's used to fully qualify service names when configuring Pulsar. The default value is 'cluster.local'.

nodeSelectors

[]key/value

Global node selector. If set, this will apply to all the components.

persistence

boolean

If persistence is enabled, components that has state will be deployed with PersistentVolumeClaims, otherwise, for test purposes, they will be deployed with emptyDir

priorityClassName

string

Priority class name to attach to each pod.

racks

[]

Racks configuration.

resourceSets

[]

Resource sets.

restartOnConfigMapChange

boolean

By default, Kubernetes will not restart pods when only their configmap is changed. This setting will restart pods when their configmap is changed using an annotation that calculates the checksum of the configmap.

storage

Storage

tls

Tls

zookeeperPlainSslStorePassword

boolean

Use plain password in zookeeper server and client configuration. Default is false. Old versions of Apache Zookeeper (<3.8.0) does not support getting password from file. In that case, set this to true.

Antiaffinity

Complete namespace: Broker.Spec.Global.Antiaffinity

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    antiaffinity: {}

Field

Description

host

Host

zone

Zone

Auth

Complete namespace: Broker.Spec.Global.Auth

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    auth: {}

Field

Description

enabled

boolean

Enable authentication in the cluster. Default is 'false'.

token

Token

Token

Complete namespace: Broker.Spec.Global.Auth.Token

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    auth:
      token: {}

Field

Description

initialize

boolean

Initialize Secrets with new pair of keys and tokens for the super user roles. The generated Secret name is 'token-<role>'.

privateKeyFile

string

Private key file name stored in the Secret. Default is 'my-private.key'

proxyRoles

[]

string

Proxy roles.

publicKeyFile

string

Public key file name stored in the Secret. Default is 'my-public.key'

superUserRoles

[]

string

Super user roles.

Components

Complete namespace: Broker.Spec.Global.Components

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    components: {}

Field

Description

autorecoveryBaseName

string

Autorecovery base name. Default value is 'autorecovery'.

bastionBaseName

string

Bastion base name. Default value is 'bastion'.

bookkeeperBaseName

string

BookKeeper base name. Default value is 'bookkeeper'.

brokerBaseName

string

Broker base name. Default value is 'broker'.

functionsWorkerBaseName

string

Functions Worker base name. Default value is 'function'.

proxyBaseName

string

Proxy base name. Default value is 'proxy'.

zookeeperBaseName

string

Zookeeper base name. Default value is 'zookeeper'.

Dnsconfig

Complete namespace: Broker.Spec.Global.Dnsconfig

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    dnsconfig: {}

Field

Description

nameservers

[]

string

options

[]Options

searches

[]

string

Racks

Complete namespace: Broker.Spec.Global.Racks

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    racks: {}

Field

Description

host

Host

zone

Zone

Host

Complete namespace: Broker.Spec.Global.Racks.Host

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    racks:
      host: {}

Field

Description

enabled

boolean

Enable the rack affinity rules.

requireRackAffinity

boolean

Indicates if the podAffinity rules will be enforced. Default is false. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.

requireRackAntiAffinity

boolean

Indicates if the podAntiAffinity rules will be enforced. Default is true. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.

Zone

Complete namespace: Broker.Spec.Global.Racks.Zone

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    racks:
      zone: {}

Field

Description

enableHostAntiAffinity

boolean

Enable the host anti affinity. If set, all the pods of the same rack will deployed on different nodes of the same zone.Default is true.

enabled

boolean

Enable the rack affinity rules.

requireRackAffinity

boolean

Indicates if the podAffinity rules will be enforced. Default is false. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.

requireRackAntiAffinity

boolean

Indicates if the podAntiAffinity rules will be enforced. Default is true. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.

requireRackHostAntiAffinity

boolean

Indicates if the podAntiAffinity rules will be enforced for the host. Default is true. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.

Resourcesets

Complete namespace: Broker.Spec.Global.Resourcesets

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    resourcesets: {}

Field

Description

rack

string

Place this resource set to a specific rack, defined at .global.racks.

Storage

Complete namespace: Broker.Spec.Global.Storage

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    storage: {}

Field

Description

existingStorageClassName

string

Indicates if an already existing storage class should be used.

storageClass

StorageClass

Storageclass

Complete namespace: Broker.Spec.Global.Storage.Storageclass

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    storage:
      storageclass: {}

Field

Description

extraParams

[]key/value

Adds extra parameters for the StorageClass.

fsType

string

Indicates the 'fsType' parameter for the StorageClass.

provisioner

string

Indicates the provisioner property for the StorageClass.

reclaimPolicy

string

Indicates the reclaimPolicy property for the StorageClass.

type

string

Indicates the 'type' parameter for the StorageClass.

Tls

Complete namespace: Broker.Spec.Global.Tls

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls: {}

Field

Description

autorecovery

Autorecovery

bookkeeper

Bookkeeper

broker

Broker

brokerResourceSets

[]

TLS configurations related to the Broker resource sets.

caPath

string

Path in the container filesystem where the TLS CA certificates are retrieved. It has to point to a certificate file. The default value is /etc/ssl/certs/ca-certificates.crt.

certProvisioner

CertProvisioner

defaultSecretName

string

Secret name used by each component to load TLS certificates. Each component can load a different secret by setting the 'secretName' entry in the tls component spec.

enabled

boolean

Global switch to turn on or off the TLS configurations. Additionally, you have configure each component section.

functionsWorker

FunctionsWorker

proxy

Proxy

proxyResourceSets

[]

TLS configurations related to the Proxy resource sets.

ssCa

SsCa

zookeeper

Zookeeper

Autorecovery

Complete namespace: Broker.Spec.Global.Tls.Autorecovery

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      autorecovery: {}

Field

Description

enabled

boolean

Enable TLS.

secretName

string

Override the default secret name from where to load the certificates.

Bookkeeper

Complete namespace: Broker.Spec.Global.Tls.Bookkeeper

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      bookkeeper: {}

Field

Description

enabled

boolean

Enable TLS.

secretName

string

Override the default secret name from where to load the certificates.

Broker

Complete namespace: Broker.Spec.Global.Tls.Broker

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      broker: {}

Field

Description

enabled

boolean

Enable TLS.

secretName

string

Override the default secret name from where to load the certificates.

Brokerresourcesets

Complete namespace: Broker.Spec.Global.Tls.Brokerresourcesets

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      brokerresourcesets: {}

Field

Description

enabled

boolean

Enable TLS.

secretName

string

Override the default secret name from where to load the certificates.

Certprovisioner

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner: {}

Field

Description

selfSigned

SelfSigned

Selfsigned

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner.Selfsigned

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner:
        selfsigned: {}

Field

Description

autorecovery

Autorecovery

bookkeeper

Bookkeeper

broker

Broker

caSecretName

string

Secret where to store the root CA certificate.

enabled

boolean

Generate self signed certificates for broker, proxy and functions worker.

functionsWorker

FunctionsWorker

includeDns

boolean

Include dns name in the DNS names covered by the certificate.

perComponent

boolean

Generate a different certificate for each component.

privateKey

PrivateKey

proxy

Proxy

zookeeper

Zookeeper

Autorecovery

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner.Selfsigned.Autorecovery

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner:
        selfsigned:
          autorecovery: {}

Field

Description

generate

boolean

Generate self signed certificates for the component.

privateKey

PrivateKey

Privatekey

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner.Selfsigned.Autorecovery.Privatekey

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner:
        selfsigned:
          autorecovery:
            privatekey: {}

Field

Description

algorithm

string

encoding

string

rotationPolicy

string

size

integer

Bookkeeper

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner.Selfsigned.Bookkeeper

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner:
        selfsigned:
          bookkeeper: {}

Field

Description

generate

boolean

Generate self signed certificates for the component.

privateKey

PrivateKey

Broker

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner.Selfsigned.Broker

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner:
        selfsigned:
          broker: {}

Field

Description

generate

boolean

Generate self signed certificates for the component.

privateKey

PrivateKey

Functionsworker

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner.Selfsigned.Functionsworker

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner:
        selfsigned:
          functionsworker: {}

Field

Description

generate

boolean

Generate self signed certificates for the component.

privateKey

PrivateKey

Proxy

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner.Selfsigned.Proxy

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner:
        selfsigned:
          proxy: {}

Field

Description

generate

boolean

Generate self signed certificates for the component.

privateKey

PrivateKey

Zookeeper

Complete namespace: Broker.Spec.Global.Tls.Certprovisioner.Selfsigned.Zookeeper

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      certprovisioner:
        selfsigned:
          zookeeper: {}

Field

Description

generate

boolean

Generate self signed certificates for the component.

privateKey

PrivateKey

Functionsworker

Complete namespace: Broker.Spec.Global.Tls.Functionsworker

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      functionsworker: {}

Field

Description

enabled

boolean

Enable TLS.

enabledWithBroker

boolean

Enable TLS for the functions worker to broker connections.

secretName

string

Override the default secret name from where to load the certificates.

Proxy

Complete namespace: Broker.Spec.Global.Tls.Proxy

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      proxy: {}

Field

Description

enabled

boolean

Enable TLS.

enabledWithBroker

boolean

Enable TLS for the proxy to broker connections.

secretName

string

Override the default secret name from where to load the certificates.

Proxyresourcesets

Complete namespace: Broker.Spec.Global.Tls.Proxyresourcesets

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      proxyresourcesets: {}

Field

Description

enabled

boolean

Enable TLS.

enabledWithBroker

boolean

Enable TLS for the proxy to broker connections.

secretName

string

Override the default secret name from where to load the certificates.

Ssca

Complete namespace: Broker.Spec.Global.Tls.Ssca

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      ssca: {}

Field

Description

enabled

boolean

Enable TLS.

secretName

string

Override the default secret name from where to load the certificates.

Zookeeper

Complete namespace: Broker.Spec.Global.Tls.Zookeeper

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  global:
    tls:
      zookeeper: {}

Field

Description

enabled

boolean

Enable TLS.

secretName

string

Override the default secret name from where to load the certificates.

Status

Complete namespace: Broker.Status

Field

Description

conditions

[]Conditions

Conditions: 1. Condition Ready: possible status are True or False. If False, the reason contains the error message.

lastApplied

string

Last spec applied.

Conditions

Complete namespace: Broker.Status.Conditions

Example use:

apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Broker
metadata:
  name: example-pulsarcluster
spec:
  conditions: {}

Field

Description

lastTransitionTime

string

message

string

observedGeneration

integer

reason

string

status

string

type

string

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com