BookKeeper
Bookkeeper
Field |
Description |
spec |
|
status |
Spec
Complete namespace: Bookkeeper.Spec
Field |
Description |
bookkeeper |
|
global |
Bookkeeper
Complete namespace: Bookkeeper.Spec.Bookkeeper
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper: {}
Field |
Description |
additionalVolumes |
|
annotations []key/value |
Annotations to add to each resource (except pods). |
antiAffinity |
|
autoRackConfig |
|
autoscaler |
|
cleanUpPvcs boolean |
Cleanup PVCs after the bookie has been removed. |
config any |
Configuration. |
env []Env |
Additional container env variables. |
gracePeriod integer |
Termination grace period in seconds. |
image string |
Override Pulsar image. |
imagePullPolicy string |
Override image pull policy. |
imagePullSecrets |
Image pull secrets. |
initContainers |
Init containers |
labels []key/value |
Labels to add to each resource (except pods). |
matchLabels []key/value |
Match labels selectors to add to each pod. |
nodeAffinity |
|
nodeSelectors []key/value |
Additional node selectors. |
overrideResourceName string |
Override the resource names generated by the operator. |
pdb |
|
podAnnotations []key/value |
Annotations to add to pod. |
podLabels []key/value |
Labels to add to each pod. |
podManagementPolicy string |
Pod management policy. Default value is 'Parallel'. |
probes |
|
pvcPrefix string |
Prefix for each PVC created. |
replicas integer |
Number of desired replicas. |
resources |
|
service |
|
sets [] |
Bookie sets. |
setsUpdateStrategy string |
Sets update strategy. 'RollingUpdate' or 'Parallel'. Default is 'RollingUpdate'. |
sidecars []Sidecars |
Sidecar containers |
tolerations |
Pod tolerations. |
updateStrategy |
|
volumes |
Additionalvolumes
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes: {}
Field |
Description |
mounts []Mounts |
Mount points for the additional volumes |
volumes []Volumes |
Additional volumes to be mounted to the pod |
Mounts
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Mounts
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
mounts: {}
Field |
Description |
mountPath string |
|
mountPropagation string |
|
name string |
|
readOnly boolean |
|
subPath string |
|
subPathExpr string |
Volumes
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes: {}
Field |
Description |
awsElasticBlockStore |
|
azureDisk |
|
azureFile |
|
cephfs |
|
cinder |
|
configMap |
|
csi |
|
downwardAPI |
|
emptyDir |
|
ephemeral |
|
fc |
|
flexVolume |
|
flocker |
|
gcePersistentDisk |
|
gitRepo |
|
glusterfs |
|
hostPath |
|
iscsi |
|
name string |
|
nfs |
|
persistentVolumeClaim |
|
photonPersistentDisk |
|
portworxVolume |
|
projected |
|
quobyte |
|
rbd |
|
scaleIO |
|
secret |
|
storageos |
|
vsphereVolume |
Awselasticblockstore
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Awselasticblockstore
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
awselasticblockstore: {}
Field |
Description |
fsType string |
|
partition integer |
|
readOnly boolean |
|
volumeID string |
Azuredisk
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Azuredisk
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
azuredisk: {}
Field |
Description |
cachingMode string |
|
diskName string |
|
diskURI string |
|
fsType string |
|
kind string |
|
readOnly boolean |
Azurefile
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Azurefile
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
azurefile: {}
Field |
Description |
readOnly boolean |
|
secretName string |
|
shareName string |
Cephfs
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Cephfs
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
cephfs: {}
Field |
Description |
monitors [] string |
|
path string |
|
readOnly boolean |
|
secretFile string |
|
secretRef |
|
user string |
Secretref
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Cephfs.Secretref
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
cephfs:
secretref: {}
Field |
Description |
name string |
Cinder
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Cinder
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
cinder: {}
Field |
Description |
fsType string |
|
readOnly boolean |
|
secretRef |
|
volumeID string |
Configmap
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Configmap
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
configmap: {}
Field |
Description |
defaultMode integer |
|
items []Items |
|
name string |
|
optional boolean |
Items
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Configmap.Items
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
configmap:
items: {}
Field |
Description |
key string |
|
mode integer |
|
path string |
Csi
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Csi
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
csi: {}
Field |
Description |
driver string |
|
fsType string |
|
nodePublishSecretRef |
|
readOnly boolean |
|
volumeAttributes []key/value |
Downwardapi
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Downwardapi
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
downwardapi: {}
Field |
Description |
defaultMode integer |
|
items []Items |
Items
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Downwardapi.Items
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
downwardapi:
items: {}
Field |
Description |
fieldRef |
|
mode integer |
|
path string |
|
resourceFieldRef |
Fieldref
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Downwardapi.Items.Fieldref
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
downwardapi:
items:
fieldref: {}
Field |
Description |
apiVersion string |
|
fieldPath string |
Resourcefieldref
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Downwardapi.Items.Resourcefieldref
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
downwardapi:
items:
resourcefieldref: {}
Field |
Description |
containerName string |
|
divisor integer or string |
|
resource string |
Emptydir
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Emptydir
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
emptydir: {}
Field |
Description |
medium string |
|
sizeLimit integer or string |
Ephemeral
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral: {}
Field |
Description |
volumeClaimTemplate |
Volumeclaimtemplate
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate: {}
Field |
Description |
metadata |
|
spec |
Metadata
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Metadata
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate:
metadata: {}
Field |
Description |
annotations []key/value |
|
creationTimestamp string |
|
deletionGracePeriodSeconds integer |
|
deletionTimestamp string |
|
finalizers [] string |
|
generateName string |
|
generation integer |
|
labels []key/value |
|
managedFields |
|
name string |
|
namespace string |
|
ownerReferences |
|
resourceVersion string |
|
selfLink string |
|
uid string |
Managedfields
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Metadata.Managedfields
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate:
metadata:
managedfields: {}
Field |
Description |
apiVersion string |
|
fieldsType string |
|
fieldsV1 |
|
manager string |
|
operation string |
|
subresource string |
|
time string |
Ownerreferences
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Metadata.Ownerreferences
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate:
metadata:
ownerreferences: {}
Field |
Description |
apiVersion string |
|
blockOwnerDeletion boolean |
|
controller boolean |
|
kind string |
|
name string |
|
uid string |
Spec
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate:
spec: {}
Field |
Description |
accessModes [] string |
|
dataSource |
|
dataSourceRef |
|
resources |
|
selector |
|
storageClassName string |
|
volumeMode string |
|
volumeName string |
Datasource
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec.Datasource
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate:
spec:
datasource: {}
Field |
Description |
apiGroup string |
|
kind string |
|
name string |
Resources
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec.Resources
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate:
spec:
resources: {}
Field |
Description |
limits [] integer or string |
|
requests [] integer or string |
Selector
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec.Selector
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate:
spec:
selector: {}
Field |
Description |
matchExpressions |
|
matchLabels []key/value |
Matchexpressions
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Ephemeral.Volumeclaimtemplate.Spec.Selector.Matchexpressions
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
ephemeral:
volumeclaimtemplate:
spec:
selector:
matchexpressions: {}
Field |
Description |
key string |
|
operator string |
|
values [] string |
Fc
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Fc
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
fc: {}
Field |
Description |
fsType string |
|
lun integer |
|
readOnly boolean |
|
targetWWNs [] string |
|
wwids [] string |
Flexvolume
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Flexvolume
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
flexvolume: {}
Field |
Description |
driver string |
|
fsType string |
|
options []key/value |
|
readOnly boolean |
|
secretRef |
Flocker
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Flocker
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
flocker: {}
Field |
Description |
datasetName string |
|
datasetUUID string |
Gcepersistentdisk
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Gcepersistentdisk
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
gcepersistentdisk: {}
Field |
Description |
fsType string |
|
partition integer |
|
pdName string |
|
readOnly boolean |
Gitrepo
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Gitrepo
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
gitrepo: {}
Field |
Description |
directory string |
|
repository string |
|
revision string |
Glusterfs
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Glusterfs
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
glusterfs: {}
Field |
Description |
endpoints string |
|
path string |
|
readOnly boolean |
Hostpath
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Hostpath
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
hostpath: {}
Field |
Description |
path string |
|
type string |
Iscsi
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Iscsi
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
iscsi: {}
Field |
Description |
chapAuthDiscovery boolean |
|
chapAuthSession boolean |
|
fsType string |
|
initiatorName string |
|
iqn string |
|
iscsiInterface string |
|
lun integer |
|
portals [] string |
|
readOnly boolean |
|
secretRef |
|
targetPortal string |
Nfs
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Nfs
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
nfs: {}
Field |
Description |
path string |
|
readOnly boolean |
|
server string |
Persistentvolumeclaim
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Persistentvolumeclaim
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
persistentvolumeclaim: {}
Field |
Description |
claimName string |
|
readOnly boolean |
Photonpersistentdisk
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Photonpersistentdisk
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
photonpersistentdisk: {}
Field |
Description |
fsType string |
|
pdID string |
Portworxvolume
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Portworxvolume
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
portworxvolume: {}
Field |
Description |
fsType string |
|
readOnly boolean |
|
volumeID string |
Projected
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Projected
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
projected: {}
Field |
Description |
defaultMode integer |
|
sources []Sources |
Sources
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Projected.Sources
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
projected:
sources: {}
Field |
Description |
configMap |
|
downwardAPI |
|
secret |
|
serviceAccountToken |
Configmap
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Projected.Sources.Configmap
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
projected:
sources:
configmap: {}
Field |
Description |
items []Items |
|
name string |
|
optional boolean |
Downwardapi
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Projected.Sources.Downwardapi
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
projected:
sources:
downwardapi: {}
Field |
Description |
items []Items |
Serviceaccounttoken
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Projected.Sources.Serviceaccounttoken
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
projected:
sources:
serviceaccounttoken: {}
Field |
Description |
audience string |
|
expirationSeconds integer |
|
path string |
Quobyte
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Quobyte
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
quobyte: {}
Field |
Description |
group string |
|
readOnly boolean |
|
registry string |
|
tenant string |
|
user string |
|
volume string |
Rbd
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Rbd
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
rbd: {}
Field |
Description |
fsType string |
|
image string |
|
keyring string |
|
monitors [] string |
|
pool string |
|
readOnly boolean |
|
secretRef |
|
user string |
Scaleio
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Scaleio
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
scaleio: {}
Field |
Description |
fsType string |
|
gateway string |
|
protectionDomain string |
|
readOnly boolean |
|
secretRef |
|
sslEnabled boolean |
|
storageMode string |
|
storagePool string |
|
system string |
|
volumeName string |
Secret
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Secret
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
secret: {}
Field |
Description |
defaultMode integer |
|
items []Items |
|
optional boolean |
|
secretName string |
Storageos
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Storageos
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
storageos: {}
Field |
Description |
fsType string |
|
readOnly boolean |
|
secretRef |
|
volumeName string |
|
volumeNamespace string |
Vspherevolume
Complete namespace: Bookkeeper.Spec.Bookkeeper.Additionalvolumes.Volumes.Vspherevolume
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
additionalvolumes:
volumes:
vspherevolume: {}
Field |
Description |
fsType string |
|
storagePolicyID string |
|
storagePolicyName string |
|
volumePath string |
Antiaffinity
Complete namespace: Bookkeeper.Spec.Bookkeeper.Antiaffinity
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
antiaffinity: {}
Field |
Description |
host |
|
zone |
Host
Complete namespace: Bookkeeper.Spec.Bookkeeper.Antiaffinity.Host
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
antiaffinity:
host: {}
Field |
Description |
enabled boolean |
Indicates the reclaimPolicy property for the StorageClass. |
required boolean |
Indicates the reclaimPolicy property for the StorageClass. |
Zone
Complete namespace: Bookkeeper.Spec.Bookkeeper.Antiaffinity.Zone
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
antiaffinity:
zone: {}
Field |
Description |
enabled boolean |
Indicates the reclaimPolicy property for the StorageClass. |
required boolean |
Indicates the reclaimPolicy property for the StorageClass. |
Autorackconfig
Complete namespace: Bookkeeper.Spec.Bookkeeper.Autorackconfig
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
autorackconfig: {}
Field |
Description |
enabled boolean |
Enable rack configuration monitoring. |
periodMs integer |
Period for the schedule of the monitoring thread. |
Autoscaler
Complete namespace: Bookkeeper.Spec.Bookkeeper.Autoscaler
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
autoscaler: {}
Field |
Description |
diskUsageToleranceHwm bigdecimal |
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.92' |
diskUsageToleranceLwm bigdecimal |
The threshold to trigger a scale up. The autoscaler will scale up if all the bookies' disk usage is higher than this threshold. Default is '0.75' |
enabled boolean |
Enable autoscaling for bookies. |
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'. |
periodMs integer |
The interval in milliseconds between two consecutive autoscaling checks. |
scaleDownBy integer |
The number of bookies to remove at each scale down. Default is '1' |
scaleUpBy integer |
The number of bookies to add at each scale up. Default is '1' |
scaleUpMaxLimit integer |
Max number of bookies. If the number of bookies is equals to this value, the autoscaler will never scale up. |
stabilizationWindowMs integer |
The stabilization window is used to restrict the flapping of replica count when the metrics used for scaling keep fluctuating. The autoscaling algorithm uses this window to infer a previous desired state and avoid unwanted changes to workload scale.Default value is 5 minutes after the pod readiness. |
Env
Complete namespace: Bookkeeper.Spec.Bookkeeper.Env
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
env: {}
Field |
Description |
name string |
|
value string |
|
valueFrom |
Valuefrom
Complete namespace: Bookkeeper.Spec.Bookkeeper.Env.Valuefrom
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
env:
valuefrom: {}
Field |
Description |
configMapKeyRef |
|
fieldRef |
|
resourceFieldRef |
|
secretKeyRef |
Configmapkeyref
Complete namespace: Bookkeeper.Spec.Bookkeeper.Env.Valuefrom.Configmapkeyref
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
env:
valuefrom:
configmapkeyref: {}
Field |
Description |
key string |
|
name string |
|
optional boolean |
Initcontainers
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers: {}
Field |
Description |
args [] string |
|
command [] string |
|
env []Env |
|
envFrom []EnvFrom |
|
image string |
|
imagePullPolicy string |
|
lifecycle |
|
livenessProbe |
|
name string |
|
ports []Ports |
|
readinessProbe |
|
resources |
|
securityContext |
|
startupProbe |
|
stdin boolean |
|
stdinOnce boolean |
|
terminationMessagePath string |
|
terminationMessagePolicy string |
|
tty boolean |
|
volumeDevices |
|
volumeMounts |
|
workingDir string |
Envfrom
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Envfrom
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
envfrom: {}
Field |
Description |
configMapRef |
|
prefix string |
|
secretRef |
Configmapref
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Envfrom.Configmapref
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
envfrom:
configmapref: {}
Field |
Description |
name string |
|
optional boolean |
Lifecycle
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Lifecycle
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
lifecycle: {}
Field |
Description |
postStart |
|
preStop |
Poststart
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Lifecycle.Poststart
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
lifecycle:
poststart: {}
Field |
Description |
exec |
|
httpGet |
|
tcpSocket |
Exec
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Lifecycle.Poststart.Exec
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
lifecycle:
poststart:
exec: {}
Field |
Description |
command [] string |
Httpget
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Lifecycle.Poststart.Httpget
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
lifecycle:
poststart:
httpget: {}
Field |
Description |
host string |
|
httpHeaders |
|
path string |
|
port integer or string |
|
scheme string |
Httpheaders
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Lifecycle.Poststart.Httpget.Httpheaders
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
lifecycle:
poststart:
httpget:
httpheaders: {}
Field |
Description |
name string |
|
value string |
Tcpsocket
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Lifecycle.Poststart.Tcpsocket
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
lifecycle:
poststart:
tcpsocket: {}
Field |
Description |
host string |
|
port integer or string |
Livenessprobe
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Livenessprobe
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
livenessprobe: {}
Field |
Description |
exec |
|
failureThreshold integer |
|
grpc |
|
httpGet |
|
initialDelaySeconds integer |
|
periodSeconds integer |
|
successThreshold integer |
|
tcpSocket |
|
terminationGracePeriodSeconds integer |
|
timeoutSeconds integer |
Grpc
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Livenessprobe.Grpc
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
livenessprobe:
grpc: {}
Field |
Description |
port integer |
|
service string |
Ports
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Ports
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
ports: {}
Field |
Description |
containerPort integer |
|
hostIP string |
|
hostPort integer |
|
name string |
|
protocol string |
Securitycontext
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Securitycontext
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
securitycontext: {}
Field |
Description |
allowPrivilegeEscalation boolean |
|
capabilities |
|
privileged boolean |
|
procMount string |
|
readOnlyRootFilesystem boolean |
|
runAsGroup integer |
|
runAsNonRoot boolean |
|
runAsUser integer |
|
seLinuxOptions |
|
seccompProfile |
|
windowsOptions |
Capabilities
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Securitycontext.Capabilities
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
securitycontext:
capabilities: {}
Field |
Description |
add [] string |
|
drop [] string |
Selinuxoptions
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Securitycontext.Selinuxoptions
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
securitycontext:
selinuxoptions: {}
Field |
Description |
level string |
|
role string |
|
type string |
|
user string |
Seccompprofile
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Securitycontext.Seccompprofile
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
securitycontext:
seccompprofile: {}
Field |
Description |
localhostProfile string |
|
type string |
Windowsoptions
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Securitycontext.Windowsoptions
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
securitycontext:
windowsoptions: {}
Field |
Description |
gmsaCredentialSpec string |
|
gmsaCredentialSpecName string |
|
hostProcess boolean |
|
runAsUserName string |
Volumedevices
Complete namespace: Bookkeeper.Spec.Bookkeeper.Initcontainers.Volumedevices
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
initcontainers:
volumedevices: {}
Field |
Description |
devicePath string |
|
name string |
Nodeaffinity
Complete namespace: Bookkeeper.Spec.Bookkeeper.Nodeaffinity
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
nodeaffinity: {}
Field |
Description |
preferredDuringSchedulingIgnoredDuringExecution |
|
requiredDuringSchedulingIgnoredDuringExecution |
Preferredduringschedulingignoredduringexecution
Complete namespace: Bookkeeper.Spec.Bookkeeper.Nodeaffinity.Preferredduringschedulingignoredduringexecution
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
nodeaffinity:
preferredduringschedulingignoredduringexecution: {}
Field |
Description |
preference |
|
weight integer |
Preference
Complete namespace: Bookkeeper.Spec.Bookkeeper.Nodeaffinity.Preferredduringschedulingignoredduringexecution.Preference
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
nodeaffinity:
preferredduringschedulingignoredduringexecution:
preference: {}
Field |
Description |
matchExpressions |
|
matchFields |
Requiredduringschedulingignoredduringexecution
Complete namespace: Bookkeeper.Spec.Bookkeeper.Nodeaffinity.Requiredduringschedulingignoredduringexecution
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
nodeaffinity:
requiredduringschedulingignoredduringexecution: {}
Field |
Description |
nodeSelectorTerms |
Pdb
Complete namespace: Bookkeeper.Spec.Bookkeeper.Pdb
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
pdb: {}
Field |
Description |
enabled boolean |
Enable Pdb policy. |
maxUnavailable integer |
Number of maxUnavailable pods. |
Probes
Complete namespace: Bookkeeper.Spec.Bookkeeper.Probes
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
probes: {}
Field |
Description |
liveness |
|
readiness |
Liveness
Complete namespace: Bookkeeper.Spec.Bookkeeper.Probes.Liveness
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
probes:
liveness: {}
Field |
Description |
enabled boolean |
Enables the probe. |
failureThreshold integer |
Failure threshold. |
initialDelaySeconds integer |
Indicates the initial delay (in seconds) for the probe. |
periodSeconds integer |
Indicates the period (in seconds) for the probe. |
successThreshold integer |
Success threshold. |
terminationGracePeriodSeconds integer |
Indicates the termination grace period (in seconds) for the probe. |
timeoutSeconds integer |
Indicates the timeout (in seconds) for the probe. |
Readiness
Complete namespace: Bookkeeper.Spec.Bookkeeper.Probes.Readiness
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
probes:
readiness: {}
Field |
Description |
enabled boolean |
Enables the probe. |
failureThreshold integer |
Failure threshold. |
initialDelaySeconds integer |
Indicates the initial delay (in seconds) for the probe. |
periodSeconds integer |
Indicates the period (in seconds) for the probe. |
successThreshold integer |
Success threshold. |
terminationGracePeriodSeconds integer |
Indicates the termination grace period (in seconds) for the probe. |
timeoutSeconds integer |
Indicates the timeout (in seconds) for the probe. |
Resources
Complete namespace: Bookkeeper.Spec.Bookkeeper.Resources
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
resources: {}
Field |
Description |
limits [] integer or string |
|
requests [] integer or string |
Service
Complete namespace: Bookkeeper.Spec.Bookkeeper.Service
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
service: {}
Field |
Description |
additionalPorts |
Additional ports to add to the Service. |
annotations []key/value |
Additional annotations to add to the Service. |
Additionalports
Complete namespace: Bookkeeper.Spec.Bookkeeper.Service.Additionalports
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
service:
additionalports: {}
Field |
Description |
appProtocol string |
|
name string |
|
nodePort integer |
|
port integer |
|
protocol string |
|
targetPort integer or string |
Sets
Complete namespace: Bookkeeper.Spec.Bookkeeper.Sets
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
sets: {}
Field |
Description |
additionalVolumes |
|
annotations []key/value |
Annotations to add to each resource (except pods). |
antiAffinity |
|
autoscaler |
|
cleanUpPvcs boolean |
Cleanup PVCs after the bookie has been removed. |
config any |
Configuration. |
env []Env |
Additional container env variables. |
gracePeriod integer |
Termination grace period in seconds. |
image string |
Override Pulsar image. |
imagePullPolicy string |
Override image pull policy. |
imagePullSecrets |
Image pull secrets. |
initContainers |
Init containers |
labels []key/value |
Labels to add to each resource (except pods). |
matchLabels []key/value |
Match labels selectors to add to each pod. |
nodeAffinity |
|
nodeSelectors []key/value |
Additional node selectors. |
overrideResourceName string |
Override the resource names generated by the operator. |
pdb |
|
podAnnotations []key/value |
Annotations to add to pod. |
podLabels []key/value |
Labels to add to each pod. |
podManagementPolicy string |
Pod management policy. Default value is 'Parallel'. |
probes |
|
pvcPrefix string |
Prefix for each PVC created. |
replicas integer |
Number of desired replicas. |
resources |
|
service |
|
sidecars []Sidecars |
Sidecar containers |
tolerations |
Pod tolerations. |
updateStrategy |
|
volumes |
Tolerations
Complete namespace: Bookkeeper.Spec.Bookkeeper.Sets.Tolerations
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
sets:
tolerations: {}
Field |
Description |
effect string |
|
key string |
|
operator string |
|
tolerationSeconds integer |
|
value string |
Updatestrategy
Complete namespace: Bookkeeper.Spec.Bookkeeper.Sets.Updatestrategy
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
sets:
updatestrategy: {}
Field |
Description |
rollingUpdate |
|
type string |
Rollingupdate
Complete namespace: Bookkeeper.Spec.Bookkeeper.Sets.Updatestrategy.Rollingupdate
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
sets:
updatestrategy:
rollingupdate: {}
Field |
Description |
maxUnavailable integer or string |
|
partition integer |
Volumes
Complete namespace: Bookkeeper.Spec.Bookkeeper.Sets.Volumes
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
sets:
volumes: {}
Field |
Description |
journal |
|
ledgers |
Journal
Complete namespace: Bookkeeper.Spec.Bookkeeper.Sets.Volumes.Journal
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
sets:
volumes:
journal: {}
Field |
Description |
existingStorageClassName string |
Indicates if an already existing storage class should be used. |
name string |
Indicates the suffix for the volume. Default value is 'data'. |
size string |
Indicates the requested size for the volume. The format follows the Kubernetes' Quantity. |
storageClass |
Storageclass
Complete namespace: Bookkeeper.Spec.Bookkeeper.Sets.Volumes.Journal.Storageclass
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
sets:
volumes:
journal:
storageclass: {}
Field |
Description |
extraParams []key/value |
Adds extra parameters for the StorageClass. |
fsType string |
Indicates the 'fsType' parameter for the StorageClass. |
provisioner string |
Indicates the provisioner property for the StorageClass. |
reclaimPolicy string |
Indicates the reclaimPolicy property for the StorageClass. |
type string |
Indicates the 'type' parameter for the StorageClass. |
Ledgers
Complete namespace: Bookkeeper.Spec.Bookkeeper.Sets.Volumes.Ledgers
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
bookkeeper:
sets:
volumes:
ledgers: {}
Field |
Description |
existingStorageClassName string |
Indicates if an already existing storage class should be used. |
name string |
Indicates the suffix for the volume. Default value is 'data'. |
size string |
Indicates the requested size for the volume. The format follows the Kubernetes' Quantity. |
storageClass |
Global
Complete namespace: Bookkeeper.Spec.Global
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global: {}
Field |
Description |
name string |
(Optional) Pulsar cluster name. |
antiAffinity |
|
auth |
|
components |
|
dnsConfig |
|
dnsName string |
Public dns name for the cluster's load balancer. |
image string |
Default Pulsar image to use. Any components can be configured to use a different image. |
imagePullPolicy string |
Default Pulsar image pull policy to use. Any components can be configured to use a different image pull policy. Default value is 'IfNotPresent'. |
kubernetesClusterDomain string |
The domain name for your kubernetes cluster. This domain is documented here: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#a-aaaa-records-1 . It's used to fully qualify service names when configuring Pulsar. The default value is 'cluster.local'. |
nodeSelectors []key/value |
Global node selector. If set, this will apply to all the components. |
persistence boolean |
If persistence is enabled, components that has state will be deployed with PersistentVolumeClaims, otherwise, for test purposes, they will be deployed with emptyDir |
priorityClassName string |
Priority class name to attach to each pod. |
racks [] |
Racks configuration. |
resourceSets [] |
Resource sets. |
restartOnConfigMapChange boolean |
By default, Kubernetes will not restart pods when only their configmap is changed. This setting will restart pods when their configmap is changed using an annotation that calculates the checksum of the configmap. |
storage |
|
tls |
|
zookeeperPlainSslStorePassword boolean |
Use plain password in zookeeper server and client configuration. Default is false. Old versions of Apache Zookeeper (<3.8.0) does not support getting password from file. In that case, set this to true. |
Antiaffinity
Complete namespace: Bookkeeper.Spec.Global.Antiaffinity
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
antiaffinity: {}
Field |
Description |
host |
|
zone |
Auth
Complete namespace: Bookkeeper.Spec.Global.Auth
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
auth: {}
Field |
Description |
enabled boolean |
Enable authentication in the cluster. Default is 'false'. |
token |
Token
Complete namespace: Bookkeeper.Spec.Global.Auth.Token
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
auth:
token: {}
Field |
Description |
initialize boolean |
Initialize Secrets with new pair of keys and tokens for the super user roles. The generated Secret name is 'token-<role>'. |
privateKeyFile string |
Private key file name stored in the Secret. Default is 'my-private.key' |
proxyRoles [] string |
Proxy roles. |
publicKeyFile string |
Public key file name stored in the Secret. Default is 'my-public.key' |
superUserRoles [] string |
Super user roles. |
Components
Complete namespace: Bookkeeper.Spec.Global.Components
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
components: {}
Field |
Description |
autorecoveryBaseName string |
Autorecovery base name. Default value is 'autorecovery'. |
bastionBaseName string |
Bastion base name. Default value is 'bastion'. |
bookkeeperBaseName string |
BookKeeper base name. Default value is 'bookkeeper'. |
brokerBaseName string |
Broker base name. Default value is 'broker'. |
functionsWorkerBaseName string |
Functions Worker base name. Default value is 'function'. |
proxyBaseName string |
Proxy base name. Default value is 'proxy'. |
zookeeperBaseName string |
Zookeeper base name. Default value is 'zookeeper'. |
Dnsconfig
Complete namespace: Bookkeeper.Spec.Global.Dnsconfig
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
dnsconfig: {}
Field |
Description |
nameservers [] string |
|
options []Options |
|
searches [] string |
Racks
Complete namespace: Bookkeeper.Spec.Global.Racks
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
racks: {}
Field |
Description |
host |
|
zone |
Host
Complete namespace: Bookkeeper.Spec.Global.Racks.Host
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
racks:
host: {}
Field |
Description |
enabled boolean |
Enable the rack affinity rules. |
requireRackAffinity boolean |
Indicates if the podAffinity rules will be enforced. Default is false. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'. |
requireRackAntiAffinity boolean |
Indicates if the podAntiAffinity rules will be enforced. Default is true. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'. |
Zone
Complete namespace: Bookkeeper.Spec.Global.Racks.Zone
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
racks:
zone: {}
Field |
Description |
enableHostAntiAffinity boolean |
Enable the host anti affinity. If set, all the pods of the same rack will deployed on different nodes of the same zone.Default is true. |
enabled boolean |
Enable the rack affinity rules. |
requireRackAffinity boolean |
Indicates if the podAffinity rules will be enforced. Default is false. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'. |
requireRackAntiAffinity boolean |
Indicates if the podAntiAffinity rules will be enforced. Default is true. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'. |
requireRackHostAntiAffinity boolean |
Indicates if the podAntiAffinity rules will be enforced for the host. Default is true. If required, the affinity rule will be enforced using 'requiredDuringSchedulingIgnoredDuringExecution'. |
Resourcesets
Complete namespace: Bookkeeper.Spec.Global.Resourcesets
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
resourcesets: {}
Field |
Description |
rack string |
Place this resource set to a specific rack, defined at .global.racks. |
Storage
Complete namespace: Bookkeeper.Spec.Global.Storage
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
storage: {}
Field |
Description |
existingStorageClassName string |
Indicates if an already existing storage class should be used. |
storageClass |
Tls
Complete namespace: Bookkeeper.Spec.Global.Tls
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls: {}
Field |
Description |
autorecovery |
|
bookkeeper |
|
broker |
|
brokerResourceSets [] |
TLS configurations related to the Broker resource sets. |
caPath string |
Path in the container filesystem where the TLS CA certificates are retrieved. It has to point to a certificate file. The default value is /etc/ssl/certs/ca-certificates.crt. |
certProvisioner |
|
defaultSecretName string |
Secret name used by each component to load TLS certificates. Each component can load a different secret by setting the 'secretName' entry in the tls component spec. |
enabled boolean |
Global switch to turn on or off the TLS configurations. Additionally, you have configure each component section. |
functionsWorker |
|
proxy |
|
proxyResourceSets [] |
TLS configurations related to the Proxy resource sets. |
ssCa |
|
zookeeper |
Autorecovery
Complete namespace: Bookkeeper.Spec.Global.Tls.Autorecovery
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
autorecovery: {}
Field |
Description |
enabled boolean |
Enable TLS. |
secretName string |
Override the default secret name from where to load the certificates. |
Bookkeeper
Complete namespace: Bookkeeper.Spec.Global.Tls.Bookkeeper
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
bookkeeper: {}
Field |
Description |
enabled boolean |
Enable TLS. |
secretName string |
Override the default secret name from where to load the certificates. |
Broker
Complete namespace: Bookkeeper.Spec.Global.Tls.Broker
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
broker: {}
Field |
Description |
enabled boolean |
Enable TLS. |
secretName string |
Override the default secret name from where to load the certificates. |
Brokerresourcesets
Complete namespace: Bookkeeper.Spec.Global.Tls.Brokerresourcesets
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
brokerresourcesets: {}
Field |
Description |
enabled boolean |
Enable TLS. |
secretName string |
Override the default secret name from where to load the certificates. |
Certprovisioner
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner: {}
Field |
Description |
selfSigned |
Selfsigned
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner.Selfsigned
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner:
selfsigned: {}
Field |
Description |
autorecovery |
|
bookkeeper |
|
broker |
|
caSecretName string |
Secret where to store the root CA certificate. |
enabled boolean |
Generate self signed certificates for broker, proxy and functions worker. |
functionsWorker |
|
includeDns boolean |
Include dns name in the DNS names covered by the certificate. |
perComponent boolean |
Generate a different certificate for each component. |
privateKey |
|
proxy |
|
zookeeper |
Autorecovery
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner.Selfsigned.Autorecovery
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner:
selfsigned:
autorecovery: {}
Field |
Description |
generate boolean |
Generate self signed certificates for the component. |
privateKey |
Privatekey
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner.Selfsigned.Autorecovery.Privatekey
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner:
selfsigned:
autorecovery:
privatekey: {}
Field |
Description |
algorithm string |
|
encoding string |
|
rotationPolicy string |
|
size integer |
Bookkeeper
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner.Selfsigned.Bookkeeper
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner:
selfsigned:
bookkeeper: {}
Field |
Description |
generate boolean |
Generate self signed certificates for the component. |
privateKey |
Broker
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner.Selfsigned.Broker
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner:
selfsigned:
broker: {}
Field |
Description |
generate boolean |
Generate self signed certificates for the component. |
privateKey |
Functionsworker
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner.Selfsigned.Functionsworker
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner:
selfsigned:
functionsworker: {}
Field |
Description |
generate boolean |
Generate self signed certificates for the component. |
privateKey |
Proxy
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner.Selfsigned.Proxy
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner:
selfsigned:
proxy: {}
Field |
Description |
generate boolean |
Generate self signed certificates for the component. |
privateKey |
Zookeeper
Complete namespace: Bookkeeper.Spec.Global.Tls.Certprovisioner.Selfsigned.Zookeeper
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
certprovisioner:
selfsigned:
zookeeper: {}
Field |
Description |
generate boolean |
Generate self signed certificates for the component. |
privateKey |
Functionsworker
Complete namespace: Bookkeeper.Spec.Global.Tls.Functionsworker
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
functionsworker: {}
Field |
Description |
enabled boolean |
Enable TLS. |
enabledWithBroker boolean |
Enable TLS for the functions worker to broker connections. |
secretName string |
Override the default secret name from where to load the certificates. |
Proxy
Complete namespace: Bookkeeper.Spec.Global.Tls.Proxy
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
proxy: {}
Field |
Description |
enabled boolean |
Enable TLS. |
enabledWithBroker boolean |
Enable TLS for the proxy to broker connections. |
secretName string |
Override the default secret name from where to load the certificates. |
Proxyresourcesets
Complete namespace: Bookkeeper.Spec.Global.Tls.Proxyresourcesets
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
proxyresourcesets: {}
Field |
Description |
enabled boolean |
Enable TLS. |
enabledWithBroker boolean |
Enable TLS for the proxy to broker connections. |
secretName string |
Override the default secret name from where to load the certificates. |
Ssca
Complete namespace: Bookkeeper.Spec.Global.Tls.Ssca
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
ssca: {}
Field |
Description |
enabled boolean |
Enable TLS. |
secretName string |
Override the default secret name from where to load the certificates. |
Zookeeper
Complete namespace: Bookkeeper.Spec.Global.Tls.Zookeeper
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
global:
tls:
zookeeper: {}
Field |
Description |
enabled boolean |
Enable TLS. |
secretName string |
Override the default secret name from where to load the certificates. |
Status
Complete namespace: Bookkeeper.Status
Field |
Description |
conditions |
Conditions: 1. Condition Ready: possible status are True or False. If False, the reason contains the error message. |
lastApplied string |
Last spec applied. |
Conditions
Complete namespace: Bookkeeper.Status.Conditions
Example use:
apiVersion: pulsar.oss.datastax.com/v1alpha1
kind: Bookkeeper
metadata:
name: example-pulsarcluster
spec:
conditions: {}
Field |
Description |
lastTransitionTime string |
|
message string |
|
observedGeneration integer |
|
reason string |
|
status string |
|
type string |