Skip to the content.

API Reference

Packages:

kaap.oss.datastax.com/v1beta1

Resource Types:

PulsarCluster

Name Type Description Required
apiVersion string kaap.oss.datastax.com/v1beta1 true
kind string PulsarCluster true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object
false
status object
false

PulsarCluster.spec

Name Type Description Required
autorecovery object
false
bastion object
false
bookkeeper object
false
broker object
false
functionsWorker object
false
global object
false
proxy object
false
zookeeper object
false

PulsarCluster.spec.autorecovery

Name Type Description Required
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
serviceAccountName string Service account name for the resource.
false
sidecars []object Sidecar containers
false
tolerations []object Pod tolerations.
false

PulsarCluster.spec.autorecovery.antiAffinity

Pod anti-affinity configuration. This override the global value if set.

Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false

PulsarCluster.spec.autorecovery.antiAffinity.host

Indicates the reclaimPolicy property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.autorecovery.antiAffinity.zone

Indicates the provisioner property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.autorecovery.env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.autorecovery.env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.autorecovery.env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.autorecovery.env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.autorecovery.env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.imagePullSecrets[index]

Name Type Description Required
name string
false

PulsarCluster.spec.autorecovery.initContainers[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.autorecovery.initContainers[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.autorecovery.initContainers[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.autorecovery.initContainers[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.initContainers[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.autorecovery.initContainers[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.autorecovery.initContainers[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.initContainers[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.autorecovery.initContainers[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.initContainers[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.initContainers[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.initContainers[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.autorecovery.initContainers[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.initContainers[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.autorecovery.initContainers[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.initContainers[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.initContainers[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.initContainers[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.autorecovery.initContainers[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.autorecovery.initContainers[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.initContainers[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.autorecovery.initContainers[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.initContainers[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.initContainers[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.initContainers[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.autorecovery.initContainers[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.autorecovery.initContainers[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.autorecovery.initContainers[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.autorecovery.initContainers[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.autorecovery.initContainers[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.autorecovery.initContainers[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.autorecovery.initContainers[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.initContainers[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.autorecovery.initContainers[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.initContainers[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.initContainers[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.initContainers[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.autorecovery.initContainers[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.autorecovery.nodeAffinity

Node affinity configuration.

Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false

PulsarCluster.spec.autorecovery.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

Name Type Description Required
preference object
false
weight integer
false

PulsarCluster.spec.autorecovery.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.autorecovery.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.autorecovery.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.autorecovery.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Name Type Description Required
nodeSelectorTerms []object
false

PulsarCluster.spec.autorecovery.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.autorecovery.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.autorecovery.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.autorecovery.resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.autorecovery.sidecars[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.autorecovery.sidecars[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.autorecovery.sidecars[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.autorecovery.sidecars[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.sidecars[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.autorecovery.sidecars[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.autorecovery.sidecars[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.sidecars[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.autorecovery.sidecars[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.sidecars[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.sidecars[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.sidecars[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.autorecovery.sidecars[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.sidecars[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.autorecovery.sidecars[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.sidecars[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.sidecars[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.sidecars[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.autorecovery.sidecars[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.autorecovery.sidecars[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.sidecars[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.autorecovery.sidecars[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.sidecars[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.sidecars[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.sidecars[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.autorecovery.sidecars[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.autorecovery.sidecars[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.autorecovery.sidecars[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.autorecovery.sidecars[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.autorecovery.sidecars[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.autorecovery.sidecars[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.autorecovery.sidecars[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.autorecovery.sidecars[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.autorecovery.sidecars[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.autorecovery.sidecars[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.autorecovery.sidecars[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.autorecovery.sidecars[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.autorecovery.sidecars[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.autorecovery.tolerations[index]

Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false

PulsarCluster.spec.bastion

Name Type Description Required
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
serviceAccountName string Service account name for the resource.
false
sidecars []object Sidecar containers
false
targetProxy boolean Indicates to connect to proxy or the broker. The default value depends whether Proxy is deployed or not.
false
tolerations []object Pod tolerations.
false

PulsarCluster.spec.bastion.antiAffinity

Pod anti-affinity configuration. This override the global value if set.

Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false

PulsarCluster.spec.bastion.antiAffinity.host

Indicates the reclaimPolicy property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.bastion.antiAffinity.zone

Indicates the provisioner property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.bastion.env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bastion.env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bastion.env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bastion.env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bastion.env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bastion.env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bastion.imagePullSecrets[index]

Name Type Description Required
name string
false

PulsarCluster.spec.bastion.initContainers[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.bastion.initContainers[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bastion.initContainers[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bastion.initContainers[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bastion.initContainers[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bastion.initContainers[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bastion.initContainers[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bastion.initContainers[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.bastion.initContainers[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bastion.initContainers[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.initContainers[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.initContainers[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bastion.initContainers[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.initContainers[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bastion.initContainers[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.initContainers[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.initContainers[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.initContainers[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.bastion.initContainers[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bastion.initContainers[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.initContainers[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bastion.initContainers[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.initContainers[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.initContainers[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.initContainers[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bastion.initContainers[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.bastion.initContainers[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.bastion.initContainers[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.bastion.initContainers[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.bastion.initContainers[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.bastion.initContainers[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bastion.initContainers[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.initContainers[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bastion.initContainers[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.initContainers[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.initContainers[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.initContainers[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.bastion.initContainers[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.bastion.nodeAffinity

Node affinity configuration.

Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false

PulsarCluster.spec.bastion.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

Name Type Description Required
preference object
false
weight integer
false

PulsarCluster.spec.bastion.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.bastion.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bastion.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bastion.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Name Type Description Required
nodeSelectorTerms []object
false

PulsarCluster.spec.bastion.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.bastion.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bastion.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bastion.resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bastion.sidecars[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.bastion.sidecars[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bastion.sidecars[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bastion.sidecars[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bastion.sidecars[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bastion.sidecars[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bastion.sidecars[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bastion.sidecars[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.bastion.sidecars[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bastion.sidecars[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.sidecars[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.sidecars[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bastion.sidecars[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.sidecars[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bastion.sidecars[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.sidecars[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.sidecars[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.sidecars[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.bastion.sidecars[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bastion.sidecars[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.sidecars[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bastion.sidecars[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.sidecars[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.sidecars[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.sidecars[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bastion.sidecars[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.bastion.sidecars[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.bastion.sidecars[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.bastion.sidecars[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.bastion.sidecars[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.bastion.sidecars[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bastion.sidecars[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bastion.sidecars[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bastion.sidecars[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bastion.sidecars[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bastion.sidecars[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bastion.sidecars[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.bastion.sidecars[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.bastion.tolerations[index]

Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false

PulsarCluster.spec.bookkeeper

Name Type Description Required
additionalVolumes object Mount additional volumes to the pod.
false
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
autoRackConfig object Configuration for the rack auto configuration.
false
autoscaler object Autoscaling config.
false
cleanUpPvcs boolean Cleanup PVCs after the bookie has been removed.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
overrideResourceName string Override the resource names generated by the operator.
false
pdb object Pod disruption budget configuration.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
podManagementPolicy string Pod management policy. Default value is 'Parallel'.
false
probes object Liveness and readiness probes configuration.
false
pvcPrefix string Prefix for each PVC created.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
service object Service configuration.
false
serviceAccountName string Service account name for the resource.
false
sets map[string]object Bookie sets.
false
setsUpdateStrategy string Sets update strategy. 'RollingUpdate' or 'Parallel'. Default is 'RollingUpdate'.
false
sidecars []object Sidecar containers
false
tolerations []object Pod tolerations.
false
updateStrategy object Update strategy for the StatefulSet. Default value is rolling update.
false
volumes object Volumes configuration.
false

PulsarCluster.spec.bookkeeper.additionalVolumes

Mount additional volumes to the pod.

Name Type Description Required
mounts []object Mount points for the additional volumes
false
volumes []object Additional volumes to be mounted to the pod
false

PulsarCluster.spec.bookkeeper.additionalVolumes.mounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index]

Name Type Description Required
awsElasticBlockStore object
false
azureDisk object
false
azureFile object
false
cephfs object
false
cinder object
false
configMap object
false
csi object
false
downwardAPI object
false
emptyDir object
false
ephemeral object
false
fc object
false
flexVolume object
false
flocker object
false
gcePersistentDisk object
false
gitRepo object
false
glusterfs object
false
hostPath object
false
iscsi object
false
name string
false
nfs object
false
persistentVolumeClaim object
false
photonPersistentDisk object
false
portworxVolume object
false
projected object
false
quobyte object
false
rbd object
false
scaleIO object
false
secret object
false
storageos object
false
vsphereVolume object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].awsElasticBlockStore

Name Type Description Required
fsType string
false
partition integer
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].azureDisk

Name Type Description Required
cachingMode string
false
diskName string
false
diskURI string
false
fsType string
false
kind string
false
readOnly boolean
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].azureFile

Name Type Description Required
readOnly boolean
false
secretName string
false
shareName string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].cephfs

Name Type Description Required
monitors []string
false
path string
false
readOnly boolean
false
secretFile string
false
secretRef object
false
user string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].cephfs.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].cinder

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeID string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].cinder.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].configMap

Name Type Description Required
defaultMode integer
false
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].csi

Name Type Description Required
driver string
false
fsType string
false
nodePublishSecretRef object
false
readOnly boolean
false
volumeAttributes map[string]string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].csi.nodePublishSecretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].downwardAPI

Name Type Description Required
defaultMode integer
false
items []object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].emptyDir

Name Type Description Required
medium string
false
sizeLimit int or string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral

Name Type Description Required
volumeClaimTemplate object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate

Name Type Description Required
metadata object
false
spec object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata

Name Type Description Required
annotations map[string]string
false
creationTimestamp string
false
deletionGracePeriodSeconds integer
false
deletionTimestamp string
false
finalizers []string
false
generateName string
false
generation integer
false
labels map[string]string
false
managedFields []object
false
name string
false
namespace string
false
ownerReferences []object
false
resourceVersion string
false
selfLink string
false
uid string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.managedFields[index]

Name Type Description Required
apiVersion string
false
fieldsType string
false
fieldsV1 object
false
manager string
false
operation string
false
subresource string
false
time string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.ownerReferences[index]

Name Type Description Required
apiVersion string
false
blockOwnerDeletion boolean
false
controller boolean
false
kind string
false
name string
false
uid string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec

Name Type Description Required
accessModes []string
false
dataSource object
false
dataSourceRef object
false
resources object
false
selector object
false
storageClassName string
false
volumeMode string
false
volumeName string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

Name Type Description Required
matchExpressions []object
false
matchLabels map[string]string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].fc

Name Type Description Required
fsType string
false
lun integer
false
readOnly boolean
false
targetWWNs []string
false
wwids []string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].flexVolume

Name Type Description Required
driver string
false
fsType string
false
options map[string]string
false
readOnly boolean
false
secretRef object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].flexVolume.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].flocker

Name Type Description Required
datasetName string
false
datasetUUID string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].gcePersistentDisk

Name Type Description Required
fsType string
false
partition integer
false
pdName string
false
readOnly boolean
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].gitRepo

Name Type Description Required
directory string
false
repository string
false
revision string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].glusterfs

Name Type Description Required
endpoints string
false
path string
false
readOnly boolean
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].hostPath

Name Type Description Required
path string
false
type string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].iscsi

Name Type Description Required
chapAuthDiscovery boolean
false
chapAuthSession boolean
false
fsType string
false
initiatorName string
false
iqn string
false
iscsiInterface string
false
lun integer
false
portals []string
false
readOnly boolean
false
secretRef object
false
targetPortal string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].iscsi.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].nfs

Name Type Description Required
path string
false
readOnly boolean
false
server string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].persistentVolumeClaim

Name Type Description Required
claimName string
false
readOnly boolean
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].photonPersistentDisk

Name Type Description Required
fsType string
false
pdID string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].portworxVolume

Name Type Description Required
fsType string
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected

Name Type Description Required
defaultMode integer
false
sources []object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index]

Name Type Description Required
configMap object
false
downwardAPI object
false
secret object
false
serviceAccountToken object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].configMap

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].downwardAPI

Name Type Description Required
items []object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].secret

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].projected.sources[index].serviceAccountToken

Name Type Description Required
audience string
false
expirationSeconds integer
false
path string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].quobyte

Name Type Description Required
group string
false
readOnly boolean
false
registry string
false
tenant string
false
user string
false
volume string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].rbd

Name Type Description Required
fsType string
false
image string
false
keyring string
false
monitors []string
false
pool string
false
readOnly boolean
false
secretRef object
false
user string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].rbd.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].scaleIO

Name Type Description Required
fsType string
false
gateway string
false
protectionDomain string
false
readOnly boolean
false
secretRef object
false
sslEnabled boolean
false
storageMode string
false
storagePool string
false
system string
false
volumeName string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].scaleIO.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].secret

Name Type Description Required
defaultMode integer
false
items []object
false
optional boolean
false
secretName string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].storageos

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeName string
false
volumeNamespace string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].storageos.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.additionalVolumes.volumes[index].vsphereVolume

Name Type Description Required
fsType string
false
storagePolicyID string
false
storagePolicyName string
false
volumePath string
false

PulsarCluster.spec.bookkeeper.antiAffinity

Pod anti-affinity configuration. This override the global value if set.

Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false

PulsarCluster.spec.bookkeeper.antiAffinity.host

Indicates the reclaimPolicy property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.bookkeeper.antiAffinity.zone

Indicates the provisioner property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.bookkeeper.autoRackConfig

Configuration for the rack auto configuration.

Name Type Description Required
additionalZookeeperClientConfig JSON Additional configuration for the zookeeper client.
false
enabled boolean Enable rack configuration monitoring.
false
periodMs integer Period for the schedule of the monitoring thread.

Minimum: 1000
false

PulsarCluster.spec.bookkeeper.autoscaler

Autoscaling config.

Name Type Description Required
diskUsageToleranceHwm number The threshold to trigger a scale up. The autoscaler will scale up if any of thebookie's disk usage is higher than or equal to this threshold. Default is '0.92'

Minimum: 0
Maximum: 1
false
diskUsageToleranceLwm number The threshold to trigger a scale down. The autoscaler will scale down if all the bookies' disk usage is lower than this threshold. Default is '0.75'

Minimum: 0
Maximum: 1
false
enabled boolean Enable autoscaling for bookies.
false
minWritableBookies integer Min number of writable bookies. The autoscaler will scale up if not enough writable bookies are detected. For instance, if a bookie went to read-only mode, the autoscaler will scale up to replace it. Default is '3'.

Minimum: 1
false
periodMs integer The interval in milliseconds between two consecutive autoscaling checks.

Minimum: 1000
false
scaleDownBy integer The number of bookies to remove at each scale down. Default is '1'

Minimum: 1
false
scaleUpBy integer The number of bookies to add at each scale up. Default is '1'

Minimum: 1
false
scaleUpMaxLimit integer Max number of bookies. If the number of bookies is equals to this value, the autoscaler will never scale up.

Minimum: 1
false
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.

Minimum: 1
false

PulsarCluster.spec.bookkeeper.env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bookkeeper.env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bookkeeper.env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.imagePullSecrets[index]

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.initContainers[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.bookkeeper.initContainers[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bookkeeper.initContainers[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bookkeeper.initContainers[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.initContainers[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.initContainers[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.initContainers[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.initContainers[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.bookkeeper.initContainers[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.initContainers[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.initContainers[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.initContainers[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.initContainers[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.initContainers[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.initContainers[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.initContainers[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.initContainers[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.initContainers[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.bookkeeper.initContainers[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.initContainers[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.initContainers[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.initContainers[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.initContainers[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.initContainers[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.initContainers[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bookkeeper.initContainers[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.bookkeeper.initContainers[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.bookkeeper.initContainers[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.bookkeeper.initContainers[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.bookkeeper.initContainers[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.bookkeeper.initContainers[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.initContainers[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.initContainers[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.initContainers[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.initContainers[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.initContainers[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.initContainers[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.bookkeeper.initContainers[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.bookkeeper.nodeAffinity

Node affinity configuration.

Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false

PulsarCluster.spec.bookkeeper.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

Name Type Description Required
preference object
false
weight integer
false

PulsarCluster.spec.bookkeeper.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.bookkeeper.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Name Type Description Required
nodeSelectorTerms []object
false

PulsarCluster.spec.bookkeeper.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.bookkeeper.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.pdb

Pod disruption budget configuration.

Name Type Description Required
enabled boolean Enable Pdb policy.
false
maxUnavailable integer Number of maxUnavailable pods.
false

PulsarCluster.spec.bookkeeper.probes

Liveness and readiness probes configuration.

Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false

PulsarCluster.spec.bookkeeper.probes.liveness

Liveness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.bookkeeper.probes.readiness

Readiness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.bookkeeper.resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bookkeeper.service

Service configuration.

Name Type Description Required
additionalPorts []object Additional ports to add to the Service.
false
annotations map[string]string Additional annotations to add to the Service.
false

PulsarCluster.spec.bookkeeper.service.additionalPorts[index]

Name Type Description Required
appProtocol string
false
name string
false
nodePort integer
false
port integer
false
protocol string
false
targetPort int or string
false

PulsarCluster.spec.bookkeeper.sets[key]

Name Type Description Required
additionalVolumes object Mount additional volumes to the pod.
false
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
autoscaler object Autoscaling config.
false
cleanUpPvcs boolean Cleanup PVCs after the bookie has been removed.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
overrideResourceName string Override the resource names generated by the operator.
false
pdb object Pod disruption budget configuration.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
podManagementPolicy string Pod management policy. Default value is 'Parallel'.
false
probes object Liveness and readiness probes configuration.
false
pvcPrefix string Prefix for each PVC created.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
service object Service configuration.
false
serviceAccountName string Service account name for the resource.
false
sidecars []object Sidecar containers
false
tolerations []object Pod tolerations.
false
updateStrategy object Update strategy for the StatefulSet. Default value is rolling update.
false
volumes object Volumes configuration.
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes

Mount additional volumes to the pod.

Name Type Description Required
mounts []object Mount points for the additional volumes
false
volumes []object Additional volumes to be mounted to the pod
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.mounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index]

Name Type Description Required
awsElasticBlockStore object
false
azureDisk object
false
azureFile object
false
cephfs object
false
cinder object
false
configMap object
false
csi object
false
downwardAPI object
false
emptyDir object
false
ephemeral object
false
fc object
false
flexVolume object
false
flocker object
false
gcePersistentDisk object
false
gitRepo object
false
glusterfs object
false
hostPath object
false
iscsi object
false
name string
false
nfs object
false
persistentVolumeClaim object
false
photonPersistentDisk object
false
portworxVolume object
false
projected object
false
quobyte object
false
rbd object
false
scaleIO object
false
secret object
false
storageos object
false
vsphereVolume object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].awsElasticBlockStore

Name Type Description Required
fsType string
false
partition integer
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].azureDisk

Name Type Description Required
cachingMode string
false
diskName string
false
diskURI string
false
fsType string
false
kind string
false
readOnly boolean
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].azureFile

Name Type Description Required
readOnly boolean
false
secretName string
false
shareName string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].cephfs

Name Type Description Required
monitors []string
false
path string
false
readOnly boolean
false
secretFile string
false
secretRef object
false
user string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].cephfs.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].cinder

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeID string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].cinder.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].configMap

Name Type Description Required
defaultMode integer
false
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].csi

Name Type Description Required
driver string
false
fsType string
false
nodePublishSecretRef object
false
readOnly boolean
false
volumeAttributes map[string]string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].csi.nodePublishSecretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].downwardAPI

Name Type Description Required
defaultMode integer
false
items []object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].emptyDir

Name Type Description Required
medium string
false
sizeLimit int or string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral

Name Type Description Required
volumeClaimTemplate object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate

Name Type Description Required
metadata object
false
spec object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata

Name Type Description Required
annotations map[string]string
false
creationTimestamp string
false
deletionGracePeriodSeconds integer
false
deletionTimestamp string
false
finalizers []string
false
generateName string
false
generation integer
false
labels map[string]string
false
managedFields []object
false
name string
false
namespace string
false
ownerReferences []object
false
resourceVersion string
false
selfLink string
false
uid string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.managedFields[index]

Name Type Description Required
apiVersion string
false
fieldsType string
false
fieldsV1 object
false
manager string
false
operation string
false
subresource string
false
time string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.ownerReferences[index]

Name Type Description Required
apiVersion string
false
blockOwnerDeletion boolean
false
controller boolean
false
kind string
false
name string
false
uid string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec

Name Type Description Required
accessModes []string
false
dataSource object
false
dataSourceRef object
false
resources object
false
selector object
false
storageClassName string
false
volumeMode string
false
volumeName string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

Name Type Description Required
matchExpressions []object
false
matchLabels map[string]string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].fc

Name Type Description Required
fsType string
false
lun integer
false
readOnly boolean
false
targetWWNs []string
false
wwids []string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].flexVolume

Name Type Description Required
driver string
false
fsType string
false
options map[string]string
false
readOnly boolean
false
secretRef object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].flexVolume.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].flocker

Name Type Description Required
datasetName string
false
datasetUUID string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].gcePersistentDisk

Name Type Description Required
fsType string
false
partition integer
false
pdName string
false
readOnly boolean
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].gitRepo

Name Type Description Required
directory string
false
repository string
false
revision string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].glusterfs

Name Type Description Required
endpoints string
false
path string
false
readOnly boolean
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].hostPath

Name Type Description Required
path string
false
type string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].iscsi

Name Type Description Required
chapAuthDiscovery boolean
false
chapAuthSession boolean
false
fsType string
false
initiatorName string
false
iqn string
false
iscsiInterface string
false
lun integer
false
portals []string
false
readOnly boolean
false
secretRef object
false
targetPortal string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].iscsi.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].nfs

Name Type Description Required
path string
false
readOnly boolean
false
server string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].persistentVolumeClaim

Name Type Description Required
claimName string
false
readOnly boolean
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].photonPersistentDisk

Name Type Description Required
fsType string
false
pdID string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].portworxVolume

Name Type Description Required
fsType string
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected

Name Type Description Required
defaultMode integer
false
sources []object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index]

Name Type Description Required
configMap object
false
downwardAPI object
false
secret object
false
serviceAccountToken object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].configMap

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI

Name Type Description Required
items []object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].secret

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].projected.sources[index].serviceAccountToken

Name Type Description Required
audience string
false
expirationSeconds integer
false
path string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].quobyte

Name Type Description Required
group string
false
readOnly boolean
false
registry string
false
tenant string
false
user string
false
volume string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].rbd

Name Type Description Required
fsType string
false
image string
false
keyring string
false
monitors []string
false
pool string
false
readOnly boolean
false
secretRef object
false
user string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].rbd.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].scaleIO

Name Type Description Required
fsType string
false
gateway string
false
protectionDomain string
false
readOnly boolean
false
secretRef object
false
sslEnabled boolean
false
storageMode string
false
storagePool string
false
system string
false
volumeName string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].scaleIO.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].secret

Name Type Description Required
defaultMode integer
false
items []object
false
optional boolean
false
secretName string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].storageos

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeName string
false
volumeNamespace string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].storageos.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].additionalVolumes.volumes[index].vsphereVolume

Name Type Description Required
fsType string
false
storagePolicyID string
false
storagePolicyName string
false
volumePath string
false

PulsarCluster.spec.bookkeeper.sets[key].antiAffinity

Pod anti-affinity configuration. This override the global value if set.

Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false

PulsarCluster.spec.bookkeeper.sets[key].antiAffinity.host

Indicates the reclaimPolicy property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.bookkeeper.sets[key].antiAffinity.zone

Indicates the provisioner property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.bookkeeper.sets[key].autoscaler

Autoscaling config.

Name Type Description Required
diskUsageToleranceHwm number The threshold to trigger a scale up. The autoscaler will scale up if any of thebookie's disk usage is higher than or equal to this threshold. Default is '0.92'

Minimum: 0
Maximum: 1
false
diskUsageToleranceLwm number The threshold to trigger a scale down. The autoscaler will scale down if all the bookies' disk usage is lower than this threshold. Default is '0.75'

Minimum: 0
Maximum: 1
false
enabled boolean Enable autoscaling for bookies.
false
minWritableBookies integer Min number of writable bookies. The autoscaler will scale up if not enough writable bookies are detected. For instance, if a bookie went to read-only mode, the autoscaler will scale up to replace it. Default is '3'.

Minimum: 1
false
periodMs integer The interval in milliseconds between two consecutive autoscaling checks.

Minimum: 1000
false
scaleDownBy integer The number of bookies to remove at each scale down. Default is '1'

Minimum: 1
false
scaleUpBy integer The number of bookies to add at each scale up. Default is '1'

Minimum: 1
false
scaleUpMaxLimit integer Max number of bookies. If the number of bookies is equals to this value, the autoscaler will never scale up.

Minimum: 1
false
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.

Minimum: 1
false

PulsarCluster.spec.bookkeeper.sets[key].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bookkeeper.sets[key].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bookkeeper.sets[key].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.sets[key].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.sets[key].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].imagePullSecrets[index]

Name Type Description Required
name string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.bookkeeper.sets[key].initContainers[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity

Node affinity configuration.

Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

Name Type Description Required
preference object
false
weight integer
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Name Type Description Required
nodeSelectorTerms []object
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.bookkeeper.sets[key].pdb

Pod disruption budget configuration.

Name Type Description Required
enabled boolean Enable Pdb policy.
false
maxUnavailable integer Number of maxUnavailable pods.
false

PulsarCluster.spec.bookkeeper.sets[key].probes

Liveness and readiness probes configuration.

Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false

PulsarCluster.spec.bookkeeper.sets[key].probes.liveness

Liveness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.bookkeeper.sets[key].probes.readiness

Readiness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.bookkeeper.sets[key].resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bookkeeper.sets[key].service

Service configuration.

Name Type Description Required
additionalPorts []object Additional ports to add to the Service.
false
annotations map[string]string Additional annotations to add to the Service.
false

PulsarCluster.spec.bookkeeper.sets[key].service.additionalPorts[index]

Name Type Description Required
appProtocol string
false
name string
false
nodePort integer
false
port integer
false
protocol string
false
targetPort int or string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.bookkeeper.sets[key].sidecars[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.bookkeeper.sets[key].tolerations[index]

Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false

PulsarCluster.spec.bookkeeper.sets[key].updateStrategy

Update strategy for the StatefulSet. Default value is rolling update.

Name Type Description Required
rollingUpdate object
false
type string
false

PulsarCluster.spec.bookkeeper.sets[key].updateStrategy.rollingUpdate

Name Type Description Required
maxUnavailable int or string
false
partition integer
false

PulsarCluster.spec.bookkeeper.sets[key].volumes

Volumes configuration.

Name Type Description Required
journal object Config for the journal volume.
false
ledgers object Config for the ledgers volume.
false

PulsarCluster.spec.bookkeeper.sets[key].volumes.journal

Config for the journal volume.

Name Type Description Required
existingStorageClassName string Indicates if an already existing storage class should be used.
false
name string Indicates the suffix for the volume. Default value is 'data'.
false
size string Indicates the requested size for the volume. The format follows the Kubernetes' Quantity.
false
storageClass object Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
false

PulsarCluster.spec.bookkeeper.sets[key].volumes.journal.storageClass

Indicates if a StorageClass is used. The operator will create the StorageClass if needed.

Name Type Description Required
extraParams map[string]string Adds extra parameters for the StorageClass.
false
fsType string Indicates the 'fsType' parameter for the StorageClass.
false
provisioner string Indicates the provisioner property for the StorageClass.
false
reclaimPolicy string Indicates the reclaimPolicy property for the StorageClass.
false
type string Indicates the 'type' parameter for the StorageClass.
false

PulsarCluster.spec.bookkeeper.sets[key].volumes.ledgers

Config for the ledgers volume.

Name Type Description Required
existingStorageClassName string Indicates if an already existing storage class should be used.
false
name string Indicates the suffix for the volume. Default value is 'data'.
false
size string Indicates the requested size for the volume. The format follows the Kubernetes' Quantity.
false
storageClass object Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
false

PulsarCluster.spec.bookkeeper.sets[key].volumes.ledgers.storageClass

Indicates if a StorageClass is used. The operator will create the StorageClass if needed.

Name Type Description Required
extraParams map[string]string Adds extra parameters for the StorageClass.
false
fsType string Indicates the 'fsType' parameter for the StorageClass.
false
provisioner string Indicates the provisioner property for the StorageClass.
false
reclaimPolicy string Indicates the reclaimPolicy property for the StorageClass.
false
type string Indicates the 'type' parameter for the StorageClass.
false

PulsarCluster.spec.bookkeeper.sidecars[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.bookkeeper.sidecars[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.bookkeeper.sidecars[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.bookkeeper.sidecars[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sidecars[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.bookkeeper.sidecars[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.bookkeeper.sidecars[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sidecars[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.bookkeeper.sidecars[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sidecars[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sidecars[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sidecars[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sidecars[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sidecars[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sidecars[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sidecars[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sidecars[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sidecars[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.bookkeeper.sidecars[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sidecars[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sidecars[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sidecars[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sidecars[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sidecars[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sidecars[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.bookkeeper.sidecars[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.bookkeeper.sidecars[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.bookkeeper.sidecars[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.bookkeeper.sidecars[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.bookkeeper.sidecars[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.bookkeeper.sidecars[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.bookkeeper.sidecars[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.bookkeeper.sidecars[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.bookkeeper.sidecars[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.bookkeeper.sidecars[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.bookkeeper.sidecars[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.bookkeeper.sidecars[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.bookkeeper.sidecars[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.bookkeeper.tolerations[index]

Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false

PulsarCluster.spec.bookkeeper.updateStrategy

Update strategy for the StatefulSet. Default value is rolling update.

Name Type Description Required
rollingUpdate object
false
type string
false

PulsarCluster.spec.bookkeeper.updateStrategy.rollingUpdate

Name Type Description Required
maxUnavailable int or string
false
partition integer
false

PulsarCluster.spec.bookkeeper.volumes

Volumes configuration.

Name Type Description Required
journal object Config for the journal volume.
false
ledgers object Config for the ledgers volume.
false

PulsarCluster.spec.bookkeeper.volumes.journal

Config for the journal volume.

Name Type Description Required
existingStorageClassName string Indicates if an already existing storage class should be used.
false
name string Indicates the suffix for the volume. Default value is 'data'.
false
size string Indicates the requested size for the volume. The format follows the Kubernetes' Quantity.
false
storageClass object Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
false

PulsarCluster.spec.bookkeeper.volumes.journal.storageClass

Indicates if a StorageClass is used. The operator will create the StorageClass if needed.

Name Type Description Required
extraParams map[string]string Adds extra parameters for the StorageClass.
false
fsType string Indicates the 'fsType' parameter for the StorageClass.
false
provisioner string Indicates the provisioner property for the StorageClass.
false
reclaimPolicy string Indicates the reclaimPolicy property for the StorageClass.
false
type string Indicates the 'type' parameter for the StorageClass.
false

PulsarCluster.spec.bookkeeper.volumes.ledgers

Config for the ledgers volume.

Name Type Description Required
existingStorageClassName string Indicates if an already existing storage class should be used.
false
name string Indicates the suffix for the volume. Default value is 'data'.
false
size string Indicates the requested size for the volume. The format follows the Kubernetes' Quantity.
false
storageClass object Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
false

PulsarCluster.spec.bookkeeper.volumes.ledgers.storageClass

Indicates if a StorageClass is used. The operator will create the StorageClass if needed.

Name Type Description Required
extraParams map[string]string Adds extra parameters for the StorageClass.
false
fsType string Indicates the 'fsType' parameter for the StorageClass.
false
provisioner string Indicates the provisioner property for the StorageClass.
false
reclaimPolicy string Indicates the reclaimPolicy property for the StorageClass.
false
type string Indicates the 'type' parameter for the StorageClass.
false

PulsarCluster.spec.broker

Name Type Description Required
additionalVolumes object Mount additional volumes to the pod.
false
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
autoscaler object Autoscaling config.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
functionsWorkerEnabled boolean Enable functions worker embedded in the broker.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
kafka object Enable Kafka protocol.
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
overrideResourceName string Override the resource names generated by the operator.
false
pdb object Pod disruption budget configuration.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
podManagementPolicy string Pod management policy.
false
probes object Liveness and readiness probes configuration.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
service object Service configuration.
false
serviceAccountName string Service account name for the resource.
false
sets map[string]object Broker sets.
false
setsUpdateStrategy string Sets update strategy. 'RollingUpdate' or 'Parallel'. Default is 'RollingUpdate'.
false
sidecars []object Sidecar containers
false
tolerations []object Pod tolerations.
false
transactions object Enable transactions in the broker.
false
updateStrategy object Update strategy for the StatefulSet.
false

PulsarCluster.spec.broker.additionalVolumes

Mount additional volumes to the pod.

Name Type Description Required
mounts []object Mount points for the additional volumes
false
volumes []object Additional volumes to be mounted to the pod
false

PulsarCluster.spec.broker.additionalVolumes.mounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index]

Name Type Description Required
awsElasticBlockStore object
false
azureDisk object
false
azureFile object
false
cephfs object
false
cinder object
false
configMap object
false
csi object
false
downwardAPI object
false
emptyDir object
false
ephemeral object
false
fc object
false
flexVolume object
false
flocker object
false
gcePersistentDisk object
false
gitRepo object
false
glusterfs object
false
hostPath object
false
iscsi object
false
name string
false
nfs object
false
persistentVolumeClaim object
false
photonPersistentDisk object
false
portworxVolume object
false
projected object
false
quobyte object
false
rbd object
false
scaleIO object
false
secret object
false
storageos object
false
vsphereVolume object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].awsElasticBlockStore

Name Type Description Required
fsType string
false
partition integer
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].azureDisk

Name Type Description Required
cachingMode string
false
diskName string
false
diskURI string
false
fsType string
false
kind string
false
readOnly boolean
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].azureFile

Name Type Description Required
readOnly boolean
false
secretName string
false
shareName string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].cephfs

Name Type Description Required
monitors []string
false
path string
false
readOnly boolean
false
secretFile string
false
secretRef object
false
user string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].cephfs.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].cinder

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeID string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].cinder.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].configMap

Name Type Description Required
defaultMode integer
false
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].csi

Name Type Description Required
driver string
false
fsType string
false
nodePublishSecretRef object
false
readOnly boolean
false
volumeAttributes map[string]string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].csi.nodePublishSecretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].downwardAPI

Name Type Description Required
defaultMode integer
false
items []object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].emptyDir

Name Type Description Required
medium string
false
sizeLimit int or string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral

Name Type Description Required
volumeClaimTemplate object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate

Name Type Description Required
metadata object
false
spec object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata

Name Type Description Required
annotations map[string]string
false
creationTimestamp string
false
deletionGracePeriodSeconds integer
false
deletionTimestamp string
false
finalizers []string
false
generateName string
false
generation integer
false
labels map[string]string
false
managedFields []object
false
name string
false
namespace string
false
ownerReferences []object
false
resourceVersion string
false
selfLink string
false
uid string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.managedFields[index]

Name Type Description Required
apiVersion string
false
fieldsType string
false
fieldsV1 object
false
manager string
false
operation string
false
subresource string
false
time string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.ownerReferences[index]

Name Type Description Required
apiVersion string
false
blockOwnerDeletion boolean
false
controller boolean
false
kind string
false
name string
false
uid string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec

Name Type Description Required
accessModes []string
false
dataSource object
false
dataSourceRef object
false
resources object
false
selector object
false
storageClassName string
false
volumeMode string
false
volumeName string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

Name Type Description Required
matchExpressions []object
false
matchLabels map[string]string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].fc

Name Type Description Required
fsType string
false
lun integer
false
readOnly boolean
false
targetWWNs []string
false
wwids []string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].flexVolume

Name Type Description Required
driver string
false
fsType string
false
options map[string]string
false
readOnly boolean
false
secretRef object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].flexVolume.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].flocker

Name Type Description Required
datasetName string
false
datasetUUID string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].gcePersistentDisk

Name Type Description Required
fsType string
false
partition integer
false
pdName string
false
readOnly boolean
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].gitRepo

Name Type Description Required
directory string
false
repository string
false
revision string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].glusterfs

Name Type Description Required
endpoints string
false
path string
false
readOnly boolean
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].hostPath

Name Type Description Required
path string
false
type string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].iscsi

Name Type Description Required
chapAuthDiscovery boolean
false
chapAuthSession boolean
false
fsType string
false
initiatorName string
false
iqn string
false
iscsiInterface string
false
lun integer
false
portals []string
false
readOnly boolean
false
secretRef object
false
targetPortal string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].iscsi.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].nfs

Name Type Description Required
path string
false
readOnly boolean
false
server string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].persistentVolumeClaim

Name Type Description Required
claimName string
false
readOnly boolean
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].photonPersistentDisk

Name Type Description Required
fsType string
false
pdID string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].portworxVolume

Name Type Description Required
fsType string
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected

Name Type Description Required
defaultMode integer
false
sources []object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index]

Name Type Description Required
configMap object
false
downwardAPI object
false
secret object
false
serviceAccountToken object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].configMap

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].downwardAPI

Name Type Description Required
items []object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].secret

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].projected.sources[index].serviceAccountToken

Name Type Description Required
audience string
false
expirationSeconds integer
false
path string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].quobyte

Name Type Description Required
group string
false
readOnly boolean
false
registry string
false
tenant string
false
user string
false
volume string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].rbd

Name Type Description Required
fsType string
false
image string
false
keyring string
false
monitors []string
false
pool string
false
readOnly boolean
false
secretRef object
false
user string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].rbd.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].scaleIO

Name Type Description Required
fsType string
false
gateway string
false
protectionDomain string
false
readOnly boolean
false
secretRef object
false
sslEnabled boolean
false
storageMode string
false
storagePool string
false
system string
false
volumeName string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].scaleIO.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].secret

Name Type Description Required
defaultMode integer
false
items []object
false
optional boolean
false
secretName string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].storageos

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeName string
false
volumeNamespace string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].storageos.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.additionalVolumes.volumes[index].vsphereVolume

Name Type Description Required
fsType string
false
storagePolicyID string
false
storagePolicyName string
false
volumePath string
false

PulsarCluster.spec.broker.antiAffinity

Pod anti-affinity configuration. This override the global value if set.

Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false

PulsarCluster.spec.broker.antiAffinity.host

Indicates the reclaimPolicy property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.broker.antiAffinity.zone

Indicates the provisioner property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.broker.autoscaler

Autoscaling config.

Name Type Description Required
enabled boolean Enable autoscaling for brokers.
false
higherCpuThreshold number 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'

Minimum: 0
Maximum: 1
false
lowerCpuThreshold number 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'

Minimum: 0
Maximum: 1
false
max integer Max number of brokers. If the number of brokers is equals to this value, the autoscaler will never scale up.
false
min integer Min number of brokers. If the number of brokers is equals to this value, the autoscaler will never scale down.

Minimum: 1
false
periodMs integer The interval in milliseconds between two consecutive autoscaling checks.

Minimum: 1000
false
resourcesUsageSource string Source for getting the brokers resources usage. Possible values are 'PulsarLBReport' and 'K8SMetrics'. Default is 'PulsarLBReport'
false
scaleDownBy integer The number of brokers to remove at each scale down. Default is '1'

Minimum: 1
false
scaleUpBy integer The number of brokers to add at each scale up. Default is '1'

Minimum: 1
false
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.

Minimum: 1
false

PulsarCluster.spec.broker.env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.broker.env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.broker.env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.imagePullSecrets[index]

Name Type Description Required
name string
false

PulsarCluster.spec.broker.initContainers[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.broker.initContainers[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.broker.initContainers[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.broker.initContainers[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.initContainers[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.initContainers[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.initContainers[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.initContainers[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.broker.initContainers[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.broker.initContainers[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.broker.initContainers[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.initContainers[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.initContainers[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.initContainers[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.initContainers[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.initContainers[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.initContainers[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.initContainers[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.initContainers[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.broker.initContainers[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.initContainers[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.initContainers[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.initContainers[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.initContainers[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.initContainers[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.initContainers[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.initContainers[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.broker.initContainers[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.broker.initContainers[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.broker.initContainers[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.broker.initContainers[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.broker.initContainers[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.initContainers[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.initContainers[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.initContainers[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.initContainers[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.initContainers[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.initContainers[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.broker.initContainers[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.broker.kafka

Enable Kafka protocol.

Name Type Description Required
enabled boolean Allow the cluster to accept Kafka protocol. Default is 'false'.
false
exposePorts boolean Expose the kafka protocol port.
false

PulsarCluster.spec.broker.nodeAffinity

Node affinity configuration.

Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false

PulsarCluster.spec.broker.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

Name Type Description Required
preference object
false
weight integer
false

PulsarCluster.spec.broker.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.broker.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Name Type Description Required
nodeSelectorTerms []object
false

PulsarCluster.spec.broker.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.broker.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.pdb

Pod disruption budget configuration.

Name Type Description Required
enabled boolean Enable Pdb policy.
false
maxUnavailable integer Number of maxUnavailable pods.
false

PulsarCluster.spec.broker.probes

Liveness and readiness probes configuration.

Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false
useHealthCheckForLiveness boolean Use healthcheck for the liveness probe. If false, the /metrics endpoint will be used.
false
useHealthCheckForReadiness boolean Use healthcheck for the readiness probe. If false, the /metrics endpoint will be used.
false

PulsarCluster.spec.broker.probes.liveness

Liveness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.broker.probes.readiness

Readiness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.broker.resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.service

Service configuration.

Name Type Description Required
additionalPorts []object Additional ports to add to the Service.
false
annotations map[string]string Additional annotations to add to the Service.
false
type string Service type. Default value is 'ClusterIP'
false

PulsarCluster.spec.broker.service.additionalPorts[index]

Name Type Description Required
appProtocol string
false
name string
false
nodePort integer
false
port integer
false
protocol string
false
targetPort int or string
false

PulsarCluster.spec.broker.sets[key]

Name Type Description Required
additionalVolumes object Mount additional volumes to the pod.
false
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
autoscaler object Autoscaling config.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
functionsWorkerEnabled boolean Enable functions worker embedded in the broker.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
kafka object Enable Kafka protocol.
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
overrideResourceName string Override the resource names generated by the operator.
false
pdb object Pod disruption budget configuration.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
podManagementPolicy string Pod management policy.
false
probes object Liveness and readiness probes configuration.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
service object Service configuration.
false
serviceAccountName string Service account name for the resource.
false
sidecars []object Sidecar containers
false
tolerations []object Pod tolerations.
false
transactions object Enable transactions in the broker.
false
updateStrategy object Update strategy for the StatefulSet.
false

PulsarCluster.spec.broker.sets[key].additionalVolumes

Mount additional volumes to the pod.

Name Type Description Required
mounts []object Mount points for the additional volumes
false
volumes []object Additional volumes to be mounted to the pod
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.mounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index]

Name Type Description Required
awsElasticBlockStore object
false
azureDisk object
false
azureFile object
false
cephfs object
false
cinder object
false
configMap object
false
csi object
false
downwardAPI object
false
emptyDir object
false
ephemeral object
false
fc object
false
flexVolume object
false
flocker object
false
gcePersistentDisk object
false
gitRepo object
false
glusterfs object
false
hostPath object
false
iscsi object
false
name string
false
nfs object
false
persistentVolumeClaim object
false
photonPersistentDisk object
false
portworxVolume object
false
projected object
false
quobyte object
false
rbd object
false
scaleIO object
false
secret object
false
storageos object
false
vsphereVolume object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].awsElasticBlockStore

Name Type Description Required
fsType string
false
partition integer
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].azureDisk

Name Type Description Required
cachingMode string
false
diskName string
false
diskURI string
false
fsType string
false
kind string
false
readOnly boolean
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].azureFile

Name Type Description Required
readOnly boolean
false
secretName string
false
shareName string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].cephfs

Name Type Description Required
monitors []string
false
path string
false
readOnly boolean
false
secretFile string
false
secretRef object
false
user string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].cephfs.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].cinder

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeID string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].cinder.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].configMap

Name Type Description Required
defaultMode integer
false
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].csi

Name Type Description Required
driver string
false
fsType string
false
nodePublishSecretRef object
false
readOnly boolean
false
volumeAttributes map[string]string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].csi.nodePublishSecretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].downwardAPI

Name Type Description Required
defaultMode integer
false
items []object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].emptyDir

Name Type Description Required
medium string
false
sizeLimit int or string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral

Name Type Description Required
volumeClaimTemplate object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate

Name Type Description Required
metadata object
false
spec object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata

Name Type Description Required
annotations map[string]string
false
creationTimestamp string
false
deletionGracePeriodSeconds integer
false
deletionTimestamp string
false
finalizers []string
false
generateName string
false
generation integer
false
labels map[string]string
false
managedFields []object
false
name string
false
namespace string
false
ownerReferences []object
false
resourceVersion string
false
selfLink string
false
uid string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.managedFields[index]

Name Type Description Required
apiVersion string
false
fieldsType string
false
fieldsV1 object
false
manager string
false
operation string
false
subresource string
false
time string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.ownerReferences[index]

Name Type Description Required
apiVersion string
false
blockOwnerDeletion boolean
false
controller boolean
false
kind string
false
name string
false
uid string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec

Name Type Description Required
accessModes []string
false
dataSource object
false
dataSourceRef object
false
resources object
false
selector object
false
storageClassName string
false
volumeMode string
false
volumeName string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

Name Type Description Required
matchExpressions []object
false
matchLabels map[string]string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].fc

Name Type Description Required
fsType string
false
lun integer
false
readOnly boolean
false
targetWWNs []string
false
wwids []string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].flexVolume

Name Type Description Required
driver string
false
fsType string
false
options map[string]string
false
readOnly boolean
false
secretRef object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].flexVolume.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].flocker

Name Type Description Required
datasetName string
false
datasetUUID string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].gcePersistentDisk

Name Type Description Required
fsType string
false
partition integer
false
pdName string
false
readOnly boolean
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].gitRepo

Name Type Description Required
directory string
false
repository string
false
revision string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].glusterfs

Name Type Description Required
endpoints string
false
path string
false
readOnly boolean
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].hostPath

Name Type Description Required
path string
false
type string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].iscsi

Name Type Description Required
chapAuthDiscovery boolean
false
chapAuthSession boolean
false
fsType string
false
initiatorName string
false
iqn string
false
iscsiInterface string
false
lun integer
false
portals []string
false
readOnly boolean
false
secretRef object
false
targetPortal string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].iscsi.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].nfs

Name Type Description Required
path string
false
readOnly boolean
false
server string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].persistentVolumeClaim

Name Type Description Required
claimName string
false
readOnly boolean
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].photonPersistentDisk

Name Type Description Required
fsType string
false
pdID string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].portworxVolume

Name Type Description Required
fsType string
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected

Name Type Description Required
defaultMode integer
false
sources []object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index]

Name Type Description Required
configMap object
false
downwardAPI object
false
secret object
false
serviceAccountToken object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].configMap

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI

Name Type Description Required
items []object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].secret

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].projected.sources[index].serviceAccountToken

Name Type Description Required
audience string
false
expirationSeconds integer
false
path string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].quobyte

Name Type Description Required
group string
false
readOnly boolean
false
registry string
false
tenant string
false
user string
false
volume string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].rbd

Name Type Description Required
fsType string
false
image string
false
keyring string
false
monitors []string
false
pool string
false
readOnly boolean
false
secretRef object
false
user string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].rbd.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].scaleIO

Name Type Description Required
fsType string
false
gateway string
false
protectionDomain string
false
readOnly boolean
false
secretRef object
false
sslEnabled boolean
false
storageMode string
false
storagePool string
false
system string
false
volumeName string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].scaleIO.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].secret

Name Type Description Required
defaultMode integer
false
items []object
false
optional boolean
false
secretName string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].storageos

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeName string
false
volumeNamespace string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].storageos.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].additionalVolumes.volumes[index].vsphereVolume

Name Type Description Required
fsType string
false
storagePolicyID string
false
storagePolicyName string
false
volumePath string
false

PulsarCluster.spec.broker.sets[key].antiAffinity

Pod anti-affinity configuration. This override the global value if set.

Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false

PulsarCluster.spec.broker.sets[key].antiAffinity.host

Indicates the reclaimPolicy property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.broker.sets[key].antiAffinity.zone

Indicates the provisioner property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.broker.sets[key].autoscaler

Autoscaling config.

Name Type Description Required
enabled boolean Enable autoscaling for brokers.
false
higherCpuThreshold number 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'

Minimum: 0
Maximum: 1
false
lowerCpuThreshold number 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'

Minimum: 0
Maximum: 1
false
max integer Max number of brokers. If the number of brokers is equals to this value, the autoscaler will never scale up.
false
min integer Min number of brokers. If the number of brokers is equals to this value, the autoscaler will never scale down.

Minimum: 1
false
periodMs integer The interval in milliseconds between two consecutive autoscaling checks.

Minimum: 1000
false
resourcesUsageSource string Source for getting the brokers resources usage. Possible values are 'PulsarLBReport' and 'K8SMetrics'. Default is 'PulsarLBReport'
false
scaleDownBy integer The number of brokers to remove at each scale down. Default is '1'

Minimum: 1
false
scaleUpBy integer The number of brokers to add at each scale up. Default is '1'

Minimum: 1
false
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.

Minimum: 1
false

PulsarCluster.spec.broker.sets[key].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.broker.sets[key].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.broker.sets[key].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.sets[key].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.sets[key].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].imagePullSecrets[index]

Name Type Description Required
name string
false

PulsarCluster.spec.broker.sets[key].initContainers[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.broker.sets[key].initContainers[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.broker.sets[key].initContainers[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].initContainers[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].initContainers[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.broker.sets[key].initContainers[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].initContainers[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sets[key].initContainers[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sets[key].initContainers[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.broker.sets[key].initContainers[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sets[key].initContainers[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.broker.sets[key].initContainers[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.broker.sets[key].kafka

Enable Kafka protocol.

Name Type Description Required
enabled boolean Allow the cluster to accept Kafka protocol. Default is 'false'.
false
exposePorts boolean Expose the kafka protocol port.
false

PulsarCluster.spec.broker.sets[key].nodeAffinity

Node affinity configuration.

Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false

PulsarCluster.spec.broker.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

Name Type Description Required
preference object
false
weight integer
false

PulsarCluster.spec.broker.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.broker.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Name Type Description Required
nodeSelectorTerms []object
false

PulsarCluster.spec.broker.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.broker.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.broker.sets[key].pdb

Pod disruption budget configuration.

Name Type Description Required
enabled boolean Enable Pdb policy.
false
maxUnavailable integer Number of maxUnavailable pods.
false

PulsarCluster.spec.broker.sets[key].probes

Liveness and readiness probes configuration.

Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false
useHealthCheckForLiveness boolean Use healthcheck for the liveness probe. If false, the /metrics endpoint will be used.
false
useHealthCheckForReadiness boolean Use healthcheck for the readiness probe. If false, the /metrics endpoint will be used.
false

PulsarCluster.spec.broker.sets[key].probes.liveness

Liveness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.broker.sets[key].probes.readiness

Readiness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.broker.sets[key].resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.sets[key].service

Service configuration.

Name Type Description Required
additionalPorts []object Additional ports to add to the Service.
false
annotations map[string]string Additional annotations to add to the Service.
false
type string Service type. Default value is 'ClusterIP'
false

PulsarCluster.spec.broker.sets[key].service.additionalPorts[index]

Name Type Description Required
appProtocol string
false
name string
false
nodePort integer
false
port integer
false
protocol string
false
targetPort int or string
false

PulsarCluster.spec.broker.sets[key].sidecars[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.broker.sets[key].sidecars[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.broker.sets[key].sidecars[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].sidecars[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].sidecars[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.broker.sets[key].sidecars[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].sidecars[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sets[key].sidecars[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sets[key].sidecars[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.broker.sets[key].sidecars[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sets[key].sidecars[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.broker.sets[key].sidecars[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.broker.sets[key].tolerations[index]

Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false

PulsarCluster.spec.broker.sets[key].transactions

Enable transactions in the broker.

Name Type Description Required
enabled boolean Initialize the transaction coordinator if it's not yet and configure the broker to accept transactions.
false
initJob object Config for the init job.
false
partitions integer Number of coordinators to create.
false

PulsarCluster.spec.broker.sets[key].transactions.initJob

Config for the init job.

Name Type Description Required
resources object Resources requirements.
false

PulsarCluster.spec.broker.sets[key].transactions.initJob.resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.sets[key].updateStrategy

Update strategy for the StatefulSet.

Name Type Description Required
rollingUpdate object
false
type string
false

PulsarCluster.spec.broker.sets[key].updateStrategy.rollingUpdate

Name Type Description Required
maxUnavailable int or string
false
partition integer
false

PulsarCluster.spec.broker.sidecars[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.broker.sidecars[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.broker.sidecars[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.broker.sidecars[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sidecars[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.broker.sidecars[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.broker.sidecars[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.broker.sidecars[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.broker.sidecars[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.broker.sidecars[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.broker.sidecars[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sidecars[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sidecars[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sidecars[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sidecars[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sidecars[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sidecars[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sidecars[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sidecars[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.broker.sidecars[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sidecars[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sidecars[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sidecars[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sidecars[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sidecars[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sidecars[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.sidecars[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.broker.sidecars[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.broker.sidecars[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.broker.sidecars[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.broker.sidecars[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.broker.sidecars[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.broker.sidecars[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.broker.sidecars[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.broker.sidecars[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.broker.sidecars[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.broker.sidecars[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.broker.sidecars[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.broker.sidecars[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.broker.tolerations[index]

Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false

PulsarCluster.spec.broker.transactions

Enable transactions in the broker.

Name Type Description Required
enabled boolean Initialize the transaction coordinator if it's not yet and configure the broker to accept transactions.
false
initJob object Config for the init job.
false
partitions integer Number of coordinators to create.
false

PulsarCluster.spec.broker.transactions.initJob

Config for the init job.

Name Type Description Required
resources object Resources requirements.
false

PulsarCluster.spec.broker.transactions.initJob.resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.broker.updateStrategy

Update strategy for the StatefulSet.

Name Type Description Required
rollingUpdate object
false
type string
false

PulsarCluster.spec.broker.updateStrategy.rollingUpdate

Name Type Description Required
maxUnavailable int or string
false
partition integer
false

PulsarCluster.spec.functionsWorker

Name Type Description Required
additionalVolumes object Mount additional volumes to the pod.
false
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
labels map[string]string Labels to add to each resource (except pods).
false
logsVolume object Volume configuration for export function logs.
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
pdb object Pod disruption budget configuration.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
podManagementPolicy string Pod management policy.
false
probes object Liveness and readiness probes configuration.
false
rbac object RBAC config.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
runtime string Runtime mode for functions.
false
service object Service configuration.
false
serviceAccountName string Service account name for the resource.
false
sidecars []object Sidecar containers
false
tolerations []object Pod tolerations.
false
updateStrategy object Update strategy for the StatefulSet.
false

PulsarCluster.spec.functionsWorker.additionalVolumes

Mount additional volumes to the pod.

Name Type Description Required
mounts []object Mount points for the additional volumes
false
volumes []object Additional volumes to be mounted to the pod
false

PulsarCluster.spec.functionsWorker.additionalVolumes.mounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index]

Name Type Description Required
awsElasticBlockStore object
false
azureDisk object
false
azureFile object
false
cephfs object
false
cinder object
false
configMap object
false
csi object
false
downwardAPI object
false
emptyDir object
false
ephemeral object
false
fc object
false
flexVolume object
false
flocker object
false
gcePersistentDisk object
false
gitRepo object
false
glusterfs object
false
hostPath object
false
iscsi object
false
name string
false
nfs object
false
persistentVolumeClaim object
false
photonPersistentDisk object
false
portworxVolume object
false
projected object
false
quobyte object
false
rbd object
false
scaleIO object
false
secret object
false
storageos object
false
vsphereVolume object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].awsElasticBlockStore

Name Type Description Required
fsType string
false
partition integer
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].azureDisk

Name Type Description Required
cachingMode string
false
diskName string
false
diskURI string
false
fsType string
false
kind string
false
readOnly boolean
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].azureFile

Name Type Description Required
readOnly boolean
false
secretName string
false
shareName string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].cephfs

Name Type Description Required
monitors []string
false
path string
false
readOnly boolean
false
secretFile string
false
secretRef object
false
user string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].cephfs.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].cinder

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeID string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].cinder.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].configMap

Name Type Description Required
defaultMode integer
false
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].csi

Name Type Description Required
driver string
false
fsType string
false
nodePublishSecretRef object
false
readOnly boolean
false
volumeAttributes map[string]string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].csi.nodePublishSecretRef

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].downwardAPI

Name Type Description Required
defaultMode integer
false
items []object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].emptyDir

Name Type Description Required
medium string
false
sizeLimit int or string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral

Name Type Description Required
volumeClaimTemplate object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate

Name Type Description Required
metadata object
false
spec object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata

Name Type Description Required
annotations map[string]string
false
creationTimestamp string
false
deletionGracePeriodSeconds integer
false
deletionTimestamp string
false
finalizers []string
false
generateName string
false
generation integer
false
labels map[string]string
false
managedFields []object
false
name string
false
namespace string
false
ownerReferences []object
false
resourceVersion string
false
selfLink string
false
uid string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.managedFields[index]

Name Type Description Required
apiVersion string
false
fieldsType string
false
fieldsV1 object
false
manager string
false
operation string
false
subresource string
false
time string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.ownerReferences[index]

Name Type Description Required
apiVersion string
false
blockOwnerDeletion boolean
false
controller boolean
false
kind string
false
name string
false
uid string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec

Name Type Description Required
accessModes []string
false
dataSource object
false
dataSourceRef object
false
resources object
false
selector object
false
storageClassName string
false
volumeMode string
false
volumeName string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

Name Type Description Required
apiGroup string
false
kind string
false
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

Name Type Description Required
matchExpressions []object
false
matchLabels map[string]string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].fc

Name Type Description Required
fsType string
false
lun integer
false
readOnly boolean
false
targetWWNs []string
false
wwids []string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].flexVolume

Name Type Description Required
driver string
false
fsType string
false
options map[string]string
false
readOnly boolean
false
secretRef object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].flexVolume.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].flocker

Name Type Description Required
datasetName string
false
datasetUUID string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].gcePersistentDisk

Name Type Description Required
fsType string
false
partition integer
false
pdName string
false
readOnly boolean
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].gitRepo

Name Type Description Required
directory string
false
repository string
false
revision string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].glusterfs

Name Type Description Required
endpoints string
false
path string
false
readOnly boolean
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].hostPath

Name Type Description Required
path string
false
type string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].iscsi

Name Type Description Required
chapAuthDiscovery boolean
false
chapAuthSession boolean
false
fsType string
false
initiatorName string
false
iqn string
false
iscsiInterface string
false
lun integer
false
portals []string
false
readOnly boolean
false
secretRef object
false
targetPortal string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].iscsi.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].nfs

Name Type Description Required
path string
false
readOnly boolean
false
server string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].persistentVolumeClaim

Name Type Description Required
claimName string
false
readOnly boolean
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].photonPersistentDisk

Name Type Description Required
fsType string
false
pdID string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].portworxVolume

Name Type Description Required
fsType string
false
readOnly boolean
false
volumeID string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected

Name Type Description Required
defaultMode integer
false
sources []object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index]

Name Type Description Required
configMap object
false
downwardAPI object
false
secret object
false
serviceAccountToken object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].configMap

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].configMap.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].downwardAPI

Name Type Description Required
items []object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]

Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].secret

Name Type Description Required
items []object
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].projected.sources[index].serviceAccountToken

Name Type Description Required
audience string
false
expirationSeconds integer
false
path string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].quobyte

Name Type Description Required
group string
false
readOnly boolean
false
registry string
false
tenant string
false
user string
false
volume string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].rbd

Name Type Description Required
fsType string
false
image string
false
keyring string
false
monitors []string
false
pool string
false
readOnly boolean
false
secretRef object
false
user string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].rbd.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].scaleIO

Name Type Description Required
fsType string
false
gateway string
false
protectionDomain string
false
readOnly boolean
false
secretRef object
false
sslEnabled boolean
false
storageMode string
false
storagePool string
false
system string
false
volumeName string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].scaleIO.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].secret

Name Type Description Required
defaultMode integer
false
items []object
false
optional boolean
false
secretName string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].secret.items[index]

Name Type Description Required
key string
false
mode integer
false
path string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].storageos

Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeName string
false
volumeNamespace string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].storageos.secretRef

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.additionalVolumes.volumes[index].vsphereVolume

Name Type Description Required
fsType string
false
storagePolicyID string
false
storagePolicyName string
false
volumePath string
false

PulsarCluster.spec.functionsWorker.antiAffinity

Pod anti-affinity configuration. This override the global value if set.

Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false

PulsarCluster.spec.functionsWorker.antiAffinity.host

Indicates the reclaimPolicy property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.functionsWorker.antiAffinity.zone

Indicates the provisioner property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.functionsWorker.env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.functionsWorker.env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.functionsWorker.env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.functionsWorker.env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.functionsWorker.env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.imagePullSecrets[index]

Name Type Description Required
name string
false

PulsarCluster.spec.functionsWorker.initContainers[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.functionsWorker.initContainers[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.functionsWorker.initContainers[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.functionsWorker.initContainers[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.initContainers[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.functionsWorker.initContainers[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.functionsWorker.initContainers[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.initContainers[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.functionsWorker.initContainers[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.initContainers[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.initContainers[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.initContainers[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.functionsWorker.initContainers[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.initContainers[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.functionsWorker.initContainers[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.initContainers[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.initContainers[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.initContainers[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.functionsWorker.initContainers[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.functionsWorker.initContainers[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.initContainers[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.functionsWorker.initContainers[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.initContainers[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.initContainers[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.initContainers[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.functionsWorker.initContainers[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.functionsWorker.initContainers[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.functionsWorker.initContainers[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.functionsWorker.initContainers[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.functionsWorker.initContainers[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.functionsWorker.initContainers[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.functionsWorker.initContainers[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.initContainers[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.functionsWorker.initContainers[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.initContainers[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.initContainers[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.initContainers[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.functionsWorker.initContainers[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.functionsWorker.logsVolume

Volume configuration for export function logs.

Name Type Description Required
existingStorageClassName string Indicates if an already existing storage class should be used.
false
name string Indicates the suffix for the volume. Default value is 'data'.
false
size string Indicates the requested size for the volume. The format follows the Kubernetes' Quantity.
false
storageClass object Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
false

PulsarCluster.spec.functionsWorker.logsVolume.storageClass

Indicates if a StorageClass is used. The operator will create the StorageClass if needed.

Name Type Description Required
extraParams map[string]string Adds extra parameters for the StorageClass.
false
fsType string Indicates the 'fsType' parameter for the StorageClass.
false
provisioner string Indicates the provisioner property for the StorageClass.
false
reclaimPolicy string Indicates the reclaimPolicy property for the StorageClass.
false
type string Indicates the 'type' parameter for the StorageClass.
false

PulsarCluster.spec.functionsWorker.nodeAffinity

Node affinity configuration.

Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false

PulsarCluster.spec.functionsWorker.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

Name Type Description Required
preference object
false
weight integer
false

PulsarCluster.spec.functionsWorker.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.functionsWorker.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.functionsWorker.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.functionsWorker.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Name Type Description Required
nodeSelectorTerms []object
false

PulsarCluster.spec.functionsWorker.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Name Type Description Required
matchExpressions []object
false
matchFields []object
false

PulsarCluster.spec.functionsWorker.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.functionsWorker.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

Name Type Description Required
key string
false
operator string
false
values []string
false

PulsarCluster.spec.functionsWorker.pdb

Pod disruption budget configuration.

Name Type Description Required
enabled boolean Enable Pdb policy.
false
maxUnavailable integer Number of maxUnavailable pods.
false

PulsarCluster.spec.functionsWorker.probes

Liveness and readiness probes configuration.

Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false

PulsarCluster.spec.functionsWorker.probes.liveness

Liveness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.functionsWorker.probes.readiness

Readiness probe configuration.

Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false

PulsarCluster.spec.functionsWorker.rbac

RBAC config.

Name Type Description Required
create boolean Create needed RBAC to run the Functions Worker.
false
namespaced boolean Whether or not the RBAC is created per-namespace or cluster-wise.
false

PulsarCluster.spec.functionsWorker.resources

Resources requirements.

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.functionsWorker.service

Service configuration.

Name Type Description Required
additionalPorts []object Additional ports to add to the Service.
false
annotations map[string]string Additional annotations to add to the Service.
false
type string Service type. Default value is 'ClusterIP'
false

PulsarCluster.spec.functionsWorker.service.additionalPorts[index]

Name Type Description Required
appProtocol string
false
name string
false
nodePort integer
false
port integer
false
protocol string
false
targetPort int or string
false

PulsarCluster.spec.functionsWorker.sidecars[index]

Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false

PulsarCluster.spec.functionsWorker.sidecars[index].env[index]

Name Type Description Required
name string
false
value string
false
valueFrom object
false

PulsarCluster.spec.functionsWorker.sidecars[index].env[index].valueFrom

Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false

PulsarCluster.spec.functionsWorker.sidecars[index].env[index].valueFrom.configMapKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.sidecars[index].env[index].valueFrom.fieldRef

Name Type Description Required
apiVersion string
false
fieldPath string
false

PulsarCluster.spec.functionsWorker.sidecars[index].env[index].valueFrom.resourceFieldRef

Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false

PulsarCluster.spec.functionsWorker.sidecars[index].env[index].valueFrom.secretKeyRef

Name Type Description Required
key string
false
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.sidecars[index].envFrom[index]

Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false

PulsarCluster.spec.functionsWorker.sidecars[index].envFrom[index].configMapRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.sidecars[index].envFrom[index].secretRef

Name Type Description Required
name string
false
optional boolean
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle

Name Type Description Required
postStart object
false
preStop object
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.postStart

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.postStart.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.postStart.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.postStart.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.preStop

Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.preStop.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.preStop.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.sidecars[index].lifecycle.preStop.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.sidecars[index].livenessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.functionsWorker.sidecars[index].livenessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.sidecars[index].livenessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.functionsWorker.sidecars[index].livenessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.sidecars[index].livenessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.sidecars[index].livenessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.sidecars[index].ports[index]

Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false

PulsarCluster.spec.functionsWorker.sidecars[index].readinessProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.functionsWorker.sidecars[index].readinessProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.sidecars[index].readinessProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.functionsWorker.sidecars[index].readinessProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.sidecars[index].readinessProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.sidecars[index].readinessProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.sidecars[index].resources

Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false

PulsarCluster.spec.functionsWorker.sidecars[index].securityContext

Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false

PulsarCluster.spec.functionsWorker.sidecars[index].securityContext.capabilities

Name Type Description Required
add []string
false
drop []string
false

PulsarCluster.spec.functionsWorker.sidecars[index].securityContext.seLinuxOptions

Name Type Description Required
level string
false
role string
false
type string
false
user string
false

PulsarCluster.spec.functionsWorker.sidecars[index].securityContext.seccompProfile

Name Type Description Required
localhostProfile string
false
type string
false

PulsarCluster.spec.functionsWorker.sidecars[index].securityContext.windowsOptions

Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false

PulsarCluster.spec.functionsWorker.sidecars[index].startupProbe

Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false

PulsarCluster.spec.functionsWorker.sidecars[index].startupProbe.exec

Name Type Description Required
command []string
false

PulsarCluster.spec.functionsWorker.sidecars[index].startupProbe.grpc

Name Type Description Required
port integer
false
service string
false

PulsarCluster.spec.functionsWorker.sidecars[index].startupProbe.httpGet

Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false

PulsarCluster.spec.functionsWorker.sidecars[index].startupProbe.httpGet.httpHeaders[index]

Name Type Description Required
name string
false
value string
false

PulsarCluster.spec.functionsWorker.sidecars[index].startupProbe.tcpSocket

Name Type Description Required
host string
false
port int or string
false

PulsarCluster.spec.functionsWorker.sidecars[index].volumeDevices[index]

Name Type Description Required
devicePath string
false
name string
false

PulsarCluster.spec.functionsWorker.sidecars[index].volumeMounts[index]

Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false

PulsarCluster.spec.functionsWorker.tolerations[index]

Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false

PulsarCluster.spec.functionsWorker.updateStrategy

Update strategy for the StatefulSet.

Name Type Description Required
rollingUpdate object
false
type string
false

PulsarCluster.spec.functionsWorker.updateStrategy.rollingUpdate

Name Type Description Required
maxUnavailable int or string
false
partition integer
false

PulsarCluster.spec.global

Name Type Description Required
name string Name of the Pulsar cluster spec. This is used as a prefix for managed Kubernetes resources.
true
antiAffinity object Pod anti affinity configuration.
false
auth object Authentication and authorization configuration.
false
clusterName string Corresponds to the 'clusterName' field in the broker.conf. Defaults to the value of the 'name' field
false
components object Pulsar cluster components names.
false
dnsConfig object Override default DNS config for each pod. Note that because we use fully qualified service names for intra cluster networking with Pulsar components, we set the ndots value to 4 (the default is 5). This prevents unnecessary DNS lookups for the fully qualified service names that would be guaranteed to result in NXDOMAIN. For example, the name 'pulsar-broker.pulsar.svc.cluster.local' has 4 dots, so it would be resolved directly instead of appending the configured search domains. More info here: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-config.
false
dnsName string Public dns name for the cluster's load balancer.
false
image string Default Pulsar image to use. Any components can be configured to use a different image.
false
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'.
false
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'.
false
nodeSelectors map[string]string Global node selector. If set, this will apply to all the components.
false
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
false
priorityClassName string Priority class name to attach to each pod.
false
racks map[string]object Racks configuration.
false
resourceSets map[string]object Resource sets.
false
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.
false
storage object Storage configuration.
false
tls object TLS configuration for the cluster.
false
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.
false

PulsarCluster.spec.global.antiAffinity

Pod anti affinity configuration.

Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false

PulsarCluster.spec.global.antiAffinity.host

Indicates the reclaimPolicy property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.global.antiAffinity.zone

Indicates the provisioner property for the StorageClass.

Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false

PulsarCluster.spec.global.auth

Authentication and authorization configuration.

Name Type Description Required
enabled boolean Enable authentication in the cluster. Default is 'false'.
false
token object Token based authentication configuration.
false

PulsarCluster.spec.global.auth.token

Token based authentication configuration.

</tr></tbody> </table> ### PulsarCluster.spec.global.components Pulsar cluster components names.
Name Type Description Required
initialize boolean Initialize Secrets with new pair of keys and tokens for the super user roles. The generated Secret name is 'token-'.
</td>
false
privateKeyFile string Private key file name stored in the Secret. Default is 'my-private.key'
false
proxyRoles []string Proxy roles.
false
publicKeyFile string Public key file name stored in the Secret. Default is 'my-public.key'
false
superUserRoles []string Super user roles.
false
Name Type Description Required
autorecoveryBaseName string Autorecovery base name. Default value is 'autorecovery'.
false
bastionBaseName string Bastion base name. Default value is 'bastion'.
false
bookkeeperBaseName string BookKeeper base name. Default value is 'bookkeeper'.
false
brokerBaseName string Broker base name. Default value is 'broker'.
false
functionsWorkerBaseName string Functions Worker base name. Default value is 'function'.
false
proxyBaseName string Proxy base name. Default value is 'proxy'.
false
zookeeperBaseName string Zookeeper base name. Default value is 'zookeeper'.
false
### PulsarCluster.spec.global.dnsConfig Override default DNS config for each pod. Note that because we use fully qualified service names for intra cluster networking with Pulsar components, we set the ndots value to 4 (the default is 5). This prevents unnecessary DNS lookups for the fully qualified service names that would be guaranteed to result in NXDOMAIN. For example, the name 'pulsar-broker.pulsar.svc.cluster.local' has 4 dots, so it would be resolved directly instead of appending the configured search domains. More info here: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-config.
Name Type Description Required
nameservers []string
false
options []object
false
searches []string
false
### PulsarCluster.spec.global.dnsConfig.options[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.global.racks[key]
Name Type Description Required
host object Enable rack rules based on the hostname of the node.
false
zone object Enable rack rules based on the failure domain (availability zone) of the node.
false
### PulsarCluster.spec.global.racks[key].host Enable rack rules based on the hostname of the node.
Name Type Description Required
enabled boolean Enable the rack affinity rules.
false
requireRackAffinity boolean Indicates if the podAffinity rules will be enforced. Default is false. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.
false
requireRackAntiAffinity boolean Indicates if the podAntiAffinity rules will be enforced. Default is true. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.
false
### PulsarCluster.spec.global.racks[key].zone Enable rack rules based on the failure domain (availability zone) of the node.
Name Type Description Required
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.
false
enabled boolean Enable the rack affinity rules.
false
requireRackAffinity boolean Indicates if the podAffinity rules will be enforced. Default is false. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.
false
requireRackAntiAffinity boolean Indicates if the podAntiAffinity rules will be enforced. Default is true. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'.
false
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'.
false
### PulsarCluster.spec.global.resourceSets[key]
Name Type Description Required
rack string Place this resource set to a specific rack, defined at .global.racks.
false
### PulsarCluster.spec.global.storage Storage configuration.
Name Type Description Required
existingStorageClassName string Indicates if an already existing storage class should be used.
false
storageClass object Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
false
### PulsarCluster.spec.global.storage.storageClass Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
Name Type Description Required
extraParams map[string]string Adds extra parameters for the StorageClass.
false
fsType string Indicates the 'fsType' parameter for the StorageClass.
false
provisioner string Indicates the provisioner property for the StorageClass.
false
reclaimPolicy string Indicates the reclaimPolicy property for the StorageClass.
false
type string Indicates the 'type' parameter for the StorageClass.
false
### PulsarCluster.spec.global.tls TLS configuration for the cluster.
Name Type Description Required
autorecovery object TLS configurations related to the Autorecovery component.
false
bookkeeper object TLS configurations related to the BookKeeper component.
false
broker object TLS configurations related to the Broker component.
false
brokerResourceSets map[string]object TLS configurations related to the Broker resource sets.
false
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.
false
certProvisioner object Certificate provisioner configuration.
false
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.
false
enabled boolean Deprecated. Use the 'enabled' field in each component spec instead.
false
functionsWorker object TLS configurations related to the Functions worker component.
false
proxy object TLS configurations related to the Proxy component.
false
proxyResourceSets map[string]object TLS configurations related to the Proxy resource sets.
false
ssCa object TLS configurations used by additional components, such as the Bastion component.
false
zookeeper object TLS configurations related to the ZooKeeper component.
false
### PulsarCluster.spec.global.tls.autorecovery TLS configurations related to the Autorecovery component.
Name Type Description Required
enabled boolean Enable TLS.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.global.tls.bookkeeper TLS configurations related to the BookKeeper component.
Name Type Description Required
enabled boolean Enable TLS.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.global.tls.broker TLS configurations related to the Broker component.
Name Type Description Required
enabled boolean Enable TLS.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.global.tls.brokerResourceSets[key]
Name Type Description Required
enabled boolean Enable TLS.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.global.tls.certProvisioner Certificate provisioner configuration.
Name Type Description Required
selfSigned object Self signed certificate provisioner configuration.
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned Self signed certificate provisioner configuration.
Name Type Description Required
autorecovery object Autorecovery self signed certificate config.
false
bookkeeper object Bookkeeper self signed certificate config.
false
broker object Broker self signed certificate config.
false
caSecretName string Secret where to store the root CA certificate.
false
enabled boolean Generate self signed certificates for broker, proxy and functions worker.
false
functionsWorker object Functions worker self signed certificate config.
false
includeDns boolean Include dns name in the DNS names covered by the certificate.
false
perComponent boolean Generate a different certificate for each component.
false
privateKey object Cert-manager options for generating the private key.
false
proxy object Proxy self signed certificate config.
false
zookeeper object Zookeeper self signed certificate config.
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.autorecovery Autorecovery self signed certificate config.
Name Type Description Required
generate boolean Generate self signed certificates for the component.
false
privateKey object Cert-manager options for generating the private key.
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.autorecovery.privateKey Cert-manager options for generating the private key.
Name Type Description Required
algorithm string
false
encoding string
false
rotationPolicy string
false
size integer
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.bookkeeper Bookkeeper self signed certificate config.
Name Type Description Required
generate boolean Generate self signed certificates for the component.
false
privateKey object Cert-manager options for generating the private key.
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.bookkeeper.privateKey Cert-manager options for generating the private key.
Name Type Description Required
algorithm string
false
encoding string
false
rotationPolicy string
false
size integer
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.broker Broker self signed certificate config.
Name Type Description Required
generate boolean Generate self signed certificates for the component.
false
privateKey object Cert-manager options for generating the private key.
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.broker.privateKey Cert-manager options for generating the private key.
Name Type Description Required
algorithm string
false
encoding string
false
rotationPolicy string
false
size integer
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.functionsWorker Functions worker self signed certificate config.
Name Type Description Required
generate boolean Generate self signed certificates for the component.
false
privateKey object Cert-manager options for generating the private key.
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.functionsWorker.privateKey Cert-manager options for generating the private key.
Name Type Description Required
algorithm string
false
encoding string
false
rotationPolicy string
false
size integer
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.privateKey Cert-manager options for generating the private key.
Name Type Description Required
algorithm string
false
encoding string
false
rotationPolicy string
false
size integer
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.proxy Proxy self signed certificate config.
Name Type Description Required
generate boolean Generate self signed certificates for the component.
false
privateKey object Cert-manager options for generating the private key.
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.proxy.privateKey Cert-manager options for generating the private key.
Name Type Description Required
algorithm string
false
encoding string
false
rotationPolicy string
false
size integer
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.zookeeper Zookeeper self signed certificate config.
Name Type Description Required
generate boolean Generate self signed certificates for the component.
false
privateKey object Cert-manager options for generating the private key.
false
### PulsarCluster.spec.global.tls.certProvisioner.selfSigned.zookeeper.privateKey Cert-manager options for generating the private key.
Name Type Description Required
algorithm string
false
encoding string
false
rotationPolicy string
false
size integer
false
### PulsarCluster.spec.global.tls.functionsWorker TLS configurations related to the Functions worker component.
Name Type Description Required
enabled boolean Enable TLS.
false
enabledWithBroker boolean Enable TLS for the functions worker to broker connections.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.global.tls.proxy TLS configurations related to the Proxy component.
Name Type Description Required
enabled boolean Enable TLS.
false
enabledWithBroker boolean Enable TLS for the proxy to broker connections.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.global.tls.proxyResourceSets[key]
Name Type Description Required
enabled boolean Enable TLS.
false
enabledWithBroker boolean Enable TLS for the proxy to broker connections.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.global.tls.ssCa TLS configurations used by additional components, such as the Bastion component.
Name Type Description Required
enabled boolean Enable TLS.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.global.tls.zookeeper TLS configurations related to the ZooKeeper component.
Name Type Description Required
enabled boolean Enable TLS.
false
secretName string Override the default secret name from where to load the certificates.
false
### PulsarCluster.spec.proxy
Name Type Description Required
additionalVolumes object Mount additional volumes to the pod.
false
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
kafka object Enable Kafka protocol.
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
overrideResourceName string Override the resource names generated by the operator.
false
pdb object Pod disruption budget configuration.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
probes object Liveness and readiness probes configuration.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
service object Service configuration.
false
serviceAccountName string Service account name for the resource.
false
sets map[string]object Proxy sets.
false
setsUpdateStrategy string Sets update strategy. 'RollingUpdate' or 'Parallel'. Default is 'RollingUpdate'.
false
sidecars []object Sidecar containers
false
standaloneFunctionsWorker boolean Whether or not the functions worker is in standalone mode.
false
tolerations []object Pod tolerations.
false
updateStrategy object Strategy for the proxy deployment.
false
webSocket object WebSocket configuration.
false
### PulsarCluster.spec.proxy.additionalVolumes Mount additional volumes to the pod.
Name Type Description Required
mounts []object Mount points for the additional volumes
false
volumes []object Additional volumes to be mounted to the pod
false
### PulsarCluster.spec.proxy.additionalVolumes.mounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index]
Name Type Description Required
awsElasticBlockStore object
false
azureDisk object
false
azureFile object
false
cephfs object
false
cinder object
false
configMap object
false
csi object
false
downwardAPI object
false
emptyDir object
false
ephemeral object
false
fc object
false
flexVolume object
false
flocker object
false
gcePersistentDisk object
false
gitRepo object
false
glusterfs object
false
hostPath object
false
iscsi object
false
name string
false
nfs object
false
persistentVolumeClaim object
false
photonPersistentDisk object
false
portworxVolume object
false
projected object
false
quobyte object
false
rbd object
false
scaleIO object
false
secret object
false
storageos object
false
vsphereVolume object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].awsElasticBlockStore
Name Type Description Required
fsType string
false
partition integer
false
readOnly boolean
false
volumeID string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].azureDisk
Name Type Description Required
cachingMode string
false
diskName string
false
diskURI string
false
fsType string
false
kind string
false
readOnly boolean
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].azureFile
Name Type Description Required
readOnly boolean
false
secretName string
false
shareName string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].cephfs
Name Type Description Required
monitors []string
false
path string
false
readOnly boolean
false
secretFile string
false
secretRef object
false
user string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].cephfs.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].cinder
Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeID string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].cinder.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].configMap
Name Type Description Required
defaultMode integer
false
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].configMap.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].csi
Name Type Description Required
driver string
false
fsType string
false
nodePublishSecretRef object
false
readOnly boolean
false
volumeAttributes map[string]string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].csi.nodePublishSecretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].downwardAPI
Name Type Description Required
defaultMode integer
false
items []object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].downwardAPI.items[index]
Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].downwardAPI.items[index].fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].emptyDir
Name Type Description Required
medium string
false
sizeLimit int or string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral
Name Type Description Required
volumeClaimTemplate object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate
Name Type Description Required
metadata object
false
spec object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata
Name Type Description Required
annotations map[string]string
false
creationTimestamp string
false
deletionGracePeriodSeconds integer
false
deletionTimestamp string
false
finalizers []string
false
generateName string
false
generation integer
false
labels map[string]string
false
managedFields []object
false
name string
false
namespace string
false
ownerReferences []object
false
resourceVersion string
false
selfLink string
false
uid string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.managedFields[index]
Name Type Description Required
apiVersion string
false
fieldsType string
false
fieldsV1 object
false
manager string
false
operation string
false
subresource string
false
time string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.ownerReferences[index]
Name Type Description Required
apiVersion string
false
blockOwnerDeletion boolean
false
controller boolean
false
kind string
false
name string
false
uid string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec
Name Type Description Required
accessModes []string
false
dataSource object
false
dataSourceRef object
false
resources object
false
selector object
false
storageClassName string
false
volumeMode string
false
volumeName string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource
Name Type Description Required
apiGroup string
false
kind string
false
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef
Name Type Description Required
apiGroup string
false
kind string
false
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector
Name Type Description Required
matchExpressions []object
false
matchLabels map[string]string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].fc
Name Type Description Required
fsType string
false
lun integer
false
readOnly boolean
false
targetWWNs []string
false
wwids []string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].flexVolume
Name Type Description Required
driver string
false
fsType string
false
options map[string]string
false
readOnly boolean
false
secretRef object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].flexVolume.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].flocker
Name Type Description Required
datasetName string
false
datasetUUID string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].gcePersistentDisk
Name Type Description Required
fsType string
false
partition integer
false
pdName string
false
readOnly boolean
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].gitRepo
Name Type Description Required
directory string
false
repository string
false
revision string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].glusterfs
Name Type Description Required
endpoints string
false
path string
false
readOnly boolean
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].hostPath
Name Type Description Required
path string
false
type string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].iscsi
Name Type Description Required
chapAuthDiscovery boolean
false
chapAuthSession boolean
false
fsType string
false
initiatorName string
false
iqn string
false
iscsiInterface string
false
lun integer
false
portals []string
false
readOnly boolean
false
secretRef object
false
targetPortal string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].iscsi.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].nfs
Name Type Description Required
path string
false
readOnly boolean
false
server string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].persistentVolumeClaim
Name Type Description Required
claimName string
false
readOnly boolean
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].photonPersistentDisk
Name Type Description Required
fsType string
false
pdID string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].portworxVolume
Name Type Description Required
fsType string
false
readOnly boolean
false
volumeID string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected
Name Type Description Required
defaultMode integer
false
sources []object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index]
Name Type Description Required
configMap object
false
downwardAPI object
false
secret object
false
serviceAccountToken object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].configMap
Name Type Description Required
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].configMap.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].downwardAPI
Name Type Description Required
items []object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]
Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].secret
Name Type Description Required
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].secret.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].projected.sources[index].serviceAccountToken
Name Type Description Required
audience string
false
expirationSeconds integer
false
path string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].quobyte
Name Type Description Required
group string
false
readOnly boolean
false
registry string
false
tenant string
false
user string
false
volume string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].rbd
Name Type Description Required
fsType string
false
image string
false
keyring string
false
monitors []string
false
pool string
false
readOnly boolean
false
secretRef object
false
user string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].rbd.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].scaleIO
Name Type Description Required
fsType string
false
gateway string
false
protectionDomain string
false
readOnly boolean
false
secretRef object
false
sslEnabled boolean
false
storageMode string
false
storagePool string
false
system string
false
volumeName string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].scaleIO.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].secret
Name Type Description Required
defaultMode integer
false
items []object
false
optional boolean
false
secretName string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].secret.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].storageos
Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeName string
false
volumeNamespace string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].storageos.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.additionalVolumes.volumes[index].vsphereVolume
Name Type Description Required
fsType string
false
storagePolicyID string
false
storagePolicyName string
false
volumePath string
false
### PulsarCluster.spec.proxy.antiAffinity Pod anti-affinity configuration. This override the global value if set.
Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false
### PulsarCluster.spec.proxy.antiAffinity.host Indicates the reclaimPolicy property for the StorageClass.
Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false
### PulsarCluster.spec.proxy.antiAffinity.zone Indicates the provisioner property for the StorageClass.
Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false
### PulsarCluster.spec.proxy.env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.proxy.env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.proxy.env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.imagePullSecrets[index]
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.initContainers[index]
Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false
### PulsarCluster.spec.proxy.initContainers[index].env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.proxy.initContainers[index].env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.proxy.initContainers[index].env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.initContainers[index].env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.initContainers[index].env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.initContainers[index].env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.initContainers[index].envFrom[index]
Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false
### PulsarCluster.spec.proxy.initContainers[index].envFrom[index].configMapRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.initContainers[index].envFrom[index].secretRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle
Name Type Description Required
postStart object
false
preStop object
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.postStart
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.postStart.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.postStart.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.postStart.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.preStop
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.preStop.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.preStop.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.initContainers[index].lifecycle.preStop.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.initContainers[index].livenessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.initContainers[index].livenessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.initContainers[index].livenessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.initContainers[index].livenessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.initContainers[index].livenessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.initContainers[index].livenessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.initContainers[index].ports[index]
Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false
### PulsarCluster.spec.proxy.initContainers[index].readinessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.initContainers[index].readinessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.initContainers[index].readinessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.initContainers[index].readinessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.initContainers[index].readinessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.initContainers[index].readinessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.initContainers[index].resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.initContainers[index].securityContext
Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false
### PulsarCluster.spec.proxy.initContainers[index].securityContext.capabilities
Name Type Description Required
add []string
false
drop []string
false
### PulsarCluster.spec.proxy.initContainers[index].securityContext.seLinuxOptions
Name Type Description Required
level string
false
role string
false
type string
false
user string
false
### PulsarCluster.spec.proxy.initContainers[index].securityContext.seccompProfile
Name Type Description Required
localhostProfile string
false
type string
false
### PulsarCluster.spec.proxy.initContainers[index].securityContext.windowsOptions
Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false
### PulsarCluster.spec.proxy.initContainers[index].startupProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.initContainers[index].startupProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.initContainers[index].startupProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.initContainers[index].startupProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.initContainers[index].startupProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.initContainers[index].startupProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.initContainers[index].volumeDevices[index]
Name Type Description Required
devicePath string
false
name string
false
### PulsarCluster.spec.proxy.initContainers[index].volumeMounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.proxy.kafka Enable Kafka protocol.
Name Type Description Required
enabled boolean Allow the cluster to accept Kafka protocol. Default is 'false'.
false
exposePorts boolean Expose the kafka protocol port.
false
### PulsarCluster.spec.proxy.nodeAffinity Node affinity configuration.
Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false
### PulsarCluster.spec.proxy.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
Name Type Description Required
preference object
false
weight integer
false
### PulsarCluster.spec.proxy.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
Name Type Description Required
matchExpressions []object
false
matchFields []object
false
### PulsarCluster.spec.proxy.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
Name Type Description Required
nodeSelectorTerms []object
false
### PulsarCluster.spec.proxy.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
Name Type Description Required
matchExpressions []object
false
matchFields []object
false
### PulsarCluster.spec.proxy.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.pdb Pod disruption budget configuration.
Name Type Description Required
enabled boolean Enable Pdb policy.
false
maxUnavailable integer Number of maxUnavailable pods.
false
### PulsarCluster.spec.proxy.probes Liveness and readiness probes configuration.
Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false
### PulsarCluster.spec.proxy.probes.liveness Liveness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.proxy.probes.readiness Readiness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.proxy.resources Resources requirements.
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.service Service configuration.
Name Type Description Required
additionalPorts []object Additional ports to add to the Service.
false
annotations map[string]string Additional annotations to add to the Service.
false
enablePlainTextWithTLS boolean Enable plain text connections even if TLS is enabled.
false
loadBalancerIP string Assign a load balancer IP.
false
type string Service type. Default value is 'ClusterIP'
false
### PulsarCluster.spec.proxy.service.additionalPorts[index]
Name Type Description Required
appProtocol string
false
name string
false
nodePort integer
false
port integer
false
protocol string
false
targetPort int or string
false
### PulsarCluster.spec.proxy.sets[key]
Name Type Description Required
additionalVolumes object Mount additional volumes to the pod.
false
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
config JSON Configuration.
false
env []object Additional container env variables.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
kafka object Enable Kafka protocol.
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
overrideResourceName string Override the resource names generated by the operator.
false
pdb object Pod disruption budget configuration.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
probes object Liveness and readiness probes configuration.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
service object Service configuration.
false
serviceAccountName string Service account name for the resource.
false
sidecars []object Sidecar containers
false
standaloneFunctionsWorker boolean Whether or not the functions worker is in standalone mode.
false
tolerations []object Pod tolerations.
false
updateStrategy object Strategy for the proxy deployment.
false
webSocket object WebSocket configuration.
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes Mount additional volumes to the pod.
Name Type Description Required
mounts []object Mount points for the additional volumes
false
volumes []object Additional volumes to be mounted to the pod
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.mounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index]
Name Type Description Required
awsElasticBlockStore object
false
azureDisk object
false
azureFile object
false
cephfs object
false
cinder object
false
configMap object
false
csi object
false
downwardAPI object
false
emptyDir object
false
ephemeral object
false
fc object
false
flexVolume object
false
flocker object
false
gcePersistentDisk object
false
gitRepo object
false
glusterfs object
false
hostPath object
false
iscsi object
false
name string
false
nfs object
false
persistentVolumeClaim object
false
photonPersistentDisk object
false
portworxVolume object
false
projected object
false
quobyte object
false
rbd object
false
scaleIO object
false
secret object
false
storageos object
false
vsphereVolume object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].awsElasticBlockStore
Name Type Description Required
fsType string
false
partition integer
false
readOnly boolean
false
volumeID string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].azureDisk
Name Type Description Required
cachingMode string
false
diskName string
false
diskURI string
false
fsType string
false
kind string
false
readOnly boolean
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].azureFile
Name Type Description Required
readOnly boolean
false
secretName string
false
shareName string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].cephfs
Name Type Description Required
monitors []string
false
path string
false
readOnly boolean
false
secretFile string
false
secretRef object
false
user string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].cephfs.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].cinder
Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeID string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].cinder.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].configMap
Name Type Description Required
defaultMode integer
false
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].configMap.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].csi
Name Type Description Required
driver string
false
fsType string
false
nodePublishSecretRef object
false
readOnly boolean
false
volumeAttributes map[string]string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].csi.nodePublishSecretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].downwardAPI
Name Type Description Required
defaultMode integer
false
items []object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index]
Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index].fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].emptyDir
Name Type Description Required
medium string
false
sizeLimit int or string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral
Name Type Description Required
volumeClaimTemplate object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate
Name Type Description Required
metadata object
false
spec object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata
Name Type Description Required
annotations map[string]string
false
creationTimestamp string
false
deletionGracePeriodSeconds integer
false
deletionTimestamp string
false
finalizers []string
false
generateName string
false
generation integer
false
labels map[string]string
false
managedFields []object
false
name string
false
namespace string
false
ownerReferences []object
false
resourceVersion string
false
selfLink string
false
uid string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.managedFields[index]
Name Type Description Required
apiVersion string
false
fieldsType string
false
fieldsV1 object
false
manager string
false
operation string
false
subresource string
false
time string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.ownerReferences[index]
Name Type Description Required
apiVersion string
false
blockOwnerDeletion boolean
false
controller boolean
false
kind string
false
name string
false
uid string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec
Name Type Description Required
accessModes []string
false
dataSource object
false
dataSourceRef object
false
resources object
false
selector object
false
storageClassName string
false
volumeMode string
false
volumeName string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource
Name Type Description Required
apiGroup string
false
kind string
false
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef
Name Type Description Required
apiGroup string
false
kind string
false
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector
Name Type Description Required
matchExpressions []object
false
matchLabels map[string]string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].fc
Name Type Description Required
fsType string
false
lun integer
false
readOnly boolean
false
targetWWNs []string
false
wwids []string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].flexVolume
Name Type Description Required
driver string
false
fsType string
false
options map[string]string
false
readOnly boolean
false
secretRef object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].flexVolume.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].flocker
Name Type Description Required
datasetName string
false
datasetUUID string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].gcePersistentDisk
Name Type Description Required
fsType string
false
partition integer
false
pdName string
false
readOnly boolean
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].gitRepo
Name Type Description Required
directory string
false
repository string
false
revision string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].glusterfs
Name Type Description Required
endpoints string
false
path string
false
readOnly boolean
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].hostPath
Name Type Description Required
path string
false
type string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].iscsi
Name Type Description Required
chapAuthDiscovery boolean
false
chapAuthSession boolean
false
fsType string
false
initiatorName string
false
iqn string
false
iscsiInterface string
false
lun integer
false
portals []string
false
readOnly boolean
false
secretRef object
false
targetPortal string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].iscsi.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].nfs
Name Type Description Required
path string
false
readOnly boolean
false
server string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].persistentVolumeClaim
Name Type Description Required
claimName string
false
readOnly boolean
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].photonPersistentDisk
Name Type Description Required
fsType string
false
pdID string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].portworxVolume
Name Type Description Required
fsType string
false
readOnly boolean
false
volumeID string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected
Name Type Description Required
defaultMode integer
false
sources []object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index]
Name Type Description Required
configMap object
false
downwardAPI object
false
secret object
false
serviceAccountToken object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].configMap
Name Type Description Required
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].configMap.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI
Name Type Description Required
items []object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]
Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].secret
Name Type Description Required
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].secret.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].projected.sources[index].serviceAccountToken
Name Type Description Required
audience string
false
expirationSeconds integer
false
path string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].quobyte
Name Type Description Required
group string
false
readOnly boolean
false
registry string
false
tenant string
false
user string
false
volume string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].rbd
Name Type Description Required
fsType string
false
image string
false
keyring string
false
monitors []string
false
pool string
false
readOnly boolean
false
secretRef object
false
user string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].rbd.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].scaleIO
Name Type Description Required
fsType string
false
gateway string
false
protectionDomain string
false
readOnly boolean
false
secretRef object
false
sslEnabled boolean
false
storageMode string
false
storagePool string
false
system string
false
volumeName string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].scaleIO.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].secret
Name Type Description Required
defaultMode integer
false
items []object
false
optional boolean
false
secretName string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].secret.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].storageos
Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeName string
false
volumeNamespace string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].storageos.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].additionalVolumes.volumes[index].vsphereVolume
Name Type Description Required
fsType string
false
storagePolicyID string
false
storagePolicyName string
false
volumePath string
false
### PulsarCluster.spec.proxy.sets[key].antiAffinity Pod anti-affinity configuration. This override the global value if set.
Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false
### PulsarCluster.spec.proxy.sets[key].antiAffinity.host Indicates the reclaimPolicy property for the StorageClass.
Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false
### PulsarCluster.spec.proxy.sets[key].antiAffinity.zone Indicates the provisioner property for the StorageClass.
Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false
### PulsarCluster.spec.proxy.sets[key].env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.proxy.sets[key].env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.proxy.sets[key].env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.sets[key].env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.sets[key].env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].imagePullSecrets[index]
Name Type Description Required
name string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index]
Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].envFrom[index]
Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].envFrom[index].configMapRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].envFrom[index].secretRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle
Name Type Description Required
postStart object
false
preStop object
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.postStart
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.postStart.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.postStart.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.postStart.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.preStop
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.preStop.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.preStop.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].lifecycle.preStop.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].livenessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].livenessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].livenessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].livenessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].livenessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].livenessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].ports[index]
Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].readinessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].readinessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].readinessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].readinessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].readinessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].readinessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].securityContext
Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].securityContext.capabilities
Name Type Description Required
add []string
false
drop []string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].securityContext.seLinuxOptions
Name Type Description Required
level string
false
role string
false
type string
false
user string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].securityContext.seccompProfile
Name Type Description Required
localhostProfile string
false
type string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].securityContext.windowsOptions
Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].startupProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].startupProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].startupProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].startupProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].startupProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].startupProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].volumeDevices[index]
Name Type Description Required
devicePath string
false
name string
false
### PulsarCluster.spec.proxy.sets[key].initContainers[index].volumeMounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.proxy.sets[key].kafka Enable Kafka protocol.
Name Type Description Required
enabled boolean Allow the cluster to accept Kafka protocol. Default is 'false'.
false
exposePorts boolean Expose the kafka protocol port.
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity Node affinity configuration.
Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
Name Type Description Required
preference object
false
weight integer
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
Name Type Description Required
matchExpressions []object
false
matchFields []object
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
Name Type Description Required
nodeSelectorTerms []object
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
Name Type Description Required
matchExpressions []object
false
matchFields []object
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.sets[key].nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.proxy.sets[key].pdb Pod disruption budget configuration.
Name Type Description Required
enabled boolean Enable Pdb policy.
false
maxUnavailable integer Number of maxUnavailable pods.
false
### PulsarCluster.spec.proxy.sets[key].probes Liveness and readiness probes configuration.
Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false
### PulsarCluster.spec.proxy.sets[key].probes.liveness Liveness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.proxy.sets[key].probes.readiness Readiness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.proxy.sets[key].resources Resources requirements.
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.sets[key].service Service configuration.
Name Type Description Required
additionalPorts []object Additional ports to add to the Service.
false
annotations map[string]string Additional annotations to add to the Service.
false
enablePlainTextWithTLS boolean Enable plain text connections even if TLS is enabled.
false
loadBalancerIP string Assign a load balancer IP.
false
type string Service type. Default value is 'ClusterIP'
false
### PulsarCluster.spec.proxy.sets[key].service.additionalPorts[index]
Name Type Description Required
appProtocol string
false
name string
false
nodePort integer
false
port integer
false
protocol string
false
targetPort int or string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index]
Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].envFrom[index]
Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].envFrom[index].configMapRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].envFrom[index].secretRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle
Name Type Description Required
postStart object
false
preStop object
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.postStart
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.postStart.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.postStart.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.postStart.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.preStop
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.preStop.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.preStop.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].lifecycle.preStop.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].livenessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].livenessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].livenessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].livenessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].livenessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].livenessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].ports[index]
Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].readinessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].readinessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].readinessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].readinessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].readinessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].readinessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].securityContext
Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].securityContext.capabilities
Name Type Description Required
add []string
false
drop []string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].securityContext.seLinuxOptions
Name Type Description Required
level string
false
role string
false
type string
false
user string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].securityContext.seccompProfile
Name Type Description Required
localhostProfile string
false
type string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].securityContext.windowsOptions
Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].startupProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].startupProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].startupProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].startupProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].startupProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].startupProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].volumeDevices[index]
Name Type Description Required
devicePath string
false
name string
false
### PulsarCluster.spec.proxy.sets[key].sidecars[index].volumeMounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.proxy.sets[key].tolerations[index]
Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false
### PulsarCluster.spec.proxy.sets[key].updateStrategy Strategy for the proxy deployment.
Name Type Description Required
rollingUpdate object
false
type string
false
### PulsarCluster.spec.proxy.sets[key].updateStrategy.rollingUpdate
Name Type Description Required
maxSurge int or string
false
maxUnavailable int or string
false
### PulsarCluster.spec.proxy.sets[key].webSocket WebSocket configuration.
Name Type Description Required
config JSON Configuration.
false
enabled boolean Enable WebSocket standalone as container in the proxy pod.
false
probes object Liveness and readiness probes configuration.
false
resources object Resources requirements.
false
### PulsarCluster.spec.proxy.sets[key].webSocket.probes Liveness and readiness probes configuration.
Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false
### PulsarCluster.spec.proxy.sets[key].webSocket.probes.liveness Liveness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.proxy.sets[key].webSocket.probes.readiness Readiness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.proxy.sets[key].webSocket.resources Resources requirements.
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.sidecars[index]
Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false
### PulsarCluster.spec.proxy.sidecars[index].env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.proxy.sidecars[index].env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.proxy.sidecars[index].env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sidecars[index].env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.proxy.sidecars[index].env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.proxy.sidecars[index].env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sidecars[index].envFrom[index]
Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false
### PulsarCluster.spec.proxy.sidecars[index].envFrom[index].configMapRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sidecars[index].envFrom[index].secretRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle
Name Type Description Required
postStart object
false
preStop object
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.postStart
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.postStart.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.postStart.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.postStart.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.preStop
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.preStop.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.preStop.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sidecars[index].lifecycle.preStop.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sidecars[index].livenessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sidecars[index].livenessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sidecars[index].livenessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sidecars[index].livenessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sidecars[index].livenessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sidecars[index].livenessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sidecars[index].ports[index]
Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false
### PulsarCluster.spec.proxy.sidecars[index].readinessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sidecars[index].readinessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sidecars[index].readinessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sidecars[index].readinessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sidecars[index].readinessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sidecars[index].readinessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sidecars[index].resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.proxy.sidecars[index].securityContext
Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false
### PulsarCluster.spec.proxy.sidecars[index].securityContext.capabilities
Name Type Description Required
add []string
false
drop []string
false
### PulsarCluster.spec.proxy.sidecars[index].securityContext.seLinuxOptions
Name Type Description Required
level string
false
role string
false
type string
false
user string
false
### PulsarCluster.spec.proxy.sidecars[index].securityContext.seccompProfile
Name Type Description Required
localhostProfile string
false
type string
false
### PulsarCluster.spec.proxy.sidecars[index].securityContext.windowsOptions
Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false
### PulsarCluster.spec.proxy.sidecars[index].startupProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.proxy.sidecars[index].startupProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.proxy.sidecars[index].startupProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.proxy.sidecars[index].startupProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.proxy.sidecars[index].startupProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.proxy.sidecars[index].startupProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.proxy.sidecars[index].volumeDevices[index]
Name Type Description Required
devicePath string
false
name string
false
### PulsarCluster.spec.proxy.sidecars[index].volumeMounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.proxy.tolerations[index]
Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false
### PulsarCluster.spec.proxy.updateStrategy Strategy for the proxy deployment.
Name Type Description Required
rollingUpdate object
false
type string
false
### PulsarCluster.spec.proxy.updateStrategy.rollingUpdate
Name Type Description Required
maxSurge int or string
false
maxUnavailable int or string
false
### PulsarCluster.spec.proxy.webSocket WebSocket configuration.
Name Type Description Required
config JSON Configuration.
false
enabled boolean Enable WebSocket standalone as container in the proxy pod.
false
probes object Liveness and readiness probes configuration.
false
resources object Resources requirements.
false
### PulsarCluster.spec.proxy.webSocket.probes Liveness and readiness probes configuration.
Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false
### PulsarCluster.spec.proxy.webSocket.probes.liveness Liveness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.proxy.webSocket.probes.readiness Readiness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.proxy.webSocket.resources Resources requirements.
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.zookeeper
Name Type Description Required
additionalVolumes object Mount additional volumes to the pod.
false
annotations map[string]string Annotations to add to each resource (except pods).
false
antiAffinity object Pod anti-affinity configuration. This override the global value if set.
false
config JSON Configuration.
false
dataVolume object Volume configuration for ZooKeeper data.
false
env []object Additional container env variables.
false
gracePeriod integer Termination grace period in seconds.

Minimum: 0
false
image string Override Pulsar image.
false
imagePullPolicy string Override image pull policy.
false
imagePullSecrets []object Image pull secrets.
false
initContainers []object Init containers
false
labels map[string]string Labels to add to each resource (except pods).
false
matchLabels map[string]string Match labels selectors to add to each pod.
false
metadataInitializationJob object Configuration about the job that initializes the Pulsar cluster creating the needed ZooKeeper nodes.
false
nodeAffinity object Node affinity configuration.
false
nodeSelectors map[string]string Additional node selectors.
false
pdb object Pod disruption budget configuration.
false
podAnnotations map[string]string Annotations to add to pod.
false
podLabels map[string]string Labels to add to each pod.
false
podManagementPolicy string Pod management policy. Default value is 'Parallel'.
false
probes object Liveness probe configuration.
false
replicas integer Number of desired replicas.
false
resources object Resources requirements.
false
service object Service configuration.
false
serviceAccountName string Service account name for the resource.
false
sidecars []object Sidecar containers
false
tolerations []object Pod tolerations.
false
updateStrategy object Update strategy for the StatefulSet. Default value is rolling update.
false
### PulsarCluster.spec.zookeeper.additionalVolumes Mount additional volumes to the pod.
Name Type Description Required
mounts []object Mount points for the additional volumes
false
volumes []object Additional volumes to be mounted to the pod
false
### PulsarCluster.spec.zookeeper.additionalVolumes.mounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index]
Name Type Description Required
awsElasticBlockStore object
false
azureDisk object
false
azureFile object
false
cephfs object
false
cinder object
false
configMap object
false
csi object
false
downwardAPI object
false
emptyDir object
false
ephemeral object
false
fc object
false
flexVolume object
false
flocker object
false
gcePersistentDisk object
false
gitRepo object
false
glusterfs object
false
hostPath object
false
iscsi object
false
name string
false
nfs object
false
persistentVolumeClaim object
false
photonPersistentDisk object
false
portworxVolume object
false
projected object
false
quobyte object
false
rbd object
false
scaleIO object
false
secret object
false
storageos object
false
vsphereVolume object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].awsElasticBlockStore
Name Type Description Required
fsType string
false
partition integer
false
readOnly boolean
false
volumeID string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].azureDisk
Name Type Description Required
cachingMode string
false
diskName string
false
diskURI string
false
fsType string
false
kind string
false
readOnly boolean
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].azureFile
Name Type Description Required
readOnly boolean
false
secretName string
false
shareName string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].cephfs
Name Type Description Required
monitors []string
false
path string
false
readOnly boolean
false
secretFile string
false
secretRef object
false
user string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].cephfs.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].cinder
Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeID string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].cinder.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].configMap
Name Type Description Required
defaultMode integer
false
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].configMap.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].csi
Name Type Description Required
driver string
false
fsType string
false
nodePublishSecretRef object
false
readOnly boolean
false
volumeAttributes map[string]string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].csi.nodePublishSecretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].downwardAPI
Name Type Description Required
defaultMode integer
false
items []object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].downwardAPI.items[index]
Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].downwardAPI.items[index].fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].emptyDir
Name Type Description Required
medium string
false
sizeLimit int or string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral
Name Type Description Required
volumeClaimTemplate object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate
Name Type Description Required
metadata object
false
spec object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata
Name Type Description Required
annotations map[string]string
false
creationTimestamp string
false
deletionGracePeriodSeconds integer
false
deletionTimestamp string
false
finalizers []string
false
generateName string
false
generation integer
false
labels map[string]string
false
managedFields []object
false
name string
false
namespace string
false
ownerReferences []object
false
resourceVersion string
false
selfLink string
false
uid string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.managedFields[index]
Name Type Description Required
apiVersion string
false
fieldsType string
false
fieldsV1 object
false
manager string
false
operation string
false
subresource string
false
time string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.metadata.ownerReferences[index]
Name Type Description Required
apiVersion string
false
blockOwnerDeletion boolean
false
controller boolean
false
kind string
false
name string
false
uid string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec
Name Type Description Required
accessModes []string
false
dataSource object
false
dataSourceRef object
false
resources object
false
selector object
false
storageClassName string
false
volumeMode string
false
volumeName string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource
Name Type Description Required
apiGroup string
false
kind string
false
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef
Name Type Description Required
apiGroup string
false
kind string
false
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector
Name Type Description Required
matchExpressions []object
false
matchLabels map[string]string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].fc
Name Type Description Required
fsType string
false
lun integer
false
readOnly boolean
false
targetWWNs []string
false
wwids []string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].flexVolume
Name Type Description Required
driver string
false
fsType string
false
options map[string]string
false
readOnly boolean
false
secretRef object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].flexVolume.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].flocker
Name Type Description Required
datasetName string
false
datasetUUID string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].gcePersistentDisk
Name Type Description Required
fsType string
false
partition integer
false
pdName string
false
readOnly boolean
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].gitRepo
Name Type Description Required
directory string
false
repository string
false
revision string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].glusterfs
Name Type Description Required
endpoints string
false
path string
false
readOnly boolean
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].hostPath
Name Type Description Required
path string
false
type string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].iscsi
Name Type Description Required
chapAuthDiscovery boolean
false
chapAuthSession boolean
false
fsType string
false
initiatorName string
false
iqn string
false
iscsiInterface string
false
lun integer
false
portals []string
false
readOnly boolean
false
secretRef object
false
targetPortal string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].iscsi.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].nfs
Name Type Description Required
path string
false
readOnly boolean
false
server string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].persistentVolumeClaim
Name Type Description Required
claimName string
false
readOnly boolean
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].photonPersistentDisk
Name Type Description Required
fsType string
false
pdID string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].portworxVolume
Name Type Description Required
fsType string
false
readOnly boolean
false
volumeID string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected
Name Type Description Required
defaultMode integer
false
sources []object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index]
Name Type Description Required
configMap object
false
downwardAPI object
false
secret object
false
serviceAccountToken object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].configMap
Name Type Description Required
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].configMap.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].downwardAPI
Name Type Description Required
items []object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]
Name Type Description Required
fieldRef object
false
mode integer
false
path string
false
resourceFieldRef object
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].secret
Name Type Description Required
items []object
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].secret.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].projected.sources[index].serviceAccountToken
Name Type Description Required
audience string
false
expirationSeconds integer
false
path string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].quobyte
Name Type Description Required
group string
false
readOnly boolean
false
registry string
false
tenant string
false
user string
false
volume string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].rbd
Name Type Description Required
fsType string
false
image string
false
keyring string
false
monitors []string
false
pool string
false
readOnly boolean
false
secretRef object
false
user string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].rbd.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].scaleIO
Name Type Description Required
fsType string
false
gateway string
false
protectionDomain string
false
readOnly boolean
false
secretRef object
false
sslEnabled boolean
false
storageMode string
false
storagePool string
false
system string
false
volumeName string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].scaleIO.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].secret
Name Type Description Required
defaultMode integer
false
items []object
false
optional boolean
false
secretName string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].secret.items[index]
Name Type Description Required
key string
false
mode integer
false
path string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].storageos
Name Type Description Required
fsType string
false
readOnly boolean
false
secretRef object
false
volumeName string
false
volumeNamespace string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].storageos.secretRef
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.additionalVolumes.volumes[index].vsphereVolume
Name Type Description Required
fsType string
false
storagePolicyID string
false
storagePolicyName string
false
volumePath string
false
### PulsarCluster.spec.zookeeper.antiAffinity Pod anti-affinity configuration. This override the global value if set.
Name Type Description Required
host object Indicates the reclaimPolicy property for the StorageClass.
false
zone object Indicates the provisioner property for the StorageClass.
false
### PulsarCluster.spec.zookeeper.antiAffinity.host Indicates the reclaimPolicy property for the StorageClass.
Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false
### PulsarCluster.spec.zookeeper.antiAffinity.zone Indicates the provisioner property for the StorageClass.
Name Type Description Required
enabled boolean Indicates the reclaimPolicy property for the StorageClass.
false
required boolean Indicates the reclaimPolicy property for the StorageClass.
false
### PulsarCluster.spec.zookeeper.dataVolume Volume configuration for ZooKeeper data.
Name Type Description Required
existingStorageClassName string Indicates if an already existing storage class should be used.
false
name string Indicates the suffix for the volume. Default value is 'data'.
false
size string Indicates the requested size for the volume. The format follows the Kubernetes' Quantity.
false
storageClass object Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
false
### PulsarCluster.spec.zookeeper.dataVolume.storageClass Indicates if a StorageClass is used. The operator will create the StorageClass if needed.
Name Type Description Required
extraParams map[string]string Adds extra parameters for the StorageClass.
false
fsType string Indicates the 'fsType' parameter for the StorageClass.
false
provisioner string Indicates the provisioner property for the StorageClass.
false
reclaimPolicy string Indicates the reclaimPolicy property for the StorageClass.
false
type string Indicates the 'type' parameter for the StorageClass.
false
### PulsarCluster.spec.zookeeper.env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.zookeeper.env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.zookeeper.env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.zookeeper.env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.zookeeper.env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.imagePullSecrets[index]
Name Type Description Required
name string
false
### PulsarCluster.spec.zookeeper.initContainers[index]
Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false
### PulsarCluster.spec.zookeeper.initContainers[index].env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.zookeeper.initContainers[index].env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.zookeeper.initContainers[index].env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.initContainers[index].env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.zookeeper.initContainers[index].env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.zookeeper.initContainers[index].env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.initContainers[index].envFrom[index]
Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false
### PulsarCluster.spec.zookeeper.initContainers[index].envFrom[index].configMapRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.initContainers[index].envFrom[index].secretRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle
Name Type Description Required
postStart object
false
preStop object
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.postStart
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.postStart.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.postStart.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.postStart.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.preStop
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.preStop.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.preStop.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.initContainers[index].lifecycle.preStop.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.initContainers[index].livenessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.zookeeper.initContainers[index].livenessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.initContainers[index].livenessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.zookeeper.initContainers[index].livenessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.initContainers[index].livenessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.initContainers[index].livenessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.initContainers[index].ports[index]
Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false
### PulsarCluster.spec.zookeeper.initContainers[index].readinessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.zookeeper.initContainers[index].readinessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.initContainers[index].readinessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.zookeeper.initContainers[index].readinessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.initContainers[index].readinessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.initContainers[index].readinessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.initContainers[index].resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.zookeeper.initContainers[index].securityContext
Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false
### PulsarCluster.spec.zookeeper.initContainers[index].securityContext.capabilities
Name Type Description Required
add []string
false
drop []string
false
### PulsarCluster.spec.zookeeper.initContainers[index].securityContext.seLinuxOptions
Name Type Description Required
level string
false
role string
false
type string
false
user string
false
### PulsarCluster.spec.zookeeper.initContainers[index].securityContext.seccompProfile
Name Type Description Required
localhostProfile string
false
type string
false
### PulsarCluster.spec.zookeeper.initContainers[index].securityContext.windowsOptions
Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false
### PulsarCluster.spec.zookeeper.initContainers[index].startupProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.zookeeper.initContainers[index].startupProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.initContainers[index].startupProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.zookeeper.initContainers[index].startupProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.initContainers[index].startupProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.initContainers[index].startupProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.initContainers[index].volumeDevices[index]
Name Type Description Required
devicePath string
false
name string
false
### PulsarCluster.spec.zookeeper.initContainers[index].volumeMounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.zookeeper.metadataInitializationJob Configuration about the job that initializes the Pulsar cluster creating the needed ZooKeeper nodes.
Name Type Description Required
resources object Resources requirements.
false
timeout integer Timeout (in seconds) for the metadata initialization execution. Default value is 60.
false
### PulsarCluster.spec.zookeeper.metadataInitializationJob.resources Resources requirements.
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.zookeeper.nodeAffinity Node affinity configuration.
Name Type Description Required
preferredDuringSchedulingIgnoredDuringExecution []object
false
requiredDuringSchedulingIgnoredDuringExecution object
false
### PulsarCluster.spec.zookeeper.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
Name Type Description Required
preference object
false
weight integer
false
### PulsarCluster.spec.zookeeper.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
Name Type Description Required
matchExpressions []object
false
matchFields []object
false
### PulsarCluster.spec.zookeeper.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.zookeeper.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.zookeeper.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
Name Type Description Required
nodeSelectorTerms []object
false
### PulsarCluster.spec.zookeeper.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
Name Type Description Required
matchExpressions []object
false
matchFields []object
false
### PulsarCluster.spec.zookeeper.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.zookeeper.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
Name Type Description Required
key string
false
operator string
false
values []string
false
### PulsarCluster.spec.zookeeper.pdb Pod disruption budget configuration.
Name Type Description Required
enabled boolean Enable Pdb policy.
false
maxUnavailable integer Number of maxUnavailable pods.
false
### PulsarCluster.spec.zookeeper.probes Liveness probe configuration.
Name Type Description Required
liveness object Liveness probe configuration.
false
readiness object Readiness probe configuration.
false
### PulsarCluster.spec.zookeeper.probes.liveness Liveness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.zookeeper.probes.readiness Readiness probe configuration.
Name Type Description Required
enabled boolean Enables the probe.
false
failureThreshold integer Failure threshold.
false
initialDelaySeconds integer Indicates the initial delay (in seconds) for the probe.
false
periodSeconds integer Indicates the period (in seconds) for the probe.
false
successThreshold integer Success threshold.
false
terminationGracePeriodSeconds integer Indicates the termination grace period (in seconds) for the probe.
false
timeoutSeconds integer Indicates the timeout (in seconds) for the probe.
false
### PulsarCluster.spec.zookeeper.resources Resources requirements.
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.zookeeper.service Service configuration.
Name Type Description Required
additionalPorts []object Additional ports to add to the Service.
false
annotations map[string]string Additional annotations to add to the Service.
false
### PulsarCluster.spec.zookeeper.service.additionalPorts[index]
Name Type Description Required
appProtocol string
false
name string
false
nodePort integer
false
port integer
false
protocol string
false
targetPort int or string
false
### PulsarCluster.spec.zookeeper.sidecars[index]
Name Type Description Required
args []string
false
command []string
false
env []object
false
envFrom []object
false
image string
false
imagePullPolicy string
false
lifecycle object
false
livenessProbe object
false
name string
false
ports []object
false
readinessProbe object
false
resources object
false
securityContext object
false
startupProbe object
false
stdin boolean
false
stdinOnce boolean
false
terminationMessagePath string
false
terminationMessagePolicy string
false
tty boolean
false
volumeDevices []object
false
volumeMounts []object
false
workingDir string
false
### PulsarCluster.spec.zookeeper.sidecars[index].env[index]
Name Type Description Required
name string
false
value string
false
valueFrom object
false
### PulsarCluster.spec.zookeeper.sidecars[index].env[index].valueFrom
Name Type Description Required
configMapKeyRef object
false
fieldRef object
false
resourceFieldRef object
false
secretKeyRef object
false
### PulsarCluster.spec.zookeeper.sidecars[index].env[index].valueFrom.configMapKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.sidecars[index].env[index].valueFrom.fieldRef
Name Type Description Required
apiVersion string
false
fieldPath string
false
### PulsarCluster.spec.zookeeper.sidecars[index].env[index].valueFrom.resourceFieldRef
Name Type Description Required
containerName string
false
divisor int or string
false
resource string
false
### PulsarCluster.spec.zookeeper.sidecars[index].env[index].valueFrom.secretKeyRef
Name Type Description Required
key string
false
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.sidecars[index].envFrom[index]
Name Type Description Required
configMapRef object
false
prefix string
false
secretRef object
false
### PulsarCluster.spec.zookeeper.sidecars[index].envFrom[index].configMapRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.sidecars[index].envFrom[index].secretRef
Name Type Description Required
name string
false
optional boolean
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle
Name Type Description Required
postStart object
false
preStop object
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.postStart
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.postStart.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.postStart.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.postStart.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.postStart.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.preStop
Name Type Description Required
exec object
false
httpGet object
false
tcpSocket object
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.preStop.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.preStop.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.preStop.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.sidecars[index].lifecycle.preStop.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.sidecars[index].livenessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.zookeeper.sidecars[index].livenessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.sidecars[index].livenessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.zookeeper.sidecars[index].livenessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.sidecars[index].livenessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.sidecars[index].livenessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.sidecars[index].ports[index]
Name Type Description Required
containerPort integer
false
hostIP string
false
hostPort integer
false
name string
false
protocol string
false
### PulsarCluster.spec.zookeeper.sidecars[index].readinessProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.zookeeper.sidecars[index].readinessProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.sidecars[index].readinessProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.zookeeper.sidecars[index].readinessProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.sidecars[index].readinessProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.sidecars[index].readinessProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.sidecars[index].resources
Name Type Description Required
limits map[string]int or string
false
requests map[string]int or string
false
### PulsarCluster.spec.zookeeper.sidecars[index].securityContext
Name Type Description Required
allowPrivilegeEscalation boolean
false
capabilities object
false
privileged boolean
false
procMount string
false
readOnlyRootFilesystem boolean
false
runAsGroup integer
false
runAsNonRoot boolean
false
runAsUser integer
false
seLinuxOptions object
false
seccompProfile object
false
windowsOptions object
false
### PulsarCluster.spec.zookeeper.sidecars[index].securityContext.capabilities
Name Type Description Required
add []string
false
drop []string
false
### PulsarCluster.spec.zookeeper.sidecars[index].securityContext.seLinuxOptions
Name Type Description Required
level string
false
role string
false
type string
false
user string
false
### PulsarCluster.spec.zookeeper.sidecars[index].securityContext.seccompProfile
Name Type Description Required
localhostProfile string
false
type string
false
### PulsarCluster.spec.zookeeper.sidecars[index].securityContext.windowsOptions
Name Type Description Required
gmsaCredentialSpec string
false
gmsaCredentialSpecName string
false
hostProcess boolean
false
runAsUserName string
false
### PulsarCluster.spec.zookeeper.sidecars[index].startupProbe
Name Type Description Required
exec object
false
failureThreshold integer
false
grpc object
false
httpGet object
false
initialDelaySeconds integer
false
periodSeconds integer
false
successThreshold integer
false
tcpSocket object
false
terminationGracePeriodSeconds integer
false
timeoutSeconds integer
false
### PulsarCluster.spec.zookeeper.sidecars[index].startupProbe.exec
Name Type Description Required
command []string
false
### PulsarCluster.spec.zookeeper.sidecars[index].startupProbe.grpc
Name Type Description Required
port integer
false
service string
false
### PulsarCluster.spec.zookeeper.sidecars[index].startupProbe.httpGet
Name Type Description Required
host string
false
httpHeaders []object
false
path string
false
port int or string
false
scheme string
false
### PulsarCluster.spec.zookeeper.sidecars[index].startupProbe.httpGet.httpHeaders[index]
Name Type Description Required
name string
false
value string
false
### PulsarCluster.spec.zookeeper.sidecars[index].startupProbe.tcpSocket
Name Type Description Required
host string
false
port int or string
false
### PulsarCluster.spec.zookeeper.sidecars[index].volumeDevices[index]
Name Type Description Required
devicePath string
false
name string
false
### PulsarCluster.spec.zookeeper.sidecars[index].volumeMounts[index]
Name Type Description Required
mountPath string
false
mountPropagation string
false
name string
false
readOnly boolean
false
subPath string
false
subPathExpr string
false
### PulsarCluster.spec.zookeeper.tolerations[index]
Name Type Description Required
effect string
false
key string
false
operator string
false
tolerationSeconds integer
false
value string
false
### PulsarCluster.spec.zookeeper.updateStrategy Update strategy for the StatefulSet. Default value is rolling update.
Name Type Description Required
rollingUpdate object
false
type string
false
### PulsarCluster.spec.zookeeper.updateStrategy.rollingUpdate
Name Type Description Required
maxUnavailable int or string
false
partition integer
false
### PulsarCluster.status
Name Type Description Required
conditions []object Conditions: 1. Condition Ready: possible status are True or False. If False, the reason contains the error message.
false
lastApplied string Last spec applied.
false
### PulsarCluster.status.conditions[index]
Name Type Description Required
lastTransitionTime string
false
message string
false
observedGeneration integer
false
reason string
false
status string
false
type string
false