Cassandra cluster

CassandraCluster describes the desired state of the Cassandra cluster we want to setup through the operator.

apiVersion: "db.orange.com/v2"
kind: "CassandraCluster"
metadata:
  name: cassandra-demo
  labels:
    cluster: k8s.kaas
spec:
  cassandraImage: cassandra:3.11
  bootstrapImage: ghcr.io/cscetbon/casskop-bootstrap:0.1.4
  configMapName: cassandra-configmap-v1
  dataCapacity: "200Mi"
  dataStorageClass: "local-storage"
  imagepullpolicy: IfNotPresent  
  hardAntiAffinity: false           # Do we ensure only 1 cassandra on each node ?
  deletePVC: true
  autoPilot: false
  config:
    jvm-options:
      log_gc: "true"
  autoUpdateSeedList: false
  maxPodUnavailable: 1
  runAsUser: 999
  shareProcessNamespace: true
  resources:         
    limits:
      cpu: '1'
      memory: 2Gi
  topology:
    dc:
      - name: dc1
        nodesPerRacks: 1
        rack:
          - name: rack1
          - name: rack2
          - name: rack3

CassandraCluster

Field	Type	Description	Required	Default
metadata	ObjectMetadata	is metadata that all persisted resources must have, which includes all objects users must create.	No	nil
spec	CassandraClusterSpec	defines the desired state of CassandraCluster.	No	nil
status	CassandraClusterStatus	defines the observed state of CassandraCluster.	No	nil

CassandraClusterSpec

Field	Type	Description	Required	Default
nodesPerRacks	int32	Number of nodes to deploy for a Cassandra deployment in each Racks. If NodesPerRacks = 2 and there is 3 racks, the cluster will have 6 Cassandra Nodes	Yes	1
cassandraImage	string	Image + version to use for Cassandra	Yes	cassandra:3.11.6
configBuilderImage	string	Image + version to use for configBuilder	No	datastax/cass-config-builder:1.0.4
imagepullpolicy	PullPolicy	Define the pull policy for C* docker image	Yes	PullAlways
bootstrapImage	string	Image used for bootstrapping cluster (use the form : base:version)	Yes	ghcr.io/cscetbon/casskop-bootstrap:0.1.4
runAsUser	int64	Define the id of the user to run in the Cassandra image	Yes	999
fsGroup	int64	FSGroup defines the GID owning volumes in the Cassandra image	No	1
config	map	Configuration used by the config builder to generated cassandra.yaml and other configuration files	No
readOnlyRootFilesystem	Make the pod as Readonly	bool	Yes	true
resources	Resources	Define the Requests & Limits resources spec of the "cassandra" container	Yes	-
hardAntiAffinity	bool	HardAntiAffinity defines if the PodAntiAffinity of the statefulset has to be hard (it's soft by default)	Yes	false
pod	PodPolicy		No	-
service	ServicePolicy		No	-
deletePVC	bool	Defines if the PVC must be deleted when the cluster is deleted	Yes	false
debug	bool	Is used to surcharge Cassandra pod command to not directly start cassandra but starts an infinite wait to allow user to connect a bash into the pod to make some diagnoses.	Yes	false
shareProcessNamespace	bool	When process namespace sharing is enabled, processes in a container are visible to all other containers in that pod. Check documentation for more informations	Yes	false
autoPilot	bool	Defines if the Operator can fly alone or if we need human action to trigger actions on specific Cassandra nodes. Check documentation for more informations	Yes	false
noCheckStsAreEqual	bool		Yes	false
autoUpdateSeedList	bool	Defines if the Operator automatically update the SeedList according to new cluster CRD topology	Yes	false
maxPodUnavailable	int32	Number of MaxPodUnavailable used in the PodDisruptionBudget	Yes	1
restartCountBeforePodDeletion	int32	defines the number of restart allowed for a cassandra container allowed before deleting the pod to force its restart from scratch. if set to 0 or omit, no action will be performed based on restart count. Check documentation for more informations	Yes	0
unlockNextOperation	bool	Very special Flag to hack CassKop reconcile loop - use with really good Care	Yes	false
dataCapacity	string	Define the Capacity for Persistent Volume Claims in the local storage. Check documentation for more informations	Yes
dataStorageClass	string	Define StorageClass for Persistent Volume Claims in the local storage. Check documentation for more informations	Yes
storageConfigs	[ ]StorageConfig	Defines additional storage configurations. Check documentation for more informations	No	-
sidecarConfigs	[ ]Container	Defines additional sidecar configurations. Check documentation for more informations	No	-
configMapName	string	Name of the ConfigMap for Cassandra configuration (cassandra.yaml). If this is empty, operator will uses default cassandra.yaml from the baseImage. If this is not empty, operator will uses the cassandra.yaml from the Configmap instead. Check documentation for more informations	No	-
imagePullSecret	LocalObjectReference	Name of the secret to uses to authenticate on Docker registries. If this is empty, operator do nothing. If this is not empty, propagate the imagePullSecrets to the statefulsets	No	-
imageJolokiaSecret	LocalObjectReference	JMX Secret if Set is used to set JMX_USER and JMX_PASSWORD	No	-
topology	Topology	To create Cassandra DC and Racks and to target appropriate Kubernetes Nodes	Yes	-
livenessInitialDelaySeconds	int32	Defines initial delay for the liveness probe of the main. Configure liveness Readiness startup probes	Yes	120
livenessHealthCheckTimeout	int32	Defines health check timeout for the liveness probe of the main. Configure liveness Readiness startup probes	Yes	20
livenessHealthCheckPeriod	int32	Defines health check period for the liveness probe of the main. Configure liveness Readiness startup probes	Yes	10
livenessFailureThreshold	int32	Defines failure threshold for the liveness probe of the main. Configure liveness Readiness startup probes	Yes	(value set by kubernetes cluster)
livenessSuccessThreshold	int32	Defines success threshold for the liveness probe of the main. Configure liveness Readiness startup probes	Yes	(value set by kubernetes cluster)
readinessInitialDelaySeconds	int32	Defines initial delay for the readiness probe of the main. Configure liveness Readiness startup probes	Yes	60
readinessHealthCheckTimeout	int32	Defines health check timeout for the readiness probe of the main. Configure liveness Readiness startup probes	Yes	10
readinessHealthCheckPeriod	int32	Defines health check period for the readiness probe of the main. Configure liveness Readiness startup probes	Yes	10
readinessFailureThreshold	int32	Defines failure threshold for the readiness probe of the main. Configure liveness Readiness startup probes	Yes	(value set by kubernetes cluster)
readinessSuccessThreshold	int32	Defines success threshold for the readiness probe of the main. Configure liveness Readiness startup probes	Yes	(value set by kubernetes cluster)

PodPolicy

Field	Type	Description	Required	Default
annotations	map[string]string	Annotations specifies the annotations to attach to pods the CassKop operator creates	No	-
tolerations	Toleration	Tolerations specifies the tolerations to attach to the pods the CassKop operator creates	No	-

ServicePolicy

Field	Type	Description	Required	Default
annotations	map[string]string	Annotations specifies the annotations to attach to headless service the CassKop operator creates	No	-

StorageConfig

Field	Type	Description	Required	Default
name	string	Name of the storage config, used to name PV to reuse into sidecars for example.	Yes	-
mountPath	string	Path where the volume will be mount into the main cassandra container inside the pod.	Yes	-
pvcSpec	PersistentVolumeClaimSpec	Kubernetes PVC spec. create-a-persistentvolumeclaim.	Yes	-