K8ssandra-operator CRDs v1.2

Configuration reference for the CRDs used with K8ssandra-operator v1.2.

Packages:

config.k8ssandra.io/v1beta1

Resource Types:

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

k8ssandra.io/v1alpha1

Resource Types:

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 will be deployed on every Cassandra datacenter in this K8ssandraCluster.
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 is configuration settings that are applied to cassandra.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
datacenters []object Datacenters a list of the DCs in the cluster.
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 The image to use in each Cassandra pod for the (short-lived) init container that enables JMX remote authentication on Cassandra pods. This is only useful when authentication is enabled in the cluster. The default is "busybox:1.34.1".

Default: map[name:busybox tag:1.34.1]
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
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
serverVersion string ServerVersion is the Cassandra version.
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 Description 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 its password the expected format of the secret is a "keystore" entry and a "keystore-password" entry
true
truststoreSecretRef object ref to the secret that contains the truststore and its password the expected format of the secret is a "truststore" entry and a "truststore-password" entry
true

K8ssandraCluster.spec.cassandra.clientEncryptionStores.keystoreSecretRef

↩ Parent

ref to the secret that contains the keystore and its password the expected format of the secret is a “keystore” entry and a “keystore-password” entry

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.clientEncryptionStores.truststoreSecretRef

↩ Parent

ref to the secret that contains the truststore and its password the expected format of the secret is a “truststore” entry and a “truststore-password” entry

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.config

↩ Parent

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

Name Type Description Required
cassandraYaml object CassandraYaml defines the contents of the cassandra.yaml file. For more info see: https://cassandra.apache.org/doc/latest/cassandra/configuration/cass_yaml_file.html
false
jvmOptions object
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml

↩ Parent

CassandraYaml defines the contents of the cassandra.yaml file. For more info see: https://cassandra.apache.org/doc/latest/cassandra/configuration/cass_yaml_file.html

Name Type Description Required
allocate_tokens_for_keyspace string Exists in 3.11, 4.0, trunk
false
allocate_tokens_for_local_replication_factor integer Exists in: 4.0, trunk
false
audit_logging_options object Exists in: 4.0, trunk
false
auth_read_consistency_level enum Exists in trunk

Enum: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE, NODE_LOCAL
false
auth_write_consistency_level enum Exists in trunk

Enum: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE, NODE_LOCAL
false
authenticator string Exists in 3.11, 4.0, trunk
false
authorizer string Exists in 3.11, 4.0, trunk
false
auto_hints_cleanup_enabled boolean Exists in trunk
false
auto_optimise_full_repair_streams boolean Exists in: 4.0, trunk
false
auto_optimise_inc_repair_streams boolean Exists in: 4.0, trunk
false
auto_optimise_preview_repair_streams boolean Exists in: 4.0, trunk
false
auto_snapshot boolean Exists in 3.11, 4.0, trunk
false
autocompaction_on_startup_enabled boolean Exists in: 4.0, trunk
false
automatic_sstable_upgrade boolean Exists in: 4.0, trunk
false
available_processors integer Exists in trunk
false
back_pressure_enabled boolean Exists in 3.11, 4.0, trunk
false
back_pressure_strategy object Exists in 3.11, 4.0, trunk
false
batch_size_fail_threshold_in_kb integer Exists in 3.11, 4.0, trunk
false
batch_size_warn_threshold_in_kb integer Exists in 3.11, 4.0, trunk
false
batchlog_replay_throttle_in_kb integer Exists in 3.11, 4.0, trunk
false
block_for_peers_in_remote_dcs boolean Exists in: 4.0, trunk
false
block_for_peers_timeout_in_secs integer Exists in: 4.0, trunk
false
buffer_pool_use_heap_if_exhausted boolean Exists in 3.11, 4.0, trunk
false
cas_contention_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
cdc_enabled boolean Exists in 3.11, 4.0, trunk
false
cdc_free_space_check_interval_ms integer Exists in 3.11, 4.0, trunk
false
cdc_raw_directory string Exists in 3.11, 4.0, trunk TODO mountable directory
false
cdc_total_space_in_mb integer Exists in 3.11, 4.0, trunk
false
check_for_duplicate_rows_during_compaction boolean Exists in 3.11, 4.0, trunk
false
check_for_duplicate_rows_during_reads boolean Exists in 3.11, 4.0, trunk
false
client_encryption_options object Exists in 3.11, 4.0, trunk
false
client_error_reporting_exclusions object Exists in trunk
false
column_index_cache_size_in_kb integer Exists in 3.11, 4.0, trunk
false
column_index_size_in_kb integer Exists in 3.11, 4.0, trunk
false
commitlog_compression object Exists in 3.11, 4.0, trunk
false
commitlog_max_compression_buffers_in_pool integer Exists in 3.11, 4.0, trunk
false
commitlog_periodic_queue_size integer Exists in 3.11, 4.0, trunk
false
commitlog_segment_size_in_mb integer Exists in 3.11, 4.0, trunk
false
commitlog_sync enum Exists in 3.11, 4.0, trunk

Enum: periodic, batch, group
false
commitlog_sync_batch_window_in_ms string Exists in 3.11, 4.0, trunk
false
commitlog_sync_group_window_in_ms integer Exists in: 4.0, trunk
false
commitlog_sync_period_in_ms integer Exists in 3.11, 4.0, trunk
false
commitlog_total_space_in_mb integer Exists in 3.11, 4.0, trunk
false
compaction_large_partition_warning_threshold_mb integer Exists in 3.11, 4.0, trunk
false
compaction_throughput_mb_per_sec integer Exists in 3.11, 4.0, trunk
false
compaction_tombstone_warning_threshold integer Exists in trunk
false
concurrent_compactors integer Exists in 3.11, 4.0, trunk
false
concurrent_counter_writes integer Exists in 3.11, 4.0, trunk
false
concurrent_materialized_view_builders integer Exists in: 4.0, trunk
false
concurrent_materialized_view_writes integer Exists in 3.11, 4.0, trunk
false
concurrent_reads integer Exists in 3.11, 4.0, trunk
false
concurrent_replicates integer Exists in 3.11, 4.0, trunk
false
concurrent_validations integer Exists in: 4.0, trunk
false
concurrent_writes integer Exists in 3.11, 4.0, trunk
false
consecutive_message_errors_threshold integer Exists in: 4.0, trunk
false
corrupted_tombstone_strategy enum Exists in: 4.0, trunk

Enum: disabled, warn, exception
false
counter_cache_keys_to_save integer Exists in 3.11, 4.0, trunk
false
counter_cache_save_period integer Exists in 3.11, 4.0, trunk
false
counter_cache_size_in_mb integer Exists in 3.11, 4.0, trunk
false
counter_write_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
credentials_cache_max_entries integer Exists in 3.11, 4.0, trunk
false
credentials_update_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
credentials_validity_in_ms integer Exists in 3.11, 4.0, trunk
false
cross_node_timeout boolean Exists in 3.11, 4.0, trunk
false
default_keyspace_rf integer Exists in trunk
false
denylist_consistency_level enum Exists in trunk

Enum: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE, NODE_LOCAL
false
denylist_initial_load_retry_seconds integer Exists in trunk
false
denylist_max_keys_per_table integer Exists in trunk
false
denylist_max_keys_total integer Exists in trunk
false
denylist_refresh_seconds integer Exists in trunk
false
diagnostic_events_enabled boolean Exists in: 4.0, trunk
false
disk_access_mode enum Exists in 3.11, 4.0, trunk

Enum: auto, mmap, mmap_index_only, standard
false
disk_optimization_estimate_percentile string Exists in 3.11, 4.0, trunk
false
disk_optimization_page_cross_chance string Exists in 3.11, 4.0, trunk
false
disk_optimization_strategy enum Exists in 3.11, 4.0, trunk

Enum: ssd, spinning
false
dynamic_snitch boolean Exists in 3.11, 4.0, trunk
false
dynamic_snitch_badness_threshold string Exists in 3.11, 4.0, trunk
false
dynamic_snitch_reset_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
dynamic_snitch_update_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
enable_denylist_range_reads boolean Exists in trunk
false
enable_denylist_reads boolean Exists in trunk
false
enable_denylist_writes boolean Exists in trunk
false
enable_drop_compact_storage boolean Exists in 3.11, 4.0, trunk
false
enable_materialized_views boolean Exists in 3.11, 4.0, trunk
false
enable_partition_denylist boolean Exists in trunk
false
enable_sasi_indexes boolean Exists in 3.11, 4.0, trunk
false
enable_scripted_user_defined_functions boolean Exists in 3.11, 4.0, trunk
false
enable_transient_replication boolean Exists in: 4.0, trunk
false
enable_user_defined_functions boolean Exists in 3.11, 4.0, trunk
false
enable_user_defined_functions_threads boolean Exists in 3.11, 4.0, trunk
false
endpoint_snitch string Exists in 3.11, 4.0, trunk
false
failure_detector string Exists in trunk
false
file_cache_enabled boolean Exists in: 4.0, trunk
false
file_cache_round_up boolean Exists in 3.11, 4.0, trunk
false
file_cache_size_in_mb integer Exists in 3.11, 4.0, trunk
false
flush_compression enum Exists in: 4.0, trunk

Enum: none, fast, table
false
full_query_logging_options object Exists in: 4.0, trunk
false
gc_log_threshold_in_ms integer Exists in 3.11, 4.0, trunk
false
gc_warn_threshold_in_ms integer Exists in 3.11, 4.0, trunk
false
hint_window_persistent_enabled boolean Exists in trunk
false
hinted_handoff_disabled_datacenters []string Exists in 3.11, 4.0, trunk
false
hinted_handoff_enabled boolean Exists in 3.11, 4.0, trunk
false
hinted_handoff_throttle_in_kb integer Exists in 3.11, 4.0, trunk
false
hints_compression object Exists in 3.11, 4.0, trunk
false
hints_flush_period_in_ms integer Exists in 3.11, 4.0, trunk
false
ideal_consistency_level enum Exists in: 4.0, trunk

Enum: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE, NODE_LOCAL
false
index_interval integer Exists in 3.11
false
index_summary_capacity_in_mb integer Exists in 3.11, 4.0, trunk
false
index_summary_resize_interval_in_minutes integer Exists in 3.11, 4.0, trunk
false
initial_range_tombstone_list_allocation_size integer Exists in: 4.0, trunk
false
inter_dc_stream_throughput_outbound_megabits_per_sec integer Exists in 3.11, 4.0, trunk
false
inter_dc_tcp_nodelay boolean Exists in 3.11, 4.0, trunk
false
internode_application_receive_queue_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_receive_queue_reserve_endpoint_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_receive_queue_reserve_global_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_send_queue_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_send_queue_reserve_endpoint_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_send_queue_reserve_global_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_authenticator string Exists in 3.11, 4.0, trunk
false
internode_compression enum Exists in 3.11, 4.0, trunk

Enum: all, none, dc
false
internode_error_reporting_exclusions object Exists in trunk
false
internode_max_message_size_in_bytes integer Exists in: 4.0, trunk
false
internode_recv_buff_size_in_bytes integer Exists in 3.11
false
internode_send_buff_size_in_bytes integer Exists in 3.11
false
internode_socket_receive_buffer_size_in_bytes integer Exists in: 4.0, trunk
false
internode_socket_send_buffer_size_in_bytes integer Exists in: 4.0, trunk
false
internode_streaming_tcp_user_timeout_in_ms integer Exists in: 4.0, trunk
false
internode_tcp_connect_timeout_in_ms integer Exists in: 4.0, trunk
false
internode_tcp_user_timeout_in_ms integer Exists in: 4.0, trunk
false
key_cache_keys_to_save integer Exists in 3.11, 4.0, trunk
false
key_cache_migrate_during_compaction boolean Exists in: 4.0, trunk
false
key_cache_save_period integer Exists in 3.11, 4.0, trunk
false
key_cache_size_in_mb integer Exists in 3.11, 4.0, trunk
false
keyspace_count_warn_threshold integer Exists in: 4.0, trunk
false
max_concurrent_automatic_sstable_upgrades integer Exists in: 4.0, trunk
false
max_hint_window_in_ms integer Exists in 3.11, 4.0, trunk
false
max_hints_delivery_threads integer Exists in 3.11, 4.0, trunk
false
max_hints_file_size_in_mb integer Exists in 3.11, 4.0, trunk
false
max_mutation_size_in_kb integer Exists in 3.11, 4.0, trunk
false
max_streaming_retries integer Exists in 3.11, 4.0, trunk
false
max_value_size_in_mb integer Exists in 3.11, 4.0, trunk
false
memtable_allocation_type enum Exists in 3.11, 4.0, trunk

Enum: unslabbed_heap_buffers, unslabbed_heap_buffers_logged, heap_buffers, offheap_buffers, offheap_objects
false
memtable_cleanup_threshold string Exists in 3.11, 4.0, trunk
false
memtable_flush_writers integer Exists in 3.11, 4.0, trunk
false
memtable_heap_space_in_mb integer Exists in 3.11, 4.0, trunk
false
memtable_offheap_space_in_mb integer Exists in 3.11, 4.0, trunk
false
min_free_space_per_drive_in_mb integer Exists in 3.11, 4.0, trunk
false
minimum_keyspace_rf integer Exists in trunk
false
native_transport_allow_older_protocols boolean Exists in: 4.0, trunk
false
native_transport_flush_in_batches_legacy boolean Exists in 3.11, 4.0, trunk
false
native_transport_idle_timeout_in_ms integer Exists in: 4.0, trunk
false
native_transport_max_concurrent_connections integer Exists in 3.11, 4.0, trunk
false
native_transport_max_concurrent_connections_per_ip integer Exists in 3.11, 4.0, trunk
false
native_transport_max_concurrent_requests_in_bytes integer Exists in 3.11, 4.0, trunk
false
native_transport_max_concurrent_requests_in_bytes_per_ip integer Exists in 3.11, 4.0, trunk
false
native_transport_max_frame_size_in_mb integer Exists in 3.11, 4.0, trunk
false
native_transport_max_negotiable_protocol_version integer Exists in 3.11, 4.0, trunk
false
native_transport_max_requests_per_second integer Exists in trunk
false
native_transport_max_threads integer Exists in 3.11, 4.0, trunk
false
native_transport_rate_limiting_enabled boolean Exists in trunk
false
native_transport_receive_queue_capacity_in_bytes integer Exists in: 4.0, trunk
false
network_authorizer string Exists in: 4.0, trunk
false
networking_cache_size_in_mb integer Exists in: 4.0, trunk
false
num_tokens integer Exists in 3.11, 4.0, trunk
false
otc_backlog_expiration_interval_ms integer Exists in 3.11
false
otc_coalescing_enough_coalesced_messages integer Exists in 3.11, 4.0, trunk
false
otc_coalescing_strategy string Exists in 3.11, 4.0, trunk
false
otc_coalescing_window_us integer Exists in 3.11, 4.0, trunk
false
paxos_cache_size_in_mb integer Exists in trunk
false
periodic_commitlog_sync_lag_block_in_ms integer Exists in: 4.0, trunk
false
permissions_cache_max_entries integer Exists in 3.11, 4.0, trunk
false
permissions_update_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
permissions_validity_in_ms integer Exists in 3.11, 4.0, trunk
false
phi_convict_threshold string Exists in 3.11, 4.0, trunk
false
prepared_statements_cache_size_mb integer Exists in 3.11, 4.0, trunk
false
range_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
range_tombstone_list_growth_factor string Exists in: 4.0, trunk
false
read_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
reject_repair_compaction_threshold integer Exists in: 4.0, trunk
false
repair_command_pool_full_strategy enum Exists in: 4.0, trunk

Enum: queue, reject
false
repair_command_pool_size integer Exists in: 4.0, trunk
false
repair_session_max_tree_depth integer Exists in 3.11, 4.0, trunk
false
repair_session_space_in_mb integer Exists in: 4.0, trunk
false
repaired_data_tracking_for_partition_reads_enabled boolean Exists in: 4.0, trunk
false
repaired_data_tracking_for_range_reads_enabled boolean Exists in: 4.0, trunk
false
replica_filtering_protection object Exists in 3.11, 4.0, trunk
false
report_unconfirmed_repaired_data_mismatches boolean Exists in: 4.0, trunk
false
request_scheduler string Exists in 3.11
false
request_scheduler_id enum Exists in 3.11

Enum: keyspace
false
request_scheduler_options object Exists in 3.11
false
request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
role_manager string Exists in 3.11, 4.0, trunk
false
roles_cache_max_entries integer Exists in 3.11, 4.0, trunk
false
roles_update_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
roles_validity_in_ms integer Exists in 3.11, 4.0, trunk
false
row_cache_class_name string Exists in 3.11, 4.0, trunk
false
row_cache_keys_to_save integer Exists in 3.11, 4.0, trunk
false
row_cache_save_period integer Exists in 3.11, 4.0, trunk
false
row_cache_size_in_mb integer Exists in 3.11, 4.0, trunk
false
server_encryption_options object Exists in 3.11, 4.0, trunk
false
slow_query_log_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
snapshot_before_compaction boolean Exists in 3.11, 4.0, trunk
false
snapshot_links_per_second integer Exists in: 4.0, trunk
false
snapshot_on_duplicate_row_detection boolean Exists in 3.11, 4.0, trunk
false
snapshot_on_repaired_data_mismatch boolean Exists in: 4.0, trunk
false
sstable_preemptive_open_interval_in_mb integer Exists in 3.11, 4.0, trunk
false
stream_entire_sstables boolean Exists in: 4.0, trunk
false
stream_throughput_outbound_megabits_per_sec integer Exists in 3.11, 4.0, trunk
false
streaming_connections_per_host integer Exists in: 4.0, trunk
false
streaming_keep_alive_period_in_secs integer Exists in 3.11, 4.0, trunk
false
streaming_socket_timeout_in_ms integer Exists in 3.11
false
table_count_warn_threshold integer Exists in: 4.0, trunk
false
thrift_framed_transport_size_in_mb integer Exists in 3.11
false
thrift_max_message_length_in_mb integer Exists in 3.11
false
thrift_prepared_statements_cache_size_mb integer Exists in 3.11
false
tombstone_failure_threshold integer Exists in 3.11, 4.0, trunk
false
tombstone_warn_threshold integer Exists in 3.11, 4.0, trunk
false
tracetype_query_ttl integer Exists in 3.11, 4.0, trunk
false
tracetype_repair_ttl integer Exists in 3.11, 4.0, trunk
false
track_warnings object Exists in trunk
false
traverse_auth_from_root boolean Exists in trunk
false
trickle_fsync boolean Exists in 3.11, 4.0, trunk
false
trickle_fsync_interval_in_kb integer Exists in 3.11, 4.0, trunk
false
truncate_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
unlogged_batch_across_partitions_warn_threshold integer Exists in 3.11, 4.0, trunk
false
use_deterministic_table_id boolean Exists in trunk
false
use_offheap_merkle_trees boolean Exists in: 4.0, trunk
false
user_defined_function_fail_timeout integer Exists in 3.11, 4.0, trunk
false
user_defined_function_warn_timeout integer Exists in 3.11, 4.0, trunk
false
user_function_timeout_policy enum Exists in 3.11, 4.0, trunk

Enum: ignore, die, die_immediate
false
validation_preview_purge_head_start_in_sec integer Exists in: 4.0, trunk
false
windows_timer_interval integer Exists in 3.11, 4.0, trunk
false
write_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.audit_logging_options

↩ Parent

Exists in: 4.0, trunk

Name Type Description Required
enabled boolean
true
archive_command string
false
block boolean
false
excluded_categories string
false
excluded_keyspaces string
false
excluded_users string
false
included_categories string
false
included_keyspaces string
false
included_users string
false
logger object
false
max_archive_retries integer
false
max_log_size integer
false
max_queue_weight integer
false
roll_cycle string
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.audit_logging_options.logger

↩ Parent

Name Type Description Required
class_name string
true
parameters map[string]string
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.back_pressure_strategy

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
class_name string
true
parameters map[string]string
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.client_encryption_options

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
enabled boolean
true
accepted_protocols []string
false
algorithm string
false
cipher_suites []string
false
optional boolean
false
protocol string
false
require_client_auth boolean

Default: false
false
store_type string
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.client_error_reporting_exclusions

↩ Parent

Exists in trunk

Name Type Description Required
subnets []string
true

K8ssandraCluster.spec.cassandra.config.cassandraYaml.commitlog_compression

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
class_name string
true
parameters map[string]string
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.full_query_logging_options

↩ Parent

Exists in: 4.0, trunk

Name Type Description Required
archive_command string
false
block boolean
false
log_dir string
false
max_archive_retries integer
false
max_log_size integer
false
max_queue_weight integer
false
roll_cycle string
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.hints_compression

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
class_name string
true
parameters map[string]string
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.internode_error_reporting_exclusions

↩ Parent

Exists in trunk

Name Type Description Required
subnets []string
true

K8ssandraCluster.spec.cassandra.config.cassandraYaml.replica_filtering_protection

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
cached_rows_fail_threshold integer
false
cached_rows_warn_threshold integer
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.request_scheduler_options

↩ Parent

Exists in 3.11

Name Type Description Required
default_weight integer
false
throttle_limit integer
false
weights map[string]integer
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.server_encryption_options

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
accepted_protocols []string
false
algorithm string
false
cipher_suites []string
false
enable_legacy_ssl_storage_port boolean

Default: false
false
internode_encryption enum

Enum: none, dc, rack, all
Default: none
false
optional boolean

Default: false
false
protocol string
false
require_client_auth boolean

Default: false
false
require_endpoint_verification boolean

Default: false
false
store_type string
false

K8ssandraCluster.spec.cassandra.config.cassandraYaml.track_warnings

↩ Parent

Exists in trunk

Name Type Description Required
enabled boolean
true
coordinator_read_size integer
false
local_read_size integer
false
row_index_size integer
false

K8ssandraCluster.spec.cassandra.config.jvmOptions

↩ Parent

Name Type Description Required
additionalOptions []string Additional, arbitrary JVM options (advanced).
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 docker 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 docker 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 Docker 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. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. 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

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
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
true
value string The header field value
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
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
true
value string The header field value
true

K8ssandraCluster.spec.cassandra.containers[index].lifecycle.preStop.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].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 an alpha 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

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. This is an alpha 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

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
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. This is an alpha 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

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. This is an alpha 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

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
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].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

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 only be set if type is "Localhost".
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. 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

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. This is an alpha 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

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. This is an alpha 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

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
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 is configuration settings that are applied to cassandra.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
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 The image to use in each Cassandra pod for the (short-lived) init container that enables JMX remote authentication on Cassandra pods. This is only useful when authentication is enabled in the cluster. The default is "busybox:1.34.1".

Default: map[name:busybox tag:1.34.1]
false
k8sContext string
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
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 version.
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 Description 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 is configuration settings that are applied to cassandra.yaml and the various jvm*.options files.

Name Type Description Required
cassandraYaml object CassandraYaml defines the contents of the cassandra.yaml file. For more info see: https://cassandra.apache.org/doc/latest/cassandra/configuration/cass_yaml_file.html
false
jvmOptions object
false

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

↩ Parent

CassandraYaml defines the contents of the cassandra.yaml file. For more info see: https://cassandra.apache.org/doc/latest/cassandra/configuration/cass_yaml_file.html

Name Type Description Required
allocate_tokens_for_keyspace string Exists in 3.11, 4.0, trunk
false
allocate_tokens_for_local_replication_factor integer Exists in: 4.0, trunk
false
audit_logging_options object Exists in: 4.0, trunk
false
auth_read_consistency_level enum Exists in trunk

Enum: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE, NODE_LOCAL
false
auth_write_consistency_level enum Exists in trunk

Enum: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE, NODE_LOCAL
false
authenticator string Exists in 3.11, 4.0, trunk
false
authorizer string Exists in 3.11, 4.0, trunk
false
auto_hints_cleanup_enabled boolean Exists in trunk
false
auto_optimise_full_repair_streams boolean Exists in: 4.0, trunk
false
auto_optimise_inc_repair_streams boolean Exists in: 4.0, trunk
false
auto_optimise_preview_repair_streams boolean Exists in: 4.0, trunk
false
auto_snapshot boolean Exists in 3.11, 4.0, trunk
false
autocompaction_on_startup_enabled boolean Exists in: 4.0, trunk
false
automatic_sstable_upgrade boolean Exists in: 4.0, trunk
false
available_processors integer Exists in trunk
false
back_pressure_enabled boolean Exists in 3.11, 4.0, trunk
false
back_pressure_strategy object Exists in 3.11, 4.0, trunk
false
batch_size_fail_threshold_in_kb integer Exists in 3.11, 4.0, trunk
false
batch_size_warn_threshold_in_kb integer Exists in 3.11, 4.0, trunk
false
batchlog_replay_throttle_in_kb integer Exists in 3.11, 4.0, trunk
false
block_for_peers_in_remote_dcs boolean Exists in: 4.0, trunk
false
block_for_peers_timeout_in_secs integer Exists in: 4.0, trunk
false
buffer_pool_use_heap_if_exhausted boolean Exists in 3.11, 4.0, trunk
false
cas_contention_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
cdc_enabled boolean Exists in 3.11, 4.0, trunk
false
cdc_free_space_check_interval_ms integer Exists in 3.11, 4.0, trunk
false
cdc_raw_directory string Exists in 3.11, 4.0, trunk TODO mountable directory
false
cdc_total_space_in_mb integer Exists in 3.11, 4.0, trunk
false
check_for_duplicate_rows_during_compaction boolean Exists in 3.11, 4.0, trunk
false
check_for_duplicate_rows_during_reads boolean Exists in 3.11, 4.0, trunk
false
client_encryption_options object Exists in 3.11, 4.0, trunk
false
client_error_reporting_exclusions object Exists in trunk
false
column_index_cache_size_in_kb integer Exists in 3.11, 4.0, trunk
false
column_index_size_in_kb integer Exists in 3.11, 4.0, trunk
false
commitlog_compression object Exists in 3.11, 4.0, trunk
false
commitlog_max_compression_buffers_in_pool integer Exists in 3.11, 4.0, trunk
false
commitlog_periodic_queue_size integer Exists in 3.11, 4.0, trunk
false
commitlog_segment_size_in_mb integer Exists in 3.11, 4.0, trunk
false
commitlog_sync enum Exists in 3.11, 4.0, trunk

Enum: periodic, batch, group
false
commitlog_sync_batch_window_in_ms string Exists in 3.11, 4.0, trunk
false
commitlog_sync_group_window_in_ms integer Exists in: 4.0, trunk
false
commitlog_sync_period_in_ms integer Exists in 3.11, 4.0, trunk
false
commitlog_total_space_in_mb integer Exists in 3.11, 4.0, trunk
false
compaction_large_partition_warning_threshold_mb integer Exists in 3.11, 4.0, trunk
false
compaction_throughput_mb_per_sec integer Exists in 3.11, 4.0, trunk
false
compaction_tombstone_warning_threshold integer Exists in trunk
false
concurrent_compactors integer Exists in 3.11, 4.0, trunk
false
concurrent_counter_writes integer Exists in 3.11, 4.0, trunk
false
concurrent_materialized_view_builders integer Exists in: 4.0, trunk
false
concurrent_materialized_view_writes integer Exists in 3.11, 4.0, trunk
false
concurrent_reads integer Exists in 3.11, 4.0, trunk
false
concurrent_replicates integer Exists in 3.11, 4.0, trunk
false
concurrent_validations integer Exists in: 4.0, trunk
false
concurrent_writes integer Exists in 3.11, 4.0, trunk
false
consecutive_message_errors_threshold integer Exists in: 4.0, trunk
false
corrupted_tombstone_strategy enum Exists in: 4.0, trunk

Enum: disabled, warn, exception
false
counter_cache_keys_to_save integer Exists in 3.11, 4.0, trunk
false
counter_cache_save_period integer Exists in 3.11, 4.0, trunk
false
counter_cache_size_in_mb integer Exists in 3.11, 4.0, trunk
false
counter_write_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
credentials_cache_max_entries integer Exists in 3.11, 4.0, trunk
false
credentials_update_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
credentials_validity_in_ms integer Exists in 3.11, 4.0, trunk
false
cross_node_timeout boolean Exists in 3.11, 4.0, trunk
false
default_keyspace_rf integer Exists in trunk
false
denylist_consistency_level enum Exists in trunk

Enum: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE, NODE_LOCAL
false
denylist_initial_load_retry_seconds integer Exists in trunk
false
denylist_max_keys_per_table integer Exists in trunk
false
denylist_max_keys_total integer Exists in trunk
false
denylist_refresh_seconds integer Exists in trunk
false
diagnostic_events_enabled boolean Exists in: 4.0, trunk
false
disk_access_mode enum Exists in 3.11, 4.0, trunk

Enum: auto, mmap, mmap_index_only, standard
false
disk_optimization_estimate_percentile string Exists in 3.11, 4.0, trunk
false
disk_optimization_page_cross_chance string Exists in 3.11, 4.0, trunk
false
disk_optimization_strategy enum Exists in 3.11, 4.0, trunk

Enum: ssd, spinning
false
dynamic_snitch boolean Exists in 3.11, 4.0, trunk
false
dynamic_snitch_badness_threshold string Exists in 3.11, 4.0, trunk
false
dynamic_snitch_reset_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
dynamic_snitch_update_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
enable_denylist_range_reads boolean Exists in trunk
false
enable_denylist_reads boolean Exists in trunk
false
enable_denylist_writes boolean Exists in trunk
false
enable_drop_compact_storage boolean Exists in 3.11, 4.0, trunk
false
enable_materialized_views boolean Exists in 3.11, 4.0, trunk
false
enable_partition_denylist boolean Exists in trunk
false
enable_sasi_indexes boolean Exists in 3.11, 4.0, trunk
false
enable_scripted_user_defined_functions boolean Exists in 3.11, 4.0, trunk
false
enable_transient_replication boolean Exists in: 4.0, trunk
false
enable_user_defined_functions boolean Exists in 3.11, 4.0, trunk
false
enable_user_defined_functions_threads boolean Exists in 3.11, 4.0, trunk
false
endpoint_snitch string Exists in 3.11, 4.0, trunk
false
failure_detector string Exists in trunk
false
file_cache_enabled boolean Exists in: 4.0, trunk
false
file_cache_round_up boolean Exists in 3.11, 4.0, trunk
false
file_cache_size_in_mb integer Exists in 3.11, 4.0, trunk
false
flush_compression enum Exists in: 4.0, trunk

Enum: none, fast, table
false
full_query_logging_options object Exists in: 4.0, trunk
false
gc_log_threshold_in_ms integer Exists in 3.11, 4.0, trunk
false
gc_warn_threshold_in_ms integer Exists in 3.11, 4.0, trunk
false
hint_window_persistent_enabled boolean Exists in trunk
false
hinted_handoff_disabled_datacenters []string Exists in 3.11, 4.0, trunk
false
hinted_handoff_enabled boolean Exists in 3.11, 4.0, trunk
false
hinted_handoff_throttle_in_kb integer Exists in 3.11, 4.0, trunk
false
hints_compression object Exists in 3.11, 4.0, trunk
false
hints_flush_period_in_ms integer Exists in 3.11, 4.0, trunk
false
ideal_consistency_level enum Exists in: 4.0, trunk

Enum: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE, NODE_LOCAL
false
index_interval integer Exists in 3.11
false
index_summary_capacity_in_mb integer Exists in 3.11, 4.0, trunk
false
index_summary_resize_interval_in_minutes integer Exists in 3.11, 4.0, trunk
false
initial_range_tombstone_list_allocation_size integer Exists in: 4.0, trunk
false
inter_dc_stream_throughput_outbound_megabits_per_sec integer Exists in 3.11, 4.0, trunk
false
inter_dc_tcp_nodelay boolean Exists in 3.11, 4.0, trunk
false
internode_application_receive_queue_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_receive_queue_reserve_endpoint_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_receive_queue_reserve_global_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_send_queue_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_send_queue_reserve_endpoint_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_application_send_queue_reserve_global_capacity_in_bytes integer Exists in: 4.0, trunk
false
internode_authenticator string Exists in 3.11, 4.0, trunk
false
internode_compression enum Exists in 3.11, 4.0, trunk

Enum: all, none, dc
false
internode_error_reporting_exclusions object Exists in trunk
false
internode_max_message_size_in_bytes integer Exists in: 4.0, trunk
false
internode_recv_buff_size_in_bytes integer Exists in 3.11
false
internode_send_buff_size_in_bytes integer Exists in 3.11
false
internode_socket_receive_buffer_size_in_bytes integer Exists in: 4.0, trunk
false
internode_socket_send_buffer_size_in_bytes integer Exists in: 4.0, trunk
false
internode_streaming_tcp_user_timeout_in_ms integer Exists in: 4.0, trunk
false
internode_tcp_connect_timeout_in_ms integer Exists in: 4.0, trunk
false
internode_tcp_user_timeout_in_ms integer Exists in: 4.0, trunk
false
key_cache_keys_to_save integer Exists in 3.11, 4.0, trunk
false
key_cache_migrate_during_compaction boolean Exists in: 4.0, trunk
false
key_cache_save_period integer Exists in 3.11, 4.0, trunk
false
key_cache_size_in_mb integer Exists in 3.11, 4.0, trunk
false
keyspace_count_warn_threshold integer Exists in: 4.0, trunk
false
max_concurrent_automatic_sstable_upgrades integer Exists in: 4.0, trunk
false
max_hint_window_in_ms integer Exists in 3.11, 4.0, trunk
false
max_hints_delivery_threads integer Exists in 3.11, 4.0, trunk
false
max_hints_file_size_in_mb integer Exists in 3.11, 4.0, trunk
false
max_mutation_size_in_kb integer Exists in 3.11, 4.0, trunk
false
max_streaming_retries integer Exists in 3.11, 4.0, trunk
false
max_value_size_in_mb integer Exists in 3.11, 4.0, trunk
false
memtable_allocation_type enum Exists in 3.11, 4.0, trunk

Enum: unslabbed_heap_buffers, unslabbed_heap_buffers_logged, heap_buffers, offheap_buffers, offheap_objects
false
memtable_cleanup_threshold string Exists in 3.11, 4.0, trunk
false
memtable_flush_writers integer Exists in 3.11, 4.0, trunk
false
memtable_heap_space_in_mb integer Exists in 3.11, 4.0, trunk
false
memtable_offheap_space_in_mb integer Exists in 3.11, 4.0, trunk
false
min_free_space_per_drive_in_mb integer Exists in 3.11, 4.0, trunk
false
minimum_keyspace_rf integer Exists in trunk
false
native_transport_allow_older_protocols boolean Exists in: 4.0, trunk
false
native_transport_flush_in_batches_legacy boolean Exists in 3.11, 4.0, trunk
false
native_transport_idle_timeout_in_ms integer Exists in: 4.0, trunk
false
native_transport_max_concurrent_connections integer Exists in 3.11, 4.0, trunk
false
native_transport_max_concurrent_connections_per_ip integer Exists in 3.11, 4.0, trunk
false
native_transport_max_concurrent_requests_in_bytes integer Exists in 3.11, 4.0, trunk
false
native_transport_max_concurrent_requests_in_bytes_per_ip integer Exists in 3.11, 4.0, trunk
false
native_transport_max_frame_size_in_mb integer Exists in 3.11, 4.0, trunk
false
native_transport_max_negotiable_protocol_version integer Exists in 3.11, 4.0, trunk
false
native_transport_max_requests_per_second integer Exists in trunk
false
native_transport_max_threads integer Exists in 3.11, 4.0, trunk
false
native_transport_rate_limiting_enabled boolean Exists in trunk
false
native_transport_receive_queue_capacity_in_bytes integer Exists in: 4.0, trunk
false
network_authorizer string Exists in: 4.0, trunk
false
networking_cache_size_in_mb integer Exists in: 4.0, trunk
false
num_tokens integer Exists in 3.11, 4.0, trunk
false
otc_backlog_expiration_interval_ms integer Exists in 3.11
false
otc_coalescing_enough_coalesced_messages integer Exists in 3.11, 4.0, trunk
false
otc_coalescing_strategy string Exists in 3.11, 4.0, trunk
false
otc_coalescing_window_us integer Exists in 3.11, 4.0, trunk
false
paxos_cache_size_in_mb integer Exists in trunk
false
periodic_commitlog_sync_lag_block_in_ms integer Exists in: 4.0, trunk
false
permissions_cache_max_entries integer Exists in 3.11, 4.0, trunk
false
permissions_update_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
permissions_validity_in_ms integer Exists in 3.11, 4.0, trunk
false
phi_convict_threshold string Exists in 3.11, 4.0, trunk
false
prepared_statements_cache_size_mb integer Exists in 3.11, 4.0, trunk
false
range_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
range_tombstone_list_growth_factor string Exists in: 4.0, trunk
false
read_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
reject_repair_compaction_threshold integer Exists in: 4.0, trunk
false
repair_command_pool_full_strategy enum Exists in: 4.0, trunk

Enum: queue, reject
false
repair_command_pool_size integer Exists in: 4.0, trunk
false
repair_session_max_tree_depth integer Exists in 3.11, 4.0, trunk
false
repair_session_space_in_mb integer Exists in: 4.0, trunk
false
repaired_data_tracking_for_partition_reads_enabled boolean Exists in: 4.0, trunk
false
repaired_data_tracking_for_range_reads_enabled boolean Exists in: 4.0, trunk
false
replica_filtering_protection object Exists in 3.11, 4.0, trunk
false
report_unconfirmed_repaired_data_mismatches boolean Exists in: 4.0, trunk
false
request_scheduler string Exists in 3.11
false
request_scheduler_id enum Exists in 3.11

Enum: keyspace
false
request_scheduler_options object Exists in 3.11
false
request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
role_manager string Exists in 3.11, 4.0, trunk
false
roles_cache_max_entries integer Exists in 3.11, 4.0, trunk
false
roles_update_interval_in_ms integer Exists in 3.11, 4.0, trunk
false
roles_validity_in_ms integer Exists in 3.11, 4.0, trunk
false
row_cache_class_name string Exists in 3.11, 4.0, trunk
false
row_cache_keys_to_save integer Exists in 3.11, 4.0, trunk
false
row_cache_save_period integer Exists in 3.11, 4.0, trunk
false
row_cache_size_in_mb integer Exists in 3.11, 4.0, trunk
false
server_encryption_options object Exists in 3.11, 4.0, trunk
false
slow_query_log_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
snapshot_before_compaction boolean Exists in 3.11, 4.0, trunk
false
snapshot_links_per_second integer Exists in: 4.0, trunk
false
snapshot_on_duplicate_row_detection boolean Exists in 3.11, 4.0, trunk
false
snapshot_on_repaired_data_mismatch boolean Exists in: 4.0, trunk
false
sstable_preemptive_open_interval_in_mb integer Exists in 3.11, 4.0, trunk
false
stream_entire_sstables boolean Exists in: 4.0, trunk
false
stream_throughput_outbound_megabits_per_sec integer Exists in 3.11, 4.0, trunk
false
streaming_connections_per_host integer Exists in: 4.0, trunk
false
streaming_keep_alive_period_in_secs integer Exists in 3.11, 4.0, trunk
false
streaming_socket_timeout_in_ms integer Exists in 3.11
false
table_count_warn_threshold integer Exists in: 4.0, trunk
false
thrift_framed_transport_size_in_mb integer Exists in 3.11
false
thrift_max_message_length_in_mb integer Exists in 3.11
false
thrift_prepared_statements_cache_size_mb integer Exists in 3.11
false
tombstone_failure_threshold integer Exists in 3.11, 4.0, trunk
false
tombstone_warn_threshold integer Exists in 3.11, 4.0, trunk
false
tracetype_query_ttl integer Exists in 3.11, 4.0, trunk
false
tracetype_repair_ttl integer Exists in 3.11, 4.0, trunk
false
track_warnings object Exists in trunk
false
traverse_auth_from_root boolean Exists in trunk
false
trickle_fsync boolean Exists in 3.11, 4.0, trunk
false
trickle_fsync_interval_in_kb integer Exists in 3.11, 4.0, trunk
false
truncate_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false
unlogged_batch_across_partitions_warn_threshold integer Exists in 3.11, 4.0, trunk
false
use_deterministic_table_id boolean Exists in trunk
false
use_offheap_merkle_trees boolean Exists in: 4.0, trunk
false
user_defined_function_fail_timeout integer Exists in 3.11, 4.0, trunk
false
user_defined_function_warn_timeout integer Exists in 3.11, 4.0, trunk
false
user_function_timeout_policy enum Exists in 3.11, 4.0, trunk

Enum: ignore, die, die_immediate
false
validation_preview_purge_head_start_in_sec integer Exists in: 4.0, trunk
false
windows_timer_interval integer Exists in 3.11, 4.0, trunk
false
write_request_timeout_in_ms integer Exists in 3.11, 4.0, trunk
false

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

↩ Parent

Exists in: 4.0, trunk

Name Type Description Required
enabled boolean
true
archive_command string
false
block boolean
false
excluded_categories string
false
excluded_keyspaces string
false
excluded_users string
false
included_categories string
false
included_keyspaces string
false
included_users string
false
logger object
false
max_archive_retries integer
false
max_log_size integer
false
max_queue_weight integer
false
roll_cycle string
false

K8ssandraCluster.spec.cassandra.datacenters[index].config.cassandraYaml.audit_logging_options.logger

↩ Parent

Name Type Description Required
class_name string
true
parameters map[string]string
false

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

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
class_name string
true
parameters map[string]string
false

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

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
enabled boolean
true
accepted_protocols []string
false
algorithm string
false
cipher_suites []string
false
optional boolean
false
protocol string
false
require_client_auth boolean

Default: false
false
store_type string
false

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

↩ Parent

Exists in trunk

Name Type Description Required
subnets []string
true

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

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
class_name string
true
parameters map[string]string
false

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

↩ Parent

Exists in: 4.0, trunk

Name Type Description Required
archive_command string
false
block boolean
false
log_dir string
false
max_archive_retries integer
false
max_log_size integer
false
max_queue_weight integer
false
roll_cycle string
false

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

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
class_name string
true
parameters map[string]string
false

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

↩ Parent

Exists in trunk

Name Type Description Required
subnets []string
true

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

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
cached_rows_fail_threshold integer
false
cached_rows_warn_threshold integer
false

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

↩ Parent

Exists in 3.11

Name Type Description Required
default_weight integer
false
throttle_limit integer
false
weights map[string]integer
false

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

↩ Parent

Exists in 3.11, 4.0, trunk

Name Type Description Required
accepted_protocols []string
false
algorithm string
false
cipher_suites []string
false
enable_legacy_ssl_storage_port boolean

Default: false
false
internode_encryption enum

Enum: none, dc, rack, all
Default: none
false
optional boolean

Default: false
false
protocol string
false
require_client_auth boolean

Default: false
false
require_endpoint_verification boolean

Default: false
false
store_type string
false

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

↩ Parent

Exists in trunk

Name Type Description Required
enabled boolean
true
coordinator_read_size integer
false
local_read_size integer
false
row_index_size integer
false

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

↩ Parent

Name Type Description Required
additionalOptions []string Additional, arbitrary JVM options (advanced).
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 docker 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 docker 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 Docker 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. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. 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

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

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.datacenters[index].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.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

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
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
true
value string The header field value
true

K8ssandraCluster.spec.cassandra.datacenters[index].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.datacenters[index].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
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
true
value string The header field value
true

K8ssandraCluster.spec.cassandra.datacenters[index].containers[index].lifecycle.preStop.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.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. This is an alpha 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

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. This is an alpha 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

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
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

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. This is an alpha 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

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. This is an alpha 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

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
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].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

K8ssandraCluster.spec.cassandra.datacenters[index].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.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

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.datacenters[index].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 only be set if type is "Localhost".
false

K8ssandraCluster.spec.cassandra.datacenters[index].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. 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

K8ssandraCluster.spec.cassandra.datacenters[index].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. This is an alpha 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

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. This is an alpha 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

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
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].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 StorageConfig defines additional storage configurations

Name Type Description Required
mountPath string Mount path into cassandra container
true
name string Name of the pvc
true
pvcSpec object Persistent volume claim spec
true

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

↩ Parent

Persistent volume claim spec

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 This 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 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. (Alpha) 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 A label query over volumes to consider for binding.
false
storageClassName string 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

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

↩ Parent

This 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

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

↩ Parent

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. (Alpha) 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

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

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

↩ Parent

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.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 Volume's name. 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 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

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 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 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 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 Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". 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 The Name of the data disk in the blob storage
true
diskURI string The URI the data disk in the blob storage
true
cachingMode string Host Caching mode: None, Read Only, Read Write.
false
fsType string 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 Expected values 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 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 the name of secret that contains Azure Storage Account Name and Key
true
shareName string Share Name
true
readOnly boolean 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 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 Optional: Used as the mounted root, rather than the full Ceph tree, default is /
false
readOnly boolean 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 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 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 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

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 volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
true
fsType string 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 Optional: 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 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

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 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 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 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 The key to project.
true
path string 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 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 Filesystem type 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 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

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.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 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 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

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].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

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].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

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].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 This 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 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. (Alpha) 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 A label query over volumes to consider for binding.
false
storageClassName string 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

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

↩ Parent

This 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

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

↩ Parent

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. (Alpha) 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

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.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. 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

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 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 Optional: FC target lun number

Format: int32
false
readOnly boolean Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
targetWWNs []string Optional: FC target worldwide names (WWNs)
false
wwids []string 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 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 Optional: Extra command options if any.
false
readOnly boolean Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
secretRef object 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

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.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 Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
false
datasetUUID string UUID of the dataset. This is unique identifier of a Flocker dataset
false

K8ssandraCluster.spec.cassandra.datacenters[index].extraVolumes.volumes[index].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 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 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 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

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 URL
true
directory string 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 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 EndpointsName 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 Target iSCSI Qualified Name.
true
lun integer iSCSI Target Lun number.

Format: int32
true
targetPortal string 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 whether support iSCSI Discovery CHAP authentication
false
chapAuthSession boolean whether support iSCSI Session CHAP authentication
false
fsType string 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 Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
false
iscsiInterface string iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
false
portals []string 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 CHAP Secret for iSCSI target and initiator authentication
false

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

↩ Parent

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

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 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 ID that identifies Photon Controller persistent disk
true
fsType string 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 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

Items for all in one resources secrets, configmaps, and downward API

Name Type Description Required
defaultMode integer 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 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
configMap object information about the configMap data to project
false
downwardAPI object information about the downwardAPI data to project
false
secret object information about the secret data to project
false
serviceAccountToken object information about the serviceAccountToken data to project
false

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

↩ Parent

information about the configMap data to project

Name Type Description Required
items []object 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 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 The key to project.
true
path string 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 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

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

information about the secret data to project

Name Type Description Required
items []object 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 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 The key to project.
true
path string 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 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

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 The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
true
monitors []string A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
true
fsType string 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 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 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 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 The name of the storage system as configured in ScaleIO.
true
fsType string 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 The name of the ScaleIO Protection Domain for the configured storage.
false
readOnly boolean Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
sslEnabled boolean Flag to enable/disable SSL communication with Gateway, default false
false
storageMode string Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
false
storagePool string The ScaleIO Storage Pool associated with the protection domain.
false
volumeName string 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 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 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 Specify whether the Secret or its keys must be defined
false
secretName string 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 The key to project.
true
path string 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 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 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 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 Path that identifies vSphere volume vmdk
true
fsType string 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 Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
false
storagePolicyName string 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 docker 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 docker 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 Docker 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. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. 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

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

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.datacenters[index].initContainers[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.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

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
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
true
value string The header field value
true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[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.datacenters[index].initContainers[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
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
true
value string The header field value
true

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[index].lifecycle.preStop.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.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. This is an alpha 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

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. This is an alpha 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

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
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

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. This is an alpha 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

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. This is an alpha 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

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
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].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

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[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.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

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.datacenters[index].initContainers[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 only be set if type is "Localhost".
false

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[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. 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

K8ssandraCluster.spec.cassandra.datacenters[index].initContainers[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. This is an alpha 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

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. This is an alpha 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

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
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

The image to use in each Cassandra pod for the (short-lived) init container that enables JMX remote authentication on Cassandra pods. This is only useful when authentication is enabled in the cluster. The default is “busybox:1.34.1”.

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.

Default: docker.io
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].metadata

↩ Parent

Name Type Description Required
name string
true
annotations map[string]string
false
labels map[string]string
false
namespace 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 Description Required
internode integer
false
internodeSSL integer
false
native integer
false
nativeSSL integer
false

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

↩ Parent

Rack …

Name Type Description Required
name string The rack name
true
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

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

↩ Parent

Resources is the cpu and memory resources for the cassandra 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

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.45]
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
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
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 overriden 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

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].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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

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

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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

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

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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

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.

Default: docker.io
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

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].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. This is an alpha 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

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. This is an alpha 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

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
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.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.45]
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
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
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 overriden 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

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.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

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].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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

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

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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

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

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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

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.

Default: docker.io
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

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].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. This is an alpha 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

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. This is an alpha 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

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
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].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. This is an alpha 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

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. This is an alpha 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

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
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
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

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 overriden by DC specific settings)

Name Type Description Required
mcac object
false
prometheus object
false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.mcac

↩ Parent

Name Type Description Required
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].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. This is an alpha 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

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. This is an alpha 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

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
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
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

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 overriden by DC specific settings)

Name Type Description Required
mcac object
false
prometheus object
false

K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.mcac

↩ Parent

Name Type Description Required
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.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 StorageConfig defines additional storage configurations

Name Type Description Required
mountPath string Mount path into cassandra container
true
name string Name of the pvc
true
pvcSpec object Persistent volume claim spec
true

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec

↩ Parent

Persistent volume claim spec

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 This 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 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. (Alpha) 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 A label query over volumes to consider for binding.
false
storageClassName string 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

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec.dataSource

↩ Parent

This 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

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec.dataSourceRef

↩ Parent

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. (Alpha) 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

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.additionalVolumes[index].pvcSpec.selector

↩ Parent

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.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 This 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 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. (Alpha) 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 A label query over volumes to consider for binding.
false
storageClassName string 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

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.dataSource

↩ Parent

This 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

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.dataSourceRef

↩ Parent

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. (Alpha) 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

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

K8ssandraCluster.spec.cassandra.datacenters[index].storageConfig.cassandraDataVolumeClaimSpec.selector

↩ Parent

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 Description Required
mcac object
false
prometheus object
false

K8ssandraCluster.spec.cassandra.datacenters[index].telemetry.mcac

↩ Parent

Name Type Description Required
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].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.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 StorageConfig defines additional storage configurations

Name Type Description Required
mountPath string Mount path into cassandra container
true
name string Name of the pvc
true
pvcSpec object Persistent volume claim spec
true

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

↩ Parent

Persistent volume claim spec

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 This 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 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. (Alpha) 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 A label query over volumes to consider for binding.
false
storageClassName string 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

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

↩ Parent

This 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

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

↩ Parent

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. (Alpha) 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

K8ssandraCluster.spec.cassandra.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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

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

↩ Parent

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.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 Volume's name. 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 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

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 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 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 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 Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". 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 The Name of the data disk in the blob storage
true
diskURI string The URI the data disk in the blob storage
true
cachingMode string Host Caching mode: None, Read Only, Read Write.
false
fsType string 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 Expected values 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 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 the name of secret that contains Azure Storage Account Name and Key
true
shareName string Share Name
true
readOnly boolean 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 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 Optional: Used as the mounted root, rather than the full Ceph tree, default is /
false
readOnly boolean 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 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 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 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

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 volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
true
fsType string 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 Optional: 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 Optional: points to a secret object containing parameters used to connect to OpenStack.
false

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

↩ Parent

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 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 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 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 The key to project.
true
path string 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 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 Filesystem type 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 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

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.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 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 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

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].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

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].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

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].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 This 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 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. (Alpha) 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 A label query over volumes to consider for binding.
false
storageClassName string 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

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

↩ Parent

This 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

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

↩ Parent

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. (Alpha) 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

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

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

↩ Parent

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 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 Optional: FC target lun number

Format: int32
false
readOnly boolean Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
targetWWNs []string Optional: FC target worldwide names (WWNs)
false
wwids []string 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 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 Optional: Extra command options if any.
false
readOnly boolean Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
secretRef object 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

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.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 Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
false
datasetUUID string UUID of the dataset. This is unique identifier of a Flocker dataset
false

K8ssandraCluster.spec.cassandra.extraVolumes.volumes[index].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 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 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 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

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 URL
true
directory string 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 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 EndpointsName 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 Target iSCSI Qualified Name.
true
lun integer iSCSI Target Lun number.

Format: int32
true
targetPortal string 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 whether support iSCSI Discovery CHAP authentication
false
chapAuthSession boolean whether support iSCSI Session CHAP authentication
false
fsType string 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 Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
false
iscsiInterface string iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
false
portals []string 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 CHAP Secret for iSCSI target and initiator authentication
false

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

↩ Parent

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

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 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 ID that identifies Photon Controller persistent disk
true
fsType string 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 Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false

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

↩ Parent

Items for all in one resources secrets, configmaps, and downward API

Name Type Description Required
defaultMode integer 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 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
configMap object information about the configMap data to project
false
downwardAPI object information about the downwardAPI data to project
false
secret object information about the secret data to project
false
serviceAccountToken object information about the serviceAccountToken data to project
false

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

↩ Parent

information about the configMap data to project

Name Type Description Required
items []object 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 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 The key to project.
true
path string 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 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

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

information about the secret data to project

Name Type Description Required
items []object 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 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 The key to project.
true
path string 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 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

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 The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
true
monitors []string A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
true
fsType string 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 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 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 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 The name of the storage system as configured in ScaleIO.
true
fsType string 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 The name of the ScaleIO Protection Domain for the configured storage.
false
readOnly boolean Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
sslEnabled boolean Flag to enable/disable SSL communication with Gateway, default false
false
storageMode string Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
false
storagePool string The ScaleIO Storage Pool associated with the protection domain.
false
volumeName string 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 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 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 Specify whether the Secret or its keys must be defined
false
secretName string 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 The key to project.
true
path string 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 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 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 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 Path that identifies vSphere volume vmdk
true
fsType string 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 Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
false
storagePolicyName string 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 docker 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 docker 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 Docker 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. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. 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

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

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.initContainers[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.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

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
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
true
value string The header field value
true

K8ssandraCluster.spec.cassandra.initContainers[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.initContainers[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
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
true
value string The header field value
true

K8ssandraCluster.spec.cassandra.initContainers[index].lifecycle.preStop.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.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 an alpha 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

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. This is an alpha 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

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
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

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. This is an alpha 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

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. This is an alpha 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

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
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].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

K8ssandraCluster.spec.cassandra.initContainers[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.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

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.initContainers[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 only be set if type is "Localhost".
false

K8ssandraCluster.spec.cassandra.initContainers[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. 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

K8ssandraCluster.spec.cassandra.initContainers[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. This is an alpha 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

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. This is an alpha 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

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
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

The image to use in each Cassandra pod for the (short-lived) init container that enables JMX remote authentication on Cassandra pods. This is only useful when authentication is enabled in the cluster. The default is “busybox:1.34.1”.

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.

Default: docker.io
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

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.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 Description Required
internode integer
false
internodeSSL integer
false
native integer
false
nativeSSL integer
false

K8ssandraCluster.spec.cassandra.racks[index]

↩ Parent

Rack …

Name Type Description Required
name string The rack name
true
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

K8ssandraCluster.spec.cassandra.resources

↩ Parent

Resources is the cpu and memory resources for the cassandra 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

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 its password the expected format of the secret is a "keystore" entry and a "keystore-password" entry
true
truststoreSecretRef object ref to the secret that contains the truststore and its password the expected format of the secret is a "truststore" entry and a "truststore-password" entry
true

K8ssandraCluster.spec.cassandra.serverEncryptionStores.keystoreSecretRef

↩ Parent

ref to the secret that contains the keystore and its password the expected format of the secret is a “keystore” entry and a “keystore-password” entry

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.serverEncryptionStores.truststoreSecretRef

↩ Parent

ref to the secret that contains the truststore and its password the expected format of the secret is a “truststore” entry and a “truststore-password” entry

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

↩ 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 StorageConfig defines additional storage configurations

Name Type Description Required
mountPath string Mount path into cassandra container
true
name string Name of the pvc
true
pvcSpec object Persistent volume claim spec
true

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec

↩ Parent

Persistent volume claim spec

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 This 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 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. (Alpha) 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 A label query over volumes to consider for binding.
false
storageClassName string 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

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec.dataSource

↩ Parent

This 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

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec.dataSourceRef

↩ Parent

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. (Alpha) 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

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

K8ssandraCluster.spec.cassandra.storageConfig.additionalVolumes[index].pvcSpec.selector

↩ Parent

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.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 This 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 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. (Alpha) 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 A label query over volumes to consider for binding.
false
storageClassName string 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

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.dataSource

↩ Parent

This 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

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.dataSourceRef

↩ Parent

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. (Alpha) 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

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

K8ssandraCluster.spec.cassandra.storageConfig.cassandraDataVolumeClaimSpec.selector

↩ Parent

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

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 Description Required
mcac object
false
prometheus object
false

K8ssandraCluster.spec.cassandra.telemetry.mcac

↩ Parent

Name Type Description Required
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.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
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.

Default: docker.io
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

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.medusa.containerResources

↩ Parent

Medusa main container 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
false

K8ssandraCluster.spec.medusa.initContainerResources

↩ Parent

medusa-restore init container 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
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

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.medusa.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 only be set if type is "Localhost".
false

K8ssandraCluster.spec.medusa.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. 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

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 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
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
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 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 will be deployed on every Cassandra datacenter in this K8ssandraCluster.

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.2.0".

Default: map[name:cassandra-reaper repository:thelastpickle tag:3.2.0]
false
deploymentMode enum

Enum: PER_DC, SINGLE
Default: PER_DC
false
heapSize int or string HeapSize sets the JVM heap size to use for Reaper.

Default: 2Gi
false
initContainerImage object The image to use for the Reaper pod init container (that performs schema migrations). The default is "thelastpickle/cassandra-reaper:3.2.0".

Default: map[name:cassandra-reaper repository:thelastpickle tag:3.2.0]
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 Defines the username and password that Reaper will use to authenticate JMX connections to Cassandra clusters. These credentials will be automatically passed to each Cassandra node in the datacenter, as well as to the Reaper instance, so that the latter can authenticate against the former. If JMX 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
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
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
securityContext object SecurityContext applied to the Reaper main container.
false
telemetry object Telemetry defines the desired telemetry integrations to deploy targeting the Reaper pods for all DCs in this cluster (unless overriden 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.
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

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.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.
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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
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.

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

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. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

Name Type Description Required