K8ssandra-operator CRDs latest build

Configuration reference for the CRDs used with K8ssandra-operator latest build.

Packages:

config.k8ssandra.io/v1beta1
control.k8ssandra.io/v1alpha1
k8ssandra.io/v1alpha1
medusa.k8ssandra.io/v1alpha1
reaper.k8ssandra.io/v1alpha1
replication.k8ssandra.io/v1alpha1
stargate.k8ssandra.io/v1alpha1

config.k8ssandra.io/v1beta1

Resource Types:

ClientConfig

ClientConfig

^{^{↩ Parent}}

ClientConfig is the Schema for the kubeconfigs API

Name	Type	Description	Required
apiVersion	string	config.k8ssandra.io/v1beta1	true
kind	string	ClientConfig	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	ClientConfigSpec defines the desired state of KubeConfig	false

ClientConfig.spec

^{^{↩ Parent}}

ClientConfigSpec defines the desired state of KubeConfig

Name	Type	Description	Required
contextName	string	ContextName allows to override the object name for context-name. If not set, the ClientConfig.Name is used as context name	false
kubeConfigSecret	object	KubeConfigSecret should reference an existing secret; the actual configuration will be read from this secret's "kubeconfig" key.	false

ClientConfig.spec.kubeConfigSecret

^{^{↩ Parent}}

KubeConfigSecret should reference an existing secret; the actual configuration will be read from this secret’s “kubeconfig” key.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

control.k8ssandra.io/v1alpha1

Resource Types:

K8ssandraTask

K8ssandraTask

^{^{↩ Parent}}

K8ssandraTask is the Schema for the k8ssandratasks API

Name	Type	Description	Required
apiVersion	string	control.k8ssandra.io/v1alpha1	true
kind	string	K8ssandraTask	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	K8ssandraTaskSpec defines the desired state of K8ssandraTask	false
status	object	K8ssandraTaskStatus defines the observed state of K8ssandraTask	false

K8ssandraTask.spec

^{^{↩ Parent}}

K8ssandraTaskSpec defines the desired state of K8ssandraTask

Name	Type	Description	Required
cluster	object	Which K8ssandraCluster this task is operating on.	false
datacenters	[]string	The names of the targeted datacenters. If omitted, will default to all DCs in spec order.	false
dcConcurrencyPolicy	string	How to handle concurrency across DCs. Valid values are: - "Forbid" (default): sequential processing. The K8ssandraTask only spawns one CassandraTask at a time, which must run to completion before the CassandraTask for the next DC is created. If any CassandraTask fails, the K8ssandraTask is marked as failed, and the remaining CassandraTasks are cancelled (i.e. never created). - "Allow": parallel processing. The K8ssandraTask spawns all CassandraTasks at once. If any CassandraTask fails, the K8ssandraTask is marked as failed, but the remaining CassandraTasks finish running.	false
template	object	The characteristics of the CassandraTask that will get created for each DC.	false

K8ssandraTask.spec.cluster

^{^{↩ Parent}}

Which K8ssandraCluster this task is operating on.

Name	Type	Description	Required
apiVersion	string	API version of the referent.	false
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.	false
kind	string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	false
namespace	string	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	false
resourceVersion	string	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	false
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids	false

K8ssandraTask.spec.template

^{^{↩ Parent}}

The characteristics of the CassandraTask that will get created for each DC.

Name	Type	Description	Required
concurrencyPolicy	string	Specifics if this task can be run concurrently with other active tasks. Valid values are: - "Allow": allows multiple Tasks to run concurrently on Cassandra cluster - "Forbid" (default): only a single task is executed at once The "Allow" property is only valid if all the other active Tasks have "Allow" as well.	false
jobs	[]object	Jobs defines the jobs this task will execute (and their order)	false
restartPolicy	string	RestartPolicy indicates the behavior n case of failure. Default is Never.	false
scheduledTime	string	ScheduledTime indicates the earliest possible time this task is executed. This does not necessarily equal to the time it is actually executed (if other tasks are blocking for example). If not set, the task will be executed immediately. Format: date-time	false
ttlSecondsAfterFinished	integer	TTLSecondsAfterFinished defines how long the completed job will kept before being cleaned up. If set to 0 the task will not be cleaned up by the cass-operator. If unset, the default time (86400s) is used. Format: int32	false

K8ssandraTask.spec.template.jobs[index]

^{^{↩ Parent}}

Name	Type	Description	Required
command	string	Command defines what is run against Cassandra pods	true
name	string		true
args	object	Arguments are additional parameters for the command	false

K8ssandraTask.spec.template.jobs[index].args

^{^{↩ Parent}}

Arguments are additional parameters for the command

Name	Type	Description	Required
end_token	string		false
jobs	integer		false
keyspace_name	string		false
new_tokens	map[string]string	NewTokens is a map of pod names to their newly-assigned tokens. Required for the move command, ignored otherwise. Pods referenced in this map must exist; any existing pod not referenced in this map will not be moved.	false
no_snapshot	boolean		false
no_validate	boolean	Scrub arguments	false
pod_name	string		false
rack	string		false
skip_corrupted	boolean		false
source_datacenter	string		false
split_output	boolean	Compaction arguments	false
start_token	string		false
tables	[]string		false

K8ssandraTask.status

^{^{↩ Parent}}

K8ssandraTaskStatus defines the observed state of K8ssandraTask

Name	Type	Description	Required
active	integer	The number of actively running pods.	false
completionTime	string	Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully. Format: date-time	false
conditions	[]object	The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/	false
datacenters	map[string]object	The individual progress of the CassandraTask in each datacenter.	false
failed	integer	The number of pods which reached phase Failed.	false
startTime	string	Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC. Format: date-time	false
succeeded	integer	The number of pods which reached phase Succeeded.	false

K8ssandraTask.status.conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

This struct is intended for direct use as an array at the field path .status.conditions. For example,

type FooStatus struct{
    // Represents the observations of a foo's current state.
    // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
    // +patchMergeKey=type
    // +patchStrategy=merge
    // +listType=map
    // +listMapKey=type
    Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`


    // other fields
}

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

K8ssandraTask.status.datacenters[key]

^{^{↩ Parent}}

CassandraTaskStatus defines the observed state of CassandraJob

Name	Type	Description	Required
active	integer	The number of actively running pods.	false
completionTime	string	Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully. Format: date-time	false
conditions	[]object	The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/	false
failed	integer	The number of pods which reached phase Failed.	false
startTime	string	Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC. Format: date-time	false
succeeded	integer	The number of pods which reached phase Succeeded.	false

K8ssandraTask.status.datacenters[key].conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

This struct is intended for direct use as an array at the field path .status.conditions. For example,

type FooStatus struct{
    // Represents the observations of a foo's current state.
    // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
    // +patchMergeKey=type
    // +patchStrategy=merge
    // +listType=map
    // +listMapKey=type
    Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`


    // other fields
}

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

k8ssandra.io/v1alpha1

Resource Types:

K8ssandraCluster

K8ssandraCluster

^{^{↩ Parent}}

K8ssandraCluster is the Schema for the k8ssandraclusters API. The K8ssandraCluster CRD name is also the name of the Cassandra cluster (which corresponds to cluster_name in cassandra.yaml).

Name	Type	Description	Required
apiVersion	string	k8ssandra.io/v1alpha1	true
kind	string	K8ssandraCluster	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	K8ssandraClusterSpec defines the desired state of K8ssandraCluster	false
status	object	K8ssandraClusterStatus defines the observed state of K8ssandraCluster	false

K8ssandraCluster.spec

^{^{↩ Parent}}

K8ssandraClusterSpec defines the desired state of K8ssandraCluster

Name	Type	Description	Required
auth	boolean	Whether to enable authentication in this cluster. The default is true; it is highly recommended to always leave authentication turned on. When enabled, authentication will be enforced not only on Cassandra nodes, but also on Reaper, Medusa and Stargate nodes, if any. Default: true	false
cassandra	object	Cassandra is a specification of the Cassandra cluster. This includes everything from the number of datacenters, the k8s cluster where each DC should be deployed, node affinity (via racks), individual C* node settings, JVM settings, and more.	false
externalDatacenters	[]string	During a migration the operator should alter keyspaces replication settings including the following external DCs. This avoids removing replicas from datacenters which are outside of the operator scope (not referenced in the CR). Replication settings changes will only apply to system_* keyspaces as well as reaper_db and data_endpoint_auth (Stargate).	false
medusa	object	Medusa defines the desired deployment characteristics for Medusa in this K8ssandraCluster. If this is non-nil, Medusa will be deployed in every Cassandra pod in this K8ssandraCluster.	false
reaper	object	Reaper defines the desired deployment characteristics for Reaper in this K8ssandraCluster. If this is non-nil, Reaper might be deployed on every Cassandra datacenter in this K8ssandraCluster, unless there is a Control Plane Reaper present. In that case, the K8ssandraCluster will get registered to it.	false
secretsProvider	enum	SecretsProvider defines whether the secrets used for credentials and certs will be backed by an external secret backend (e.g. vault). This moves the responsibility of generating and storing secrets from the operators to the user and will rely on a mutating webhook to inject the secrets into the necessary resources Enum: internal, external Default: internal	false
stargate	object	Stargate defines the desired deployment characteristics for Stargate in this K8ssandraCluster. If this is non-nil, Stargate will be deployed on every Cassandra datacenter in this K8ssandraCluster.	false

K8ssandraCluster.spec.cassandra

^{^{↩ Parent}}

Cassandra is a specification of the Cassandra cluster. This includes everything from the number of datacenters, the k8s cluster where each DC should be deployed, node affinity (via racks), individual C* node settings, JVM settings, and more.

Name	Type	Description	Required
additionalSeeds	[]string	AdditionalSeeds specifies Cassandra node IPs for an existing datacenter. This is primarily intended for migrations from an existing Cassandra cluster that is not managed by k8ssandra-operator. Note that this property should NOT be used to set seeds for a DC that is or will be managed by k8ssandra-operator. k8ssandra-operator already manages seeds for DCs that it manages. If you have DNS set up such that you can resolve hostnames for the remote Cassandra cluster, then you can specify hostnames here; otherwise, use IP addresses.	false
cdc	object	CDC defines the desired state for CDC integrations. It can be used to feed mutation events from Cassandra into an Apache Pulsar cluster, from where they can be expored to external systems.	false
clientEncryptionStores	object	Client encryption stores which are used by Cassandra and Reaper.	false
clusterName	string	Override the Cassandra cluster name. If unspecified, the cluster name will be the same as the K8ssandraCluster CRD name.	false
config	object	CassandraConfig contains configuration settings that are applied to cassandra.yaml, dse.yaml and the various jvm*.options files.	false
containers	[]object	Containers defines containers to be deployed in each Cassandra pod. K8ssandra-operator and cass-operator will create their own containers, which can be referenced here to override specific settings, such as mounts or resources request/limits for example. Example: containers: - name: server-system-logger - name: custom-container image: busybox - name: cassandra	false
datacenterName	string	DatacenterName allows to override the name of the Cassandra datacenter. Kubernetes objects will be named after a sanitized version of it if set, and if not metadata.name. In Cassandra the DC name will be overridden by this value. It may generate some confusion as objects created for the DC will have a different name than the CasandraDatacenter object itself. This setting can create conflicts if multiple DCs coexist in the same namespace if metadata.name for a DC with no override is set to the same value as the override name of another DC. Use cautiously.	false
datacenters	[]object	Datacenters a list of the DCs in the cluster.	false
dseWorkloads	object		false
extraVolumes	object	Volumes defines additional volumes to be added to each Cassandra pod. If the volume uses a PersistentVolumeClaim, the PVC will be managed by the statefulset.	false
initContainers	[]object	InitContainers defines init-containers to be deployed in each Cassandra pod. K8ssandra-operator and cass-operator will create their own init-containers, which can be referenced here to control ordering or override specific settings such as mounts or resources request/limits for example. Only the name of the k8ssandra-operator/cass-operator init-containers is required, not their full definition which will be created by the operators. Example: initContainers: - name: server-config-init - name: custom-init-container image: busybox - name: medusa-restore Otherwise init-containers referenced here will be injected in first position	false
jmxInitContainerImage	object	Deprecated: JMX security is now based on CQL roles. We don't need an init container to configure JMX authentication anymore. The value of this field will be ignored.	false
managementApiAuth	object	ManagementApiAuth defines the authentication settings for the management API in the Cassandra pods.	false
metadata	object	Struct to hold labels and annotations for the top-level Cassandra cluster definition.	false
mgmtAPIHeap	int or string	MgmtAPIHeap defines the amount of memory devoted to the management api heap.	false
networking	object	Networking enables host networking and configures a NodePort ports.	false
perNodeConfigInitContainerImage	string	The image to use in each Cassandra pod for the (short-lived) init container that merges global and perNodeConfig configuration. This is only useful when PerNodeConfigMapRef is set. The default is "mikefarah/yq:4". Default: mikefarah/yq:4	false
podSecurityContext	object	PodSecurityContext defines the security context for the Cassandra pods.	false
racks	[]object	Racks is a list of named racks. Note that racks are used to create node affinity. //	false
resources	object	Resources is the cpu and memory resources for the cassandra container.	false
serverEncryptionStores	object	Internode encryption stores which are used by Cassandra and Stargate.	false
serverImage	string	ServerImage is the image for the cassandra container. Note that this should be a management-api image. If left empty the operator will choose a default image based on ServerVersion.	false
serverType	enum	Server type: "cassandra" or "dse". Enum: cassandra, dse, hcd Default: cassandra	false
serverVersion	string	ServerVersion is the Cassandra or DSE version. The following versions are supported: - Cassandra: 3.11.X, 4.X.X and 5.X.X - DSE: 6.8.X, 7.x.x - HCD: 1.0.x	false
serviceAccount	string	The k8s service account to use for the Cassandra pods	false
softPodAntiAffinity	boolean	SoftPodAntiAffinity sets whether multiple Cassandra instances can be scheduled on the same node. This should normally be false to ensure cluster resilience but may be set true for test/dev scenarios to minimise the number of nodes required.	false
storageConfig	object	StorageConfig is the persistent storage requirements for each Cassandra pod. This includes everything under /var/lib/cassandra, namely the commit log and data directories.	false
superuserSecretRef	object	The reference to the superuser secret to use for Cassandra. If unspecified, a default secret will be generated with a random password; the generated secret name will be "-superuser" where is the K8ssandraCluster CRD name.	false
telemetry	object	Telemetry defines the desired state for telemetry resources in this datacenter. If telemetry configurations are defined, telemetry resources will be deployed to integrate with a user-provided monitoring solution (at present, only support for Prometheus is available).	false
tolerations	[]object	Tolerations applied to every Cassandra pod.	false

K8ssandraCluster.spec.cassandra.cdc

^{^{↩ Parent}}

CDC defines the desired state for CDC integrations. It can be used to feed mutation events from Cassandra into an Apache Pulsar cluster, from where they can be expored to external systems.

Name	Type	Required
pulsarServiceUrl	string	true
cdcConcurrentProcessors	integer	false
cdcPollIntervalM	integer	false
cdcWorkingDir	string	false
errorCommitLogReprocessEnabled	boolean	false
pulsarAuthParams	string	false
pulsarAuthPluginClassName	string	false
pulsarBatchDelayInMs	integer	false
pulsarKeyBasedBatcher	boolean	false
pulsarMaxPendingMessages	integer	false
pulsarMaxPendingMessagesAcrossPartitions	integer	false
sslAllowInsecureConnection	string	false
sslCipherSuites	string	false
sslEnabledProtocols	string	false
sslHostnameVerificationEnable	string	false
sslKeystorePassword	string	false
sslKeystorePath	string	false
sslProvider	string	false
sslTruststorePassword	string	false
sslTruststorePath	string	false
sslTruststoreType	string	false
topicPrefix	string	false

K8ssandraCluster.spec.cassandra.clientEncryptionStores

^{^{↩ Parent}}

Client encryption stores which are used by Cassandra and Reaper.

Name	Type	Description	Required
keystoreSecretRef	object	ref to the secret that contains the keystore and optionally its password (which can also be specified through the keystorePasswordSecretRef field) if keys are not specified, "keystore" entry and a "keystore-password" entry will be used	true
truststoreSecretRef	object	ref to the secret that contains the truststore and optionally its password (which can also be specified through the truststorePasswordSecretRef field) if keys are not specified explicitly, "keystore" entry and a "keystore-password" entry will be used	true
keystorePasswordSecretRef	object	ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "keystore-password" entry will be used	false
truststorePasswordSecretRef	object	ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "truststore-password" entry will be used	false

K8ssandraCluster.spec.cassandra.clientEncryptionStores.keystoreSecretRef

^{^{↩ Parent}}

ref to the secret that contains the keystore and optionally its password (which can also be specified through the keystorePasswordSecretRef field) if keys are not specified, “keystore” entry and a “keystore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.clientEncryptionStores.truststoreSecretRef

^{^{↩ Parent}}

ref to the secret that contains the truststore and optionally its password (which can also be specified through the truststorePasswordSecretRef field) if keys are not specified explicitly, “keystore” entry and a “keystore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.clientEncryptionStores.keystorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “keystore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.clientEncryptionStores.truststorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “truststore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.config

^{^{↩ Parent}}

CassandraConfig contains configuration settings that are applied to cassandra.yaml, dse.yaml and the various jvm*.options files.

Name	Type	Required
cassandraYaml	object	false
dseYaml	object	false
jvmOptions	object	false

K8ssandraCluster.spec.cassandra.config.jvmOptions

^{^{↩ Parent}}

Name	Type	Description	Required
additionalJvm11ServerOptions	[]string	Jvm11ServerOptions are additional options that will be passed on to the jvm11-server-options file.	false
additionalJvm8ServerOptions	[]string	Jvm8ServerOptions are additional options that will be passed on to the jvm8-server-options file.	false
additionalJvmServerOptions	[]string	JvmServerOptions are additional options that will be passed on to the jvm-server-options file.	false
additionalOptions	[]string	Additional, arbitrary JVM options which are written into the cassandra-env.sh file.	false
cassandra_available_processors	integer	Available CPU processors. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.available_processors.	false
cassandra_disable_auth_caches_remote_configuration	boolean	Disable remote configuration via JMX of auth caches. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.disable_auth_caches_remote_configuration.	false
cassandra_expiration_date_overflow_policy	string	Defines how to handle INSERT requests with TTL exceeding the maximum supported expiration date. Possible values include `REJECT`, `CAP`, `CAP_NOWARN`. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.expiration_date_overflow_policy.	false
cassandra_force_3_0_protocol_version	boolean	Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Dcassandra.force_3_0_protocol_version=true.	false
cassandra_force_default_indexing_page_size	boolean	Disable dynamic calculation of the page size used when indexing an entire partition (during initial index build/rebuild). Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.force_default_indexing_page_size.	false
cassandra_max_hint_ttl_seconds	integer	Imposes an upper bound on hint lifetime below the normal min gc_grace_seconds. Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.maxHintTTL.	false
cassandra_metrics_reporter_config_file	string	Enable pluggable metrics reporter. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.metricsReporterConfigFile. TODO mountable directory	false
cassandra_ring_delay_ms	integer	Amount of time in milliseconds that a node waits before joining the ring. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.ring_delay_ms.	false
cassandra_triggers_directory	string	Default location for the trigger JARs. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.triggers_dir. TODO mountable directory	false
cassandra_write_survey	boolean	For testing new compaction and compression strategies. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.write_survey.	false
debug_disable_contended_annotations	boolean	Disable honoring user code @Contended annotations. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:-RestrictContended.	false
debug_enable_flight_recorder	boolean	Enable Flight Recorder (Use in production is subject to Oracle licensing). Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+FlightRecorder.	false
debug_listen_remote_debuggers	boolean	Listen for JVM remote debuggers on port 1414. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=1414".	false
debug_log_compilation	boolean	Make Cassandra JVM log internal method compilation (developers only). Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+LogCompilation.	false
debug_non_safepoints	boolean	Whether the compiler should generate the necessary metadata for the parts of the code not at safe points as well. For use with Flight Recorder. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+DebugNonSafepoints.	false
debug_preserve_frame_pointer	boolean	Preserve Frame Pointer. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+PreserveFramePointer.	false
debug_unlock_commercial_features	boolean	Unlock commercial features. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UnlockCommercialFeatures.	false
debug_unlock_diagnostic_vm_options	boolean	Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UnlockDiagnosticVMOptions.	false
gc	enum	The name of the garbage collector to use. Depending on the Cassandra version, not all values are supported: Cassandra 3.11 supports only G1GC and CMS; Cassandra 4.0 supports G1GC, ZGC, Shenandoah and Graal. This option will unlock the corresponding garbage collector with a default configuration; to further tune the GC settings, use the additional JVM options field. Use the special value Custom if you intend to use non-standard garbage collectors. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Enum: G1GC, CMS, ZGC, Shenandoah, Graal, Custom Default: G1GC	false
gc_cms_heap_size_young_generation	int or string	Disabled by default. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Xmn.	false
gc_cms_initiating_occupancy_fraction	integer	Defaults to 75. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:CMSInitiatingOccupancyFraction. Minimum: 0 Maximum: 100	false
gc_cms_max_tenuring_threshold	integer	Defaults to 1. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:MaxTenuringThreshold.	false
gc_cms_survivor_ratio	integer	Defaults to 8. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:SurvivorRatio.	false
gc_cms_wait_duration_ms	integer	Defaults to 10000. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:CMSWaitDuration.	false
gc_g1_conc_threads	integer	Concurrent GC Threads. Can only be used when G1 garbage collector is used. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:ConcGCThreads.	false
gc_g1_initiating_heap_occupancy_percent	integer	Initiating Heap Occupancy Percentage. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:InitiatingHeapOccupancyPercent. Minimum: 0 Maximum: 100	false
gc_g1_max_gc_pause_ms	integer	G1GC Max GC Pause in milliseconds. Defaults to 500. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:MaxGCPauseMillis.	false
gc_g1_parallel_threads	integer	Parallel GC Threads. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:ParallelGCThreads.	false
gc_g1_rset_updating_pause_time_percent	integer	G1GC Updating Pause Time Percentage. Defaults to 5. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:G1RSetUpdatingPauseTimePercent. Minimum: 0 Maximum: 100	false
gc_print_application_stopped_time	boolean	Print GC Application Stopped Time. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCApplicationStoppedTime.	false
gc_print_date_stamps	boolean	Print GC Date Stamps. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCDateStamps.	false
gc_print_details	boolean	Print GC details. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCDetails.	false
gc_print_flss_statistics	boolean	Print FLSS Statistics. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:PrintFLSStatistics=1.	false
gc_print_heap	boolean	Print Heap at GC. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintHeapAtGC.	false
gc_print_log_file_size	int or string	Size of each log file. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:GCLogFileSize.	false
gc_print_number_of_log_files	integer	Number of GC log files. Disabled by default. Can only be used when the G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:NumberOfGCLogFiles.	false
gc_print_promotion_failure	boolean	Print promotion failure. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintPromotionFailure.	false
gc_print_tenuring_distribution	boolean	Print tenuring distribution. Defaults to false. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintTenuringDistribution.	false
gc_print_use_log_file	boolean	Whether to print GC logs to /var/log/cassandra/gc.log. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Xloggc:/var/log/cassandra/gc.log.	false
gc_print_use_log_file_rotation	boolean	Use GC Log File Rotation. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+UseGCLogFileRotation.	false
heapNewGenSize	int or string	Deprecated. Use gc_cms_heap_size_young_generation instead. Valid for CMS garbage collector only + Cassandra 3.11.	false
heapSize	int or string	Deprecated. Use heap_initial_size and heap_max_size instead. If this field is defined, it applies to both max_heap_size and initial_heap_size.	false
heap_initial_size	int or string	Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Xms.	false
heap_max_size	int or string	Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Xmx.	false
jdk_allow_attach_self	boolean	Allow the current VM to attach to itself. Defaults to true. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -Djdk.attach.allowAttachSelf=true.	false
jmx_connection_type	string	Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Possible values for 3.11 include `local-no-auth`, `remote-no-auth`, and `remote-dse-unified-auth`. Defaults to `local-no-auth`. Possible values for 4.0 include `local-no-auth`, `remote-no-auth`. Defaults to `local-no-auth`.	false
jmx_port	integer	Disabled by default. Defaults to 7199. TODO Make Reaper aware of the JMX port if a non-default port is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.	false
jmx_remote_ssl	boolean	Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Defaults to false. Valid only when JmxConnectionType is "remote-no-auth", "remote-dse-unified-auth".	false
jmx_remote_ssl_opts	string	Remote SSL options. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.	false
jmx_remote_ssl_require_client_auth	boolean	Require Client Authentication for remote SSL? Defaults to false. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.	false
netty_eventloop_maxpendingtasks	integer	Defaults to 65536. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dio.netty.eventLoop.maxPendingTasks.	false
netty_try_reflection_set_accessible	boolean	Netty setting `io.netty.tryReflectionSetAccessible`. Defaults to true. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -Dio.netty.tryReflectionSetAccessible=true.	false
nio_align_direct_memory	boolean	Align direct memory allocations on page boundaries. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dsun.nio.PageAlignDirectMemory=true.	false
nio_maxcachedbuffersize	int or string	Defaults to 1048576. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Djdk.nio.maxCachedBufferSize.	false
vm_always_pre_touch	boolean	Ensure all memory is faulted and zeroed on startup. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+AlwaysPreTouch.	false
vm_crash_on_out_of_memory_error	boolean	Disabled by default. Requires `exit_on_out_of_memory_error` to be disabled.. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+CrashOnOutOfMemoryError.	false
vm_disable_biased_locking	boolean	Disable biased locking to avoid biased lock revocation pauses. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:-UseBiasedLocking. Note: the Cass Config Builder option is named use_biased_locking, but setting it to true disables biased locking.	false
vm_disable_perf_shared_mem	boolean	Disable hsperfdata mmap'ed file. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+PerfDisableSharedMem.	false
vm_enable_assertions	boolean	Enable assertions. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -ea.	false
vm_enable_non_root_thread_priority	boolean	Enable lowering thread priority without being root on linux. See CASSANDRA-1181 for details. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:ThreadPriorityPolicy=42.	false
vm_enable_thread_priorities	boolean	Enable thread priorities. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UseThreadPriorities.	false
vm_exit_on_out_of_memory_error	boolean	Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+ExitOnOutOfMemoryError.	false
vm_guaranteed_safepoint_interval_ms	integer	Defaults to 300000 milliseconds. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:GuaranteedSafepointInterval.	false
vm_heap_dump_on_out_of_memory_error	boolean	Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+HeapDumpOnOutOfMemoryError.	false
vm_per_thread_stack_size	int or string	Per-thread stack size. Defaults to 256Ki. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Xss.	false
vm_prefer_ipv4	boolean	Prefer binding to IPv4 network interfaces. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Djava.net.preferIPv4Stack=true.	false
vm_print_heap_histogram_on_out_of_memory_error	boolean	Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.printHeapHistogramOnOutOfMemoryError.	false
vm_resize_tlab	boolean	Allow resizing of thread-local allocation blocks. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+ResizeTLAB.	false
vm_string_table_size	int or string	The size of interned string table. Larger sizes are beneficial to gossip. Defaults to 1000003. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:StringTableSize.	false
vm_use_numa	boolean	Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UseNUMA.	false
vm_use_tlab	boolean	Enable thread-local allocation blocks. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UseTLAB.	false

K8ssandraCluster.spec.cassandra.containers[index]

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resizePolicy	[]object	Resources resize policy for the container.	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

K8ssandraCluster.spec.cassandra.containers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

K8ssandraCluster.spec.cassandra.containers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable’s value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

K8ssandraCluster.spec.cassandra.containers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

K8ssandraCluster.spec.cassandra.containers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.containers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.containers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod’s namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.containers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

K8ssandraCluster.spec.cassandra.containers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

K8ssandraCluster.spec.cassandra.containers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.postStart

^{^{↩ Parent}}

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.postStart.sleep

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.preStop

^{^{↩ Parent}}

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod’s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.preStop.sleep

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.containers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.containers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.containers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.containers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.containers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.containers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.containers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

K8ssandraCluster.spec.cassandra.containers[index].readinessProbe

^{^{↩ Parent}}

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.containers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.containers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.containers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.containers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.containers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.containers[index].resizePolicy[index]

^{^{↩ Parent}}

ContainerResizePolicy represents resource resize policy for the container.

Name	Type	Description	Required
resourceName	string	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.	true
restartPolicy	string	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.	true

K8ssandraCluster.spec.cassandra.containers[index].resources

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

K8ssandraCluster.spec.cassandra.containers[index].resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.containers[index].securityContext

^{^{↩ Parent}}

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.cassandra.containers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

K8ssandraCluster.spec.cassandra.containers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.cassandra.containers[index].securityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.cassandra.containers[index].securityContext.windowsOptions

^{^{↩ Parent}}

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.cassandra.containers[index].startupProbe

^{^{↩ Parent}}

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.containers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.containers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.containers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.containers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.containers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.containers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

K8ssandraCluster.spec.cassandra.containers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

K8ssandraCluster.spec.cassandra.datacenters[index]

^{^{↩ Parent}}

Name	Type	Description	Required
size	integer	Size is the number Cassandra pods to deploy in this datacenter. This number does not include Stargate instances. Format: int32 Minimum: 1	true
cdc	object	CDC defines the desired state for CDC integrations. It can be used to feed mutation events from Cassandra into an Apache Pulsar cluster, from where they can be expored to external systems.	false
config	object	CassandraConfig contains configuration settings that are applied to cassandra.yaml, dse.yaml and the various jvm*.options files.	false
containers	[]object	Containers defines containers to be deployed in each Cassandra pod. K8ssandra-operator and cass-operator will create their own containers, which can be referenced here to override specific settings, such as mounts or resources request/limits for example. Example: containers: - name: server-system-logger - name: custom-container image: busybox - name: cassandra	false
datacenterName	string	DatacenterName allows to override the name of the Cassandra datacenter. Kubernetes objects will be named after a sanitized version of it if set, and if not metadata.name. In Cassandra the DC name will be overridden by this value. It may generate some confusion as objects created for the DC will have a different name than the CasandraDatacenter object itself. This setting can create conflicts if multiple DCs coexist in the same namespace if metadata.name for a DC with no override is set to the same value as the override name of another DC. Use cautiously.	false
dseWorkloads	object		false
extraVolumes	object	Volumes defines additional volumes to be added to each Cassandra pod. If the volume uses a PersistentVolumeClaim, the PVC will be managed by the statefulset.	false
initContainers	[]object	InitContainers defines init-containers to be deployed in each Cassandra pod. K8ssandra-operator and cass-operator will create their own init-containers, which can be referenced here to control ordering or override specific settings such as mounts or resources request/limits for example. Only the name of the k8ssandra-operator/cass-operator init-containers is required, not their full definition which will be created by the operators. Example: initContainers: - name: server-config-init - name: custom-init-container image: busybox - name: medusa-restore Otherwise init-containers referenced here will be injected in first position	false
jmxInitContainerImage	object	Deprecated: JMX security is now based on CQL roles. We don't need an init container to configure JMX authentication anymore. The value of this field will be ignored.	false
k8sContext	string		false
managementApiAuth	object	ManagementApiAuth defines the authentication settings for the management API in the Cassandra pods.	false
metadata	object		false
mgmtAPIHeap	int or string	MgmtAPIHeap defines the amount of memory devoted to the management api heap.	false
networking	object	Networking enables host networking and configures a NodePort ports.	false
perNodeConfigInitContainerImage	string	The image to use in each Cassandra pod for the (short-lived) init container that merges global and perNodeConfig configuration. This is only useful when PerNodeConfigMapRef is set. The default is "mikefarah/yq:4". Default: mikefarah/yq:4	false
perNodeConfigMapRef	object	PerNodeConfigMapRef is a reference to a ConfigMap that contains per-node configuration for this DC. The ConfigMap is expected to have entries in the following form: _.yaml, where is the name of the pod and is the name of a configuration file (typically, cassandra.yaml). The value of the entry is expected to be a YAML fragment that contains the per-node configuration for each pod. When the pod is started, the per-node ConfigMap is mounted and the contents of each entry corresponding to the pod are merged into their respective configuration files.	false
podSecurityContext	object	PodSecurityContext defines the security context for the Cassandra pods.	false
racks	[]object	Racks is a list of named racks. Note that racks are used to create node affinity. //	false
resources	object	Resources is the cpu and memory resources for the cassandra container.	false
serverImage	string	ServerImage is the image for the cassandra container. Note that this should be a management-api image. If left empty the operator will choose a default image based on ServerVersion.	false
serverVersion	string	ServerVersion is the Cassandra or DSE version. The following versions are supported: - Cassandra: 3.11.X, 4.X.X and 5.X.X - DSE: 6.8.X, 7.x.x - HCD: 1.0.x	false
serviceAccount	string	The k8s service account to use for the Cassandra pods	false
softPodAntiAffinity	boolean	SoftPodAntiAffinity sets whether multiple Cassandra instances can be scheduled on the same node. This should normally be false to ensure cluster resilience but may be set true for test/dev scenarios to minimise the number of nodes required.	false
stargate	object	Stargate defines the desired deployment characteristics for Stargate in this datacenter. Leave nil to skip deploying Stargate in this datacenter.	false
stopped	boolean	Stopped means that the datacenter will be stopped. Use this for maintenance or for cost saving. A stopped CassandraDatacenter will have no running server pods, like using "stop" with traditional System V init scripts. Other Kubernetes resources will be left intact, and volumes will re-attach when the CassandraDatacenter workload is resumed. Default: false	false
storageConfig	object	StorageConfig is the persistent storage requirements for each Cassandra pod. This includes everything under /var/lib/cassandra, namely the commit log and data directories.	false
telemetry	object	Telemetry defines the desired state for telemetry resources in this datacenter. If telemetry configurations are defined, telemetry resources will be deployed to integrate with a user-provided monitoring solution (at present, only support for Prometheus is available).	false
tolerations	[]object	Tolerations applied to every Cassandra pod.	false

K8ssandraCluster.spec.cassandra.datacenters[index].cdc

^{^{↩ Parent}}

CDC defines the desired state for CDC integrations. It can be used to feed mutation events from Cassandra into an Apache Pulsar cluster, from where they can be expored to external systems.

Name	Type	Required
pulsarServiceUrl	string	true
cdcConcurrentProcessors	integer	false
cdcPollIntervalM	integer	false
cdcWorkingDir	string	false
errorCommitLogReprocessEnabled	boolean	false
pulsarAuthParams	string	false
pulsarAuthPluginClassName	string	false
pulsarBatchDelayInMs	integer	false
pulsarKeyBasedBatcher	boolean	false
pulsarMaxPendingMessages	integer	false
pulsarMaxPendingMessagesAcrossPartitions	integer	false
sslAllowInsecureConnection	string	false
sslCipherSuites	string	false
sslEnabledProtocols	string	false
sslHostnameVerificationEnable	string	false
sslKeystorePassword	string	false
sslKeystorePath	string	false
sslProvider	string	false
sslTruststorePassword	string	false
sslTruststorePath	string	false
sslTruststoreType	string	false
topicPrefix	string	false

K8ssandraCluster.spec.cassandra.datacenters[index].config

^{^{↩ Parent}}

CassandraConfig contains configuration settings that are applied to cassandra.yaml, dse.yaml and the various jvm*.options files.

Name	Type	Required
cassandraYaml	object	false
dseYaml	object	false
jvmOptions	object	false

K8ssandraCluster.spec.cassandra.datacenters[index].config.jvmOptions

^{^{↩ Parent}}

Name	Type	Description	Required
additionalJvm11ServerOptions	[]string	Jvm11ServerOptions are additional options that will be passed on to the jvm11-server-options file.	false
additionalJvm8ServerOptions	[]string	Jvm8ServerOptions are additional options that will be passed on to the jvm8-server-options file.	false
additionalJvmServerOptions	[]string	JvmServerOptions are additional options that will be passed on to the jvm-server-options file.	false
additionalOptions	[]string	Additional, arbitrary JVM options which are written into the cassandra-env.sh file.	false
cassandra_available_processors	integer	Available CPU processors. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.available_processors.	false
cassandra_disable_auth_caches_remote_configuration	boolean	Disable remote configuration via JMX of auth caches. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.disable_auth_caches_remote_configuration.	false
cassandra_expiration_date_overflow_policy	string	Defines how to handle INSERT requests with TTL exceeding the maximum supported expiration date. Possible values include `REJECT`, `CAP`, `CAP_NOWARN`. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.expiration_date_overflow_policy.	false
cassandra_force_3_0_protocol_version	boolean	Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Dcassandra.force_3_0_protocol_version=true.	false
cassandra_force_default_indexing_page_size	boolean	Disable dynamic calculation of the page size used when indexing an entire partition (during initial index build/rebuild). Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.force_default_indexing_page_size.	false
cassandra_max_hint_ttl_seconds	integer	Imposes an upper bound on hint lifetime below the normal min gc_grace_seconds. Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.maxHintTTL.	false
cassandra_metrics_reporter_config_file	string	Enable pluggable metrics reporter. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.metricsReporterConfigFile. TODO mountable directory	false
cassandra_ring_delay_ms	integer	Amount of time in milliseconds that a node waits before joining the ring. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.ring_delay_ms.	false
cassandra_triggers_directory	string	Default location for the trigger JARs. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.triggers_dir. TODO mountable directory	false
cassandra_write_survey	boolean	For testing new compaction and compression strategies. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.write_survey.	false
debug_disable_contended_annotations	boolean	Disable honoring user code @Contended annotations. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:-RestrictContended.	false
debug_enable_flight_recorder	boolean	Enable Flight Recorder (Use in production is subject to Oracle licensing). Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+FlightRecorder.	false
debug_listen_remote_debuggers	boolean	Listen for JVM remote debuggers on port 1414. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=1414".	false
debug_log_compilation	boolean	Make Cassandra JVM log internal method compilation (developers only). Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+LogCompilation.	false
debug_non_safepoints	boolean	Whether the compiler should generate the necessary metadata for the parts of the code not at safe points as well. For use with Flight Recorder. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+DebugNonSafepoints.	false
debug_preserve_frame_pointer	boolean	Preserve Frame Pointer. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+PreserveFramePointer.	false
debug_unlock_commercial_features	boolean	Unlock commercial features. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UnlockCommercialFeatures.	false
debug_unlock_diagnostic_vm_options	boolean	Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UnlockDiagnosticVMOptions.	false
gc	enum	The name of the garbage collector to use. Depending on the Cassandra version, not all values are supported: Cassandra 3.11 supports only G1GC and CMS; Cassandra 4.0 supports G1GC, ZGC, Shenandoah and Graal. This option will unlock the corresponding garbage collector with a default configuration; to further tune the GC settings, use the additional JVM options field. Use the special value Custom if you intend to use non-standard garbage collectors. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Enum: G1GC, CMS, ZGC, Shenandoah, Graal, Custom Default: G1GC	false
gc_cms_heap_size_young_generation	int or string	Disabled by default. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Xmn.	false
gc_cms_initiating_occupancy_fraction	integer	Defaults to 75. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:CMSInitiatingOccupancyFraction. Minimum: 0 Maximum: 100	false
gc_cms_max_tenuring_threshold	integer	Defaults to 1. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:MaxTenuringThreshold.	false
gc_cms_survivor_ratio	integer	Defaults to 8. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:SurvivorRatio.	false
gc_cms_wait_duration_ms	integer	Defaults to 10000. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:CMSWaitDuration.	false
gc_g1_conc_threads	integer	Concurrent GC Threads. Can only be used when G1 garbage collector is used. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:ConcGCThreads.	false
gc_g1_initiating_heap_occupancy_percent	integer	Initiating Heap Occupancy Percentage. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:InitiatingHeapOccupancyPercent. Minimum: 0 Maximum: 100	false
gc_g1_max_gc_pause_ms	integer	G1GC Max GC Pause in milliseconds. Defaults to 500. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:MaxGCPauseMillis.	false
gc_g1_parallel_threads	integer	Parallel GC Threads. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:ParallelGCThreads.	false
gc_g1_rset_updating_pause_time_percent	integer	G1GC Updating Pause Time Percentage. Defaults to 5. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -XX:G1RSetUpdatingPauseTimePercent. Minimum: 0 Maximum: 100	false
gc_print_application_stopped_time	boolean	Print GC Application Stopped Time. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCApplicationStoppedTime.	false
gc_print_date_stamps	boolean	Print GC Date Stamps. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCDateStamps.	false
gc_print_details	boolean	Print GC details. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCDetails.	false
gc_print_flss_statistics	boolean	Print FLSS Statistics. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:PrintFLSStatistics=1.	false
gc_print_heap	boolean	Print Heap at GC. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintHeapAtGC.	false
gc_print_log_file_size	int or string	Size of each log file. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:GCLogFileSize.	false
gc_print_number_of_log_files	integer	Number of GC log files. Disabled by default. Can only be used when the G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:NumberOfGCLogFiles.	false
gc_print_promotion_failure	boolean	Print promotion failure. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintPromotionFailure.	false
gc_print_tenuring_distribution	boolean	Print tenuring distribution. Defaults to false. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintTenuringDistribution.	false
gc_print_use_log_file	boolean	Whether to print GC logs to /var/log/cassandra/gc.log. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Xloggc:/var/log/cassandra/gc.log.	false
gc_print_use_log_file_rotation	boolean	Use GC Log File Rotation. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+UseGCLogFileRotation.	false
heapNewGenSize	int or string	Deprecated. Use gc_cms_heap_size_young_generation instead. Valid for CMS garbage collector only + Cassandra 3.11.	false
heapSize	int or string	Deprecated. Use heap_initial_size and heap_max_size instead. If this field is defined, it applies to both max_heap_size and initial_heap_size.	false
heap_initial_size	int or string	Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Xms.	false
heap_max_size	int or string	Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Xmx.	false
jdk_allow_attach_self	boolean	Allow the current VM to attach to itself. Defaults to true. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -Djdk.attach.allowAttachSelf=true.	false
jmx_connection_type	string	Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Possible values for 3.11 include `local-no-auth`, `remote-no-auth`, and `remote-dse-unified-auth`. Defaults to `local-no-auth`. Possible values for 4.0 include `local-no-auth`, `remote-no-auth`. Defaults to `local-no-auth`.	false
jmx_port	integer	Disabled by default. Defaults to 7199. TODO Make Reaper aware of the JMX port if a non-default port is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.	false
jmx_remote_ssl	boolean	Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Defaults to false. Valid only when JmxConnectionType is "remote-no-auth", "remote-dse-unified-auth".	false
jmx_remote_ssl_opts	string	Remote SSL options. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.	false
jmx_remote_ssl_require_client_auth	boolean	Require Client Authentication for remote SSL? Defaults to false. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.	false
netty_eventloop_maxpendingtasks	integer	Defaults to 65536. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dio.netty.eventLoop.maxPendingTasks.	false
netty_try_reflection_set_accessible	boolean	Netty setting `io.netty.tryReflectionSetAccessible`. Defaults to true. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -Dio.netty.tryReflectionSetAccessible=true.	false
nio_align_direct_memory	boolean	Align direct memory allocations on page boundaries. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dsun.nio.PageAlignDirectMemory=true.	false
nio_maxcachedbuffersize	int or string	Defaults to 1048576. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Djdk.nio.maxCachedBufferSize.	false
vm_always_pre_touch	boolean	Ensure all memory is faulted and zeroed on startup. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+AlwaysPreTouch.	false
vm_crash_on_out_of_memory_error	boolean	Disabled by default. Requires `exit_on_out_of_memory_error` to be disabled.. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+CrashOnOutOfMemoryError.	false
vm_disable_biased_locking	boolean	Disable biased locking to avoid biased lock revocation pauses. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:-UseBiasedLocking. Note: the Cass Config Builder option is named use_biased_locking, but setting it to true disables biased locking.	false
vm_disable_perf_shared_mem	boolean	Disable hsperfdata mmap'ed file. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+PerfDisableSharedMem.	false
vm_enable_assertions	boolean	Enable assertions. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -ea.	false
vm_enable_non_root_thread_priority	boolean	Enable lowering thread priority without being root on linux. See CASSANDRA-1181 for details. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:ThreadPriorityPolicy=42.	false
vm_enable_thread_priorities	boolean	Enable thread priorities. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UseThreadPriorities.	false
vm_exit_on_out_of_memory_error	boolean	Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+ExitOnOutOfMemoryError.	false
vm_guaranteed_safepoint_interval_ms	integer	Defaults to 300000 milliseconds. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:GuaranteedSafepointInterval.	false
vm_heap_dump_on_out_of_memory_error	boolean	Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+HeapDumpOnOutOfMemoryError.	false
vm_per_thread_stack_size	int or string	Per-thread stack size. Defaults to 256Ki. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Xss.	false
vm_prefer_ipv4	boolean	Prefer binding to IPv4 network interfaces. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Djava.net.preferIPv4Stack=true.	false
vm_print_heap_histogram_on_out_of_memory_error	boolean	Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.printHeapHistogramOnOutOfMemoryError.	false
vm_resize_tlab	boolean	Allow resizing of thread-local allocation blocks. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+ResizeTLAB.	false
vm_string_table_size	int or string	The size of interned string table. Larger sizes are beneficial to gossip. Defaults to 1000003. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:StringTableSize.	false
vm_use_numa	boolean	Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UseNUMA.	false
vm_use_tlab	boolean	Enable thread-local allocation blocks. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UseTLAB.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index]

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resizePolicy	[]object	Resources resize policy for the container.	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable’s value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod’s namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.postStart

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.postStart.sleep

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.preStop

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.preStop.sleep

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].readinessProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].resizePolicy[index]

^{^{↩ Parent}}

ContainerResizePolicy represents resource resize policy for the container.

Name	Type	Description	Required
resourceName	string	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.	true
restartPolicy	string	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].resources

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].securityContext

^{^{↩ Parent}}

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].startupProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

K8ssandraCluster.spec.cassandra.datacenters[index].dseWorkloads

^{^{↩ Parent}}

Name	Type	Required
analyticsEnabled	boolean	false
graphEnabled	boolean	false
searchEnabled	boolean	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes

^{^{↩ Parent}}

Volumes defines additional volumes to be added to each Cassandra pod. If the volume uses a PersistentVolumeClaim, the PVC will be managed by the statefulset.

Name	Type	Description	Required
pvcs	[]object	PVCs defines additional volumes to be added to each Cassandra pod and managed by the statefulset. Such volumes are automatically mounted by cass-operator into the cassandra containers.	false
volumes	[]object	Volumes defines volumes to be added to each Cassandra pod.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index]

^{^{↩ Parent}}

AdditionalVolumes defines additional storage configurations

Name	Type	Description	Required
mountPath	string	Mount path into cassandra container	true
name	string	Name of the pvc / volume	true
pvcSpec	object	PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.	false
volumeSource	object	VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].pvcSpec

^{^{↩ Parent}}

PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].pvcSpec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].pvcSpec.dataSourceRef

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn’t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef:

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].pvcSpec.resources

^{^{↩ Parent}}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].pvcSpec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].pvcSpec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource

^{^{↩ Parent}}

VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.

Name	Type	Description	Required
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.awsElasticBlockStore

^{^{↩ Parent}}

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.azureDisk

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.azureFile

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.cephfs

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.cephfs.secretRef

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.cinder

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.cinder.secretRef

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.configMap

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.csi

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.csi.nodePublishSecretRef

^{^{↩ Parent}}

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.downwardAPI

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.emptyDir

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral

^{^{↩ Parent}}

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.fc

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.flexVolume

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.flexVolume.secretRef

^{^{↩ Parent}}

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.flocker

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.gcePersistentDisk

^{^{↩ Parent}}

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.gitRepo

^{^{↩ Parent}}

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.glusterfs

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.hostPath

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.iscsi

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.iscsi.secretRef

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.nfs

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.persistentVolumeClaim

^{^{↩ Parent}}

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.photonPersistentDisk

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.portworxVolume

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].clusterTrustBundle

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].clusterTrustBundle.labelSelector

^{^{↩ Parent}}

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as “match nothing”. If set but empty, interpreted as “match everything”.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].configMap

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].downwardAPI

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].secret

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.quobyte

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.rbd

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.rbd.secretRef

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.scaleIO

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.scaleIO.secretRef

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.secret

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.storageos

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.storageos.secretRef

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.pvcs[index].volumeSource.vsphereVolume

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index]

^{^{↩ Parent}}

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Type	Description	Required
name	string	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].awsElasticBlockStore

^{^{↩ Parent}}

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].azureDisk

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].azureFile

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].cephfs

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].cephfs.secretRef

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].cinder

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].cinder.secretRef

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].configMap

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].csi

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].csi.nodePublishSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].downwardAPI

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].emptyDir

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral

^{^{↩ Parent}}

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].fc

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].flexVolume

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].flexVolume.secretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].flocker

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].gcePersistentDisk

^{^{↩ Parent}}

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].gitRepo

^{^{↩ Parent}}

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].glusterfs

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].hostPath

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].iscsi

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].iscsi.secretRef

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].nfs

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].persistentVolumeClaim

^{^{↩ Parent}}

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].photonPersistentDisk

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].portworxVolume

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].clusterTrustBundle

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].configMap

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].downwardAPI

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].secret

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].quobyte

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].rbd

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].rbd.secretRef

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].scaleIO

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].scaleIO.secretRef

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].secret

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].storageos

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].storageos.secretRef

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].vsphereVolume

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index]

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resizePolicy	[]object	Resources resize policy for the container.	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable’s value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod’s namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.postStart

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.postStart.sleep

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.preStop

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.preStop.sleep

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].readinessProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].resizePolicy[index]

^{^{↩ Parent}}

ContainerResizePolicy represents resource resize policy for the container.

Name	Type	Description	Required
resourceName	string	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.	true
restartPolicy	string	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].resources

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].securityContext

^{^{↩ Parent}}

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].startupProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

K8ssandraCluster.spec.cassandra.datacenters[index].jmxInitContainerImage

^{^{↩ Parent}}

Deprecated: JMX security is now based on CQL roles. We don’t need an init container to configure JMX authentication anymore. The value of this field will be ignored.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

K8ssandraCluster.spec.cassandra.datacenters[index].jmxInitContainerImage.pullSecretRef

^{^{↩ Parent}}

The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].managementApiAuth

^{^{↩ Parent}}

ManagementApiAuth defines the authentication settings for the management API in the Cassandra pods.

Name	Type	Description	Required
insecure	object		false
manual	object		false

K8ssandraCluster.spec.cassandra.datacenters[index].managementApiAuth.manual

^{^{↩ Parent}}

Name	Type	Required
clientSecretName	string	true
serverSecretName	string	true
skipSecretValidation	boolean	false

K8ssandraCluster.spec.cassandra.datacenters[index].metadata

^{^{↩ Parent}}

Name	Type	Description	Required
name	string		true
annotations	map[string]string		false
commonAnnotations	map[string]string	annotations that will be applied to all components created by the CRD	false
commonLabels	map[string]string	labels that will be applied to all components created by the CRD	false
labels	map[string]string		false
namespace	string		false
pods	object	labels/annotations for the pod components	false
services	object	labels/annotations for all of the CassandraDatacenter service components	false

K8ssandraCluster.spec.cassandra.datacenters[index].metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].metadata.services

^{^{↩ Parent}}

labels/annotations for all of the CassandraDatacenter service components

Name	Type	Required
additionalSeedService	object	false
allPodsService	object	false
dcService	object	false
nodePortService	object	false
seedService	object	false

K8ssandraCluster.spec.cassandra.datacenters[index].metadata.services.additionalSeedService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].metadata.services.allPodsService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].metadata.services.dcService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].metadata.services.nodePortService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].metadata.services.seedService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].networking

^{^{↩ Parent}}

Networking enables host networking and configures a NodePort ports.

Name	Type	Description	Required
hostNetwork	boolean		false
nodePort	object		false

K8ssandraCluster.spec.cassandra.datacenters[index].networking.nodePort

^{^{↩ Parent}}

Name	Type	Required
internode	integer	false
internodeSSL	integer	false
native	integer	false
nativeSSL	integer	false

K8ssandraCluster.spec.cassandra.datacenters[index].perNodeConfigMapRef

^{^{↩ Parent}}

PerNodeConfigMapRef is a reference to a ConfigMap that contains per-node configuration for this DC. The ConfigMap is expected to have entries in the following form: _.yaml, where is the name of the pod and is the name of a configuration file (typically, cassandra.yaml). The value of the entry is expected to be a YAML fragment that contains the per-node configuration for each pod. When the pod is started, the per-node ConfigMap is mounted and the contents of each entry corresponding to the pod are merged into their respective configuration files.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].podSecurityContext

^{^{↩ Parent}}

PodSecurityContext defines the security context for the Cassandra pods.

Name	Type	Description	Required
fsGroup	integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: The owning GID will be the FSGroup The setgid bit is set (new files created in the volume will be owned by FSGroup) The permission bits are OR’d with rw-rw—- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.	false
supplementalGroups	[]integer	A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.	false
sysctls	[]object	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.cassandra.datacenters[index].podSecurityContext.seLinuxOptions

^{^{↩ Parent}}

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.cassandra.datacenters[index].podSecurityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.cassandra.datacenters[index].podSecurityContext.sysctls[index]

^{^{↩ Parent}}

Sysctl defines a kernel parameter to be set

Name	Type	Description	Required
name	string	Name of a property to set	true
value	string	Value of a property to set	true

K8ssandraCluster.spec.cassandra.datacenters[index].podSecurityContext.windowsOptions

^{^{↩ Parent}}

The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index]

^{^{↩ Parent}}

Rack …

Name	Type	Description	Required
name	string	The rack name	true
affinity	object	Affinity rules to set for this rack only. Merged with values from PodTemplateSpec Affinity as well as NodeAffinityLabels. If you wish to override all the default PodAntiAffinity rules, set allowMultipleWorkers to true, otherwise defaults are applied and then these Affinity settings are merged.	false
nodeAffinityLabels	map[string]string	NodeAffinityLabels to pin the rack, using node affinity	false
zone	string	Deprecated. Use nodeAffinityLabels instead. DeprecatedZone name to pin the rack, using node affinity	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity

^{^{↩ Parent}}

Affinity rules to set for this rack only. Merged with values from PodTemplateSpec Affinity as well as NodeAffinityLabels. If you wish to override all the default PodAntiAffinity rules, set allowMultipleWorkers to true, otherwise defaults are applied and then these Affinity settings are merged.

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].resources

^{^{↩ Parent}}

Resources is the cpu and memory resources for the cassandra container.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.datacenters[index].resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate

^{^{↩ Parent}}

Stargate defines the desired deployment characteristics for Stargate in this datacenter. Leave nil to skip deploying Stargate in this datacenter.

Name	Type	Description	Required
size	integer	Size is the number of Stargate instances to deploy in each datacenter. They will be spread evenly across racks. Format: int32 Default: 1 Minimum: 1	true
affinity	object	Affinity is the affinity to apply to all the Stargate pods. Leave nil to let the controller reuse the same affinity rules used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity	false
allowStargateOnDataNodes	boolean	AllowStargateOnDataNodes allows Stargate pods to be scheduled on a worker node already hosting data pods for this datacenter. The default is false, which means that Stargate pods will be scheduled on separate worker nodes. Note: if the datacenter pods have HostNetwork:true, then the Stargate pods will inherit of it, in which case it is possible that Stargate nodes won't be allowed to sit on data nodes even if this property is set to true, because of port conflicts on the same IP address. Default: false	false
authOptions	object	Authentication options.	false
cassandraConfigMapRef	object	CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.	false
containerImage	object	ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image. Default: map[repository:stargateio tag:v1.0.77]	false
heapSize	int or string	HeapSize sets the JVM heap size to use for Stargate. If no Resources are specified, this value will also be used to set a default memory request and limit for the Stargate pods: these will be set to HeapSize x2 and x4, respectively. Default: 256Mi	false
livenessProbe	object	LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.	false
metadata	object	labels and annotations for Stargate resources	false
nodeSelector	map[string]string	NodeSelector is an optional map of label keys and values to restrict the scheduling of Stargate nodes to workers with matching labels. Leave nil to let the controller reuse the same node selectors used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector	false
racks	[]object	Racks allow customizing Stargate characteristics for specific racks in the datacenter.	false
readinessProbe	object	ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.	false
resources	object	Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.	false
secretsProvider	enum	SecretsProvider defines whether the secrets used for credentials and certs will be backed by an external secret backend. This moves the responsibility of generating and storing secrets from the operators to the user and will rely on a mutating webhook to inject the secrets into the necessary resources Enum: internal, external Default: internal	false
serviceAccount	string	ServiceAccount is the service account name to use for Stargate pods. Default: default	false
telemetry	object	Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)	false
tolerations	[]object	Tolerations are tolerations to apply to the Stargate pods. Leave nil to let the controller reuse the same tolerations used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity

^{^{↩ Parent}}

Affinity is the affinity to apply to all the Stargate pods. Leave nil to let the controller reuse the same affinity rules used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.authOptions

^{^{↩ Parent}}

Authentication options.

Name	Type	Description	Required
apiAuthMethod	enum	The method to use for authenticating requests to the Stargate APIs. Stargate currently has two authentication / authorization methods: - Table: table-based; - JWT: JSON web token (JWT)-based. The methods are mutually exclusive. The default method is Table. Enum: Table, JWT Default: Table	false
providerUrl	string	Required when using JWT authentication method, ignored otherwise.	false
tokenTtlSeconds	integer	The time-to-live in seconds of an API authentication token. Valid only for the Table authentication method. By default, the token persists for 30 minutes with a sliding window. Each use of the token to authenticate resets the 30-minute window. A token created and used after 29 minutes will authenticate a request, but if 31 minutes passes before use, the token will no longer exist. Default is 1800 seconds (30 minutes). Minimum: 1	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.cassandraConfigMapRef

^{^{↩ Parent}}

CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.containerImage

^{^{↩ Parent}}

ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.containerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.livenessProbe

^{^{↩ Parent}}

LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.metadata

^{^{↩ Parent}}

labels and annotations for Stargate resources

Name	Type	Description	Required
annotations	map[string]string		false
commonLabels	map[string]string	labels/annotations that will be applied to all components created by the CRD	false
labels	map[string]string		false
pods	object	labels/annotations for the pod components	false
service	object	labels/annotations for the service component	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.metadata.service

^{^{↩ Parent}}

labels/annotations for the service component

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index]

^{^{↩ Parent}}

StargateRackTemplate defines custom rules for Stargate pods in a given rack. These rules will be merged with rules defined at datacenter level in a StargateDatacenterTemplate; rack-level rules have precedence over datacenter-level ones.

Name	Type	Description	Required
name	string	Name is the rack name. It must correspond to an existing rack name in the CassandraDatacenter resource where Stargate is being deployed, otherwise it will be ignored.	true
affinity	object	Affinity is the affinity to apply to all the Stargate pods. Leave nil to let the controller reuse the same affinity rules used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity	false
allowStargateOnDataNodes	boolean	AllowStargateOnDataNodes allows Stargate pods to be scheduled on a worker node already hosting data pods for this datacenter. The default is false, which means that Stargate pods will be scheduled on separate worker nodes. Note: if the datacenter pods have HostNetwork:true, then the Stargate pods will inherit of it, in which case it is possible that Stargate nodes won't be allowed to sit on data nodes even if this property is set to true, because of port conflicts on the same IP address. Default: false	false
authOptions	object	Authentication options.	false
cassandraConfigMapRef	object	CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.	false
containerImage	object	ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image. Default: map[repository:stargateio tag:v1.0.77]	false
heapSize	int or string	HeapSize sets the JVM heap size to use for Stargate. If no Resources are specified, this value will also be used to set a default memory request and limit for the Stargate pods: these will be set to HeapSize x2 and x4, respectively. Default: 256Mi	false
livenessProbe	object	LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.	false
metadata	object	labels and annotations for Stargate resources	false
nodeSelector	map[string]string	NodeSelector is an optional map of label keys and values to restrict the scheduling of Stargate nodes to workers with matching labels. Leave nil to let the controller reuse the same node selectors used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector	false
readinessProbe	object	ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.	false
resources	object	Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.	false
secretsProvider	enum	SecretsProvider defines whether the secrets used for credentials and certs will be backed by an external secret backend. This moves the responsibility of generating and storing secrets from the operators to the user and will rely on a mutating webhook to inject the secrets into the necessary resources Enum: internal, external Default: internal	false
serviceAccount	string	ServiceAccount is the service account name to use for Stargate pods. Default: default	false
telemetry	object	Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)	false
tolerations	[]object	Tolerations are tolerations to apply to the Stargate pods. Leave nil to let the controller reuse the same tolerations used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity

^{^{↩ Parent}}

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].authOptions

^{^{↩ Parent}}

Authentication options.

Name	Type	Description	Required
apiAuthMethod	enum	The method to use for authenticating requests to the Stargate APIs. Stargate currently has two authentication / authorization methods: - Table: table-based; - JWT: JSON web token (JWT)-based. The methods are mutually exclusive. The default method is Table. Enum: Table, JWT Default: Table	false
providerUrl	string	Required when using JWT authentication method, ignored otherwise.	false
tokenTtlSeconds	integer	The time-to-live in seconds of an API authentication token. Valid only for the Table authentication method. By default, the token persists for 30 minutes with a sliding window. Each use of the token to authenticate resets the 30-minute window. A token created and used after 29 minutes will authenticate a request, but if 31 minutes passes before use, the token will no longer exist. Default is 1800 seconds (30 minutes). Minimum: 1	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].cassandraConfigMapRef

^{^{↩ Parent}}

CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].containerImage

^{^{↩ Parent}}

ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].containerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].livenessProbe

^{^{↩ Parent}}

LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].metadata

^{^{↩ Parent}}

labels and annotations for Stargate resources

Name	Type	Description	Required
annotations	map[string]string		false
commonLabels	map[string]string	labels/annotations that will be applied to all components created by the CRD	false
labels	map[string]string		false
pods	object	labels/annotations for the pod components	false
service	object	labels/annotations for the service component	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].metadata.service

^{^{↩ Parent}}

labels/annotations for the service component

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].readinessProbe

^{^{↩ Parent}}

ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].resources

^{^{↩ Parent}}

Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry

^{^{↩ Parent}}

Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines <metric_relabel_configs>-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.readinessProbe

^{^{↩ Parent}}

ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.resources

^{^{↩ Parent}}

Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry

^{^{↩ Parent}}

Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig

^{^{↩ Parent}}

StorageConfig is the persistent storage requirements for each Cassandra pod. This includes everything under /var/lib/cassandra, namely the commit log and data directories.

Name	Type	Description	Required
additionalVolumes	[]object		false
cassandraDataVolumeClaimSpec	object	PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index]

^{^{↩ Parent}}

AdditionalVolumes defines additional storage configurations

Name	Type	Description	Required
mountPath	string	Mount path into cassandra container	true
name	string	Name of the pvc / volume	true
pvcSpec	object	PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.	false
volumeSource	object	VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec

^{^{↩ Parent}}

PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource

^{^{↩ Parent}}

VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.

Name	Type	Description	Required
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.awsElasticBlockStore

^{^{↩ Parent}}

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.azureDisk

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.azureFile

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.cephfs

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.cephfs.secretRef

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.cinder

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.cinder.secretRef

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.configMap

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.csi

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.csi.nodePublishSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.downwardAPI

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.emptyDir

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.ephemeral

^{^{↩ Parent}}

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.fc

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.flexVolume

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.flexVolume.secretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.flocker

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.gcePersistentDisk

^{^{↩ Parent}}

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.gitRepo

^{^{↩ Parent}}

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.glusterfs

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.hostPath

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.iscsi

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.iscsi.secretRef

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.nfs

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.persistentVolumeClaim

^{^{↩ Parent}}

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.photonPersistentDisk

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.portworxVolume

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].clusterTrustBundle

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].clusterTrustBundle.labelSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].configMap

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].secret

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.quobyte

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.rbd

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.rbd.secretRef

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.scaleIO

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.scaleIO.secretRef

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.secret

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.storageos

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.storageos.secretRef

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].volumeSource.vsphereVolume

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec

^{^{↩ Parent}}

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry

^{^{↩ Parent}}

Telemetry defines the desired state for telemetry resources in this datacenter. If telemetry configurations are defined, telemetry resources will be deployed to integrate with a user-provided monitoring solution (at present, only support for Prometheus is available).

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.datacenters[index].tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

K8ssandraCluster.spec.cassandra.dseWorkloads

^{^{↩ Parent}}

Name	Type	Required
analyticsEnabled	boolean	false
graphEnabled	boolean	false
searchEnabled	boolean	false

K8ssandraCluster.spec.cassandra.extraVolumes

^{^{↩ Parent}}

Volumes defines additional volumes to be added to each Cassandra pod. If the volume uses a PersistentVolumeClaim, the PVC will be managed by the statefulset.

Name	Type	Description	Required
pvcs	[]object	PVCs defines additional volumes to be added to each Cassandra pod and managed by the statefulset. Such volumes are automatically mounted by cass-operator into the cassandra containers.	false
volumes	[]object	Volumes defines volumes to be added to each Cassandra pod.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index]

^{^{↩ Parent}}

AdditionalVolumes defines additional storage configurations

Name	Type	Description	Required
mountPath	string	Mount path into cassandra container	true
name	string	Name of the pvc / volume	true
pvcSpec	object	PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.	false
volumeSource	object	VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].pvcSpec

^{^{↩ Parent}}

PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].pvcSpec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].pvcSpec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].pvcSpec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].pvcSpec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].pvcSpec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource

^{^{↩ Parent}}

VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.

Name	Type	Description	Required
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.awsElasticBlockStore

^{^{↩ Parent}}

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.azureDisk

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.azureFile

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.cephfs

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.cephfs.secretRef

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.cinder

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.cinder.secretRef

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.configMap

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.csi

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.csi.nodePublishSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.downwardAPI

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.emptyDir

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.ephemeral

^{^{↩ Parent}}

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.fc

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.flexVolume

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.flexVolume.secretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.flocker

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.gcePersistentDisk

^{^{↩ Parent}}

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.gitRepo

^{^{↩ Parent}}

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.glusterfs

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.hostPath

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.iscsi

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.iscsi.secretRef

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.nfs

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.persistentVolumeClaim

^{^{↩ Parent}}

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.photonPersistentDisk

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.portworxVolume

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].clusterTrustBundle

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].clusterTrustBundle.labelSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].configMap

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].downwardAPI

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].secret

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.quobyte

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.rbd

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.rbd.secretRef

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.scaleIO

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.scaleIO.secretRef

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.secret

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.storageos

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.storageos.secretRef

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.pvcs[index].volumeSource.vsphereVolume

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index]

^{^{↩ Parent}}

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Type	Description	Required
name	string	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].awsElasticBlockStore

^{^{↩ Parent}}

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].azureDisk

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].azureFile

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].cephfs

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].cephfs.secretRef

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].cinder

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].cinder.secretRef

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].configMap

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].csi

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].csi.nodePublishSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].downwardAPI

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].emptyDir

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral

^{^{↩ Parent}}

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].fc

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].flexVolume

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].flexVolume.secretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].flocker

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].gcePersistentDisk

^{^{↩ Parent}}

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].gitRepo

^{^{↩ Parent}}

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].glusterfs

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].hostPath

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].iscsi

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].iscsi.secretRef

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].nfs

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].persistentVolumeClaim

^{^{↩ Parent}}

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].photonPersistentDisk

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].portworxVolume

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].clusterTrustBundle

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].configMap

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].downwardAPI

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].secret

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].quobyte

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].rbd

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].rbd.secretRef

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].scaleIO

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].scaleIO.secretRef

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].secret

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].storageos

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].storageos.secretRef

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].vsphereVolume

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K8ssandraCluster.spec.cassandra.initContainers[index]

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resizePolicy	[]object	Resources resize policy for the container.	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

K8ssandraCluster.spec.cassandra.initContainers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

K8ssandraCluster.spec.cassandra.initContainers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable’s value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

K8ssandraCluster.spec.cassandra.initContainers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

K8ssandraCluster.spec.cassandra.initContainers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.initContainers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.initContainers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod’s namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.initContainers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

K8ssandraCluster.spec.cassandra.initContainers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

K8ssandraCluster.spec.cassandra.initContainers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.postStart

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.postStart.sleep

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.preStop

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
sleep	object	Sleep represents the duration that the container should sleep before being terminated.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.preStop.sleep

^{^{↩ Parent}}

Sleep represents the duration that the container should sleep before being terminated.

Name	Type	Description	Required
seconds	integer	Seconds is the number of seconds to sleep. Format: int64	true

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.initContainers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.initContainers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.initContainers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.initContainers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

K8ssandraCluster.spec.cassandra.initContainers[index].readinessProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.initContainers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.initContainers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.initContainers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.initContainers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].resizePolicy[index]

^{^{↩ Parent}}

ContainerResizePolicy represents resource resize policy for the container.

Name	Type	Description	Required
resourceName	string	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.	true
restartPolicy	string	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.	true

K8ssandraCluster.spec.cassandra.initContainers[index].resources

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.initContainers[index].resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.initContainers[index].securityContext

^{^{↩ Parent}}

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.cassandra.initContainers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

K8ssandraCluster.spec.cassandra.initContainers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.cassandra.initContainers[index].securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.cassandra.initContainers[index].securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.cassandra.initContainers[index].startupProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.cassandra.initContainers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.cassandra.initContainers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.cassandra.initContainers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.cassandra.initContainers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.cassandra.initContainers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

K8ssandraCluster.spec.cassandra.initContainers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

K8ssandraCluster.spec.cassandra.jmxInitContainerImage

^{^{↩ Parent}}

Deprecated: JMX security is now based on CQL roles. We don’t need an init container to configure JMX authentication anymore. The value of this field will be ignored.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

K8ssandraCluster.spec.cassandra.jmxInitContainerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.managementApiAuth

^{^{↩ Parent}}

ManagementApiAuth defines the authentication settings for the management API in the Cassandra pods.

Name	Type	Description	Required
insecure	object		false
manual	object		false

K8ssandraCluster.spec.cassandra.managementApiAuth.manual

^{^{↩ Parent}}

Name	Type	Required
clientSecretName	string	true
serverSecretName	string	true
skipSecretValidation	boolean	false

K8ssandraCluster.spec.cassandra.metadata

^{^{↩ Parent}}

Struct to hold labels and annotations for the top-level Cassandra cluster definition.

Name	Type	Description	Required
annotations	map[string]string		false
commonAnnotations	map[string]string	annotations that will be applied to all components created by the CRD	false
commonLabels	map[string]string	labels that will be applied to all components created by the CRD	false
labels	map[string]string		false
pods	object	labels/annotations for the pod components	false
services	object	labels/annotations for all of the CassandraDatacenter service components	false

K8ssandraCluster.spec.cassandra.metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.metadata.services

^{^{↩ Parent}}

labels/annotations for all of the CassandraDatacenter service components

Name	Type	Required
additionalSeedService	object	false
allPodsService	object	false
dcService	object	false
nodePortService	object	false
seedService	object	false

K8ssandraCluster.spec.cassandra.metadata.services.additionalSeedService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.metadata.services.allPodsService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.metadata.services.dcService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.metadata.services.nodePortService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.metadata.services.seedService

^{^{↩ Parent}}

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.cassandra.networking

^{^{↩ Parent}}

Networking enables host networking and configures a NodePort ports.

Name	Type	Description	Required
hostNetwork	boolean		false
nodePort	object		false

K8ssandraCluster.spec.cassandra.networking.nodePort

^{^{↩ Parent}}

Name	Type	Required
internode	integer	false
internodeSSL	integer	false
native	integer	false
nativeSSL	integer	false

K8ssandraCluster.spec.cassandra.podSecurityContext

^{^{↩ Parent}}

PodSecurityContext defines the security context for the Cassandra pods.

Name	Type	Description	Required
fsGroup	integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: The owning GID will be the FSGroup The setgid bit is set (new files created in the volume will be owned by FSGroup) The permission bits are OR’d with rw-rw—- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.	false
supplementalGroups	[]integer	A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.	false
sysctls	[]object	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.cassandra.podSecurityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.cassandra.podSecurityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.cassandra.podSecurityContext.sysctls[index]

^{^{↩ Parent}}

Sysctl defines a kernel parameter to be set

Name	Type	Description	Required
name	string	Name of a property to set	true
value	string	Value of a property to set	true

K8ssandraCluster.spec.cassandra.podSecurityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.cassandra.racks[index]

^{^{↩ Parent}}

Rack …

Name	Type	Description	Required
name	string	The rack name	true
affinity	object	Affinity rules to set for this rack only. Merged with values from PodTemplateSpec Affinity as well as NodeAffinityLabels. If you wish to override all the default PodAntiAffinity rules, set allowMultipleWorkers to true, otherwise defaults are applied and then these Affinity settings are merged.	false
nodeAffinityLabels	map[string]string	NodeAffinityLabels to pin the rack, using node affinity	false
zone	string	Deprecated. Use nodeAffinityLabels instead. DeprecatedZone name to pin the rack, using node affinity	false

K8ssandraCluster.spec.cassandra.racks[index].affinity

^{^{↩ Parent}}

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.resources

^{^{↩ Parent}}

Resources is the cpu and memory resources for the cassandra container.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.serverEncryptionStores

^{^{↩ Parent}}

Internode encryption stores which are used by Cassandra and Stargate.

Name	Type	Description	Required
keystoreSecretRef	object	ref to the secret that contains the keystore and optionally its password (which can also be specified through the keystorePasswordSecretRef field) if keys are not specified, "keystore" entry and a "keystore-password" entry will be used	true
truststoreSecretRef	object	ref to the secret that contains the truststore and optionally its password (which can also be specified through the truststorePasswordSecretRef field) if keys are not specified explicitly, "keystore" entry and a "keystore-password" entry will be used	true
keystorePasswordSecretRef	object	ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "keystore-password" entry will be used	false
truststorePasswordSecretRef	object	ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "truststore-password" entry will be used	false

K8ssandraCluster.spec.cassandra.serverEncryptionStores.keystoreSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.serverEncryptionStores.truststoreSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.serverEncryptionStores.keystorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “keystore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.serverEncryptionStores.truststorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “truststore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig

^{^{↩ Parent}}

StorageConfig is the persistent storage requirements for each Cassandra pod. This includes everything under /var/lib/cassandra, namely the commit log and data directories.

Name	Type	Description	Required
additionalVolumes	[]object		false
cassandraDataVolumeClaimSpec	object	PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index]

^{^{↩ Parent}}

AdditionalVolumes defines additional storage configurations

Name	Type	Description	Required
mountPath	string	Mount path into cassandra container	true
name	string	Name of the pvc / volume	true
pvcSpec	object	PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.	false
volumeSource	object	VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec

^{^{↩ Parent}}

PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource

^{^{↩ Parent}}

VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.

Name	Type	Description	Required
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.awsElasticBlockStore

^{^{↩ Parent}}

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.azureDisk

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.azureFile

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.cephfs

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.cephfs.secretRef

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.cinder

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.cinder.secretRef

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.configMap

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.csi

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.csi.nodePublishSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.downwardAPI

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.emptyDir

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.ephemeral

^{^{↩ Parent}}

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.fc

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.flexVolume

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.flexVolume.secretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.flocker

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.gcePersistentDisk

^{^{↩ Parent}}

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.gitRepo

^{^{↩ Parent}}

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.glusterfs

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.hostPath

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.iscsi

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.iscsi.secretRef

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.nfs

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.persistentVolumeClaim

^{^{↩ Parent}}

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.photonPersistentDisk

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.portworxVolume

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
clusterTrustBundle	object	ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.	false
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].clusterTrustBundle

^{^{↩ Parent}}

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

Name	Type	Description	Required
path	string	Relative path from the volume root to write the bundle.	true
labelSelector	object	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".	false
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.	false
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.	false
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].clusterTrustBundle.labelSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].configMap

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].secret

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.quobyte

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.rbd

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.rbd.secretRef

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.scaleIO

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.scaleIO.secretRef

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.secret

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.storageos

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.storageos.secretRef

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].volumeSource.vsphereVolume

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec

^{^{↩ Parent}}

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.cassandra.superuserSecretRef

^{^{↩ Parent}}

The reference to the superuser secret to use for Cassandra. If unspecified, a default secret will be generated with a random password; the generated secret name will be “<cluster_name>-superuser” where <cluster_name> is the K8ssandraCluster CRD name.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.cassandra.telemetry

^{^{↩ Parent}}

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

K8ssandraCluster.spec.cassandra.telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

K8ssandraCluster.spec.cassandra.telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

K8ssandraCluster.spec.cassandra.telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

K8ssandraCluster.spec.cassandra.telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

K8ssandraCluster.spec.cassandra.telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

K8ssandraCluster.spec.cassandra.telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

K8ssandraCluster.spec.cassandra.telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

K8ssandraCluster.spec.cassandra.telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.cassandra.telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

K8ssandraCluster.spec.cassandra.telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.cassandra.telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.cassandra.telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.cassandra.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

K8ssandraCluster.spec.medusa

^{^{↩ Parent}}

Medusa defines the desired deployment characteristics for Medusa in this K8ssandraCluster. If this is non-nil, Medusa will be deployed in every Cassandra pod in this K8ssandraCluster.

Name	Type	Description	Required
cassandraUserSecretRef	object	Defines the username and password that Medusa will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Medusa instances, so that it can authenticate against nodes in the datacenter using CQL. The secret must be in the same namespace as Cassandra and must contain two keys: "username" and "password".	false
certificatesSecretRef	object	Certificates for Medusa if client encryption is enabled in Cassandra. The secret must be in the same namespace as Cassandra and must contain three keys: "rootca.crt", "client.crt_signed" and "client.key". See https://docs.datastax.com/en/developer/python-driver/latest/security/ for more information on the required files.	false
containerImage	object	MedusaContainerImage is the image characteristics to use for Medusa containers. Leave nil to use a default image.	false
containerResources	object	Medusa main container resources.	false
initContainerResources	object	medusa-restore init container resources.	false
livenessProbe	object	Define the liveness probe settings to use for the Medusa containers.	false
medusaConfigurationRef	object	MedusaConfigurationRef points to an existing MedusaConfiguration object. The purpose is to allow shared default settings across several clusters. StorageProperties override the settings from MedusaConfiguration object to allow customization.	false
purgeBackups	boolean	PurgeBackups toggles if the medusa backups should be purged nightly or not Defaults to true. Default: true	false
readinessProbe	object	Define the readiness probe settings to use for the Medusa containers.	false
securityContext	object	SecurityContext applied to the Medusa containers.	false
storageProperties	object	Provides all storage backend related properties for backups.	false

K8ssandraCluster.spec.medusa.cassandraUserSecretRef

^{^{↩ Parent}}

Defines the username and password that Medusa will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Medusa instances, so that it can authenticate against nodes in the datacenter using CQL. The secret must be in the same namespace as Cassandra and must contain two keys: “username” and “password”.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.medusa.certificatesSecretRef

^{^{↩ Parent}}

Certificates for Medusa if client encryption is enabled in Cassandra. The secret must be in the same namespace as Cassandra and must contain three keys: “rootca.crt”, “client.crt_signed” and “client.key”. See https://docs.datastax.com/en/developer/python-driver/latest/security/ for more information on the required files.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.medusa.containerImage

^{^{↩ Parent}}

MedusaContainerImage is the image characteristics to use for Medusa containers. Leave nil to use a default image.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

K8ssandraCluster.spec.medusa.containerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.medusa.containerResources

^{^{↩ Parent}}

Medusa main container resources.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.medusa.containerResources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.medusa.initContainerResources

^{^{↩ Parent}}

medusa-restore init container resources.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.medusa.initContainerResources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.medusa.livenessProbe

^{^{↩ Parent}}

Define the liveness probe settings to use for the Medusa containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.medusa.livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.medusa.livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.medusa.livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.medusa.livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.medusa.livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.medusa.medusaConfigurationRef

^{^{↩ Parent}}

MedusaConfigurationRef points to an existing MedusaConfiguration object. The purpose is to allow shared default settings across several clusters. StorageProperties override the settings from MedusaConfiguration object to allow customization.

Name	Type	Description	Required
apiVersion	string	API version of the referent.	false
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.	false
kind	string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	false
namespace	string	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	false
resourceVersion	string	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	false
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids	false

K8ssandraCluster.spec.medusa.readinessProbe

^{^{↩ Parent}}

Define the readiness probe settings to use for the Medusa containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.medusa.readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.medusa.readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.medusa.readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.medusa.readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.medusa.readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.medusa.securityContext

^{^{↩ Parent}}

SecurityContext applied to the Medusa containers.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.medusa.securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

K8ssandraCluster.spec.medusa.securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.medusa.securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.medusa.securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.medusa.storageProperties

^{^{↩ Parent}}

Provides all storage backend related properties for backups.

Name	Type	Description	Required
apiProfile	string	AWS Profile to use for authentication.	false
backupGracePeriodInDays	integer	Age after which orphan sstables can be deleted from the storage backend. Protects from race conditions between purge and ongoing backups. Defaults to 10 days.	false
bucketName	string	The name of the bucket to use for the backups.	false
concurrentTransfers	integer	Number of concurrent uploads. Helps maximizing the speed of uploads but puts more pressure on the network. Defaults to 0. Default: 0	false
credentialsType	enum	Type of credentials to use for authentication. Can be "role-based", "credential-based" or empty. Enum: role-based, credential-based	false
host	string	Host to connect to for the storage backend.	false
maxBackupAge	integer	Maximum backup age that the purge process should observe. Default: 0	false
maxBackupCount	integer	Maximum number of backups to keep (used by the purge process). Default is unlimited. Default: 0	false
multiPartUploadThreshold	integer	File size over which cloud specific cli tools are used for transfer. Defaults to 100 MB. Default: 104857600	false
podStorage	object	Pod storage settings for the local storage provider	false
port	integer	Port to connect to for the storage backend.	false
prefix	string	Name of the top level folder in the backup bucket. If empty, the cluster name will be used.	false
region	string	Region of the storage bucket. Defaults to "default".	false
secure	boolean	Whether to use SSL for the storage backend.	false
sslVerify	boolean	When using SSL, whether to also verify the certificate.	false
storageProvider	enum	The storage backend to use for the backups. Enum: google_storage, azure_blobs, s3, s3_compatible, s3_rgw, ibm_storage	false
storageSecretRef	object	Kubernetes Secret that stores the key file for the storage provider's API. If using 'local' storage, this value is ignored.	false
transferMaxBandwidth	string	Max upload bandwidth in MB/s. Defaults to 50 MB/s. Default: 50MB/s	false

K8ssandraCluster.spec.medusa.storageProperties.podStorage

^{^{↩ Parent}}

Pod storage settings for the local storage provider

Name	Type	Description	Required
accessModes	[]string	Pod local storage access modes	false
size	int or string	Size of the pod's storage in bytes. Defaults to 10 GB. Default: 10Gi	false
storageClassName	string	Storage class name to use for the pod's storage.	false

K8ssandraCluster.spec.medusa.storageProperties.storageSecretRef

^{^{↩ Parent}}

Kubernetes Secret that stores the key file for the storage provider’s API. If using ‘local’ storage, this value is ignored.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.reaper

^{^{↩ Parent}}

Reaper defines the desired deployment characteristics for Reaper in this K8ssandraCluster. If this is non-nil, Reaper might be deployed on every Cassandra datacenter in this K8ssandraCluster, unless there is a Control Plane Reaper present. In that case, the K8ssandraCluster will get registered to it.

Name	Type	Description	Required
ServiceAccountName	string	Default: default	false
affinity	object	Affinity applied to the Reaper pods.	false
autoScheduling	object	Auto scheduling properties. When you enable the auto-schedule feature, Reaper dynamically schedules repairs for all non-system keyspaces in a cluster. A cluster's keyspaces are monitored and any modifications (additions or removals) are detected. When a new keyspace is created, a new repair schedule is created automatically for that keyspace. Conversely, when a keyspace is removed, the corresponding repair schedule is deleted.	false
cassandraUserSecretRef	object	Defines the username and password that Reaper will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Reaper instance, so that it can authenticate against nodes in the datacenter using CQL. If CQL authentication is not required, leave this field empty. The secret must be in the same namespace as Reaper itself and must contain two keys: "username" and "password".	false
containerImage	object	The image to use for the Reaper pod main container. The default is "thelastpickle/cassandra-reaper:3.6.1". TODO: update with real release version. Default: map[name:cassandra-reaper repository:thelastpickle tag:3.6.1]	false
deploymentMode	enum	Enum: PER_DC, SINGLE, CONTROL_PLANE Default: PER_DC	false
heapSize	int or string	HeapSize sets the JVM heap size to use for Reaper. Default: 2Gi	false
httpManagement	object	Default: map[enabled:false]	false
initContainerImage	object	Deprecated: The main container image will be used for the init container as well.	false
initContainerResources	object	Init Container resources.	false
initContainerSecurityContext	object	InitContainerSecurityContext is the SecurityContext applied to the Reaper init container, used to perform schema migrations.	false
jmxUserSecretRef	object	Deprecated: JMX security is now based on CQL roles. Reaper will use cassandraUsefSecretRef for authentication, this field is ignored.	false
keyspace	string	The keyspace to use to store Reaper's state. Will default to "reaper_db" if unspecified. Will be created if it does not exist, and if this Reaper resource is managed by K8ssandra. Default: reaper_db	false
livenessProbe	object	LivenessProbe sets the Reaper liveness probe. Leave nil to use defaults.	false
metadata	object	labels and annotations for Reaper resources	false
podSecurityContext	object	PodSecurityContext contains a pod-level SecurityContext to apply to Reaper pods.	false
readinessProbe	object	ReadinessProbe sets the Reaper readiness probe. Leave nil to use defaults.	false
reaperRef	object	When there is a CONTROL_PLANE Reaper out there, this field allows registering a K8ssandra cluster to it. Populating this field disables some operator behaviour related to setting Reaper up.	false
resources	object	Main Container resources.	false
secretsProvider	enum	SecretsProvider defines whether the secrets used for credentials and certs will be backed by an external secret backend. This moves the responsibility of generating and storing secrets from the operators to the user and will rely on a mutating webhook to inject the secrets into the necessary resources Enum: internal, external Default: internal	false
securityContext	object	SecurityContext applied to the Reaper main container.	false
storageConfig	object	If StorageType is "local", Reaper will need a Persistent Volume to persist its data. This field allows configuring that Persistent Volume.	false
storageType	enum	The storage backend to store Reaper's data. Defaults to "cassandra" which causes Reaper to be stateless and store its state to a Cassandra cluster it repairs (implying there must be one Reaper for each Cassandra cluster). The "local" option makes Reaper to store its state locally, allowing a single Reaper to repair several clusters. Enum: cassandra, local Default: cassandra	false
telemetry	object	Telemetry defines the desired telemetry integrations to deploy targeting the Reaper pods for all DCs in this cluster (unless overridden by DC specific settings)	false
tolerations	[]object	Tolerations applied to the Reaper pods.	false
uiUserSecretRef	object	Defines the secret which contains the username and password for the Reaper UI and REST API authentication. When UiUserSecretRef.Name == "", authentication is turned off in the front-end only.	false

K8ssandraCluster.spec.reaper.affinity

^{^{↩ Parent}}

Affinity applied to the Reaper pods.

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

K8ssandraCluster.spec.reaper.affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

K8ssandraCluster.spec.reaper.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.reaper.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.reaper.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

K8ssandraCluster.spec.reaper.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.reaper.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.reaper.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.autoScheduling

^{^{↩ Parent}}

Auto scheduling properties. When you enable the auto-schedule feature, Reaper dynamically schedules repairs for all non-system keyspaces in a cluster. A cluster’s keyspaces are monitored and any modifications (additions or removals) are detected. When a new keyspace is created, a new repair schedule is created automatically for that keyspace. Conversely, when a keyspace is removed, the corresponding repair schedule is deleted.

Name	Type	Description	Required
enabled	boolean	Default: false	false
excludedClusters	[]string	ExcludedClusters are the clusters that are to be excluded from the repair schedule.	false
excludedKeyspaces	[]string	ExcludedKeyspaces are the keyspaces that are to be excluded from the repair schedule.	false
initialDelayPeriod	string	InitialDelay is the amount of delay time before the schedule period starts. Must be a valid ISO-8601 duration string. The default is "PT15S" (15 seconds). Default: PT15S	false
percentUnrepairedThreshold	integer	PercentUnrepairedThreshold is the percentage of unrepaired data over which an incremental repair should be started. Only relevant when using repair type INCREMENTAL. Default: 10 Minimum: 0 Maximum: 100	false
periodBetweenPolls	string	PeriodBetweenPolls is the interval time to wait before checking whether to start a repair task. Must be a valid ISO-8601 duration string. The default is "PT10M" (10 minutes). Default: PT10M	false
repairType	enum	RepairType is the type of repair to create: - REGULAR creates a regular repair (non-adaptive and non-incremental); - ADAPTIVE creates an adaptive repair; adaptive repairs are most suited for Cassandra 3. - INCREMENTAL creates an incremental repair; incremental repairs should only be used with Cassandra 4+. - AUTO chooses between ADAPTIVE and INCREMENTAL depending on the Cassandra server version; ADAPTIVE for Cassandra 3 and INCREMENTAL for Cassandra 4+. Enum: REGULAR, ADAPTIVE, INCREMENTAL, AUTO Default: AUTO	false
scheduleSpreadPeriod	string	ScheduleSpreadPeriod is the time spacing between each of the repair schedules that is to be carried out. Must be a valid ISO-8601 duration string. The default is "PT6H" (6 hours). Default: PT6H	false
timeBeforeFirstSchedule	string	TimeBeforeFirstSchedule is the grace period before the first repair in the schedule is started. Must be a valid ISO-8601 duration string. The default is "PT5M" (5 minutes). Default: PT5M	false

K8ssandraCluster.spec.reaper.cassandraUserSecretRef

^{^{↩ Parent}}

Defines the username and password that Reaper will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Reaper instance, so that it can authenticate against nodes in the datacenter using CQL. If CQL authentication is not required, leave this field empty. The secret must be in the same namespace as Reaper itself and must contain two keys: “username” and “password”.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.reaper.containerImage

^{^{↩ Parent}}

The image to use for the Reaper pod main container. The default is “thelastpickle/cassandra-reaper:3.6.1”. TODO: update with real release version.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

K8ssandraCluster.spec.reaper.containerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.reaper.httpManagement

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	Enable/disable the HTTP management connection between Reaper and Cassandra. When enabled, HTTP will be used instead of JMX for management connectivity between Cassandra and Reaper. In future, this will be true by default Default: false	false
keystores	object	LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.	false

K8ssandraCluster.spec.reaper.httpManagement.keystores

^{^{↩ Parent}}

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.reaper.initContainerImage

^{^{↩ Parent}}

Deprecated: The main container image will be used for the init container as well.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

K8ssandraCluster.spec.reaper.initContainerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.reaper.initContainerResources

^{^{↩ Parent}}

Init Container resources.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.reaper.initContainerResources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.reaper.initContainerSecurityContext

^{^{↩ Parent}}

InitContainerSecurityContext is the SecurityContext applied to the Reaper init container, used to perform schema migrations.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.reaper.initContainerSecurityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

K8ssandraCluster.spec.reaper.initContainerSecurityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.reaper.initContainerSecurityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.reaper.initContainerSecurityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.reaper.jmxUserSecretRef

^{^{↩ Parent}}

Deprecated: JMX security is now based on CQL roles. Reaper will use cassandraUsefSecretRef for authentication, this field is ignored.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.reaper.livenessProbe

^{^{↩ Parent}}

LivenessProbe sets the Reaper liveness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.reaper.livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.reaper.livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.reaper.livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.reaper.livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.reaper.livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.reaper.metadata

^{^{↩ Parent}}

labels and annotations for Reaper resources

Name	Type	Description	Required
annotations	map[string]string		false
commonLabels	map[string]string	labels/annotations that will be applied to all components created by the CRD	false
labels	map[string]string		false
pods	object	labels/annotations for the pod components	false
service	object	labels/annotations for the service component	false

K8ssandraCluster.spec.reaper.metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.reaper.metadata.service

^{^{↩ Parent}}

labels/annotations for the service component

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.reaper.podSecurityContext

^{^{↩ Parent}}

PodSecurityContext contains a pod-level SecurityContext to apply to Reaper pods.

Name	Type	Description	Required
fsGroup	integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: The owning GID will be the FSGroup The setgid bit is set (new files created in the volume will be owned by FSGroup) The permission bits are OR’d with rw-rw—- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.	false
supplementalGroups	[]integer	A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.	false
sysctls	[]object	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.reaper.podSecurityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.reaper.podSecurityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.reaper.podSecurityContext.sysctls[index]

^{^{↩ Parent}}

Sysctl defines a kernel parameter to be set

Name	Type	Description	Required
name	string	Name of a property to set	true
value	string	Value of a property to set	true

K8ssandraCluster.spec.reaper.podSecurityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.reaper.readinessProbe

^{^{↩ Parent}}

ReadinessProbe sets the Reaper readiness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.reaper.readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.reaper.readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.reaper.readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.reaper.readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.reaper.readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.reaper.reaperRef

^{^{↩ Parent}}

When there is a CONTROL_PLANE Reaper out there, this field allows registering a K8ssandra cluster to it. Populating this field disables some operator behaviour related to setting Reaper up.

Name	Type	Description	Required
apiVersion	string	API version of the referent.	false
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.	false
kind	string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	false
namespace	string	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	false
resourceVersion	string	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	false
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids	false

K8ssandraCluster.spec.reaper.resources

^{^{↩ Parent}}

Main Container resources.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.reaper.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.reaper.securityContext

^{^{↩ Parent}}

SecurityContext applied to the Reaper main container.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

K8ssandraCluster.spec.reaper.securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

K8ssandraCluster.spec.reaper.securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

K8ssandraCluster.spec.reaper.securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

K8ssandraCluster.spec.reaper.securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

K8ssandraCluster.spec.reaper.storageConfig

^{^{↩ Parent}}

If StorageType is “local”, Reaper will need a Persistent Volume to persist its data. This field allows configuring that Persistent Volume.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

K8ssandraCluster.spec.reaper.storageConfig.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

K8ssandraCluster.spec.reaper.storageConfig.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

K8ssandraCluster.spec.reaper.storageConfig.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

K8ssandraCluster.spec.reaper.storageConfig.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.reaper.storageConfig.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.reaper.telemetry

^{^{↩ Parent}}

Telemetry defines the desired telemetry integrations to deploy targeting the Reaper pods for all DCs in this cluster (unless overridden by DC specific settings)

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

K8ssandraCluster.spec.reaper.telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

K8ssandraCluster.spec.reaper.telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

K8ssandraCluster.spec.reaper.telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

K8ssandraCluster.spec.reaper.telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

K8ssandraCluster.spec.reaper.telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

K8ssandraCluster.spec.reaper.telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

K8ssandraCluster.spec.reaper.telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

K8ssandraCluster.spec.reaper.telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.reaper.telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

K8ssandraCluster.spec.reaper.telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.reaper.telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.reaper.telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.reaper.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

K8ssandraCluster.spec.reaper.uiUserSecretRef

^{^{↩ Parent}}

Defines the secret which contains the username and password for the Reaper UI and REST API authentication. When UiUserSecretRef.Name == “”, authentication is turned off in the front-end only.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.stargate

^{^{↩ Parent}}

Stargate defines the desired deployment characteristics for Stargate in this K8ssandraCluster. If this is non-nil, Stargate will be deployed on every Cassandra datacenter in this K8ssandraCluster.

Name	Type	Description	Required
size	integer	Size is the number of Stargate instances to deploy in each datacenter. They will be spread evenly across racks. Format: int32 Default: 1 Minimum: 1	true
affinity	object	Affinity is the affinity to apply to all the Stargate pods. Leave nil to let the controller reuse the same affinity rules used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity	false
allowStargateOnDataNodes	boolean	AllowStargateOnDataNodes allows Stargate pods to be scheduled on a worker node already hosting data pods for this datacenter. The default is false, which means that Stargate pods will be scheduled on separate worker nodes. Note: if the datacenter pods have HostNetwork:true, then the Stargate pods will inherit of it, in which case it is possible that Stargate nodes won't be allowed to sit on data nodes even if this property is set to true, because of port conflicts on the same IP address. Default: false	false
authOptions	object	Authentication options.	false
cassandraConfigMapRef	object	CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.	false
containerImage	object	ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image. Default: map[repository:stargateio tag:v1.0.77]	false
heapSize	int or string	HeapSize sets the JVM heap size to use for Stargate. If no Resources are specified, this value will also be used to set a default memory request and limit for the Stargate pods: these will be set to HeapSize x2 and x4, respectively. Default: 256Mi	false
livenessProbe	object	LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.	false
metadata	object	labels and annotations for Stargate resources	false
nodeSelector	map[string]string	NodeSelector is an optional map of label keys and values to restrict the scheduling of Stargate nodes to workers with matching labels. Leave nil to let the controller reuse the same node selectors used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector	false
readinessProbe	object	ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.	false
resources	object	Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.	false
secretsProvider	enum	SecretsProvider defines whether the secrets used for credentials and certs will be backed by an external secret backend. This moves the responsibility of generating and storing secrets from the operators to the user and will rely on a mutating webhook to inject the secrets into the necessary resources Enum: internal, external Default: internal	false
serviceAccount	string	ServiceAccount is the service account name to use for Stargate pods. Default: default	false
telemetry	object	Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)	false
tolerations	[]object	Tolerations are tolerations to apply to the Stargate pods. Leave nil to let the controller reuse the same tolerations used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/	false

K8ssandraCluster.spec.stargate.affinity

^{^{↩ Parent}}

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

K8ssandraCluster.spec.stargate.affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

K8ssandraCluster.spec.stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

K8ssandraCluster.spec.stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

K8ssandraCluster.spec.stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

K8ssandraCluster.spec.stargate.authOptions

^{^{↩ Parent}}

Authentication options.

Name	Type	Description	Required
apiAuthMethod	enum	The method to use for authenticating requests to the Stargate APIs. Stargate currently has two authentication / authorization methods: - Table: table-based; - JWT: JSON web token (JWT)-based. The methods are mutually exclusive. The default method is Table. Enum: Table, JWT Default: Table	false
providerUrl	string	Required when using JWT authentication method, ignored otherwise.	false
tokenTtlSeconds	integer	The time-to-live in seconds of an API authentication token. Valid only for the Table authentication method. By default, the token persists for 30 minutes with a sliding window. Each use of the token to authenticate resets the 30-minute window. A token created and used after 29 minutes will authenticate a request, but if 31 minutes passes before use, the token will no longer exist. Default is 1800 seconds (30 minutes). Minimum: 1	false

K8ssandraCluster.spec.stargate.cassandraConfigMapRef

^{^{↩ Parent}}

CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.stargate.containerImage

^{^{↩ Parent}}

ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

K8ssandraCluster.spec.stargate.containerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

K8ssandraCluster.spec.stargate.livenessProbe

^{^{↩ Parent}}

LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.stargate.livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.stargate.livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.stargate.livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.stargate.livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.stargate.livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.stargate.metadata

^{^{↩ Parent}}

labels and annotations for Stargate resources

Name	Type	Description	Required
annotations	map[string]string		false
commonLabels	map[string]string	labels/annotations that will be applied to all components created by the CRD	false
labels	map[string]string		false
pods	object	labels/annotations for the pod components	false
service	object	labels/annotations for the service component	false

K8ssandraCluster.spec.stargate.metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.stargate.metadata.service

^{^{↩ Parent}}

labels/annotations for the service component

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

K8ssandraCluster.spec.stargate.readinessProbe

^{^{↩ Parent}}

ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

K8ssandraCluster.spec.stargate.readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

K8ssandraCluster.spec.stargate.readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

K8ssandraCluster.spec.stargate.readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

K8ssandraCluster.spec.stargate.readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

K8ssandraCluster.spec.stargate.readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

K8ssandraCluster.spec.stargate.resources

^{^{↩ Parent}}

Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.stargate.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.stargate.telemetry

^{^{↩ Parent}}

Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

K8ssandraCluster.spec.stargate.telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

K8ssandraCluster.spec.stargate.telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

K8ssandraCluster.spec.stargate.telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

K8ssandraCluster.spec.stargate.telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

K8ssandraCluster.spec.stargate.telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

K8ssandraCluster.spec.stargate.telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

K8ssandraCluster.spec.stargate.telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

K8ssandraCluster.spec.stargate.telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.stargate.telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

K8ssandraCluster.spec.stargate.telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

K8ssandraCluster.spec.stargate.telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

K8ssandraCluster.spec.stargate.telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

K8ssandraCluster.spec.stargate.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

K8ssandraCluster.status

^{^{↩ Parent}}

K8ssandraClusterStatus defines the observed state of K8ssandraCluster

Name	Type	Description	Required
conditions	[]object		false
datacenters	map[string]object	Datacenters maps the CassandraDatacenter name to a K8ssandraStatus. The naming is a bit confusing but the mapping makes sense because we have a CassandraDatacenter and then define other components like Stargate and Reaper relative to it. I wanted to inline the field but when I do it won't serialize. TODO Figure out how to inline this field	false
error	string	Default: None	false
observedGeneration	integer	ObservedGeneration is the last observed generation of the K8ssandraCluster. Format: int64	false

K8ssandraCluster.status.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
status	string		true
type	string		true
lastTransitionTime	string	LastTransitionTime is the last time the condition transited from one status to another. Format: date-time	false

K8ssandraCluster.status.datacenters[key]

^{^{↩ Parent}}

K8ssandraStatus defines the observed of a k8ssandra instance

Name	Type	Description	Required
cassandra	object	CassandraDatacenterStatus defines the observed state of CassandraDatacenter	false
decommissionProgress	string		false
reaper	object	ReaperStatus defines the observed state of Reaper	false
stargate	object	StargateStatus defines the observed state of a Stargate resource.	false

K8ssandraCluster.status.datacenters[key].cassandra

^{^{↩ Parent}}

CassandraDatacenterStatus defines the observed state of CassandraDatacenter

Name	Type	Description	Required
cassandraOperatorProgress	string	Last known progress state of the Cassandra Operator	false
conditions	[]object		false
datacenterName	string	DatacenterName is the name of the override used for the CassandraDatacenter This field is used to perform validation checks preventing a user from changing the override	false
lastRollingRestart	string	Format: date-time	false
lastServerNodeStarted	string	The timestamp when the operator last started a Server node with the management API Format: date-time	false
nodeReplacements	[]string		false
nodeStatuses	map[string]object		false
observedGeneration	integer	Format: int64	false
quietPeriod	string	Format: date-time	false
superUserUpserted	string	Deprecated. Use usersUpserted instead. The timestamp at which CQL superuser credentials were last upserted to the management API Format: date-time	false
trackedTasks	[]object	TrackedTasks tracks the tasks for completion that were created by the cass-operator	false
usersUpserted	string	The timestamp at which managed cassandra users' credentials were last upserted to the management API Format: date-time	false

K8ssandraCluster.status.datacenters[key].cassandra.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
message	string		true
reason	string		true
status	string		true
type	string		true
lastTransitionTime	string	Format: date-time	false

K8ssandraCluster.status.datacenters[key].cassandra.nodeStatuses[key]

^{^{↩ Parent}}

Name	Type	Required
hostID	string	false
ip	string	false
rack	string	false

K8ssandraCluster.status.datacenters[key].cassandra.trackedTasks[index]

^{^{↩ Parent}}

ObjectReference contains enough information to let you inspect or modify the referred object.

New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.

Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.
Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, “must refer only to types A and B” or “UID not honored” or “name must be restricted”. Those cannot be well described when embedded.
Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.
The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple and the version of the actual struct is irrelevant.
We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don’t make new APIs embed an underspecified API type they do not control.

Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .

Name	Type	Description	Required
apiVersion	string	API version of the referent.	false
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.	false
kind	string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	false
namespace	string	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	false
resourceVersion	string	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	false
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids	false

K8ssandraCluster.status.datacenters[key].reaper

^{^{↩ Parent}}

ReaperStatus defines the observed state of Reaper

Name	Type	Description	Required
conditions	[]object		false
progress	enum	Progress is the progress of this Reaper object. Enum: Pending, Deploying, Configuring, Running	false

K8ssandraCluster.status.datacenters[key].reaper.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
status	string		true
type	string		true
lastTransitionTime	string	LastTransitionTime is the last time the condition transited from one status to another. Format: date-time	false

K8ssandraCluster.status.datacenters[key].stargate

^{^{↩ Parent}}

StargateStatus defines the observed state of a Stargate resource.

Name	Type	Description	Required
availableReplicas	integer	Total number of available pods targeted by the Stargate deployment. Will be zero if the deployment has not been created yet. Format: int32	true
readyReplicas	integer	ReadyReplicas is the total number of ready pods targeted by the Stargate deployment. Will be zero if the deployment has not been created yet. Format: int32	true
replicas	integer	Total number of non-terminated pods targeted by the Stargate deployment (their labels match the selector). Will be zero if the deployment has not been created yet. Format: int32	true
updatedReplicas	integer	UpdatedReplicas is the total number of non-terminated pods targeted by the Stargate deployment that have the desired template spec. Will be zero if the deployment has not been created yet. Format: int32	true
conditions	[]object		false
deploymentRefs	[]string	DeploymentRefs is the names of the Deployment objects that were created for this Stargate object.	false
progress	enum	Progress is the progress of this Stargate object. Enum: Pending, Deploying, Running	false
readyReplicasRatio	string	ReadyReplicasRatio is a "X/Y" string representing the ratio between ReadyReplicas and Replicas in the Stargate deployment.	false
serviceRef	string	ServiceRef is the name of the Service object that was created for this Stargate object.	false

K8ssandraCluster.status.datacenters[key].stargate.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
status	string		true
type	string		true
lastTransitionTime	string	LastTransitionTime is the last time the condition transited from one status to another. Format: date-time	false

medusa.k8ssandra.io/v1alpha1

Resource Types:

CassandraBackup
CassandraRestore
MedusaBackupJob
MedusaBackup
MedusaBackupSchedule
MedusaConfiguration
MedusaRestoreJob
Medusa
MedusaTask

CassandraBackup

^{^{↩ Parent}}

CassandraBackup is the Schema for the cassandrabackups API

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	CassandraBackup	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	CassandraBackupSpec defines the desired state of CassandraBackup	false
status	object	CassandraBackupStatus defines the observed state of CassandraBackup	false

CassandraBackup.spec

^{^{↩ Parent}}

CassandraBackupSpec defines the desired state of CassandraBackup

Name	Type	Description	Required
cassandraDatacenter	string	The name of the CassandraDatacenter to back up	true
backupType	enum	The type of the backup: "full" or "differential" Enum: differential, full Default: differential	false
name	string	The name of the backup. TODO document format of generated name	false

CassandraBackup.status

^{^{↩ Parent}}

CassandraBackupStatus defines the observed state of CassandraBackup

Name	Type	Description	Required
cassdcTemplateSpec	object		false
failed	[]string		false
finishTime	string	Format: date-time	false
finished	[]string		false
inProgress	[]string		false
startTime	string	Format: date-time	false

CassandraBackup.status.cassdcTemplateSpec

^{^{↩ Parent}}

Name	Type	Description	Required
spec	object	CassandraDatacenterSpec defines the desired state of a CassandraDatacenter	true
metadata	object	Standard object metadata	false

CassandraBackup.status.cassdcTemplateSpec.spec

^{^{↩ Parent}}

CassandraDatacenterSpec defines the desired state of a CassandraDatacenter

Name	Type	Description	Required
clusterName	string	The name by which CQL clients and instances will know the cluster. If the same cluster name is shared by multiple Datacenters in the same Kubernetes namespace, they will join together in a multi-datacenter cluster.	true
serverType	enum	Server type: "cassandra" or "dse" Enum: cassandra, dse	true
serverVersion	string	Version string for config builder, used to generate Cassandra server configuration	true
size	integer	Desired number of Cassandra server nodes Format: int32 Minimum: 1	true
storageConfig	object	StorageConfig describes the persistent storage request of each server node	true
additionalLabels	map[string]string	Additional Labels allows to define additional labels that will be included in all objects created by the operator. Note, user can override values set by default from the cass-operator and doing so could break cass-operator functionality.	false
additionalSeeds	[]string		false
additionalServiceConfig	object	AdditionalServiceConfig allows to define additional parameters that are included in the created Services. Note, user can override values set by cass-operator and doing so could break cass-operator functionality. Avoid label "cass-operator" and anything that starts with "cassandra.datastax.com/"	false
allowMultipleNodesPerWorker	boolean	Turning this option on allows multiple server pods to be created on a k8s worker node, by removing the default pod anti affinity rules. By default the operator creates just one server pod per k8s worker node. Using custom affinity rules might require turning this option on in which case the defaults are not set.	false
canaryUpgrade	boolean	Indicates that configuration and container image changes should only be pushed to the first rack of the datacenter	false
canaryUpgradeCount	integer	The number of nodes that will be updated when CanaryUpgrade is true. Note that the value is either 0 or greater than the rack size, then all nodes in the rack will get updated. Format: int32	false
cdc	object	CDC allows configuration of the change data capture agent which can run within the Management API container. Use it to send data to Pulsar.	false
config	string	Config for the server, in YAML format Format: byte	false
configBuilderImage	string	Container image for the config builder init container. Overrides value from ImageConfig ConfigBuilderImage	false
configBuilderResources	object	Kubernetes resource requests and limits per server config initialization container.	false
configSecret	string	ConfigSecret is the name of a secret that contains configuration for Cassandra. The secret is expected to have a property named config whose value should be a JSON formatted string that should look like this: config: \|- { "cassandra-yaml": { "read_request_timeout_in_ms": 10000 }, "jmv-options": { "max_heap_size": 1024M } } ConfigSecret is mutually exclusive with Config. ConfigSecret takes precedence and will be used exclusively if both properties are set. The operator sets a watch such that an update to the secret will trigger an update of the StatefulSets.	false
datacenterName	string	DatacenterName allows to override the name of the Cassandra datacenter. Kubernetes objects will be named after a sanitized version of it if set, and if not metadata.name. In Cassandra the DC name will be overridden by this value. It may generate some confusion as objects created for the DC will have a different name than the CasandraDatacenter object itself. This setting can create conflicts if multiple DCs coexist in the same namespace if metadata.name for a DC with no override is set to the same value as the override name of another DC. Use cautiously.	false
disableSystemLoggerSidecar	boolean	Configuration for disabling the simple log tailing sidecar container. Our default is to have it enabled.	false
dockerImageRunsAsCassandra	boolean	Does the Server Docker image run as the Cassandra user? Defaults to true	false
dseWorkloads	object		false
forceUpgradeRacks	[]string	Rack names in this list are set to the latest StatefulSet configuration even if Cassandra nodes are down. Use this to recover from an upgrade that couldn't roll out.	false
managementApiAuth	object	Config for the Management API certificates	false
networking	object		false
nodeAffinityLabels	map[string]string	NodeAffinityLabels to pin the Datacenter, using node affinity	false
nodeSelector	map[string]string	A map of label keys and values to restrict Cassandra node scheduling to k8s workers with matchiing labels. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector	false
podTemplateSpec	object	PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the cassandra pods	false
racks	[]object	A list of the named racks in the datacenter, representing independent failure domains. The number of racks should match the replication factor in the keyspaces you plan to create, and the number of racks cannot easily be changed once a datacenter is deployed.	false
replaceNodes	[]string	DEPRECATED Use CassandraTask replacenode to achieve correct node replacement. A list of pod names that need to be replaced.	false
resources	object	Kubernetes resource requests and limits, per pod	false
rollingRestartRequested	boolean	DEPRECATED. Use CassandraTask for rolling restarts. Whether to do a rolling restart at the next opportunity. The operator will set this back to false once the restart is in progress.	false
serverImage	string	Cassandra server image name. Use of ImageConfig to match ServerVersion is recommended instead of this value. This value will override anything set in the ImageConfig matching the ServerVersion More info: https://kubernetes.io/docs/concepts/containers/images	false
serviceAccount	string	The k8s service account to use for the server pods	false
stopped	boolean	A stopped CassandraDatacenter will have no running server pods, like using "stop" with traditional System V init scripts. Other Kubernetes resources will be left intact, and volumes will re-attach when the CassandraDatacenter workload is resumed.	false
superuserSecretName	string	This secret defines the username and password for the Cassandra server superuser. If it is omitted, we will generate a secret instead.	false
systemLoggerImage	string	Container image for the log tailing sidecar container. Overrides value from ImageConfig SystemLoggerImage	false
systemLoggerResources	object	Kubernetes resource requests and limits per system logger container.	false
tolerations	[]object	Tolerations applied to the Cassandra pod. Note that these cannot be overridden with PodTemplateSpec.	false
users	[]object	Cassandra users to bootstrap	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig

^{^{↩ Parent}}

StorageConfig describes the persistent storage request of each server node

Name	Type	Description	Required
additionalVolumes	[]object		false
cassandraDataVolumeClaimSpec	object	PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index]

^{^{↩ Parent}}

AdditionalVolumes defines additional storage configurations

Name	Type	Description	Required
mountPath	string	Mount path into cassandra container	true
name	string	Name of the pvc / volume	true
pvcSpec	object	PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.	false
volumeSource	object	VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec

^{^{↩ Parent}}

PVCSpec is a persistent volume claim spec. Either this or VolumeSource is required.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.dataSourceRef

^{^{↩ Parent}}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource

^{^{↩ Parent}}

VolumeSource to mount the volume from (such as ConfigMap / Secret). This or PVCSpec is required.

Name	Type	Description	Required
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.awsElasticBlockStore

^{^{↩ Parent}}

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.azureDisk

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.azureFile

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.cephfs

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.cephfs.secretRef

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.cinder

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.cinder.secretRef

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.configMap

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.csi

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.csi.nodePublishSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.downwardAPI

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.emptyDir

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.ephemeral

^{^{↩ Parent}}

ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.fc

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.flexVolume

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.flexVolume.secretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.flocker

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.gcePersistentDisk

^{^{↩ Parent}}

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.gitRepo

^{^{↩ Parent}}

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.glusterfs

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.hostPath

^{^{↩ Parent}}

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.iscsi

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.iscsi.secretRef

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.nfs

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.persistentVolumeClaim

^{^{↩ Parent}}

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.photonPersistentDisk

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.portworxVolume

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].configMap

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].secret

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.quobyte

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.rbd

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.rbd.secretRef

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.scaleIO

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.scaleIO.secretRef

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.secret

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.storageos

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.storageos.secretRef

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].volumeSource.vsphereVolume

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec

^{^{↩ Parent}}

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.dataSource

^{^{↩ Parent}}

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.dataSourceRef

^{^{↩ Parent}}

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig

^{^{↩ Parent}}

AdditionalServiceConfig allows to define additional parameters that are included in the created Services. Note, user can override values set by cass-operator and doing so could break cass-operator functionality. Avoid label “cass-operator” and anything that starts with “cassandra.datastax.com/”

Name	Type	Description	Required
additionalSeedService	object	ServiceConfigAdditions exposes additional options for each service	false
allpodsService	object	ServiceConfigAdditions exposes additional options for each service	false
dcService	object	ServiceConfigAdditions exposes additional options for each service	false
nodePortService	object	ServiceConfigAdditions exposes additional options for each service	false
seedService	object	ServiceConfigAdditions exposes additional options for each service	false

CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.additionalSeedService

^{^{↩ Parent}}

ServiceConfigAdditions exposes additional options for each service

Name	Type	Description	Required
additionalAnnotations	map[string]string		false
additionalLabels	map[string]string		false

CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.allpodsService

^{^{↩ Parent}}

ServiceConfigAdditions exposes additional options for each service

Name	Type	Description	Required
additionalAnnotations	map[string]string		false
additionalLabels	map[string]string		false

CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.dcService

^{^{↩ Parent}}

ServiceConfigAdditions exposes additional options for each service

Name	Type	Description	Required
additionalAnnotations	map[string]string		false
additionalLabels	map[string]string		false

CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.nodePortService

^{^{↩ Parent}}

ServiceConfigAdditions exposes additional options for each service

Name	Type	Description	Required
additionalAnnotations	map[string]string		false
additionalLabels	map[string]string		false

CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.seedService

^{^{↩ Parent}}

ServiceConfigAdditions exposes additional options for each service

Name	Type	Description	Required
additionalAnnotations	map[string]string		false
additionalLabels	map[string]string		false

CassandraBackup.status.cassdcTemplateSpec.spec.cdc

^{^{↩ Parent}}

CDC allows configuration of the change data capture agent which can run within the Management API container. Use it to send data to Pulsar.

Name	Type	Required
pulsarServiceUrl	string	true
cdcConcurrentProcessors	integer	false
cdcPollIntervalM	integer	false
cdcWorkingDir	string	false
errorCommitLogReprocessEnabled	boolean	false
pulsarAuthParams	string	false
pulsarAuthPluginClassName	string	false
pulsarBatchDelayInMs	integer	false
pulsarKeyBasedBatcher	boolean	false
pulsarMaxPendingMessages	integer	false
pulsarMaxPendingMessagesAcrossPartitions	integer	false
sslAllowInsecureConnection	string	false
sslCipherSuites	string	false
sslEnabledProtocols	string	false
sslHostnameVerificationEnable	string	false
sslKeystorePassword	string	false
sslKeystorePath	string	false
sslProvider	string	false
sslTruststorePassword	string	false
sslTruststorePath	string	false
sslTruststoreType	string	false
topicPrefix	string	false

CassandraBackup.status.cassdcTemplateSpec.spec.configBuilderResources

^{^{↩ Parent}}

Kubernetes resource requests and limits per server config initialization container.

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.dseWorkloads

^{^{↩ Parent}}

Name	Type	Required
analyticsEnabled	boolean	false
graphEnabled	boolean	false
searchEnabled	boolean	false

CassandraBackup.status.cassdcTemplateSpec.spec.managementApiAuth

^{^{↩ Parent}}

Config for the Management API certificates

Name	Type	Description	Required
insecure	object		false
manual	object		false

CassandraBackup.status.cassdcTemplateSpec.spec.managementApiAuth.manual

^{^{↩ Parent}}

Name	Type	Required
clientSecretName	string	true
serverSecretName	string	true
skipSecretValidation	boolean	false

CassandraBackup.status.cassdcTemplateSpec.spec.networking

^{^{↩ Parent}}

Name	Type	Description	Required
hostNetwork	boolean		false
nodePort	object		false

CassandraBackup.status.cassdcTemplateSpec.spec.networking.nodePort

^{^{↩ Parent}}

Name	Type	Required
internode	integer	false
internodeSSL	integer	false
native	integer	false
nativeSSL	integer	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec

^{^{↩ Parent}}

PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the cassandra pods

Name	Type	Description	Required
metadata	object	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata	false
spec	object	Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec

^{^{↩ Parent}}

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name	Type	Description	Required
containers	[]object	List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.	true
activeDeadlineSeconds	integer	Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. Format: int64	false
affinity	object	If specified, the pod's scheduling constraints	false
automountServiceAccountToken	boolean	AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.	false
dnsConfig	object	Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.	false
dnsPolicy	string	Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.	false
enableServiceLinks	boolean	EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.	false
ephemeralContainers	[]object	List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.	false
hostAliases	[]object	HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.	false
hostIPC	boolean	Use the host's ipc namespace. Optional: Default to false.	false
hostNetwork	boolean	Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.	false
hostPID	boolean	Use the host's pid namespace. Optional: Default to false.	false
hostUsers	boolean	Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.	false
hostname	string	Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.	false
imagePullSecrets	[]object	ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
initContainers	[]object	List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/	false
nodeName	string	NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.	false
nodeSelector	map[string]string	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/	false
os	object	Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup	false
overhead	map[string]int or string	Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md	false
preemptionPolicy	string	PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.	false
priority	integer	The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. Format: int32	false
priorityClassName	string	If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.	false
readinessGates	[]object	If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates	false
restartPolicy	string	Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy	false
runtimeClassName	string	RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class	false
schedulerName	string	If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.	false
securityContext	object	SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.	false
serviceAccount	string	DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.	false
serviceAccountName	string	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/	false
setHostnameAsFQDN	boolean	If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.	false
shareProcessNamespace	boolean	Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.	false
subdomain	string	If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. Format: int64	false
tolerations	[]object	If specified, the pod's tolerations.	false
topologySpreadConstraints	[]object	TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.	false
volumes	[]object	List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index]

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable’s value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod’s namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].resources

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext

^{^{↩ Parent}}

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity

^{^{↩ Parent}}

If specified, the pod’s scheduling constraints

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.dnsConfig

^{^{↩ Parent}}

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

Name	Type	Description	Required
nameservers	[]string	A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.	false
options	[]object	A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.	false
searches	[]string	A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.dnsConfig.options[index]

^{^{↩ Parent}}

PodDNSConfigOption defines DNS resolver options of a pod.

Name	Type	Description	Required
name	string	Required.	false
value	string		false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index]

^{^{↩ Parent}}

An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation. To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.

Name	Type	Description	Required
name	string	Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.	true
args	[]string	Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Lifecycle is not allowed for ephemeral containers.	false
livenessProbe	object	Probes are not allowed for ephemeral containers.	false
ports	[]object	Ports are not allowed for ephemeral containers.	false
readinessProbe	object	Probes are not allowed for ephemeral containers.	false
resources	object	Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.	false
securityContext	object	Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.	false
startupProbe	object	Probes are not allowed for ephemeral containers.	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
targetContainerName	string	If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable’s value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod’s namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle

^{^{↩ Parent}}

Lifecycle is not allowed for ephemeral containers.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].resources

^{^{↩ Parent}}

Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext

^{^{↩ Parent}}

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.hostAliases[index]

^{^{↩ Parent}}

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.

Name	Type	Description	Required
hostnames	[]string	Hostnames for the above IP address.	false
ip	string	IP address of the host file entry.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.imagePullSecrets[index]

^{^{↩ Parent}}

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index]

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable’s value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod’s namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].resources

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext

^{^{↩ Parent}}

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.os

^{^{↩ Parent}}

Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup

Name	Type	Description	Required
name	string	Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.readinessGates[index]

^{^{↩ Parent}}

PodReadinessGate contains the reference to a pod condition

Name	Type	Description	Required
conditionType	string	ConditionType refers to a condition in the pod's condition list with matching type.	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext

^{^{↩ Parent}}

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

Name	Type	Description	Required
fsGroup	integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.	false
supplementalGroups	[]integer	A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.	false
sysctls	[]object	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext.sysctls[index]

^{^{↩ Parent}}

Sysctl defines a kernel parameter to be set

Name	Type	Description	Required
name	string	Name of a property to set	true
value	string	Value of a property to set	true

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.topologySpreadConstraints[index]

^{^{↩ Parent}}

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Name	Type	Description	Required
maxSkew	integer	MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. \| zone1 \| zone2 \| zone3 \| \| P P \| P P \| P \| - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. Format: int32	true
topologyKey	string	TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.	true
whenUnsatisfiable	string	WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.	true
labelSelector	object	LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.	false
minDomains	integer	MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: \| zone1 \| zone2 \| zone3 \| \| P P \| P P \| P P \| The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default). Format: int32	false
nodeAffinityPolicy	string	NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.	false
nodeTaintsPolicy	string	NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.topologySpreadConstraints[index].labelSelector

^{^{↩ Parent}}

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index]

^{^{↩ Parent}}

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Type	Description	Required
name	string	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true
awsElasticBlockStore	object	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	azureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	configMap represents a configMap that should populate this volume	false
csi	object	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	downwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	portworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	projected items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].awsElasticBlockStore

^{^{↩ Parent}}

Name	Type	Description	Required
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].azureDisk

^{^{↩ Parent}}

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	diskName is the Name of the data disk in the blob storage	true
diskURI	string	diskURI is the URI of data disk in the blob storage	true
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.	false
fsType	string	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].azureFile

^{^{↩ Parent}}

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	shareName is the azure share Name	true
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].cephfs

^{^{↩ Parent}}

cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
monitors	[]string	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].cephfs.secretRef

^{^{↩ Parent}}

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].cinder

^{^{↩ Parent}}

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].cinder.secretRef

^{^{↩ Parent}}

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].configMap

^{^{↩ Parent}}

configMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].csi

^{^{↩ Parent}}

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].csi.nodePublishSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].downwardAPI

^{^{↩ Parent}}

downwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].emptyDir

^{^{↩ Parent}}

emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral

^{^{↩ Parent}}

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].fc

^{^{↩ Parent}}

fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	lun is Optional: FC target lun number Format: int32	false
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	targetWWNs is Optional: FC target worldwide names (WWNs)	false
wwids	[]string	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].flexVolume

^{^{↩ Parent}}

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	driver is the name of the driver to use for this volume.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	options is Optional: this field holds extra command options if any.	false
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].flexVolume.secretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].flocker

^{^{↩ Parent}}

flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].gcePersistentDisk

^{^{↩ Parent}}

Name	Type	Description	Required
pdName	string	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].gitRepo

^{^{↩ Parent}}

Name	Type	Description	Required
repository	string	repository is the URL	true
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	revision is the commit hash for the specified revision.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].glusterfs

^{^{↩ Parent}}

glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].hostPath

^{^{↩ Parent}}

Name	Type	Description	Required
path	string	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].iscsi

^{^{↩ Parent}}

iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	iqn is the target iSCSI Qualified Name.	true
lun	integer	lun represents iSCSI Target Lun number. Format: int32	true
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication	false
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.	false
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	secretRef is the CHAP Secret for iSCSI target and initiator authentication	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].iscsi.secretRef

^{^{↩ Parent}}

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].nfs

^{^{↩ Parent}}

nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].persistentVolumeClaim

^{^{↩ Parent}}

Name	Type	Description	Required
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].photonPersistentDisk

^{^{↩ Parent}}

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	pdID is the ID that identifies Photon Controller persistent disk	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].portworxVolume

^{^{↩ Parent}}

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	volumeID uniquely identifies a Portworx volume	true
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected

^{^{↩ Parent}}

projected items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	sources is the list of volume projections	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
configMap	object	configMap information about the configMap data to project	false
downwardAPI	object	downwardAPI information about the downwardAPI data to project	false
secret	object	secret information about the secret data to project	false
serviceAccountToken	object	serviceAccountToken is information about the serviceAccountToken data to project	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].configMap

^{^{↩ Parent}}

configMap information about the configMap data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional specify whether the ConfigMap or its keys must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].downwardAPI

^{^{↩ Parent}}

downwardAPI information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].secret

^{^{↩ Parent}}

secret information about the secret data to project

Name	Type	Description	Required
items	[]object	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	optional field specify whether the Secret or its key must be defined	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

serviceAccountToken is information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	path is the path relative to the mount point of the file to project the token into.	true
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].quobyte

^{^{↩ Parent}}

quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

Name	Type	Description	Required
registry	string	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	volume is a string that references an already created Quobyte volume by name.	true
group	string	group to map volume access to Default is no group	false
readOnly	boolean	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	user to map volume access to Defaults to serivceaccount user	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].rbd

^{^{↩ Parent}}

rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].rbd.secretRef

^{^{↩ Parent}}

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].scaleIO

^{^{↩ Parent}}

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	gateway is the host address of the ScaleIO API Gateway.	true
secretRef	object	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	system is the name of the storage system as configured in ScaleIO.	true
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false	false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].scaleIO.secretRef

^{^{↩ Parent}}

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].secret

^{^{↩ Parent}}

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	optional field specify whether the Secret or its keys must be defined	false
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	key is the key to project.	true
path	string	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].storageos

^{^{↩ Parent}}

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].storageos.secretRef

^{^{↩ Parent}}

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].vsphereVolume

^{^{↩ Parent}}

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	volumePath is the path that identifies vSphere volume vmdk	true
fsType	string	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index]

^{^{↩ Parent}}

Rack …

Name	Type	Description	Required
name	string	The rack name	true
affinity	object	Affinity rules to set for this rack only. Merged with values from PodTemplateSpec Affinity as well as NodeAffinityLabels. If you wish to override all the default PodAntiAffinity rules, set allowMultipleWorkers to true, otherwise defaults are applied and then these Affinity settings are merged.	false
nodeAffinityLabels	map[string]string	NodeAffinityLabels to pin the rack, using node affinity	false
zone	string	Deprecated. Use nodeAffinityLabels instead. Zone name to pin the rack, using node affinity	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity

^{^{↩ Parent}}

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

CassandraBackup.status.cassdcTemplateSpec.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

CassandraBackup.status.cassdcTemplateSpec.spec.resources

^{^{↩ Parent}}

Kubernetes resource requests and limits, per pod

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.systemLoggerResources

^{^{↩ Parent}}

Kubernetes resource requests and limits per system logger container.

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

CassandraBackup.status.cassdcTemplateSpec.spec.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

CassandraBackup.status.cassdcTemplateSpec.spec.users[index]

^{^{↩ Parent}}

Name	Type	Description	Required
secretName	string		true
superuser	boolean		true

CassandraRestore

^{^{↩ Parent}}

CassandraRestore is the Schema for the cassandrarestores API

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	CassandraRestore	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	CassandraRestoreSpec defines the desired state of CassandraRestore	false
status	object	CassandraRestoreStatus defines the observed state of CassandraRestore	false

CassandraRestore.spec

^{^{↩ Parent}}

CassandraRestoreSpec defines the desired state of CassandraRestore

Name	Type	Description	Required
backup	string	The name of the CassandraBackup to restore	true
cassandraDatacenter	object		true
inPlace	boolean	When true the restore will be performed on the source cluster from which the backup was taken. There will be a rolling restart of the source cluster.	true
shutdown	boolean	When set to true, the cluster is shutdown before the restore is applied. This is necessary process if there are schema changes between the backup and current schema. Recommended.	true

CassandraRestore.spec.cassandraDatacenter

^{^{↩ Parent}}

Name	Type	Description	Required
clusterName	string	The name to give the C* cluster.	true
name	string	The name to give the new, restored CassandraDatacenter	true

CassandraRestore.status

^{^{↩ Parent}}

CassandraRestoreStatus defines the observed state of CassandraRestore

Name	Type	Description	Required
restoreKey	string	A unique key that identifies the restore operation.	true
datacenterStopped	string	Format: date-time	false
failed	[]string		false
finishTime	string	Format: date-time	false
finished	[]string		false
inProgress	[]string		false
startTime	string	Format: date-time	false

MedusaBackupJob

^{^{↩ Parent}}

MedusaBackupJob is the Schema for the medusabackupjobs API

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	MedusaBackupJob	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	MedusaBackupJobSpec defines the desired state of MedusaBackupJob	false
status	object	MedusaBackupJobStatus defines the observed state of MedusaBackupJob	false

MedusaBackupJob.spec

^{^{↩ Parent}}

MedusaBackupJobSpec defines the desired state of MedusaBackupJob

Name	Type	Description	Required
cassandraDatacenter	string	The name of the CassandraDatacenter to back up	true
backupType	enum	The type of the backup: "full" or "differential" Enum: differential, full Default: differential	false

MedusaBackupJob.status

^{^{↩ Parent}}

MedusaBackupJobStatus defines the observed state of MedusaBackupJob

Name	Type	Description	Required
failed	[]string		false
finishTime	string	Format: date-time	false
finished	[]string		false
inProgress	[]string		false
startTime	string	Format: date-time	false

MedusaBackup

^{^{↩ Parent}}

MedusaBackup is the Schema for the medusabackups API

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	MedusaBackup	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	MedusaBackupSpec defines the desired state of MedusaBackup	false
status	object	MedusaBackupStatus defines the observed state of MedusaBackup	false

MedusaBackup.spec

^{^{↩ Parent}}

MedusaBackupSpec defines the desired state of MedusaBackup

Name	Type	Description	Required
cassandraDatacenter	string	The name of the CassandraDatacenter to back up	true
backupType	enum	The type of the backup: "full" or "differential" Enum: differential, full Default: differential	false

MedusaBackup.status

^{^{↩ Parent}}

MedusaBackupStatus defines the observed state of MedusaBackup

Name	Type	Description	Required
finishTime	string	Format: date-time	false
finishedNodes	integer	Format: int32	false
nodes	[]object		false
startTime	string	Format: date-time	false
status	string		false
totalFiles	integer	Format: int64	false
totalNodes	integer	Format: int32	false
totalSize	string		false

MedusaBackup.status.nodes[index]

^{^{↩ Parent}}

Name	Type	Required
datacenter	string	false
host	string	false
rack	string	false
tokens	[]integer	false

MedusaBackupSchedule

^{^{↩ Parent}}

MedusaBackupSchedule is the Schema for the medusabackupschedules API

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	MedusaBackupSchedule	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	MedusaBackupScheduleSpec defines the desired state of MedusaBackupSchedule	false
status	object	MedusaBackupScheduleStatus defines the observed state of MedusaBackupSchedule	false

MedusaBackupSchedule.spec

^{^{↩ Parent}}

MedusaBackupScheduleSpec defines the desired state of MedusaBackupSchedule

Name	Type	Description	Required
backupSpec	object	BackupSpec defines the MedusaBackup to be created for this job	true
cronSchedule	string	CronSchedule is a cronjob format schedule for backups. Overrides any easier methods of defining the schedule	true
concurrencyPolicy	string	Specifics if this backup task can be run concurrently with other active backup tasks. Valid values are: - "Allow": allows multiple Tasks to run concurrently on Cassandra cluster - "Forbid" (default): only a single task is executed at once The "Allow" property is only valid if all the other active Tasks have "Allow" as well.	false
disabled	boolean	Disabled if set ensures this job is not scheduling anything	false
operationType	enum	Specifies the type of operation to be performed Enum: backup, purge Default: backup	false

MedusaBackupSchedule.spec.backupSpec

^{^{↩ Parent}}

BackupSpec defines the MedusaBackup to be created for this job

Name	Type	Description	Required
cassandraDatacenter	string	The name of the CassandraDatacenter to back up	true
backupType	enum	The type of the backup: "full" or "differential" Enum: differential, full Default: differential	false

MedusaBackupSchedule.status

^{^{↩ Parent}}

MedusaBackupScheduleStatus defines the observed state of MedusaBackupSchedule

Name	Type	Description	Required
lastExecution	string	LastExecution tells when the backup was last time taken. If empty, the backup has never been taken Format: date-time	false
nextSchedule	string	NextSchedule indicates when the next backup is going to be done Format: date-time	false

MedusaConfiguration

^{^{↩ Parent}}

MedusaConfiguration is the Schema for the medusaconfigurations API

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	MedusaConfiguration	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	MedusaConfigurationSpec defines the desired state of MedusaConfiguration	false
status	object	MedusaConfigurationStatus defines the observed state of MedusaConfiguration	false

MedusaConfiguration.spec

^{^{↩ Parent}}

MedusaConfigurationSpec defines the desired state of MedusaConfiguration

Name	Type	Description	Required
storageProperties	object	StorageProperties defines the storage backend settings to use for the backups.	false

MedusaConfiguration.spec.storageProperties

^{^{↩ Parent}}

StorageProperties defines the storage backend settings to use for the backups.

Name	Type	Description	Required
apiProfile	string	AWS Profile to use for authentication.	false
backupGracePeriodInDays	integer	Age after which orphan sstables can be deleted from the storage backend. Protects from race conditions between purge and ongoing backups. Defaults to 10 days.	false
bucketName	string	The name of the bucket to use for the backups.	false
concurrentTransfers	integer	Number of concurrent uploads. Helps maximizing the speed of uploads but puts more pressure on the network. Defaults to 0. Default: 0	false
credentialsType	enum	Type of credentials to use for authentication. Can be "role-based", "credential-based" or empty. Enum: role-based, credential-based	false
host	string	Host to connect to for the storage backend.	false
maxBackupAge	integer	Maximum backup age that the purge process should observe. Default: 0	false
maxBackupCount	integer	Maximum number of backups to keep (used by the purge process). Default is unlimited. Default: 0	false
multiPartUploadThreshold	integer	File size over which cloud specific cli tools are used for transfer. Defaults to 100 MB. Default: 104857600	false
podStorage	object	Pod storage settings for the local storage provider	false
port	integer	Port to connect to for the storage backend.	false
prefix	string	Name of the top level folder in the backup bucket. If empty, the cluster name will be used.	false
region	string	Region of the storage bucket. Defaults to "default".	false
secure	boolean	Whether to use SSL for the storage backend.	false
sslVerify	boolean	When using SSL, whether to also verify the certificate.	false
storageProvider	enum	The storage backend to use for the backups. Enum: google_storage, azure_blobs, s3, s3_compatible, s3_rgw, ibm_storage	false
storageSecretRef	object	Kubernetes Secret that stores the key file for the storage provider's API. If using 'local' storage, this value is ignored.	false
transferMaxBandwidth	string	Max upload bandwidth in MB/s. Defaults to 50 MB/s. Default: 50MB/s	false

MedusaConfiguration.spec.storageProperties.podStorage

^{^{↩ Parent}}

Pod storage settings for the local storage provider

Name	Type	Description	Required
accessModes	[]string	Pod local storage access modes	false
size	int or string	Size of the pod's storage in bytes. Defaults to 10 GB. Default: 10Gi	false
storageClassName	string	Storage class name to use for the pod's storage.	false

MedusaConfiguration.spec.storageProperties.storageSecretRef

^{^{↩ Parent}}

Kubernetes Secret that stores the key file for the storage provider’s API. If using ‘local’ storage, this value is ignored.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

MedusaConfiguration.status

^{^{↩ Parent}}

MedusaConfigurationStatus defines the observed state of MedusaConfiguration

Name	Type	Description	Required
conditions	[]object		false

MedusaConfiguration.status.conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

This struct is intended for direct use as an array at the field path .status.conditions. For example,

type FooStatus struct{
    // Represents the observations of a foo's current state.
    // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
    // +patchMergeKey=type
    // +patchStrategy=merge
    // +listType=map
    // +listMapKey=type
    Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`


    // other fields
}

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

MedusaRestoreJob

^{^{↩ Parent}}

MedusaRestoreJob is the Schema for the medusarestorejobs API

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	MedusaRestoreJob	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	MedusaRestoreJobSpec defines the desired state of MedusaRestoreJob	false
status	object	MedusaRestoreJobStatus defines the observed state of MedusaRestoreJob	false

MedusaRestoreJob.spec

^{^{↩ Parent}}

MedusaRestoreJobSpec defines the desired state of MedusaRestoreJob

Name	Type	Description	Required
backup	string	The name of the MedusaBackup to restore.	true
cassandraDatacenter	string	Name of the Cassandra datacenter to perform the restore on.	true

MedusaRestoreJob.status

^{^{↩ Parent}}

MedusaRestoreJobStatus defines the observed state of MedusaRestoreJob

Name	Type	Description	Required
restoreKey	string	A unique key that identifies the restore operation.	true
datacenterStopped	string	Format: date-time	false
failed	[]string		false
finishTime	string	Format: date-time	false
finished	[]string		false
inProgress	[]string		false
message	string	Message gives the reason why restore operation failed	false
restoreMapping	object	Mapping between source and target nodes for a restore	false
restorePrepared	boolean		false
startTime	string	Format: date-time	false

MedusaRestoreJob.status.restoreMapping

^{^{↩ Parent}}

Mapping between source and target nodes for a restore

Name	Type	Description	Required
host_map	map[string]object	Mapping between source and target nodes for a restore	false
in_place	boolean	Whether the restore is in-place or not	false

MedusaRestoreJob.status.restoreMapping.host_map[key]

^{^{↩ Parent}}

Name	Type	Description	Required
seed	boolean		true
source	[]string		true

Medusa

^{^{↩ Parent}}

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	Medusa	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	MedusaSpec defines the desired state of Medusa.	false

Medusa.spec

^{^{↩ Parent}}

MedusaSpec defines the desired state of Medusa.

Name	Type	Description	Required
cassandraUserSecretRef	string	Defines the username and password that Medusa will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Medusa instances, so that it can authenticate against nodes in the datacenter using CQL. The secret must be in the same namespace as Cassandra and must contain two keys: "username" and "password".	false
containerImage	object	MedusaContainerImage is the image characteristics to use for Medusa containers. Leave nil to use a default image.	false
securityContext	object	SecurityContext applied to the Medusa containers.	false
storageProperties	object	Provides all storage backend related properties for backups.	false

Medusa.spec.containerImage

^{^{↩ Parent}}

MedusaContainerImage is the image characteristics to use for Medusa containers. Leave nil to use a default image.

Name	Type	Description	Required
repository	string	Default: k8ssandra/medusa	true
imagePullSecret	object	LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.	false
pullPolicy	string	PullPolicy describes a policy for if/when to pull a container image Default: IfNotPresent	false
registry	string	Default: docker.io	false
tag	string	Default: latest	false

Medusa.spec.containerImage.imagePullSecret

^{^{↩ Parent}}

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Medusa.spec.securityContext

^{^{↩ Parent}}

SecurityContext applied to the Medusa containers.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

Medusa.spec.securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

Medusa.spec.securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

Medusa.spec.securityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

Medusa.spec.securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

Medusa.spec.storageProperties

^{^{↩ Parent}}

Provides all storage backend related properties for backups.

Name	Type	Description	Required
apiProfile	string	AWS Profile to use for authentication.	false
backupGracePeriodInDays	integer	Age after which orphan sstables can be deleted from the storage backend. Protects from race conditions between purge and ongoing backups. Defaults to 10 days.	false
bucketName	string	The name of the bucket to use for the backups.	false
concurrentTransfers	integer	Number of concurrent uploads. Helps maximizing the speed of uploads but puts more pressure on the network. Defaults to 1. Default: 1	false
host	string	Host to connect to for the storage backend.	false
maxBackupAge	integer	Maximum backup age that the purge process should observe. Default: 0	false
maxBackupCount	integer	Maximum number of backups to keep (used by the purge process). Default is unlimited. Default: 0	false
multiPartUploadThreshold	integer	File size over which cloud specific cli tools are used for transfer. Defaults to 100 MB. Default: 104857600	false
port	integer	Port to connect to for the storage backend.	false
prefix	string	Name of the top level folder in the backup bucket. If empty, the cluster name will be used.	false
region	string	Region of the storage bucket. Defaults to "default".	false
secure	boolean	Whether to use SSL for the storage backend.	false
storageProvider	enum	The storage backend to use for the backups. Enum: local, google_storage, azure_blobs, s3, s3_compatible, s3_rgw, ibm_storage	false
storageSecretRef	string	Kubernetes Secret that stores the key file for the storage provider's API. If using 'local' storage, this value is ignored.	false
transferMaxBandwidth	string	Max upload bandwidth in MB/s. Defaults to 50 MB/s. Default: 50MB/s	false

MedusaTask

^{^{↩ Parent}}

MedusaTask is the Schema for the MedusaTasks API

Name	Type	Description	Required
apiVersion	string	medusa.k8ssandra.io/v1alpha1	true
kind	string	MedusaTask	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	MedusaTaskSpec defines the desired state of MedusaTask	false
status	object	MedusaTaskStatus defines the observed state of MedusaTask	false

MedusaTask.spec

^{^{↩ Parent}}

MedusaTaskSpec defines the desired state of MedusaTask

Name	Type	Description	Required
cassandraDatacenter	string	The name of the CassandraDatacenter to run the task on	true
backupName	string	Name of the backup. Will be necessary for operations such as verify or status.	false
operation	enum	Requested operation to perform. Enum: sync, purge, prepare_restore	false
restoreKey	string	Restore key to use for the prepare_restore operation.	false

MedusaTask.status

^{^{↩ Parent}}

MedusaTaskStatus defines the observed state of MedusaTask

Name	Type	Description	Required
failed	[]string		false
finishTime	string	Format: date-time	false
finished	[]object		false
inProgress	[]string		false
startTime	string	Format: date-time	false

MedusaTask.status.finished[index]

^{^{↩ Parent}}

Name	Type	Description	Required
nbBackupsPurged	integer	Number of backups that were purged. Only populated for purge tasks.	false
nbObjectsPurged	integer	Number of objects/files that were purged. Only populated for purge tasks.	false
podName	string	Name of the pod that ran the task. Always populated.	false
totalObjectsWithinGcGrace	integer	Number of objects that couldn't be deleted due to Medusa GC grace. Only populated for purge tasks.	false
totalPurgedSize	integer	Total size of purged files. Only populated for purge tasks.	false

reaper.k8ssandra.io/v1alpha1

Resource Types:

Reaper

Reaper

^{^{↩ Parent}}

Reaper is the Schema for the reapers API

Name	Type	Description	Required
apiVersion	string	reaper.k8ssandra.io/v1alpha1	true
kind	string	Reaper	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	ReaperSpec defines the desired state of Reaper	false
status	object	ReaperStatus defines the observed state of Reaper	false

Reaper.spec

^{^{↩ Parent}}

ReaperSpec defines the desired state of Reaper

Name	Type	Description	Required
ServiceAccountName	string	Default: default	false
affinity	object	Affinity applied to the Reaper pods.	false
autoScheduling	object	Auto scheduling properties. When you enable the auto-schedule feature, Reaper dynamically schedules repairs for all non-system keyspaces in a cluster. A cluster's keyspaces are monitored and any modifications (additions or removals) are detected. When a new keyspace is created, a new repair schedule is created automatically for that keyspace. Conversely, when a keyspace is removed, the corresponding repair schedule is deleted.	false
cassandraUserSecretRef	object	Defines the username and password that Reaper will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Reaper instance, so that it can authenticate against nodes in the datacenter using CQL. If CQL authentication is not required, leave this field empty. The secret must be in the same namespace as Reaper itself and must contain two keys: "username" and "password".	false
clientEncryptionStores	object	Client encryption stores which are used by Cassandra and Reaper.	false
containerImage	object	The image to use for the Reaper pod main container. The default is "thelastpickle/cassandra-reaper:3.6.1". TODO: update with real release version. Default: map[name:cassandra-reaper repository:thelastpickle tag:3.6.1]	false
datacenterAvailability	enum	DatacenterAvailability indicates to Reaper its deployment in relation to the target datacenter's network. For single-DC clusters, the default (ALL) is fine. For multi-DC clusters, it is recommended to use EACH, provided that there is one Reaper instance managing each DC in the cluster; otherwise, if one single Reaper instance is going to manage more than one DC in the cluster, use ALL. See https://cassandra-reaper.io/docs/usage/multi_dc/. Enum: LOCAL, ALL, EACH Default: ALL	false
datacenterRef	object	DatacenterRef is the reference of a CassandraDatacenter resource that this Reaper instance should manage. It will also be used as the backend for persisting Reaper's state. Reaper must be able to access the JMX port (7199 by default) and the CQL port (9042 by default) on this DC.	false
heapSize	int or string	HeapSize sets the JVM heap size to use for Reaper. Default: 2Gi	false
httpManagement	object	Default: map[enabled:false]	false
initContainerImage	object	Deprecated: The main container image will be used for the init container as well.	false
initContainerResources	object	Init Container resources.	false
initContainerSecurityContext	object	InitContainerSecurityContext is the SecurityContext applied to the Reaper init container, used to perform schema migrations.	false
jmxUserSecretRef	object	Deprecated: JMX security is now based on CQL roles. Reaper will use cassandraUsefSecretRef for authentication, this field is ignored.	false
keyspace	string	The keyspace to use to store Reaper's state. Will default to "reaper_db" if unspecified. Will be created if it does not exist, and if this Reaper resource is managed by K8ssandra. Default: reaper_db	false
livenessProbe	object	LivenessProbe sets the Reaper liveness probe. Leave nil to use defaults.	false
metadata	object	labels and annotations for Reaper resources	false
podSecurityContext	object	PodSecurityContext contains a pod-level SecurityContext to apply to Reaper pods.	false
readinessProbe	object	ReadinessProbe sets the Reaper readiness probe. Leave nil to use defaults.	false
resources	object	Main Container resources.	false
secretsProvider	enum	SecretsProvider defines whether the secrets used for credentials and certs will be backed by an external secret backend. This moves the responsibility of generating and storing secrets from the operators to the user and will rely on a mutating webhook to inject the secrets into the necessary resources Enum: internal, external Default: internal	false
securityContext	object	SecurityContext applied to the Reaper main container.	false
skipSchemaMigration	boolean	Whether to skip schema migration. Schema migration is done in an init container on every Reaper deployment and can slow down Reaper's startup time. Besides, schema migration requires reading data at QUORUM. It can be skipped if you know that the schema is already up-to-date, or if you know upfront that QUORUM cannot be achieved (for example, because a DC is down). Default: false	false
storageConfig	object	If StorageType is "local", Reaper will need a Persistent Volume to persist its data. This field allows configuring that Persistent Volume.	false
storageType	enum	The storage backend to store Reaper's data. Defaults to "cassandra" which causes Reaper to be stateless and store its state to a Cassandra cluster it repairs (implying there must be one Reaper for each Cassandra cluster). The "local" option makes Reaper to store its state locally, allowing a single Reaper to repair several clusters. Enum: cassandra, local Default: cassandra	false
telemetry	object	Telemetry defines the desired telemetry integrations to deploy targeting the Reaper pods for all DCs in this cluster (unless overridden by DC specific settings)	false
tolerations	[]object	Tolerations applied to the Reaper pods.	false
uiUserSecretRef	object	Defines the secret which contains the username and password for the Reaper UI and REST API authentication. When UiUserSecretRef.Name == "", authentication is turned off in the front-end only.	false

Reaper.spec.affinity

^{^{↩ Parent}}

Affinity applied to the Reaper pods.

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

Reaper.spec.affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

Reaper.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

Reaper.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

Reaper.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

Reaper.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

Reaper.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.autoScheduling

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	Default: false	false
excludedClusters	[]string	ExcludedClusters are the clusters that are to be excluded from the repair schedule.	false
excludedKeyspaces	[]string	ExcludedKeyspaces are the keyspaces that are to be excluded from the repair schedule.	false
initialDelayPeriod	string	InitialDelay is the amount of delay time before the schedule period starts. Must be a valid ISO-8601 duration string. The default is "PT15S" (15 seconds). Default: PT15S	false
percentUnrepairedThreshold	integer	PercentUnrepairedThreshold is the percentage of unrepaired data over which an incremental repair should be started. Only relevant when using repair type INCREMENTAL. Default: 10 Minimum: 0 Maximum: 100	false
periodBetweenPolls	string	PeriodBetweenPolls is the interval time to wait before checking whether to start a repair task. Must be a valid ISO-8601 duration string. The default is "PT10M" (10 minutes). Default: PT10M	false
repairType	enum	RepairType is the type of repair to create: - REGULAR creates a regular repair (non-adaptive and non-incremental); - ADAPTIVE creates an adaptive repair; adaptive repairs are most suited for Cassandra 3. - INCREMENTAL creates an incremental repair; incremental repairs should only be used with Cassandra 4+. - AUTO chooses between ADAPTIVE and INCREMENTAL depending on the Cassandra server version; ADAPTIVE for Cassandra 3 and INCREMENTAL for Cassandra 4+. Enum: REGULAR, ADAPTIVE, INCREMENTAL, AUTO Default: AUTO	false
scheduleSpreadPeriod	string	ScheduleSpreadPeriod is the time spacing between each of the repair schedules that is to be carried out. Must be a valid ISO-8601 duration string. The default is "PT6H" (6 hours). Default: PT6H	false
timeBeforeFirstSchedule	string	TimeBeforeFirstSchedule is the grace period before the first repair in the schedule is started. Must be a valid ISO-8601 duration string. The default is "PT5M" (5 minutes). Default: PT5M	false

Reaper.spec.cassandraUserSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.clientEncryptionStores

^{^{↩ Parent}}

Client encryption stores which are used by Cassandra and Reaper.

Name	Type	Description	Required
keystoreSecretRef	object	ref to the secret that contains the keystore and optionally its password (which can also be specified through the keystorePasswordSecretRef field) if keys are not specified, "keystore" entry and a "keystore-password" entry will be used	true
truststoreSecretRef	object	ref to the secret that contains the truststore and optionally its password (which can also be specified through the truststorePasswordSecretRef field) if keys are not specified explicitly, "keystore" entry and a "keystore-password" entry will be used	true
keystorePasswordSecretRef	object	ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "keystore-password" entry will be used	false
truststorePasswordSecretRef	object	ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "truststore-password" entry will be used	false

Reaper.spec.clientEncryptionStores.keystoreSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.clientEncryptionStores.truststoreSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.clientEncryptionStores.keystorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “keystore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.clientEncryptionStores.truststorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “truststore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.containerImage

^{^{↩ Parent}}

The image to use for the Reaper pod main container. The default is “thelastpickle/cassandra-reaper:3.6.1”. TODO: update with real release version.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

Reaper.spec.containerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.datacenterRef

^{^{↩ Parent}}

DatacenterRef is the reference of a CassandraDatacenter resource that this Reaper instance should manage. It will also be used as the backend for persisting Reaper’s state. Reaper must be able to access the JMX port (7199 by default) and the CQL port (9042 by default) on this DC.

Name	Type	Description	Required
name	string	The datacenter name.	false
namespace	string	The datacenter namespace. If empty, the datacenter will be assumed to reside in the same namespace as the Reaper instance.	false

Reaper.spec.httpManagement

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	Enable/disable the HTTP management connection between Reaper and Cassandra. When enabled, HTTP will be used instead of JMX for management connectivity between Cassandra and Reaper. In future, this will be true by default Default: false	false
keystores	object	LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.	false

Reaper.spec.httpManagement.keystores

^{^{↩ Parent}}

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.initContainerImage

^{^{↩ Parent}}

Deprecated: The main container image will be used for the init container as well.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

Reaper.spec.initContainerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.initContainerResources

^{^{↩ Parent}}

Init Container resources.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

Reaper.spec.initContainerResources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

Reaper.spec.initContainerSecurityContext

^{^{↩ Parent}}

InitContainerSecurityContext is the SecurityContext applied to the Reaper init container, used to perform schema migrations.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

Reaper.spec.initContainerSecurityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

Reaper.spec.initContainerSecurityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

Reaper.spec.initContainerSecurityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

Reaper.spec.initContainerSecurityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

Reaper.spec.jmxUserSecretRef

^{^{↩ Parent}}

Deprecated: JMX security is now based on CQL roles. Reaper will use cassandraUsefSecretRef for authentication, this field is ignored.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.spec.livenessProbe

^{^{↩ Parent}}

LivenessProbe sets the Reaper liveness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

Reaper.spec.livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

Reaper.spec.livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

Reaper.spec.livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

Reaper.spec.livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

Reaper.spec.livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

Reaper.spec.metadata

^{^{↩ Parent}}

labels and annotations for Reaper resources

Name	Type	Description	Required
annotations	map[string]string		false
commonLabels	map[string]string	labels/annotations that will be applied to all components created by the CRD	false
labels	map[string]string		false
pods	object	labels/annotations for the pod components	false
service	object	labels/annotations for the service component	false

Reaper.spec.metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

Reaper.spec.metadata.service

^{^{↩ Parent}}

labels/annotations for the service component

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

Reaper.spec.podSecurityContext

^{^{↩ Parent}}

PodSecurityContext contains a pod-level SecurityContext to apply to Reaper pods.

Name	Type	Description	Required
fsGroup	integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: The owning GID will be the FSGroup The setgid bit is set (new files created in the volume will be owned by FSGroup) The permission bits are OR’d with rw-rw—- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.	false
supplementalGroups	[]integer	A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.	false
sysctls	[]object	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

Reaper.spec.podSecurityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

Reaper.spec.podSecurityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

Reaper.spec.podSecurityContext.sysctls[index]

^{^{↩ Parent}}

Sysctl defines a kernel parameter to be set

Name	Type	Description	Required
name	string	Name of a property to set	true
value	string	Value of a property to set	true

Reaper.spec.podSecurityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

Reaper.spec.readinessProbe

^{^{↩ Parent}}

ReadinessProbe sets the Reaper readiness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

Reaper.spec.readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

Reaper.spec.readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

Reaper.spec.readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

Reaper.spec.readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

Reaper.spec.readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

Reaper.spec.resources

^{^{↩ Parent}}

Main Container resources.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

Reaper.spec.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

Reaper.spec.securityContext

^{^{↩ Parent}}

SecurityContext applied to the Reaper main container.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

Reaper.spec.securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

Reaper.spec.securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

Reaper.spec.securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.	false

Reaper.spec.securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

Reaper.spec.storageConfig

^{^{↩ Parent}}

If StorageType is “local”, Reaper will need a Persistent Volume to persist its data. This field allows configuring that Persistent Volume.

Name	Type	Description	Required
accessModes	[]string	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.	false
dataSourceRef	object	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false
resources	object	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	selector is a label query over volumes to consider for binding.	false
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.	false

Reaper.spec.storageConfig.dataSource

^{^{↩ Parent}}

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

Reaper.spec.storageConfig.dataSourceRef

^{^{↩ Parent}}

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.	false

Reaper.spec.storageConfig.resources

^{^{↩ Parent}}

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

Reaper.spec.storageConfig.selector

^{^{↩ Parent}}

selector is a label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Reaper.spec.storageConfig.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Reaper.spec.telemetry

^{^{↩ Parent}}

Telemetry defines the desired telemetry integrations to deploy targeting the Reaper pods for all DCs in this cluster (unless overridden by DC specific settings)

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

Reaper.spec.telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

Reaper.spec.telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

Reaper.spec.telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

Reaper.spec.telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

Reaper.spec.telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

Reaper.spec.telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

Reaper.spec.telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

Reaper.spec.telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

Reaper.spec.telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

Reaper.spec.telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

Reaper.spec.telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

Reaper.spec.telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

Reaper.spec.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

Reaper.spec.uiUserSecretRef

^{^{↩ Parent}}

Defines the secret which contains the username and password for the Reaper UI and REST API authentication. When UiUserSecretRef.Name == “”, authentication is turned off in the front-end only.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Reaper.status

^{^{↩ Parent}}

ReaperStatus defines the observed state of Reaper

Name	Type	Description	Required
conditions	[]object		false
progress	enum	Progress is the progress of this Reaper object. Enum: Pending, Deploying, Configuring, Running	false

Reaper.status.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
status	string		true
type	string		true
lastTransitionTime	string	LastTransitionTime is the last time the condition transited from one status to another. Format: date-time	false

replication.k8ssandra.io/v1alpha1

Resource Types:

ReplicatedSecret

ReplicatedSecret

^{^{↩ Parent}}

ReplicatedSecret is the Schema for the replicatedsecrets API

Name	Type	Description	Required
apiVersion	string	replication.k8ssandra.io/v1alpha1	true
kind	string	ReplicatedSecret	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	ReplicatedSecretSpec defines the desired state of ReplicatedSecret	false
status	object	ReplicatedSecretStatus defines the observed state of ReplicatedSecret	false

ReplicatedSecret.spec

^{^{↩ Parent}}

ReplicatedSecretSpec defines the desired state of ReplicatedSecret

Name	Type	Description	Required
replicationTargets	[]object	TargetContexts indicates the target clusters to which the secrets are replicated to. If empty, no clusters are targeted	false
selector	object	Selector defines which secrets are replicated. If left empty, all the secrets are replicated	false

ReplicatedSecret.spec.replicationTargets[index]

^{^{↩ Parent}}

Name	Type	Description	Required
addLabels	map[string]string	AddLabels adds labels to the target secret.	false
dropLabels	[]string	DropLabels defines the labels to be dropped from the secret before replication, this is sometimes neccessary to avoid infinite replication.	false
k8sContextName	string	K8sContextName defines the target cluster name as set in the ClientConfig. If left empty, current cluster is assumed	false
namespace	string	TODO Implement at some point Namespace to replicate the data to in the target cluster. If left empty, current namespace is used.	false
targetPrefix	string	TargetPrefix is the prefix to be used for the replicated secret in the target cluster. If left empty, the same name is used as the original secret.	false

ReplicatedSecret.spec.selector

^{^{↩ Parent}}

Selector defines which secrets are replicated. If left empty, all the secrets are replicated

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

ReplicatedSecret.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

ReplicatedSecret.status

^{^{↩ Parent}}

ReplicatedSecretStatus defines the observed state of ReplicatedSecret

Name	Type	Description	Required
conditions	[]object		false

ReplicatedSecret.status.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
cluster	string	Cluster	true
status	string	Status of the replication to target cluster	true
type	string	Type of condition	true
lastTransitionTime	string	LastTransitionTime is the last time the condition transited from one status to another. Format: date-time	false

stargate.k8ssandra.io/v1alpha1

Resource Types:

Stargate

Stargate

^{^{↩ Parent}}

Stargate is the Schema for the stargates API

Name	Type	Description	Required
apiVersion	string	stargate.k8ssandra.io/v1alpha1	true
kind	string	Stargate	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	Specification of the desired behavior of this Stargate resource.	false
status	object	Most recently observed status of this Stargate resource.	false

Stargate.spec

^{^{↩ Parent}}

Specification of the desired behavior of this Stargate resource.

Name	Type	Description	Required
datacenterRef	object	DatacenterRef is the namespace-local reference of a CassandraDatacenter resource where Stargate should be deployed.	true
size	integer	Size is the number of Stargate instances to deploy in each datacenter. They will be spread evenly across racks. Format: int32 Default: 1 Minimum: 1	true
affinity	object	Affinity is the affinity to apply to all the Stargate pods. Leave nil to let the controller reuse the same affinity rules used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity	false
allowStargateOnDataNodes	boolean	AllowStargateOnDataNodes allows Stargate pods to be scheduled on a worker node already hosting data pods for this datacenter. The default is false, which means that Stargate pods will be scheduled on separate worker nodes. Note: if the datacenter pods have HostNetwork:true, then the Stargate pods will inherit of it, in which case it is possible that Stargate nodes won't be allowed to sit on data nodes even if this property is set to true, because of port conflicts on the same IP address. Default: false	false
auth	boolean	Whether to enable authentication for Stargate. The default is true; it is highly recommended to always leave authentication turned on, not only on Stargate nodes, but also on data nodes as well. Note that Stargate REST APIs are currently only accessible if authentication is enabled, and if the authenticator in use in the whole cluster is PasswordAuthenticator. The usage of any other authenticator will cause the REST API to become inaccessible, see https://github.com/stargate/stargate/issues/792 for more. Stargate CQL API however remains accessible even if authentication is disabled in the cluster, or when a custom authenticator is being used. Default: true	false
authOptions	object	Authentication options.	false
cassandraConfigMapRef	object	CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.	false
cassandraEncryption	object	CassandraEncryption groups together encryption stores that are passed to the Stargate pods, so that they can be mounted as volumes.	false
containerImage	object	ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image. Default: map[repository:stargateio tag:v1.0.77]	false
heapSize	int or string	HeapSize sets the JVM heap size to use for Stargate. If no Resources are specified, this value will also be used to set a default memory request and limit for the Stargate pods: these will be set to HeapSize x2 and x4, respectively. Default: 256Mi	false
livenessProbe	object	LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.	false
metadata	object	labels and annotations for Stargate resources	false
nodeSelector	map[string]string	NodeSelector is an optional map of label keys and values to restrict the scheduling of Stargate nodes to workers with matching labels. Leave nil to let the controller reuse the same node selectors used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector	false
racks	[]object	Racks allow customizing Stargate characteristics for specific racks in the datacenter.	false
readinessProbe	object	ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.	false
resources	object	Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.	false
secretsProvider	enum	SecretsProvider defines whether the secrets used for credentials and certs will be backed by an external secret backend. This moves the responsibility of generating and storing secrets from the operators to the user and will rely on a mutating webhook to inject the secrets into the necessary resources Enum: internal, external Default: internal	false
serviceAccount	string	ServiceAccount is the service account name to use for Stargate pods. Default: default	false
telemetry	object	Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)	false
tolerations	[]object	Tolerations are tolerations to apply to the Stargate pods. Leave nil to let the controller reuse the same tolerations used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/	false

Stargate.spec.datacenterRef

^{^{↩ Parent}}

DatacenterRef is the namespace-local reference of a CassandraDatacenter resource where Stargate should be deployed.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.affinity

^{^{↩ Parent}}

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

Stargate.spec.affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

Stargate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

Stargate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

Stargate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

Stargate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

Stargate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.authOptions

^{^{↩ Parent}}

Authentication options.

Name	Type	Description	Required
apiAuthMethod	enum	The method to use for authenticating requests to the Stargate APIs. Stargate currently has two authentication / authorization methods: - Table: table-based; - JWT: JSON web token (JWT)-based. The methods are mutually exclusive. The default method is Table. Enum: Table, JWT Default: Table	false
providerUrl	string	Required when using JWT authentication method, ignored otherwise.	false
tokenTtlSeconds	integer	The time-to-live in seconds of an API authentication token. Valid only for the Table authentication method. By default, the token persists for 30 minutes with a sliding window. Each use of the token to authenticate resets the 30-minute window. A token created and used after 29 minutes will authenticate a request, but if 31 minutes passes before use, the token will no longer exist. Default is 1800 seconds (30 minutes). Minimum: 1	false

Stargate.spec.cassandraConfigMapRef

^{^{↩ Parent}}

CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.cassandraEncryption

^{^{↩ Parent}}

CassandraEncryption groups together encryption stores that are passed to the Stargate pods, so that they can be mounted as volumes.

Name	Type	Description	Required
clientEncryptionStores	object	Client encryption stores which are used by Cassandra and Reaper.	false
serverEncryptionStores	object	Internode encryption stores which are used by Cassandra and Stargate.	false

Stargate.spec.cassandraEncryption.clientEncryptionStores

^{^{↩ Parent}}

Client encryption stores which are used by Cassandra and Reaper.

Name	Type	Description	Required
keystoreSecretRef	object	ref to the secret that contains the keystore and optionally its password (which can also be specified through the keystorePasswordSecretRef field) if keys are not specified, "keystore" entry and a "keystore-password" entry will be used	true
truststoreSecretRef	object	ref to the secret that contains the truststore and optionally its password (which can also be specified through the truststorePasswordSecretRef field) if keys are not specified explicitly, "keystore" entry and a "keystore-password" entry will be used	true
keystorePasswordSecretRef	object	ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "keystore-password" entry will be used	false
truststorePasswordSecretRef	object	ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "truststore-password" entry will be used	false

Stargate.spec.cassandraEncryption.clientEncryptionStores.keystoreSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.cassandraEncryption.clientEncryptionStores.truststoreSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.cassandraEncryption.clientEncryptionStores.keystorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “keystore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.cassandraEncryption.clientEncryptionStores.truststorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “truststore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.cassandraEncryption.serverEncryptionStores

^{^{↩ Parent}}

Internode encryption stores which are used by Cassandra and Stargate.

Name	Type	Description	Required
keystoreSecretRef	object	ref to the secret that contains the keystore and optionally its password (which can also be specified through the keystorePasswordSecretRef field) if keys are not specified, "keystore" entry and a "keystore-password" entry will be used	true
truststoreSecretRef	object	ref to the secret that contains the truststore and optionally its password (which can also be specified through the truststorePasswordSecretRef field) if keys are not specified explicitly, "keystore" entry and a "keystore-password" entry will be used	true
keystorePasswordSecretRef	object	ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "keystore-password" entry will be used	false
truststorePasswordSecretRef	object	ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn't specified explicitly, "truststore-password" entry will be used	false

Stargate.spec.cassandraEncryption.serverEncryptionStores.keystoreSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.cassandraEncryption.serverEncryptionStores.truststoreSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.cassandraEncryption.serverEncryptionStores.keystorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the keystore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “keystore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.cassandraEncryption.serverEncryptionStores.truststorePasswordSecretRef

^{^{↩ Parent}}

ref to the secret that contains the truststore password if password stored in different secret than keystoreSecretRef if key isn’t specified explicitly, “truststore-password” entry will be used

Name	Type	Description	Required
key	string	The key of the entry in the Secret resource's `data` field to be used.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.containerImage

^{^{↩ Parent}}

ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

Stargate.spec.containerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.livenessProbe

^{^{↩ Parent}}

LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

Stargate.spec.livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

Stargate.spec.livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

Stargate.spec.livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

Stargate.spec.livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

Stargate.spec.livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

Stargate.spec.metadata

^{^{↩ Parent}}

labels and annotations for Stargate resources

Name	Type	Description	Required
annotations	map[string]string		false
commonLabels	map[string]string	labels/annotations that will be applied to all components created by the CRD	false
labels	map[string]string		false
pods	object	labels/annotations for the pod components	false
service	object	labels/annotations for the service component	false

Stargate.spec.metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

Stargate.spec.metadata.service

^{^{↩ Parent}}

labels/annotations for the service component

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

Stargate.spec.racks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the rack name. It must correspond to an existing rack name in the CassandraDatacenter resource where Stargate is being deployed, otherwise it will be ignored.	true
affinity	object	Affinity is the affinity to apply to all the Stargate pods. Leave nil to let the controller reuse the same affinity rules used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity	false
allowStargateOnDataNodes	boolean	AllowStargateOnDataNodes allows Stargate pods to be scheduled on a worker node already hosting data pods for this datacenter. The default is false, which means that Stargate pods will be scheduled on separate worker nodes. Note: if the datacenter pods have HostNetwork:true, then the Stargate pods will inherit of it, in which case it is possible that Stargate nodes won't be allowed to sit on data nodes even if this property is set to true, because of port conflicts on the same IP address. Default: false	false
authOptions	object	Authentication options.	false
cassandraConfigMapRef	object	CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.	false
containerImage	object	ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image. Default: map[repository:stargateio tag:v1.0.77]	false
heapSize	int or string	HeapSize sets the JVM heap size to use for Stargate. If no Resources are specified, this value will also be used to set a default memory request and limit for the Stargate pods: these will be set to HeapSize x2 and x4, respectively. Default: 256Mi	false
livenessProbe	object	LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.	false
metadata	object	labels and annotations for Stargate resources	false
nodeSelector	map[string]string	NodeSelector is an optional map of label keys and values to restrict the scheduling of Stargate nodes to workers with matching labels. Leave nil to let the controller reuse the same node selectors used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector	false
readinessProbe	object	ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.	false
resources	object	Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.	false
secretsProvider	enum	SecretsProvider defines whether the secrets used for credentials and certs will be backed by an external secret backend. This moves the responsibility of generating and storing secrets from the operators to the user and will rely on a mutating webhook to inject the secrets into the necessary resources Enum: internal, external Default: internal	false
serviceAccount	string	ServiceAccount is the service account name to use for Stargate pods. Default: default	false
telemetry	object	Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)	false
tolerations	[]object	Tolerations are tolerations to apply to the Stargate pods. Leave nil to let the controller reuse the same tolerations used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/	false

Stargate.spec.racks[index].affinity

^{^{↩ Parent}}

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

Stargate.spec.racks[index].affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

Stargate.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

Stargate.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

Stargate.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

Stargate.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

Stargate.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.	false
matchLabelKeys	[]string	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
mismatchLabelKeys	[]string	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".	false

Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

Stargate.spec.racks[index].authOptions

^{^{↩ Parent}}

Authentication options.

Name	Type	Description	Required
apiAuthMethod	enum	The method to use for authenticating requests to the Stargate APIs. Stargate currently has two authentication / authorization methods: - Table: table-based; - JWT: JSON web token (JWT)-based. The methods are mutually exclusive. The default method is Table. Enum: Table, JWT Default: Table	false
providerUrl	string	Required when using JWT authentication method, ignored otherwise.	false
tokenTtlSeconds	integer	The time-to-live in seconds of an API authentication token. Valid only for the Table authentication method. By default, the token persists for 30 minutes with a sliding window. Each use of the token to authenticate resets the 30-minute window. A token created and used after 29 minutes will authenticate a request, but if 31 minutes passes before use, the token will no longer exist. Default is 1800 seconds (30 minutes). Minimum: 1	false

Stargate.spec.racks[index].cassandraConfigMapRef

^{^{↩ Parent}}

CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.racks[index].containerImage

^{^{↩ Parent}}

ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image.

Name	Type	Description	Required
name	string	The image name to use.	false
pullPolicy	enum	The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent". Enum: Always, IfNotPresent, Never	false
pullSecretRef	object	The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
registry	string	The Docker registry to use. Defaults to "docker.io", the official Docker Hub.	false
repository	string	The Docker repository to use.	false
tag	string	The image tag to use. Defaults to "latest". Default: latest	false

Stargate.spec.racks[index].containerImage.pullSecretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

Stargate.spec.racks[index].livenessProbe

^{^{↩ Parent}}

LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

Stargate.spec.racks[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

Stargate.spec.racks[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

Stargate.spec.racks[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

Stargate.spec.racks[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

Stargate.spec.racks[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

Stargate.spec.racks[index].metadata

^{^{↩ Parent}}

labels and annotations for Stargate resources

Name	Type	Description	Required
annotations	map[string]string		false
commonLabels	map[string]string	labels/annotations that will be applied to all components created by the CRD	false
labels	map[string]string		false
pods	object	labels/annotations for the pod components	false
service	object	labels/annotations for the service component	false

Stargate.spec.racks[index].metadata.pods

^{^{↩ Parent}}

labels/annotations for the pod components

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

Stargate.spec.racks[index].metadata.service

^{^{↩ Parent}}

labels/annotations for the service component

Name	Type	Description	Required
annotations	map[string]string		false
labels	map[string]string		false

Stargate.spec.racks[index].readinessProbe

^{^{↩ Parent}}

ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

Stargate.spec.racks[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

Stargate.spec.racks[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

Stargate.spec.racks[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

Stargate.spec.racks[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

Stargate.spec.racks[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

Stargate.spec.racks[index].resources

^{^{↩ Parent}}

Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

Stargate.spec.racks[index].resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

Stargate.spec.racks[index].telemetry

^{^{↩ Parent}}

Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

Stargate.spec.racks[index].telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

Stargate.spec.racks[index].telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

Stargate.spec.racks[index].telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

Stargate.spec.racks[index].telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

Stargate.spec.racks[index].telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

Stargate.spec.racks[index].telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

Stargate.spec.racks[index].telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

Stargate.spec.racks[index].telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

Stargate.spec.racks[index].telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

Stargate.spec.racks[index].telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

Stargate.spec.racks[index].telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

Stargate.spec.racks[index].telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

Stargate.spec.racks[index].tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

Stargate.spec.readinessProbe

^{^{↩ Parent}}

ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

Stargate.spec.readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

Stargate.spec.readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

Stargate.spec.readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

Stargate.spec.readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.	true
value	string	The header field value	true

Stargate.spec.readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

Stargate.spec.resources

^{^{↩ Parent}}

Resources is the Kubernetes resource requests and limits to apply, per Stargate pod. Leave nil to use defaults.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

Stargate.spec.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

Stargate.spec.telemetry

^{^{↩ Parent}}

Telemetry defines the desired telemetry integrations to deploy targeting the Stargate pods for all DCs in this cluster (unless overridden by DC specific settings)

Name	Type	Required
cassandra	object	false
mcac	object	false
prometheus	object	false
vector	object	false

Stargate.spec.telemetry.cassandra

^{^{↩ Parent}}

Name	Type	Description	Required
endpoint	object		false
relabels	[]object		false

Stargate.spec.telemetry.cassandra.endpoint

^{^{↩ Parent}}

Name	Type	Description	Required
address	string		false
port	string		false

Stargate.spec.telemetry.cassandra.relabels[index]

^{^{↩ Parent}}

Name	Type	Description	Required
action	string	Action to perform based on regex matching. Default is 'replace'	false
modulus	integer	Modulus to take of the hash of the source label values. Format: int64	false
regex	string	Regular expression against which the extracted value is matched. Default is '(.*)'	false
replacement	string	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'	false
separator	string	Separator placed between concatenated source label values. default is ';'.	false
sourceLabels	[]string	The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.	false
targetLabel	string	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.	false

Stargate.spec.telemetry.mcac

^{^{↩ Parent}}

Name	Type	Description	Required
enabled	boolean	enabled sets whether MCAC (legacy metrics endpoint) is enabled. This is considered true by default.	false
metricFilters	[]string	MetricFilters allows passing filters to MCAC in order to reduce the amount of extracted metrics. Not setting this field will result in the default filters being used: - "deny:org.apache.cassandra.metrics.Table" - "deny:org.apache.cassandra.metrics.table" - "allow:org.apache.cassandra.metrics.table.live_ss_table_count" - "allow:org.apache.cassandra.metrics.Table.LiveSSTableCount" - "allow:org.apache.cassandra.metrics.table.live_disk_space_used" - "allow:org.apache.cassandra.metrics.table.LiveDiskSpaceUsed" - "allow:org.apache.cassandra.metrics.Table.Pending" - "allow:org.apache.cassandra.metrics.Table.Memtable" - "allow:org.apache.cassandra.metrics.Table.Compaction" - "allow:org.apache.cassandra.metrics.table.read" - "allow:org.apache.cassandra.metrics.table.write" - "allow:org.apache.cassandra.metrics.table.range" - "allow:org.apache.cassandra.metrics.table.coordinator" - "allow:org.apache.cassandra.metrics.table.dropped_mutations" Setting it to an empty list will result in all metrics being extracted.	false

Stargate.spec.telemetry.prometheus

^{^{↩ Parent}}

Name	Type	Description	Required
commonLabels	map[string]string	CommonLabels are applied to all serviceMonitors created.	false
enabled	boolean	Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate).	false

Stargate.spec.telemetry.vector

^{^{↩ Parent}}

Name	Type	Description	Required
components	object		false
enabled	boolean	Enabled enables the Vector agent for this resource (Cassandra, Reaper or Stargate). Enabling the vector agent will inject a sidecar container into the pod.	false
image	string	Image is the name of the Vector image to use. If not set, the default image will be used. kube:default="timberio/vector:0.26.0-alpine"	false
resources	object	Resources is the resource requirements for the Vector agent.	false
scrapeInterval	string	ScrapeInterval is the interval at which the Vector agent will scrape the metrics endpoint. Use values like 30s, 1m, 5m. kube:default=30s	false

Stargate.spec.telemetry.vector.components

^{^{↩ Parent}}

Name	Type	Description	Required
sinks	[]object	Sinks is the list of sinks to use for the Vector agent.	false
sources	[]object	Sources is the list of sources to use for the Vector agent.	false
transforms	[]object	Transforms is the list of transforms to use for the Vector agent.	false

Stargate.spec.telemetry.vector.components.sinks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the sink.	true
type	string	Type is the type of the sink.	true
config	string	Config is the configuration for the sink.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

Stargate.spec.telemetry.vector.components.sources[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the source.	true
type	string	Type is the type of the source.	true
config	string	Config is the configuration for the source.	false

Stargate.spec.telemetry.vector.components.transforms[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name is the name of the transform.	true
type	string	Type is the type of the transform.	true
config	string	Config is the configuration for the transform.	false
inputs	[]string	Inputs is the list of inputs for the transform.	false

Stargate.spec.telemetry.vector.resources

^{^{↩ Parent}}

Resources is the resource requirements for the Vector agent.

Name

Type

Description

Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

false

limits

map[string]int or string

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

false

requests

map[string]int or string

false

Stargate.spec.telemetry.vector.resources.claims[index]

^{^{↩ Parent}}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true

Stargate.spec.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

Stargate.status

^{^{↩ Parent}}

Most recently observed status of this Stargate resource.

Name	Type	Description	Required
availableReplicas	integer	Total number of available pods targeted by the Stargate deployment. Will be zero if the deployment has not been created yet. Format: int32	true
readyReplicas	integer	ReadyReplicas is the total number of ready pods targeted by the Stargate deployment. Will be zero if the deployment has not been created yet. Format: int32	true
replicas	integer	Total number of non-terminated pods targeted by the Stargate deployment (their labels match the selector). Will be zero if the deployment has not been created yet. Format: int32	true
updatedReplicas	integer	UpdatedReplicas is the total number of non-terminated pods targeted by the Stargate deployment that have the desired template spec. Will be zero if the deployment has not been created yet. Format: int32	true
conditions	[]object		false
deploymentRefs	[]string	DeploymentRefs is the names of the Deployment objects that were created for this Stargate object.	false
progress	enum	Progress is the progress of this Stargate object. Enum: Pending, Deploying, Running	false
readyReplicasRatio	string	ReadyReplicasRatio is a "X/Y" string representing the ratio between ReadyReplicas and Replicas in the Stargate deployment.	false
serviceRef	string	ServiceRef is the name of the Service object that was created for this Stargate object.	false

Stargate.status.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
status	string		true
type	string		true
lastTransitionTime	string	LastTransitionTime is the last time the condition transited from one status to another. Format: date-time	false

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified September 18, 2024: Release v1.20.0 (9dc420a)