K8ssandra-operator CRDs v0.4
Packages:
- config.k8ssandra.io/v1beta1
- k8ssandra.io/v1alpha1
- medusa.k8ssandra.io/v1alpha1
- reaper.k8ssandra.io/v1alpha1
- replication.k8ssandra.io/v1alpha1
- stargate.k8ssandra.io/v1alpha1
config.k8ssandra.io/v1beta1
Resource Types:
ClientConfig
ClientConfig 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
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
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
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
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 |
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
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 |
---|---|---|---|
cassandraTelemetry | object |
CassandraTelemetry defines the desired state for telemetry resources in this K8ssandraCluster. 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 |
clientEncryptionStores | object |
Client encryption stores which are used by Cassandra and Reaper. |
false |
config | object |
CassandraConfig is configuration settings that are applied to cassandra.yaml and jvm-options for 3.11.x or jvm-server-options for 4.x. |
false |
datacenters | []object |
Datacenters a list of the DCs in the cluster. |
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 " |
false |
systemLoggerResources | object |
SystemLoggerResources is the cpu and memory resources for the server-system-logger container. |
false |
K8ssandraCluster.spec.cassandra.cassandraTelemetry
CassandraTelemetry defines the desired state for telemetry resources in this K8ssandraCluster. 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 |
---|---|---|---|
prometheus | object |
|
false |
K8ssandraCluster.spec.cassandra.cassandraTelemetry.prometheus
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.clientEncryptionStores
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
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
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
CassandraConfig is configuration settings that are applied to cassandra.yaml and jvm-options for 3.11.x or jvm-server-options for 4.x.
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
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 |
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
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
Name | Type | Description | Required |
---|---|---|---|
class_name | string |
|
true |
parameters | map[string]string |
|
false |
K8ssandraCluster.spec.cassandra.config.cassandraYaml.back_pressure_strategy
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
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
Exists in trunk
Name | Type | Description | Required |
---|---|---|---|
subnets | []object |
|
true |
K8ssandraCluster.spec.cassandra.config.cassandraYaml.client_error_reporting_exclusions.subnets[index]
Name | Type | Description | Required |
---|---|---|---|
subnet | string |
|
true |
K8ssandraCluster.spec.cassandra.config.cassandraYaml.commitlog_compression
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
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
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
Exists in trunk
Name | Type | Description | Required |
---|---|---|---|
subnets | []object |
|
true |
K8ssandraCluster.spec.cassandra.config.cassandraYaml.internode_error_reporting_exclusions.subnets[index]
Name | Type | Description | Required |
---|---|---|---|
subnet | string |
|
true |
K8ssandraCluster.spec.cassandra.config.cassandraYaml.replica_filtering_protection
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
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
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
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
Name | Type | Description | Required |
---|---|---|---|
additionalOptions | []string |
|
false |
heapNewGenSize | int or string |
|
false |
heapSize | int or string |
|
false |
K8ssandraCluster.spec.cassandra.datacenters[index]
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 |
cassandraTelemetry | 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 |
config | object |
CassandraConfig is configuration settings that are applied to cassandra.yaml and jvm-options for 3.11.x or jvm-server-options for 4.x. |
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 |
|
false |
resources | object |
Resources is the cpu and memory resources for the cassandra container. |
false |
serverImage | string |
|
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 |
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 |
systemLoggerResources | object |
SystemLoggerResources is the cpu and memory resources for the server-system-logger container. |
false |
K8ssandraCluster.spec.cassandra.datacenters[index].cassandraTelemetry
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 |
---|---|---|---|
prometheus | object |
|
false |
K8ssandraCluster.spec.cassandra.datacenters[index].cassandraTelemetry.prometheus
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].config
CassandraConfig is configuration settings that are applied to cassandra.yaml and jvm-options for 3.11.x or jvm-server-options for 4.x.
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
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 |
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
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
Name | Type | Description | Required |
---|---|---|---|
class_name | string |
|
true |
parameters | map[string]string |
|
false |
K8ssandraCluster.spec.cassandra.datacenters[index].config.cassandraYaml.back_pressure_strategy
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
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
Exists in trunk
Name | Type | Description | Required |
---|---|---|---|
subnets | []object |
|
true |
K8ssandraCluster.spec.cassandra.datacenters[index].config.cassandraYaml.client_error_reporting_exclusions.subnets[index]
Name | Type | Description | Required |
---|---|---|---|
subnet | string |
|
true |
K8ssandraCluster.spec.cassandra.datacenters[index].config.cassandraYaml.commitlog_compression
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
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
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
Exists in trunk
Name | Type | Description | Required |
---|---|---|---|
subnets | []object |
|
true |
K8ssandraCluster.spec.cassandra.datacenters[index].config.cassandraYaml.internode_error_reporting_exclusions.subnets[index]
Name | Type | Description | Required |
---|---|---|---|
subnet | string |
|
true |
K8ssandraCluster.spec.cassandra.datacenters[index].config.cassandraYaml.replica_filtering_protection
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
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
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
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
Name | Type | Description | Required |
---|---|---|---|
additionalOptions | []string |
|
false |
heapNewGenSize | int or string |
|
false |
heapSize | int or string |
|
false |
K8ssandraCluster.spec.cassandra.datacenters[index].jmxInitContainerImage
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
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
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
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
Name | Type | Description | Required |
---|---|---|---|
internode | integer |
|
false |
internodeSSL | integer |
|
false |
native | integer |
|
false |
nativeSSL | integer |
|
false |
K8ssandraCluster.spec.cassandra.datacenters[index].racks[index]
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
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
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 |
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
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
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]
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
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]
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]
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
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]
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]
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]
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
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]
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
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
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]
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
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]
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]
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
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
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]
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
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]
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
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]
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
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
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]
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
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]
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]
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
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
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]
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
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]
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.cassandraConfigMapRef
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
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
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
LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
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
One and only one of the following should be specified. 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.httpGet
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]
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
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
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]
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 |
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
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
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]
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
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]
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]
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
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]
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]
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]
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
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]
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
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
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]
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
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]
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]
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
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
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]
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
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]
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
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]
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
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
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]
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
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]
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]
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
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
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]
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
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]
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].cassandraConfigMapRef
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
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
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
LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
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
One and only one of the following should be specified. 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.httpGet
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]
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
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
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
ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
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
One and only one of the following should be specified. 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.httpGet
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]
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
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
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
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
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 |
---|---|---|---|
prometheus | object |
|
false |
K8ssandraCluster.spec.cassandra.datacenters[index].stargate.racks[index].telemetry.prometheus
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]
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
ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
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
One and only one of the following should be specified. 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.httpGet
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]
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
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
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
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
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 |
---|---|---|---|
prometheus | object |
|
false |
K8ssandraCluster.spec.cassandra.datacenters[index].stargate.telemetry.prometheus
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]
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
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]
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
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. 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
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
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
Resources represents the minimum resources the volume should have. 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
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]
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
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. 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
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
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
Resources represents the minimum resources the volume should have. 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
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]
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].systemLoggerResources
SystemLoggerResources is the cpu and memory resources for the server-system-logger container.
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
requests | map[string]int or string |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
K8ssandraCluster.spec.cassandra.jmxInitContainerImage
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
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
Networking enables host networking and configures a NodePort ports.
Name | Type | Description | Required |
---|---|---|---|
hostNetwork | boolean |
|
false |
nodePort | object |
|
false |
K8ssandraCluster.spec.cassandra.networking.nodePort
Name | Type | Description | Required |
---|---|---|---|
internode | integer |
|
false |
internodeSSL | integer |
|
false |
native | integer |
|
false |
nativeSSL | integer |
|
false |
K8ssandraCluster.spec.cassandra.racks[index]
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
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
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
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
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
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]
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
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. 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
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
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
Resources represents the minimum resources the volume should have. 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
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]
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
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. 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
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
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
Resources represents the minimum resources the volume should have. 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
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]
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
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.systemLoggerResources
SystemLoggerResources is the cpu and memory resources for the server-system-logger container.
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
requests | map[string]int or string |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
K8ssandraCluster.spec.medusa
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 |
containerImage | object |
MedusaContainerImage is the image characteristics to use for Medusa containers. Leave nil to use a default image. |
false |
securityContext | object |
SecurityContext applied to the Medusa containers. |
false |
storageProperties | object |
Provides all storage backend related properties for backups. |
false |
K8ssandraCluster.spec.medusa.cassandraUserSecretRef
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.containerImage
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
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.securityContext
SecurityContext applied to the Medusa containers.
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean |
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
K8ssandraCluster.spec.medusa.securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
K8ssandraCluster.spec.medusa.securityContext.seLinuxOptions
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.
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
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
K8ssandraCluster.spec.medusa.securityContext.windowsOptions
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.
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
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 | string |
Kubernetes Secret that stores the key file for the storage provider's API. If using 'local' storage, this value is ignored. |
false |
transferMaxBandwidth | string |
Max upload bandwidth in MB/s. Defaults to 50 MB/s. Default: 50MB/s |
false |
K8ssandraCluster.spec.medusa.storageProperties.podStorage
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.reaper
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.1.0". Default: map[name:cassandra-reaper repository:thelastpickle tag:3.1.0] |
false |
deploymentMode | enum |
Enum: PER_DC, SINGLE Default: PER_DC |
false |
initContainerImage | object |
The image to use for the Reaper pod init container (that performs schema migrations). The default is "thelastpickle/cassandra-reaper:3.1.0". Default: map[name:cassandra-reaper repository:thelastpickle tag:3.1.0] |
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 |
securityContext | object |
SecurityContext applied to the Reaper main container. |
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
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
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]
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
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]
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]
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
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]
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]
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]
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
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]
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
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
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]
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
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.reaper.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.reaper.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.reaper.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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.reaper.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.reaper.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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.reaper.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.reaper.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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.reaper.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.reaper.autoScheduling
Auto scheduling properties. When you enable the auto-schedule feature, Reaper dynamically schedules repairs for all non-system keyspaces in a cluster. A cluster’s keyspaces are monitored and any modifications (additions or removals) are detected. When a new keyspace is created, a new repair schedule is created automatically for that keyspace. Conversely, when a keyspace is removed, the corresponding repair schedule is deleted.
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Default: false |
false |
excludedClusters | []string |
ExcludedClusters are the clusters that are to be excluded from the repair schedule. |
false |
excludedKeyspaces | []string |
ExcludedKeyspaces are the keyspaces that are to be excluded from the repair schedule. |
false |
initialDelayPeriod | string |
InitialDelay is the amount of delay time before the schedule period starts. Must be a valid ISO-8601 duration string. The default is "PT15S" (15 seconds). Default: PT15S |
false |
percentUnrepairedThreshold | integer |
PercentUnrepairedThreshold is the percentage of unrepaired data over which an incremental repair should be started. Only relevant when using repair type INCREMENTAL. Default: 10 Minimum: 0 Maximum: 100 |
false |
periodBetweenPolls | string |
PeriodBetweenPolls is the interval time to wait before checking whether to start a repair task. Must be a valid ISO-8601 duration string. The default is "PT10M" (10 minutes). Default: PT10M |
false |
repairType | enum |
RepairType is the type of repair to create: - REGULAR creates a regular repair (non-adaptive and non-incremental); - ADAPTIVE creates an adaptive repair; adaptive repairs are most suited for Cassandra 3. - INCREMENTAL creates an incremental repair; incremental repairs should only be used with Cassandra 4+. - AUTO chooses between ADAPTIVE and INCREMENTAL depending on the Cassandra server version; ADAPTIVE for Cassandra 3 and INCREMENTAL for Cassandra 4+. Enum: REGULAR, ADAPTIVE, INCREMENTAL, AUTO Default: AUTO |
false |
scheduleSpreadPeriod | string |
ScheduleSpreadPeriod is the time spacing between each of the repair schedules that is to be carried out. Must be a valid ISO-8601 duration string. The default is "PT6H" (6 hours). Default: PT6H |
false |
timeBeforeFirstSchedule | string |
TimeBeforeFirstSchedule is the grace period before the first repair in the schedule is started. Must be a valid ISO-8601 duration string. The default is "PT5M" (5 minutes). Default: PT5M |
false |
K8ssandraCluster.spec.reaper.cassandraUserSecretRef
Defines the username and password that Reaper will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Reaper instance, so that it can authenticate against nodes in the datacenter using CQL. If CQL authentication is not required, leave this field empty. The secret must be in the same namespace as Reaper itself and must contain two keys: “username” and “password”.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K8ssandraCluster.spec.reaper.containerImage
The image to use for the Reaper pod main container. The default is “thelastpickle/cassandra-reaper:3.1.0”.
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.reaper.containerImage.pullSecretRef
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.reaper.initContainerImage
The image to use for the Reaper pod init container (that performs schema migrations). The default is “thelastpickle/cassandra-reaper:3.1.0”.
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.reaper.initContainerImage.pullSecretRef
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.reaper.initContainerSecurityContext
InitContainerSecurityContext is the SecurityContext applied to the Reaper init container, used to perform schema migrations.
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean |
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
K8ssandraCluster.spec.reaper.initContainerSecurityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
K8ssandraCluster.spec.reaper.initContainerSecurityContext.seLinuxOptions
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.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
K8ssandraCluster.spec.reaper.initContainerSecurityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
K8ssandraCluster.spec.reaper.initContainerSecurityContext.windowsOptions
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.
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.reaper.jmxUserSecretRef
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”.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K8ssandraCluster.spec.reaper.livenessProbe
LivenessProbe sets the Reaper liveness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
K8ssandraCluster.spec.reaper.livenessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
K8ssandraCluster.spec.reaper.livenessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
K8ssandraCluster.spec.reaper.livenessProbe.httpGet.httpHeaders[index]
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.reaper.livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
K8ssandraCluster.spec.reaper.podSecurityContext
PodSecurityContext contains a pod-level SecurityContext to apply to Reaper pods.
Name | Type | Description | Required |
---|---|---|---|
fsGroup | integer |
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume. Format: int64 |
false |
fsGroupChangePolicy | string |
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
false |
seccompProfile | object |
The seccomp options to use by the containers in this pod. |
false |
supplementalGroups | []integer |
A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. |
false |
sysctls | []object |
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
K8ssandraCluster.spec.reaper.podSecurityContext.seLinuxOptions
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
K8ssandraCluster.spec.reaper.podSecurityContext.seccompProfile
The seccomp options to use by the containers in this pod.
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.reaper.podSecurityContext.sysctls[index]
Sysctl defines a kernel parameter to be set
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of a property to set |
true |
value | string |
Value of a property to set |
true |
K8ssandraCluster.spec.reaper.podSecurityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
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.reaper.readinessProbe
ReadinessProbe sets the Reaper readiness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
K8ssandraCluster.spec.reaper.readinessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
K8ssandraCluster.spec.reaper.readinessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
K8ssandraCluster.spec.reaper.readinessProbe.httpGet.httpHeaders[index]
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.reaper.readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
K8ssandraCluster.spec.reaper.securityContext
SecurityContext applied to the Reaper main container.
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean |
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
K8ssandraCluster.spec.reaper.securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
K8ssandraCluster.spec.reaper.securityContext.seLinuxOptions
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.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
K8ssandraCluster.spec.reaper.securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
K8ssandraCluster.spec.reaper.securityContext.windowsOptions
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.
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.reaper.tolerations[index]
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
Name | Type | Description | Required |
---|---|---|---|
effect | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
key | string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
false |
operator | string |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
false |
tolerationSeconds | integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64 |
false |
value | string |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
false |
K8ssandraCluster.spec.reaper.uiUserSecretRef
Defines the secret which contains the username and password for the Reaper UI and REST API 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.stargate
Stargate defines the desired deployment characteristics for Stargate in this K8ssandraCluster. If this is non-nil, Stargate will be deployed on every Cassandra datacenter in this K8ssandraCluster.
Name | Type | Description | Required |
---|---|---|---|
size | integer |
Size is the number of Stargate instances to deploy in each datacenter. They will be spread evenly across racks. Format: int32 Default: 1 Minimum: 1 |
true |
affinity | object |
Affinity is the affinity to apply to all the Stargate pods. Leave nil to let the controller reuse the same affinity rules used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity |
false |
allowStargateOnDataNodes | boolean |
AllowStargateOnDataNodes allows Stargate pods to be scheduled on a worker node already hosting data pods for this datacenter. The default is false, which means that Stargate pods will be scheduled on separate worker nodes. Note: if the datacenter pods have HostNetwork:true, then the Stargate pods will inherit of it, in which case it is possible that Stargate nodes won't be allowed to sit on data nodes even if this property is set to true, because of port conflicts on the same IP address. Default: false |
false |
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.stargate.affinity
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.stargate.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
false |
K8ssandraCluster.spec.stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Name | Type | Description | Required |
---|---|---|---|
preference | object |
A node selector term, associated with the corresponding weight. |
true |
weight | integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32 |
true |
K8ssandraCluster.spec.stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
A node selector term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
K8ssandraCluster.spec.stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
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.stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
K8ssandraCluster.spec.stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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.stargate.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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.stargate.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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.stargate.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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.stargate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
K8ssandraCluster.spec.stargate.cassandraConfigMapRef
CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
K8ssandraCluster.spec.stargate.containerImage
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.stargate.containerImage.pullSecretRef
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.stargate.livenessProbe
LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
K8ssandraCluster.spec.stargate.livenessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
K8ssandraCluster.spec.stargate.livenessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
K8ssandraCluster.spec.stargate.livenessProbe.httpGet.httpHeaders[index]
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.stargate.livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
K8ssandraCluster.spec.stargate.readinessProbe
ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
K8ssandraCluster.spec.stargate.readinessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
K8ssandraCluster.spec.stargate.readinessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
K8ssandraCluster.spec.stargate.readinessProbe.httpGet.httpHeaders[index]
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.stargate.readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
K8ssandraCluster.spec.stargate.resources
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.stargate.telemetry
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 |
---|---|---|---|
prometheus | object |
|
false |
K8ssandraCluster.spec.stargate.telemetry.prometheus
Name | Type | Description | Required |
---|---|---|---|
commonLabels | map[string]string |
CommonLabels are applied to all serviceMonitors created. |
false |
enabled | boolean |
Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate). |
false |
K8ssandraCluster.spec.stargate.tolerations[index]
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
Name | Type | Description | Required |
---|---|---|---|
effect | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
key | string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
false |
operator | string |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
false |
tolerationSeconds | integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64 |
false |
value | string |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
false |
K8ssandraCluster.status
K8ssandraClusterStatus defines the observed state of K8ssandraCluster
Name | Type | Description | Required |
---|---|---|---|
conditions | []object |
|
false |
datacenters | map[string]object |
Datacenters maps the CassandraDatacenter name to a K8ssandraStatus. The naming is a bit confusing but the mapping makes sense because we have a CassandraDatacenter and then define other components like Stargate and Reaper relative to it. I wanted to inline the field but when I do it won't serialize.
TODO Figure out how to inline this field |
false |
K8ssandraCluster.status.conditions[index]
Name | Type | Description | Required |
---|---|---|---|
status | string |
|
true |
type | string |
|
true |
lastTransitionTime | string |
LastTransitionTime is the last time the condition transited from one status to another. Format: date-time |
false |
K8ssandraCluster.status.datacenters[key]
K8ssandraStatus defines the observed of a k8ssandra instance
Name | Type | Description | Required |
---|---|---|---|
cassandra | object |
CassandraDatacenterStatus defines the observed state of CassandraDatacenter |
false |
decommissionProgress | string |
|
false |
reaper | object |
ReaperStatus defines the observed state of Reaper |
false |
stargate | object |
StargateStatus defines the observed state of a Stargate resource. |
false |
K8ssandraCluster.status.datacenters[key].cassandra
CassandraDatacenterStatus defines the observed state of CassandraDatacenter
Name | Type | Description | Required |
---|---|---|---|
cassandraOperatorProgress | string |
Last known progress state of the Cassandra Operator |
false |
conditions | []object |
|
false |
lastRollingRestart | string |
Format: date-time |
false |
lastServerNodeStarted | string |
The timestamp when the operator last started a Server node with the management API Format: date-time |
false |
nodeReplacements | []string |
|
false |
nodeStatuses | map[string]object |
|
false |
observedGeneration | integer |
Format: int64 |
false |
quietPeriod | string |
Format: date-time |
false |
superUserUpserted | string |
Deprecated. Use usersUpserted instead. The timestamp at which CQL superuser credentials were last upserted to the management API Format: date-time |
false |
trackedTasks | []object |
TrackedTasks tracks the tasks for completion that were created by the cass-operator |
false |
usersUpserted | string |
The timestamp at which managed cassandra users' credentials were last upserted to the management API Format: date-time |
false |
K8ssandraCluster.status.datacenters[key].cassandra.conditions[index]
Name | Type | Description | Required |
---|---|---|---|
message | string |
|
true |
reason | string |
|
true |
status | string |
|
true |
type | string |
|
true |
lastTransitionTime | string |
Format: date-time |
false |
K8ssandraCluster.status.datacenters[key].cassandra.nodeStatuses[key]
Name | Type | Description | Required |
---|---|---|---|
hostID | string |
|
false |
K8ssandraCluster.status.datacenters[key].cassandra.trackedTasks[index]
ObjectReference contains enough information to let you inspect or modify the referred object. — New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage. 2. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, “must refer only to types A and B” or “UID not honored” or “name must be restricted”. Those cannot be well described when embedded. 3. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 4. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple and the version of the actual struct is irrelevant. 5. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don’t make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string |
API version of the referent. |
false |
fieldPath | string |
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. |
false |
kind | string |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
false |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
false |
namespace | string |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
false |
resourceVersion | string |
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
false |
uid | string |
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
false |
K8ssandraCluster.status.datacenters[key].reaper
ReaperStatus defines the observed state of Reaper
Name | Type | Description | Required |
---|---|---|---|
conditions | []object |
|
false |
progress | enum |
Progress is the progress of this Reaper object. Enum: Pending, Deploying, Configuring, Running |
false |
K8ssandraCluster.status.datacenters[key].reaper.conditions[index]
Name | Type | Description | Required |
---|---|---|---|
status | string |
|
true |
type | string |
|
true |
lastTransitionTime | string |
LastTransitionTime is the last time the condition transited from one status to another. Format: date-time |
false |
K8ssandraCluster.status.datacenters[key].stargate
StargateStatus defines the observed state of a Stargate resource.
Name | Type | Description | Required |
---|---|---|---|
availableReplicas | integer |
Total number of available pods targeted by the Stargate deployment. Will be zero if the deployment has not been created yet. Format: int32 |
true |
readyReplicas | integer |
ReadyReplicas is the total number of ready pods targeted by the Stargate deployment. Will be zero if the deployment has not been created yet. Format: int32 |
true |
replicas | integer |
Total number of non-terminated pods targeted by the Stargate deployment (their labels match the selector). Will be zero if the deployment has not been created yet. Format: int32 |
true |
updatedReplicas | integer |
UpdatedReplicas is the total number of non-terminated pods targeted by the Stargate deployment that have the desired template spec. Will be zero if the deployment has not been created yet. Format: int32 |
true |
conditions | []object |
|
false |
deploymentRefs | []string |
DeploymentRefs is the names of the Deployment objects that were created for this Stargate object. |
false |
progress | enum |
Progress is the progress of this Stargate object. Enum: Pending, Deploying, Running |
false |
readyReplicasRatio | string |
ReadyReplicasRatio is a "X/Y" string representing the ratio between ReadyReplicas and Replicas in the Stargate deployment. |
false |
serviceRef | string |
ServiceRef is the name of the Service object that was created for this Stargate object. |
false |
K8ssandraCluster.status.datacenters[key].stargate.conditions[index]
Name | Type | Description | Required |
---|---|---|---|
status | string |
|
true |
type | string |
|
true |
lastTransitionTime | string |
LastTransitionTime is the last time the condition transited from one status to another. Format: date-time |
false |
medusa.k8ssandra.io/v1alpha1
Resource Types:
CassandraBackup
CassandraBackup is the Schema for the cassandrabackups API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | medusa.k8ssandra.io/v1alpha1 | true |
kind | string | CassandraBackup | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
CassandraBackupSpec defines the desired state of CassandraBackup |
false |
status | object |
CassandraBackupStatus defines the observed state of CassandraBackup |
false |
CassandraBackup.spec
CassandraBackupSpec defines the desired state of CassandraBackup
Name | Type | Description | Required |
---|---|---|---|
cassandraDatacenter | string |
The name of the CassandraDatacenter to back up |
true |
backupType | enum |
The type of the backup: "full" or "differential" Enum: differential, full Default: differential |
false |
name | string |
The name of the backup. TODO document format of generated name |
false |
CassandraBackup.status
CassandraBackupStatus defines the observed state of CassandraBackup
Name | Type | Description | Required |
---|---|---|---|
cassdcTemplateSpec | object |
|
false |
failed | []string |
|
false |
finishTime | string |
Format: date-time |
false |
finished | []string |
|
false |
inProgress | []string |
|
false |
startTime | string |
Format: date-time |
false |
CassandraBackup.status.cassdcTemplateSpec
Name | Type | Description | Required |
---|---|---|---|
spec | object |
CassandraDatacenterSpec defines the desired state of a CassandraDatacenter |
true |
metadata | object |
Standard object metadata |
false |
CassandraBackup.status.cassdcTemplateSpec.spec
CassandraDatacenterSpec defines the desired state of a CassandraDatacenter
Name | Type | Description | Required |
---|---|---|---|
clusterName | string |
The name by which CQL clients and instances will know the cluster. If the same cluster name is shared by multiple Datacenters in the same Kubernetes namespace, they will join together in a multi-datacenter cluster. |
true |
serverType | enum |
Server type: "cassandra" or "dse" Enum: cassandra, dse |
true |
serverVersion | string |
Version string for config builder, used to generate Cassandra server configuration |
true |
size | integer |
Desired number of Cassandra server nodes Format: int32 Minimum: 1 |
true |
storageConfig | object |
Describes the persistent storage request of each server node |
true |
additionalLabels | map[string]string |
Additional Labels allows to define additional labels that will be included in all objects created by the operator. Note, user can override values set by default from the cass-operator and doing so could break cass-operator functionality. |
false |
additionalSeeds | []string |
|
false |
additionalServiceConfig | object |
AdditionalServiceConfig allows to define additional parameters that are included in the created Services. Note, user can override values set by cass-operator and doing so could break cass-operator functionality. Avoid label "cass-operator" and anything that starts with "cassandra.datastax.com/" |
false |
allowMultipleNodesPerWorker | boolean |
Turning this option on allows multiple server pods to be created on a k8s worker node. By default the operator creates just one server pod per k8s worker node using k8s podAntiAffinity and requiredDuringSchedulingIgnoredDuringExecution. |
false |
canaryUpgrade | boolean |
Indicates that configuration and container image changes should only be pushed to the first rack of the datacenter |
false |
canaryUpgradeCount | integer |
The number of nodes that will be updated when CanaryUpgrade is true. Note that the value is either 0 or greater than the rack size, then all nodes in the rack will get updated. Format: int32 |
false |
config | string |
Config for the server, in YAML format Format: byte |
false |
configBuilderImage | string |
Container image for the config builder init container. Overrides value from ImageConfig ConfigBuilderImage |
false |
configBuilderResources | object |
Kubernetes resource requests and limits per server config initialization container. |
false |
configSecret | string |
ConfigSecret is the name of a secret that contains configuration for Cassandra. The secret is expected to have a property named config whose value should be a JSON formatted string that should look like this:
config: |- { "cassandra-yaml": { "read_request_timeout_in_ms": 10000 }, "jmv-options": { "max_heap_size": 1024M } }
ConfigSecret is mutually exclusive with Config. ConfigSecret takes precedence and will be used exclusively if both properties are set. The operator sets a watch such that an update to the secret will trigger an update of the StatefulSets. |
false |
disableSystemLoggerSidecar | boolean |
Configuration for disabling the simple log tailing sidecar container. Our default is to have it enabled. |
false |
dockerImageRunsAsCassandra | boolean |
Does the Server Docker image run as the Cassandra user? Defaults to true |
false |
dseWorkloads | object |
|
false |
forceUpgradeRacks | []string |
Rack names in this list are set to the latest StatefulSet configuration even if Cassandra nodes are down. Use this to recover from an upgrade that couldn't roll out. |
false |
managementApiAuth | object |
Config for the Management API certificates |
false |
networking | object |
|
false |
nodeAffinityLabels | map[string]string |
NodeAffinityLabels to pin the Datacenter, using node affinity |
false |
nodeSelector | map[string]string |
A map of label keys and values to restrict Cassandra node scheduling to k8s workers with matchiing labels. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector |
false |
podTemplateSpec | object |
PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the cassandra pods |
false |
racks | []object |
A list of the named racks in the datacenter, representing independent failure domains. The number of racks should match the replication factor in the keyspaces you plan to create, and the number of racks cannot easily be changed once a datacenter is deployed. |
false |
replaceNodes | []string |
A list of pod names that need to be replaced. |
false |
resources | object |
Kubernetes resource requests and limits, per pod |
false |
rollingRestartRequested | boolean |
Whether to do a rolling restart at the next opportunity. The operator will set this back to false once the restart is in progress. |
false |
serverImage | string |
Cassandra server image name. Use of ImageConfig to match ServerVersion is recommended instead of this value. This value will override anything set in the ImageConfig matching the ServerVersion More info: https://kubernetes.io/docs/concepts/containers/images |
false |
serviceAccount | string |
The k8s service account to use for the server pods |
false |
stopped | boolean |
A stopped CassandraDatacenter will have no running server pods, like using "stop" with traditional System V init scripts. Other Kubernetes resources will be left intact, and volumes will re-attach when the CassandraDatacenter workload is resumed. |
false |
superuserSecretName | string |
This secret defines the username and password for the Cassandra server superuser. If it is omitted, we will generate a secret instead. |
false |
systemLoggerImage | string |
Container image for the log tailing sidecar container. Overrides value from ImageConfig SystemLoggerImage |
false |
systemLoggerResources | object |
Kubernetes resource requests and limits per system logger container. |
false |
tolerations | []object |
Tolerations applied to the Cassandra pod. Note that these cannot be overridden with PodTemplateSpec. |
false |
users | []object |
Cassandra users to bootstrap |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig
Describes the persistent storage request of each server node
Name | Type | Description | Required |
---|---|---|---|
additionalVolumes | []object |
|
false |
cassandraDataVolumeClaimSpec | object |
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec
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. 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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.dataSource
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.dataSourceRef
Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.resources
Resources represents the minimum resources the volume should have. 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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.selector
A label query over volumes to consider for binding.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.additionalVolumes[index].pvcSpec.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec
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. 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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.dataSource
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.dataSourceRef
Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.resources
Resources represents the minimum resources the volume should have. 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 |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.selector
A label query over volumes to consider for binding.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.storageConfig.cassandraDataVolumeClaimSpec.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig
AdditionalServiceConfig allows to define additional parameters that are included in the created Services. Note, user can override values set by cass-operator and doing so could break cass-operator functionality. Avoid label “cass-operator” and anything that starts with “cassandra.datastax.com/”
Name | Type | Description | Required |
---|---|---|---|
additionalSeedService | object |
ServiceConfigAdditions exposes additional options for each service |
false |
allpodsService | object |
ServiceConfigAdditions exposes additional options for each service |
false |
dcService | object |
ServiceConfigAdditions exposes additional options for each service |
false |
nodePortService | object |
ServiceConfigAdditions exposes additional options for each service |
false |
seedService | object |
ServiceConfigAdditions exposes additional options for each service |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.additionalSeedService
ServiceConfigAdditions exposes additional options for each service
Name | Type | Description | Required |
---|---|---|---|
additionalAnnotations | map[string]string |
|
false |
additionalLabels | map[string]string |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.allpodsService
ServiceConfigAdditions exposes additional options for each service
Name | Type | Description | Required |
---|---|---|---|
additionalAnnotations | map[string]string |
|
false |
additionalLabels | map[string]string |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.dcService
ServiceConfigAdditions exposes additional options for each service
Name | Type | Description | Required |
---|---|---|---|
additionalAnnotations | map[string]string |
|
false |
additionalLabels | map[string]string |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.nodePortService
ServiceConfigAdditions exposes additional options for each service
Name | Type | Description | Required |
---|---|---|---|
additionalAnnotations | map[string]string |
|
false |
additionalLabels | map[string]string |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.additionalServiceConfig.seedService
ServiceConfigAdditions exposes additional options for each service
Name | Type | Description | Required |
---|---|---|---|
additionalAnnotations | map[string]string |
|
false |
additionalLabels | map[string]string |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.configBuilderResources
Kubernetes resource requests and limits per server config initialization container.
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
requests | map[string]int or string |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.dseWorkloads
Name | Type | Description | Required |
---|---|---|---|
analyticsEnabled | boolean |
|
false |
graphEnabled | boolean |
|
false |
searchEnabled | boolean |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.managementApiAuth
Config for the Management API certificates
Name | Type | Description | Required |
---|---|---|---|
insecure | object |
|
false |
manual | object |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.managementApiAuth.manual
Name | Type | Description | Required |
---|---|---|---|
clientSecretName | string |
|
true |
serverSecretName | string |
|
true |
skipSecretValidation | boolean |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.networking
Name | Type | Description | Required |
---|---|---|---|
hostNetwork | boolean |
|
false |
nodePort | object |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.networking.nodePort
Name | Type | Description | Required |
---|---|---|---|
internode | integer |
|
false |
internodeSSL | integer |
|
false |
native | integer |
|
false |
nativeSSL | integer |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec
PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the cassandra pods
Name | Type | Description | Required |
---|---|---|---|
metadata | object |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
false |
spec | object |
Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec
Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Name | Type | Description | Required |
---|---|---|---|
containers | []object |
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. |
true |
activeDeadlineSeconds | integer |
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. Format: int64 |
false |
affinity | object |
If specified, the pod's scheduling constraints |
false |
automountServiceAccountToken | boolean |
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
false |
dnsConfig | object |
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
false |
dnsPolicy | string |
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. |
false |
enableServiceLinks | boolean |
EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. |
false |
ephemeralContainers | []object |
List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. |
false |
hostAliases | []object |
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. |
false |
hostIPC | boolean |
Use the host's ipc namespace. Optional: Default to false. |
false |
hostNetwork | boolean |
Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. |
false |
hostPID | boolean |
Use the host's pid namespace. Optional: Default to false. |
false |
hostname | string |
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. |
false |
imagePullSecrets | []object |
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. 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 |
initContainers | []object |
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
false |
nodeName | string |
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. |
false |
nodeSelector | map[string]string |
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
false |
overhead | map[string]int or string |
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature. |
false |
preemptionPolicy | string |
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. |
false |
priority | integer |
The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. Format: int32 |
false |
priorityClassName | string |
If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. |
false |
readinessGates | []object |
If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates |
false |
restartPolicy | string |
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy |
false |
runtimeClassName | string |
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class This is a beta feature as of Kubernetes v1.14. |
false |
schedulerName | string |
If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. |
false |
securityContext | object |
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
false |
serviceAccount | string |
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
false |
serviceAccountName | string |
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
false |
setHostnameAsFQDN | boolean |
If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. |
false |
shareProcessNamespace | boolean |
Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. |
false |
subdomain | string |
If specified, the fully qualified Pod hostname will be " |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. Format: int64 |
false |
tolerations | []object |
If specified, the pod's tolerations. |
false |
topologySpreadConstraints | []object |
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. |
false |
volumes | []object |
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index]
EnvVar represents an environment variable present in a Container.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the environment variable. Must be a C_IDENTIFIER. |
true |
value | string |
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
false |
valueFrom | object |
Source for the environment variable's value. Cannot be used if value is not empty. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom
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[' |
false |
resourceFieldRef | object |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
false |
secretKeyRef | object |
Selects a key of a secret in the pod's namespace |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap or its key must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom.fieldRef
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom.resourceFieldRef
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].env[index].valueFrom.secretKeyRef
Selects a key of a secret in the pod’s namespace
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key of the secret to select from. Must be a valid secret key. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret or its key must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].envFrom[index]
EnvFromSource represents the source of a set of ConfigMaps
Name | Type | Description | Required |
---|---|---|---|
configMapRef | object |
The ConfigMap to select from |
false |
prefix | string |
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
false |
secretRef | object |
The Secret to select from |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].envFrom[index].configMapRef
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].envFrom[index].secretRef
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle
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 reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart
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 |
One and only one of the following should be specified. Exec specifies the action to take. |
false |
httpGet | object |
HTTPGet specifies the http request to perform. |
false |
tcpSocket | object |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.postStart.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop
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 reason for termination is passed to the handler. The Pod’s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period. 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 |
One and only one of the following should be specified. Exec specifies the action to take. |
false |
httpGet | object |
HTTPGet specifies the http request to perform. |
false |
tcpSocket | object |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].lifecycle.preStop.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe
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 |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].ports[index]
ContainerPort represents a network port in a single container.
Name | Type | Description | Required |
---|---|---|---|
containerPort | integer |
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32 |
true |
hostIP | string |
What host IP to bind the external port to. |
false |
hostPort | integer |
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32 |
false |
name | string |
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
false |
protocol | string |
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe
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 |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].resources
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
requests | map[string]int or string |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext
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 |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext.seLinuxOptions
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.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].securityContext.windowsOptions
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.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string |
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
false |
gmsaCredentialSpecName | string |
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
false |
hostProcess | boolean |
HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
false |
runAsUserName | string |
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe
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 |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].startupProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].volumeDevices[index]
volumeDevice describes a mapping of a raw block device within a container.
Name | Type | Description | Required |
---|---|---|---|
devicePath | string |
devicePath is the path inside of the container that the device will be mapped to. |
true |
name | string |
name must match the name of a persistentVolumeClaim in the pod |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.containers[index].volumeMounts[index]
VolumeMount describes a mounting of a Volume within a container.
Name | Type | Description | Required |
---|---|---|---|
mountPath | string |
Path within the container at which the volume should be mounted. Must not contain ':'. |
true |
name | string |
This must match the Name of a Volume. |
true |
mountPropagation | string |
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. |
false |
readOnly | boolean |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
false |
subPath | string |
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
false |
subPathExpr | string |
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity
If specified, the pod’s scheduling constraints
Name | Type | Description | Required |
---|---|---|---|
nodeAffinity | object |
Describes node affinity scheduling rules for the pod. |
false |
podAffinity | object |
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
false |
podAntiAffinity | object |
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Name | Type | Description | Required |
---|---|---|---|
preference | object |
A node selector term, associated with the corresponding weight. |
true |
weight | integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32 |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
A node selector term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
A label query over a set of resources, in this case pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
A label query over a set of resources, in this case pods.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.dnsConfig
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
Name | Type | Description | Required |
---|---|---|---|
nameservers | []string |
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. |
false |
options | []object |
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. |
false |
searches | []string |
A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.dnsConfig.options[index]
PodDNSConfigOption defines DNS resolver options of a pod.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Required. |
false |
value | string |
|
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index]
An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod’s ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. |
true |
args | []string |
Arguments to the entrypoint. The 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 |
false |
imagePullPolicy | string |
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
false |
lifecycle | object |
Lifecycle is not allowed for ephemeral containers. |
false |
livenessProbe | object |
Probes are not allowed for ephemeral containers. |
false |
ports | []object |
Ports are not allowed for ephemeral containers. |
false |
readinessProbe | object |
Probes are not allowed for ephemeral containers. |
false |
resources | object |
Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. |
false |
securityContext | object |
Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. |
false |
startupProbe | object |
Probes are not allowed for ephemeral containers. |
false |
stdin | boolean |
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
false |
stdinOnce | boolean |
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
false |
targetContainerName | string |
If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. |
false |
terminationMessagePath | string |
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
false |
terminationMessagePolicy | string |
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
false |
tty | boolean |
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
false |
volumeDevices | []object |
volumeDevices is the list of block devices to be used by the container. |
false |
volumeMounts | []object |
Pod volumes to mount into the container's filesystem. Cannot be updated. |
false |
workingDir | string |
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index]
EnvVar represents an environment variable present in a Container.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the environment variable. Must be a C_IDENTIFIER. |
true |
value | string |
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
false |
valueFrom | object |
Source for the environment variable's value. Cannot be used if value is not empty. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom
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[' |
false |
resourceFieldRef | object |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
false |
secretKeyRef | object |
Selects a key of a secret in the pod's namespace |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap or its key must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom.fieldRef
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom.resourceFieldRef
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].env[index].valueFrom.secretKeyRef
Selects a key of a secret in the pod’s namespace
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key of the secret to select from. Must be a valid secret key. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret or its key must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].envFrom[index]
EnvFromSource represents the source of a set of ConfigMaps
Name | Type | Description | Required |
---|---|---|---|
configMapRef | object |
The ConfigMap to select from |
false |
prefix | string |
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
false |
secretRef | object |
The Secret to select from |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].envFrom[index].configMapRef
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].envFrom[index].secretRef
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle
Lifecycle is not allowed for ephemeral containers.
Name | Type | Description | Required |
---|---|---|---|
postStart | object |
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
false |
preStop | object |
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart
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 |
One and only one of the following should be specified. Exec specifies the action to take. |
false |
httpGet | object |
HTTPGet specifies the http request to perform. |
false |
tcpSocket | object |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.postStart.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop
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 reason for termination is passed to the handler. The Pod’s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period. 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 |
One and only one of the following should be specified. Exec specifies the action to take. |
false |
httpGet | object |
HTTPGet specifies the http request to perform. |
false |
tcpSocket | object |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].lifecycle.preStop.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe
Probes are not allowed for ephemeral containers.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].ports[index]
ContainerPort represents a network port in a single container.
Name | Type | Description | Required |
---|---|---|---|
containerPort | integer |
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32 |
true |
hostIP | string |
What host IP to bind the external port to. |
false |
hostPort | integer |
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32 |
false |
name | string |
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
false |
protocol | string |
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe
Probes are not allowed for ephemeral containers.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].resources
Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
requests | map[string]int or string |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext
Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean |
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext.seLinuxOptions
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.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].securityContext.windowsOptions
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.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string |
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
false |
gmsaCredentialSpecName | string |
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
false |
hostProcess | boolean |
HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
false |
runAsUserName | string |
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe
Probes are not allowed for ephemeral containers.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].startupProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].volumeDevices[index]
volumeDevice describes a mapping of a raw block device within a container.
Name | Type | Description | Required |
---|---|---|---|
devicePath | string |
devicePath is the path inside of the container that the device will be mapped to. |
true |
name | string |
name must match the name of a persistentVolumeClaim in the pod |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.ephemeralContainers[index].volumeMounts[index]
VolumeMount describes a mounting of a Volume within a container.
Name | Type | Description | Required |
---|---|---|---|
mountPath | string |
Path within the container at which the volume should be mounted. Must not contain ':'. |
true |
name | string |
This must match the Name of a Volume. |
true |
mountPropagation | string |
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. |
false |
readOnly | boolean |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
false |
subPath | string |
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
false |
subPathExpr | string |
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.hostAliases[index]
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
Name | Type | Description | Required |
---|---|---|---|
hostnames | []string |
Hostnames for the above IP address. |
false |
ip | string |
IP address of the host file entry. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.imagePullSecrets[index]
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index]
EnvVar represents an environment variable present in a Container.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the environment variable. Must be a C_IDENTIFIER. |
true |
value | string |
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
false |
valueFrom | object |
Source for the environment variable's value. Cannot be used if value is not empty. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom
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[' |
false |
resourceFieldRef | object |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
false |
secretKeyRef | object |
Selects a key of a secret in the pod's namespace |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom.configMapKeyRef
Selects a key of a ConfigMap.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key to select. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap or its key must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom.fieldRef
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom.resourceFieldRef
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].env[index].valueFrom.secretKeyRef
Selects a key of a secret in the pod’s namespace
Name | Type | Description | Required |
---|---|---|---|
key | string |
The key of the secret to select from. Must be a valid secret key. |
true |
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret or its key must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].envFrom[index]
EnvFromSource represents the source of a set of ConfigMaps
Name | Type | Description | Required |
---|---|---|---|
configMapRef | object |
The ConfigMap to select from |
false |
prefix | string |
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
false |
secretRef | object |
The Secret to select from |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].envFrom[index].configMapRef
The ConfigMap to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the ConfigMap must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].envFrom[index].secretRef
The Secret to select from
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
optional | boolean |
Specify whether the Secret must be defined |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle
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 reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart
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 |
One and only one of the following should be specified. Exec specifies the action to take. |
false |
httpGet | object |
HTTPGet specifies the http request to perform. |
false |
tcpSocket | object |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.postStart.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop
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 reason for termination is passed to the handler. The Pod’s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period. 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 |
One and only one of the following should be specified. Exec specifies the action to take. |
false |
httpGet | object |
HTTPGet specifies the http request to perform. |
false |
tcpSocket | object |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].lifecycle.preStop.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe
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 |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].ports[index]
ContainerPort represents a network port in a single container.
Name | Type | Description | Required |
---|---|---|---|
containerPort | integer |
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32 |
true |
hostIP | string |
What host IP to bind the external port to. |
false |
hostPort | integer |
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32 |
false |
name | string |
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
false |
protocol | string |
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe
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 |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].resources
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
requests | map[string]int or string |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext
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 |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext.seLinuxOptions
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.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].securityContext.windowsOptions
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.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string |
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
false |
gmsaCredentialSpecName | string |
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
false |
hostProcess | boolean |
HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
false |
runAsUserName | string |
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe
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 |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index]
HTTPHeader describes a custom header to be used in HTTP probes
Name | Type | Description | Required |
---|---|---|---|
name | string |
The header field name |
true |
value | string |
The header field value |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].startupProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].volumeDevices[index]
volumeDevice describes a mapping of a raw block device within a container.
Name | Type | Description | Required |
---|---|---|---|
devicePath | string |
devicePath is the path inside of the container that the device will be mapped to. |
true |
name | string |
name must match the name of a persistentVolumeClaim in the pod |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.initContainers[index].volumeMounts[index]
VolumeMount describes a mounting of a Volume within a container.
Name | Type | Description | Required |
---|---|---|---|
mountPath | string |
Path within the container at which the volume should be mounted. Must not contain ':'. |
true |
name | string |
This must match the Name of a Volume. |
true |
mountPropagation | string |
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. |
false |
readOnly | boolean |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
false |
subPath | string |
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |
false |
subPathExpr | string |
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.readinessGates[index]
PodReadinessGate contains the reference to a pod condition
Name | Type | Description | Required |
---|---|---|---|
conditionType | string |
ConditionType refers to a condition in the pod's condition list with matching type. |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
Name | Type | Description | Required |
---|---|---|---|
fsGroup | integer |
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume. Format: int64 |
false |
fsGroupChangePolicy | string |
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
false |
seccompProfile | object |
The seccomp options to use by the containers in this pod. |
false |
supplementalGroups | []integer |
A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. |
false |
sysctls | []object |
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext.seLinuxOptions
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext.seccompProfile
The seccomp options to use by the containers in this pod.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext.sysctls[index]
Sysctl defines a kernel parameter to be set
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of a property to set |
true |
value | string |
Value of a property to set |
true |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.securityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string |
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
false |
gmsaCredentialSpecName | string |
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
false |
hostProcess | boolean |
HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
false |
runAsUserName | string |
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.tolerations[index]
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
Name | Type | Description | Required |
---|---|---|---|
effect | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
key | string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
false |
operator | string |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
false |
tolerationSeconds | integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64 |
false |
value | string |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.topologySpreadConstraints[index]
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
Name | Type | Description | Required |
---|---|---|---|
maxSkew | integer |
MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. Format: int32 |
true |
topologyKey | string |
TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each |
true |
whenUnsatisfiable | string |
WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. |
true |
labelSelector | object |
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.topologySpreadConstraints[index].labelSelector
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index]
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.
This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled. |
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].awsElasticBlockStore
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].azureDisk
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].azureFile
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].cephfs
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].cephfs.secretRef
Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].cinder
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].cinder.secretRef
Optional: points to a secret object containing parameters used to connect to OpenStack.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].configMap
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].configMap.items[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].csi
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].csi.nodePublishSecretRef
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].downwardAPI
DownwardAPI represents downward API about the pod that should populate this volume
Name | Type | Description | Required |
---|---|---|---|
defaultMode | integer |
Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32 |
false |
items | []object |
Items is a list of downward API volume file |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].downwardAPI.items[index]
DownwardAPIVolumeFile represents information to create the file containing the pod field
Name | Type | Description | Required |
---|---|---|---|
path | string |
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
true |
fieldRef | object |
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
false |
mode | integer |
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32 |
false |
resourceFieldRef | object |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].downwardAPI.items[index].fieldRef
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Name | Type | Description | Required |
---|---|---|---|
fieldPath | string |
Path of the field to select in the specified API version. |
true |
apiVersion | string |
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].downwardAPI.items[index].resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Name | Type | Description | Required |
---|---|---|---|
resource | string |
Required: resource to select |
true |
containerName | string |
Container name: required for volumes, optional for env vars |
false |
divisor | int or string |
Specifies the output format of the exposed resources, defaults to "1" |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].emptyDir
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral
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. This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.
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 ` |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name>
where <volume name>
is the name from the PodSpec.Volumes
array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).
An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
Name | Type | Description | Required |
---|---|---|---|
spec | object |
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |
true |
metadata | object |
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec
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. 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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef
Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources
Resources represents the minimum resources the volume should have. 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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector
A label query over volumes to consider for binding.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].fc
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].flexVolume
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].flexVolume.secretRef
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].flocker
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].gcePersistentDisk
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].gitRepo
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].glusterfs
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].hostPath
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.
Name | Type | Description | Required |
---|---|---|---|
path | string |
Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
true |
type | string |
Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].iscsi
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 |
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].iscsi.secretRef
CHAP Secret for iSCSI target and initiator authentication
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].nfs
NFS represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
Name | Type | Description | Required |
---|---|---|---|
path | string |
Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
true |
server | string |
Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
true |
readOnly | boolean |
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].persistentVolumeClaim
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].photonPersistentDisk
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].portworxVolume
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].configMap
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].configMap.items[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].downwardAPI
information about the downwardAPI data to project
Name | Type | Description | Required |
---|---|---|---|
items | []object |
Items is a list of DownwardAPIVolume file |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].downwardAPI.items[index]
DownwardAPIVolumeFile represents information to create the file containing the pod field
Name | Type | Description | Required |
---|---|---|---|
path | string |
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
true |
fieldRef | object |
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
false |
mode | integer |
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32 |
false |
resourceFieldRef | object |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Name | Type | Description | Required |
---|---|---|---|
fieldPath | string |
Path of the field to select in the specified API version. |
true |
apiVersion | string |
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
Name | Type | Description | Required |
---|---|---|---|
resource | string |
Required: resource to select |
true |
containerName | string |
Container name: required for volumes, optional for env vars |
false |
divisor | int or string |
Specifies the output format of the exposed resources, defaults to "1" |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].secret
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].secret.items[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].projected.sources[index].serviceAccountToken
information about the serviceAccountToken data to project
Name | Type | Description | Required |
---|---|---|---|
path | string |
Path is the path relative to the mount point of the file to project the token into. |
true |
audience | string |
Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
false |
expirationSeconds | integer |
ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64 |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].quobyte
Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime
Name | Type | Description | Required |
---|---|---|---|
registry | string |
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
true |
volume | string |
Volume is a string that references an already created Quobyte volume by name. |
true |
group | string |
Group to map volume access to Default is no group |
false |
readOnly | boolean |
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
false |
tenant | string |
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin |
false |
user | string |
User to map volume access to Defaults to serivceaccount user |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].rbd
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].rbd.secretRef
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].scaleIO
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].scaleIO.secretRef
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].secret
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].secret.items[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].storageos
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].storageos.secretRef
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.podTemplateSpec.spec.volumes[index].vsphereVolume
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.racks[index]
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 |
CassandraBackup.status.cassdcTemplateSpec.spec.resources
Kubernetes resource requests and limits, per pod
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
requests | map[string]int or string |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.systemLoggerResources
Kubernetes resource requests and limits per system logger container.
Name | Type | Description | Required |
---|---|---|---|
limits | map[string]int or string |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
requests | map[string]int or string |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.tolerations[index]
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
Name | Type | Description | Required |
---|---|---|---|
effect | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
key | string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
false |
operator | string |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
false |
tolerationSeconds | integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64 |
false |
value | string |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
false |
CassandraBackup.status.cassdcTemplateSpec.spec.users[index]
Name | Type | Description | Required |
---|---|---|---|
secretName | string |
|
true |
superuser | boolean |
|
true |
CassandraRestore
CassandraRestore is the Schema for the cassandrarestores API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | medusa.k8ssandra.io/v1alpha1 | true |
kind | string | CassandraRestore | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
CassandraRestoreSpec defines the desired state of CassandraRestore |
false |
status | object |
CassandraRestoreStatus defines the observed state of CassandraRestore |
false |
CassandraRestore.spec
CassandraRestoreSpec defines the desired state of CassandraRestore
Name | Type | Description | Required |
---|---|---|---|
backup | string |
The name of the CassandraBackup to restore |
true |
cassandraDatacenter | object |
|
true |
inPlace | boolean |
When true the restore will be performed on the source cluster from which the backup was taken. There will be a rolling restart of the source cluster. |
true |
shutdown | boolean |
When set to true, the cluster is shutdown before the restore is applied. This is necessary process if there are schema changes between the backup and current schema. Recommended. |
true |
CassandraRestore.spec.cassandraDatacenter
Name | Type | Description | Required |
---|---|---|---|
clusterName | string |
The name to give the C* cluster. |
true |
name | string |
The name to give the new, restored CassandraDatacenter |
true |
CassandraRestore.status
CassandraRestoreStatus defines the observed state of CassandraRestore
Name | Type | Description | Required |
---|---|---|---|
restoreKey | string |
A unique key that identifies the restore operation. |
true |
datacenterStopped | string |
Format: date-time |
false |
failed | []string |
|
false |
finishTime | string |
Format: date-time |
false |
finished | []string |
|
false |
inProgress | []string |
|
false |
startTime | string |
Format: date-time |
false |
Medusa
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | medusa.k8ssandra.io/v1alpha1 | true |
kind | string | Medusa | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
MedusaSpec defines the desired state of Medusa. |
false |
Medusa.spec
MedusaSpec defines the desired state of Medusa.
Name | Type | Description | Required |
---|---|---|---|
cassandraUserSecretRef | string |
Defines the username and password that Medusa will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Medusa instances, so that it can authenticate against nodes in the datacenter using CQL. The secret must be in the same namespace as Cassandra and must contain two keys: "username" and "password". |
false |
containerImage | object |
MedusaContainerImage is the image characteristics to use for Medusa containers. Leave nil to use a default image. |
false |
securityContext | object |
SecurityContext applied to the Medusa containers. |
false |
storageProperties | object |
Provides all storage backend related properties for backups. |
false |
Medusa.spec.containerImage
MedusaContainerImage is the image characteristics to use for Medusa containers. Leave nil to use a default image.
Name | Type | Description | Required |
---|---|---|---|
repository | string |
Default: k8ssandra/medusa |
true |
imagePullSecret | object |
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. |
false |
pullPolicy | string |
PullPolicy describes a policy for if/when to pull a container image Default: IfNotPresent |
false |
registry | string |
Default: docker.io |
false |
tag | string |
Default: latest |
false |
Medusa.spec.containerImage.imagePullSecret
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
Medusa.spec.securityContext
SecurityContext applied to the Medusa containers.
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean |
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
Medusa.spec.securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
Medusa.spec.securityContext.seLinuxOptions
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.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
Medusa.spec.securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
Medusa.spec.securityContext.windowsOptions
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.
Name | Type | Description | Required |
---|---|---|---|
gmsaCredentialSpec | string |
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
false |
gmsaCredentialSpecName | string |
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
false |
hostProcess | boolean |
HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. |
false |
runAsUserName | string |
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
Medusa.spec.storageProperties
Provides all storage backend related properties for backups.
Name | Type | Description | Required |
---|---|---|---|
apiProfile | string |
AWS Profile to use for authentication. |
false |
backupGracePeriodInDays | integer |
Age after which orphan sstables can be deleted from the storage backend. Protects from race conditions between purge and ongoing backups. Defaults to 10 days. |
false |
bucketName | string |
The name of the bucket to use for the backups. |
false |
concurrentTransfers | integer |
Number of concurrent uploads. Helps maximizing the speed of uploads but puts more pressure on the network. Defaults to 1. Default: 1 |
false |
host | string |
Host to connect to for the storage backend. |
false |
maxBackupAge | integer |
Maximum backup age that the purge process should observe. Default: 0 |
false |
maxBackupCount | integer |
Maximum number of backups to keep (used by the purge process). Default is unlimited. Default: 0 |
false |
multiPartUploadThreshold | integer |
File size over which cloud specific cli tools are used for transfer. Defaults to 100 MB. Default: 104857600 |
false |
port | integer |
Port to connect to for the storage backend. |
false |
prefix | string |
Name of the top level folder in the backup bucket. If empty, the cluster name will be used. |
false |
region | string |
Region of the storage bucket. Defaults to "default". |
false |
secure | boolean |
Whether to use SSL for the storage backend. |
false |
storageProvider | enum |
The storage backend to use for the backups. Enum: local, google_storage, azure_blobs, s3, s3_compatible, s3_rgw, ibm_storage |
false |
storageSecretRef | string |
Kubernetes Secret that stores the key file for the storage provider's API. If using 'local' storage, this value is ignored. |
false |
transferMaxBandwidth | string |
Max upload bandwidth in MB/s. Defaults to 50 MB/s. Default: 50MB/s |
false |
reaper.k8ssandra.io/v1alpha1
Resource Types:
Reaper
Reaper is the Schema for the reapers API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | reaper.k8ssandra.io/v1alpha1 | true |
kind | string | Reaper | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
ReaperSpec defines the desired state of Reaper |
false |
status | object |
ReaperStatus defines the observed state of Reaper |
false |
Reaper.spec
ReaperSpec defines the desired state of Reaper
Name | Type | Description | Required |
---|---|---|---|
datacenterRef | object |
DatacenterRef is the reference of a CassandraDatacenter resource that this Reaper instance should manage. It will also be used as the backend for persisting Reaper's state. Reaper must be able to access the JMX port (7199 by default) and the CQL port (9042 by default) on this DC. |
true |
ServiceAccountName | string |
Default: default |
false |
affinity | object |
Affinity applied to the Reaper pods. |
false |
autoScheduling | object |
Auto scheduling properties. When you enable the auto-schedule feature, Reaper dynamically schedules repairs for all non-system keyspaces in a cluster. A cluster's keyspaces are monitored and any modifications (additions or removals) are detected. When a new keyspace is created, a new repair schedule is created automatically for that keyspace. Conversely, when a keyspace is removed, the corresponding repair schedule is deleted. |
false |
cassandraUserSecretRef | object |
Defines the username and password that Reaper will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Reaper instance, so that it can authenticate against nodes in the datacenter using CQL. If CQL authentication is not required, leave this field empty. The secret must be in the same namespace as Reaper itself and must contain two keys: "username" and "password". |
false |
clientEncryptionStores | object |
Client encryption stores which are used by Cassandra and Reaper. |
false |
containerImage | object |
The image to use for the Reaper pod main container. The default is "thelastpickle/cassandra-reaper:3.1.0". Default: map[name:cassandra-reaper repository:thelastpickle tag:3.1.0] |
false |
datacenterAvailability | enum |
DatacenterAvailability indicates to Reaper its deployment in relation to the target datacenter's network. For single-DC clusters, the default (ALL) is fine. For multi-DC clusters, it is recommended to use EACH, provided that there is one Reaper instance managing each DC in the cluster; otherwise, if one single Reaper instance is going to manage more than one DC in the cluster, use ALL. See https://cassandra-reaper.io/docs/usage/multi_dc/. Enum: LOCAL, ALL, EACH Default: ALL |
false |
initContainerImage | object |
The image to use for the Reaper pod init container (that performs schema migrations). The default is "thelastpickle/cassandra-reaper:3.1.0". Default: map[name:cassandra-reaper repository:thelastpickle tag:3.1.0] |
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 |
securityContext | object |
SecurityContext applied to the Reaper main container. |
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 |
Reaper.spec.datacenterRef
DatacenterRef is the reference of a CassandraDatacenter resource that this Reaper instance should manage. It will also be used as the backend for persisting Reaper’s state. Reaper must be able to access the JMX port (7199 by default) and the CQL port (9042 by default) on this DC.
Name | Type | Description | Required |
---|---|---|---|
name | string |
The datacenter name. |
true |
namespace | string |
The datacenter namespace. If empty, the datacenter will be assumed to reside in the same namespace as the Reaper instance. |
false |
Reaper.spec.affinity
Affinity applied to the Reaper pods.
Name | Type | Description | Required |
---|---|---|---|
nodeAffinity | object |
Describes node affinity scheduling rules for the pod. |
false |
podAffinity | object |
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
false |
podAntiAffinity | object |
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
false |
Reaper.spec.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
false |
Reaper.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Name | Type | Description | Required |
---|---|---|---|
preference | object |
A node selector term, associated with the corresponding weight. |
true |
weight | integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32 |
true |
Reaper.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
A node selector term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
Reaper.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
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 |
Reaper.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
Reaper.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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 |
Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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 |
Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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 |
Reaper.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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 |
Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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 |
Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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 |
Reaper.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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 |
Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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 |
Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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 |
Reaper.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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 |
Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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 |
Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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 |
Reaper.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Reaper.spec.autoScheduling
Auto scheduling properties. When you enable the auto-schedule feature, Reaper dynamically schedules repairs for all non-system keyspaces in a cluster. A cluster’s keyspaces are monitored and any modifications (additions or removals) are detected. When a new keyspace is created, a new repair schedule is created automatically for that keyspace. Conversely, when a keyspace is removed, the corresponding repair schedule is deleted.
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Default: false |
false |
excludedClusters | []string |
ExcludedClusters are the clusters that are to be excluded from the repair schedule. |
false |
excludedKeyspaces | []string |
ExcludedKeyspaces are the keyspaces that are to be excluded from the repair schedule. |
false |
initialDelayPeriod | string |
InitialDelay is the amount of delay time before the schedule period starts. Must be a valid ISO-8601 duration string. The default is "PT15S" (15 seconds). Default: PT15S |
false |
percentUnrepairedThreshold | integer |
PercentUnrepairedThreshold is the percentage of unrepaired data over which an incremental repair should be started. Only relevant when using repair type INCREMENTAL. Default: 10 Minimum: 0 Maximum: 100 |
false |
periodBetweenPolls | string |
PeriodBetweenPolls is the interval time to wait before checking whether to start a repair task. Must be a valid ISO-8601 duration string. The default is "PT10M" (10 minutes). Default: PT10M |
false |
repairType | enum |
RepairType is the type of repair to create: - REGULAR creates a regular repair (non-adaptive and non-incremental); - ADAPTIVE creates an adaptive repair; adaptive repairs are most suited for Cassandra 3. - INCREMENTAL creates an incremental repair; incremental repairs should only be used with Cassandra 4+. - AUTO chooses between ADAPTIVE and INCREMENTAL depending on the Cassandra server version; ADAPTIVE for Cassandra 3 and INCREMENTAL for Cassandra 4+. Enum: REGULAR, ADAPTIVE, INCREMENTAL, AUTO Default: AUTO |
false |
scheduleSpreadPeriod | string |
ScheduleSpreadPeriod is the time spacing between each of the repair schedules that is to be carried out. Must be a valid ISO-8601 duration string. The default is "PT6H" (6 hours). Default: PT6H |
false |
timeBeforeFirstSchedule | string |
TimeBeforeFirstSchedule is the grace period before the first repair in the schedule is started. Must be a valid ISO-8601 duration string. The default is "PT5M" (5 minutes). Default: PT5M |
false |
Reaper.spec.cassandraUserSecretRef
Defines the username and password that Reaper will use to authenticate CQL connections to Cassandra clusters. These credentials will be automatically turned into CQL roles by cass-operator when bootstrapping the datacenter, then passed to the Reaper instance, so that it can authenticate against nodes in the datacenter using CQL. If CQL authentication is not required, leave this field empty. The secret must be in the same namespace as Reaper itself and must contain two keys: “username” and “password”.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
Reaper.spec.clientEncryptionStores
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 |
Reaper.spec.clientEncryptionStores.keystoreSecretRef
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 |
Reaper.spec.clientEncryptionStores.truststoreSecretRef
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 |
Reaper.spec.containerImage
The image to use for the Reaper pod main container. The default is “thelastpickle/cassandra-reaper:3.1.0”.
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 |
Reaper.spec.containerImage.pullSecretRef
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 |
Reaper.spec.initContainerImage
The image to use for the Reaper pod init container (that performs schema migrations). The default is “thelastpickle/cassandra-reaper:3.1.0”.
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 |
Reaper.spec.initContainerImage.pullSecretRef
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 |
Reaper.spec.initContainerSecurityContext
InitContainerSecurityContext is the SecurityContext applied to the Reaper init container, used to perform schema migrations.
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean |
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
Reaper.spec.initContainerSecurityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
Reaper.spec.initContainerSecurityContext.seLinuxOptions
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.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
Reaper.spec.initContainerSecurityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
Reaper.spec.initContainerSecurityContext.windowsOptions
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.
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 |
Reaper.spec.jmxUserSecretRef
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”.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
Reaper.spec.livenessProbe
LivenessProbe sets the Reaper liveness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
Reaper.spec.livenessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
Reaper.spec.livenessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
Reaper.spec.livenessProbe.httpGet.httpHeaders[index]
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 |
Reaper.spec.livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
Reaper.spec.podSecurityContext
PodSecurityContext contains a pod-level SecurityContext to apply to Reaper pods.
Name | Type | Description | Required |
---|---|---|---|
fsGroup | integer |
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume. Format: int64 |
false |
fsGroupChangePolicy | string |
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
false |
seccompProfile | object |
The seccomp options to use by the containers in this pod. |
false |
supplementalGroups | []integer |
A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. |
false |
sysctls | []object |
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
Reaper.spec.podSecurityContext.seLinuxOptions
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
Reaper.spec.podSecurityContext.seccompProfile
The seccomp options to use by the containers in this pod.
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 |
Reaper.spec.podSecurityContext.sysctls[index]
Sysctl defines a kernel parameter to be set
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of a property to set |
true |
value | string |
Value of a property to set |
true |
Reaper.spec.podSecurityContext.windowsOptions
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
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 |
Reaper.spec.readinessProbe
ReadinessProbe sets the Reaper readiness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
Reaper.spec.readinessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
Reaper.spec.readinessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
Reaper.spec.readinessProbe.httpGet.httpHeaders[index]
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 |
Reaper.spec.readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
Reaper.spec.securityContext
SecurityContext applied to the Reaper main container.
Name | Type | Description | Required |
---|---|---|---|
allowPrivilegeEscalation | boolean |
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
false |
capabilities | object |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
privileged | boolean |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
procMount | string |
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
false |
readOnlyRootFilesystem | boolean |
Whether this container has a read-only root filesystem. Default is false. |
false |
runAsGroup | integer |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
runAsNonRoot | boolean |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
runAsUser | integer |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Format: int64 |
false |
seLinuxOptions | object |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
seccompProfile | object |
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. |
false |
windowsOptions | object |
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
Reaper.spec.securityContext.capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Name | Type | Description | Required |
---|---|---|---|
add | []string |
Added capabilities |
false |
drop | []string |
Removed capabilities |
false |
Reaper.spec.securityContext.seLinuxOptions
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.
Name | Type | Description | Required |
---|---|---|---|
level | string |
Level is SELinux level label that applies to the container. |
false |
role | string |
Role is a SELinux role label that applies to the container. |
false |
type | string |
Type is a SELinux type label that applies to the container. |
false |
user | string |
User is a SELinux user label that applies to the container. |
false |
Reaper.spec.securityContext.seccompProfile
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
Name | Type | Description | Required |
---|---|---|---|
type | string |
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |
true |
localhostProfile | string |
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". |
false |
Reaper.spec.securityContext.windowsOptions
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.
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 |
Reaper.spec.tolerations[index]
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
Name | Type | Description | Required |
---|---|---|---|
effect | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
key | string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
false |
operator | string |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
false |
tolerationSeconds | integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64 |
false |
value | string |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
false |
Reaper.spec.uiUserSecretRef
Defines the secret which contains the username and password for the Reaper UI and REST API 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 |
Reaper.status
ReaperStatus defines the observed state of Reaper
Name | Type | Description | Required |
---|---|---|---|
conditions | []object |
|
false |
progress | enum |
Progress is the progress of this Reaper object. Enum: Pending, Deploying, Configuring, Running |
false |
Reaper.status.conditions[index]
Name | Type | Description | Required |
---|---|---|---|
status | string |
|
true |
type | string |
|
true |
lastTransitionTime | string |
LastTransitionTime is the last time the condition transited from one status to another. Format: date-time |
false |
replication.k8ssandra.io/v1alpha1
Resource Types:
ReplicatedSecret
ReplicatedSecret is the Schema for the replicatedsecrets API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | replication.k8ssandra.io/v1alpha1 | true |
kind | string | ReplicatedSecret | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
ReplicatedSecretSpec defines the desired state of ReplicatedSecret |
false |
status | object |
ReplicatedSecretStatus defines the observed state of ReplicatedSecret |
false |
ReplicatedSecret.spec
ReplicatedSecretSpec defines the desired state of ReplicatedSecret
Name | Type | Description | Required |
---|---|---|---|
replicationTargets | []object |
TargetContexts indicates the target clusters to which the secrets are replicated to. If empty, no clusters are targeted |
false |
selector | object |
Selector defines which secrets are replicated. If left empty, all the secrets are replicated |
false |
ReplicatedSecret.spec.replicationTargets[index]
Name | Type | Description | Required |
---|---|---|---|
k8sContextName | string |
K8sContextName defines the target cluster name as set in the ClientConfig. If left empty, current cluster is assumed |
false |
namespace | string |
TODO Implement at some point Namespace to replicate the data to in the target cluster. If left empty, current namespace is used. |
false |
ReplicatedSecret.spec.selector
Selector defines which secrets are replicated. If left empty, all the secrets are replicated
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
matchLabels | map[string]string |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
ReplicatedSecret.spec.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
ReplicatedSecret.status
ReplicatedSecretStatus defines the observed state of ReplicatedSecret
Name | Type | Description | Required |
---|---|---|---|
conditions | []object |
|
false |
ReplicatedSecret.status.conditions[index]
Name | Type | Description | Required |
---|---|---|---|
cluster | string |
Cluster |
true |
status | string |
Status of the replication to target cluster |
true |
type | string |
Type of condition |
true |
lastTransitionTime | string |
LastTransitionTime is the last time the condition transited from one status to another. Format: date-time |
false |
stargate.k8ssandra.io/v1alpha1
Resource Types:
Stargate
Stargate is the Schema for the stargates API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | stargate.k8ssandra.io/v1alpha1 | true |
kind | string | Stargate | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
Specification of the desired behavior of this Stargate resource. |
false |
status | object |
Most recently observed status of this Stargate resource. |
false |
Stargate.spec
Specification of the desired behavior of this Stargate resource.
Name | Type | Description | Required |
---|---|---|---|
datacenterRef | object |
DatacenterRef is the namespace-local reference of a CassandraDatacenter resource where Stargate should be deployed. |
true |
size | integer |
Size is the number of Stargate instances to deploy in each datacenter. They will be spread evenly across racks. Format: int32 Default: 1 Minimum: 1 |
true |
affinity | object |
Affinity is the affinity to apply to all the Stargate pods. Leave nil to let the controller reuse the same affinity rules used for data pods in this datacenter, if any. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity |
false |
allowStargateOnDataNodes | boolean |
AllowStargateOnDataNodes allows Stargate pods to be scheduled on a worker node already hosting data pods for this datacenter. The default is false, which means that Stargate pods will be scheduled on separate worker nodes. Note: if the datacenter pods have HostNetwork:true, then the Stargate pods will inherit of it, in which case it is possible that Stargate nodes won't be allowed to sit on data nodes even if this property is set to true, because of port conflicts on the same IP address. Default: false |
false |
auth | boolean |
Whether to enable authentication for Stargate. The default is true; it is highly recommended to always leave authentication turned on, not only on Stargate nodes, but also on data nodes as well. Note that Stargate REST APIs are currently only accessible if authentication is enabled, and if the authenticator in use in the whole cluster is PasswordAuthenticator. The usage of any other authenticator will cause the REST API to become inaccessible, see https://github.com/stargate/stargate/issues/792 for more. Stargate CQL API however remains accessible even if authentication is disabled in the cluster, or when a custom authenticator is being used. Default: true |
false |
cassandraConfigMapRef | object |
CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml. |
false |
cassandraEncryption | object |
Still it is required to pass the encryption stores secrets to the Stargate pods, so that they can be mounted as volumes. |
false |
containerImage | object |
ContainerImage is the image characteristics to use for Stargate containers. Leave nil to use a default image. Default: map[repository:stargateio tag:v1.0.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 |
Stargate.spec.datacenterRef
DatacenterRef is the namespace-local reference of a CassandraDatacenter resource where Stargate should be deployed.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
Stargate.spec.affinity
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 |
Stargate.spec.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
false |
Stargate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Name | Type | Description | Required |
---|---|---|---|
preference | object |
A node selector term, associated with the corresponding weight. |
true |
weight | integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32 |
true |
Stargate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
A node selector term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
Stargate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
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 |
Stargate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
Stargate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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 |
Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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 |
Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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 |
Stargate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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 |
Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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 |
Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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 |
Stargate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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 |
Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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 |
Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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 |
Stargate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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 |
Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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 |
Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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 |
Stargate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.cassandraConfigMapRef
CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
Stargate.spec.cassandraEncryption
Still it is required to pass the encryption stores secrets to the Stargate pods, so that they can be mounted as volumes.
Name | Type | Description | Required |
---|---|---|---|
clientEncryptionStores | object |
Client encryption stores which are used by Cassandra and Reaper. |
false |
serverEncryptionStores | object |
Internode encryption stores which are used by Cassandra and Stargate. |
false |
Stargate.spec.cassandraEncryption.clientEncryptionStores
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 |
Stargate.spec.cassandraEncryption.clientEncryptionStores.keystoreSecretRef
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 |
Stargate.spec.cassandraEncryption.clientEncryptionStores.truststoreSecretRef
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 |
Stargate.spec.cassandraEncryption.serverEncryptionStores
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 |
Stargate.spec.cassandraEncryption.serverEncryptionStores.keystoreSecretRef
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 |
Stargate.spec.cassandraEncryption.serverEncryptionStores.truststoreSecretRef
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 |
Stargate.spec.containerImage
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 |
Stargate.spec.containerImage.pullSecretRef
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 |
Stargate.spec.livenessProbe
LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
Stargate.spec.livenessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
Stargate.spec.livenessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
Stargate.spec.livenessProbe.httpGet.httpHeaders[index]
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 |
Stargate.spec.livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
Stargate.spec.racks[index]
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 |
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 |
Stargate.spec.racks[index].affinity
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 |
Stargate.spec.racks[index].affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
false |
Stargate.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Name | Type | Description | Required |
---|---|---|---|
preference | object |
A node selector term, associated with the corresponding weight. |
true |
weight | integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32 |
true |
Stargate.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference
A node selector term, associated with the corresponding weight.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
Stargate.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
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 |
Stargate.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object |
A list of node selector requirements by node's labels. |
false |
matchFields | []object |
A list of node selector requirements by node's fields. |
false |
Stargate.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
The label key that the selector applies to. |
true |
operator | string |
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
values | []string |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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 |
Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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 |
Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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 |
Stargate.spec.racks[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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 |
Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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 |
Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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 |
Stargate.spec.racks[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
Name | Type | Description | Required |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution | []object |
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
requiredDuringSchedulingIgnoredDuringExecution | []object |
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
false |
Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Name | Type | Description | Required |
---|---|---|---|
podAffinityTerm | object |
Required. A pod affinity term, associated with the corresponding weight. |
true |
weight | integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32 |
true |
Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm
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 |
Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector
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 |
Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector
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 |
Stargate.spec.racks[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]
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
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 |
Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector
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 |
Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector
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 |
Stargate.spec.racks[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string |
key is the label key that the selector applies to. |
true |
operator | string |
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
true |
values | []string |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
Stargate.spec.racks[index].cassandraConfigMapRef
CassandraConfigMapRef is a reference to a ConfigMap that holds Cassandra configuration. The map should have a key named cassandra_yaml.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
false |
Stargate.spec.racks[index].containerImage
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 |
Stargate.spec.racks[index].containerImage.pullSecretRef
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 |
Stargate.spec.racks[index].livenessProbe
LivenessProbe sets the Stargate liveness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
Stargate.spec.racks[index].livenessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
Stargate.spec.racks[index].livenessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
Stargate.spec.racks[index].livenessProbe.httpGet.httpHeaders[index]
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 |
Stargate.spec.racks[index].livenessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
Stargate.spec.racks[index].readinessProbe
ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
Stargate.spec.racks[index].readinessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
Stargate.spec.racks[index].readinessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
Stargate.spec.racks[index].readinessProbe.httpGet.httpHeaders[index]
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 |
Stargate.spec.racks[index].readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
Stargate.spec.racks[index].resources
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 |
Stargate.spec.racks[index].telemetry
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 |
---|---|---|---|
prometheus | object |
|
false |
Stargate.spec.racks[index].telemetry.prometheus
Name | Type | Description | Required |
---|---|---|---|
commonLabels | map[string]string |
CommonLabels are applied to all serviceMonitors created. |
false |
enabled | boolean |
Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate). |
false |
Stargate.spec.racks[index].tolerations[index]
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
Name | Type | Description | Required |
---|---|---|---|
effect | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
key | string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
false |
operator | string |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
false |
tolerationSeconds | integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64 |
false |
value | string |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
false |
Stargate.spec.readinessProbe
ReadinessProbe sets the Stargate readiness probe. Leave nil to use defaults.
Name | Type | Description | Required |
---|---|---|---|
exec | object |
One and only one of the following should be specified. 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 |
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. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |
false |
terminationGracePeriodSeconds | integer |
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64 |
false |
timeoutSeconds | integer |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 |
false |
Stargate.spec.readinessProbe.exec
One and only one of the following should be specified. Exec specifies the action to take.
Name | Type | Description | Required |
---|---|---|---|
command | []string |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
Stargate.spec.readinessProbe.httpGet
HTTPGet specifies the http request to perform.
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
httpHeaders | []object |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
path | string |
Path to access on the HTTP server. |
false |
scheme | string |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
Stargate.spec.readinessProbe.httpGet.httpHeaders[index]
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 |
Stargate.spec.readinessProbe.tcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook
Name | Type | Description | Required |
---|---|---|---|
port | int or string |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
host | string |
Optional: Host name to connect to, defaults to the pod IP. |
false |
Stargate.spec.resources
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 |
Stargate.spec.telemetry
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 |
---|---|---|---|
prometheus | object |
|
false |
Stargate.spec.telemetry.prometheus
Name | Type | Description | Required |
---|---|---|---|
commonLabels | map[string]string |
CommonLabels are applied to all serviceMonitors created. |
false |
enabled | boolean |
Enable the creation of Prometheus serviceMonitors for this resource (Cassandra or Stargate). |
false |
Stargate.spec.tolerations[index]
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
Name | Type | Description | Required |
---|---|---|---|
effect | string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
key | string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
false |
operator | string |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
false |
tolerationSeconds | integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64 |
false |
value | string |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
false |
Stargate.status
Most recently observed status of this Stargate resource.
Name | Type | Description | Required |
---|---|---|---|
availableReplicas | integer |
Total number of available pods targeted by the Stargate deployment. Will be zero if the deployment has not been created yet. Format: int32 |
true |
readyReplicas | integer |
ReadyReplicas is the total number of ready pods targeted by the Stargate deployment. Will be zero if the deployment has not been created yet. Format: int32 |
true |
replicas | integer |
Total number of non-terminated pods targeted by the Stargate deployment (their labels match the selector). Will be zero if the deployment has not been created yet. Format: int32 |
true |
updatedReplicas | integer |
UpdatedReplicas is the total number of non-terminated pods targeted by the Stargate deployment that have the desired template spec. Will be zero if the deployment has not been created yet. Format: int32 |
true |
conditions | []object |
|
false |
deploymentRefs | []string |
DeploymentRefs is the names of the Deployment objects that were created for this Stargate object. |
false |
progress | enum |
Progress is the progress of this Stargate object. Enum: Pending, Deploying, Running |
false |
readyReplicasRatio | string |
ReadyReplicasRatio is a "X/Y" string representing the ratio between ReadyReplicas and Replicas in the Stargate deployment. |
false |
serviceRef | string |
ServiceRef is the name of the Service object that was created for this Stargate object. |
false |
Stargate.status.conditions[index]
Name | Type | Description | Required |
---|---|---|---|
status | string |
|
true |
type | string |
|
true |
lastTransitionTime | string |
LastTransitionTime is the last time the condition transited from one status to another. Format: date-time |
false |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.