Packages:

missioncontrol.datastax.com/v1alpha1

Resource Types:

MissionControlCluster

MissionControlCluster is the Schema for the missioncontrolclusters API

Name Type Description Required

apiVersion

string

missioncontrol.datastax.com.v1alpha1

true

kind

string

MissionControlCluster

true

metadata

object

Refer to the Kubernetes API documentation for the fields of the metadata field.

true

spec

object

MissionControlClusterSpec defines the desired state of MissionControlCluster.

false

status

object

MissionControlClusterStatus defines the observed state of MissionControlCluster.

false

MissionControlCluster.spec

MissionControlClusterSpec defines the desired state of MissionControlCluster.

Name Type Description Required

datacenters

[]object

Datacenters a list of the DCs in the cluster.

true

additionalSeeds

[]string

AdditionalSeeds specifies DSE node IPs for an existing datacenter. This is primarily intended for migrations from an existing DSE cluster that is not managed by k8ssandra-operator.

false

auth

boolean

Whether to enable authentication in this cluster. The default is true; it is highly recommended to always leave authentication turned on.

  • Default: true

false

cdc

object

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

false

clientEncryptionStores

object

Client encryption stores which are used by DSE.

false

clusterName

string

Override the DSE cluster name. If unspecified, the cluster name will be the same as the K8ssandraCluster CRD name.

false

config

object

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

false

containers

[]object

Containers defines containers to be deployed in each Cassandra pod.

false

createIssuer

boolean

When true, create a self signed issuer to sign all downstream certificates. If false, a custom issuerRef may be specified in the encryption.internodeEncyption.certs.certTemplate.issuerRef field.

  • Default: true

false

datacenterName

string

DatacenterName allows to override the name of the Cassandra datacenter. Kubernetes objects will be named after a sanitized version of it if set, and if not metadata.name.

false

dseWorkloads

object

false

encryption

object

  • Default: map[internodeEncryption:map[certs:map[createCerts:true] enabled:true]]

false

externalDatacenters

[]string

During a migration the operator should alter keyspaces replication settings including the following external DCs.

false

extraVolumes

object

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

false

initContainers

[]object

InitContainers defines init-containers to be deployed in each Cassandra pod.

false

jmxInitContainerImage

object

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

false

managementApiAuth

object

ManagementApiAuth defines the authentication settings for the management API in the Cassandra pods.

false

medusa

object

false

mgmtAPIHeap

int or string

MgmtAPIHeap defines the amount of memory devoted to the management api heap.

false

networking

object

Networking enables host networking and configures a NodePort ports.

false

perNodeConfigInitContainerImage

string

The image to use in each Cassandra pod for the (short-lived) init container that merges global and perNodeConfig configuration. This is only useful when PerNodeConfigMapRef is set.

  • Default: mikefarah/yq:4

false

podSecurityContext

object

PodSecurityContext defines the security context for the Cassandra pods.

false

racks

[]object

Racks is a list of named racks. Note that racks are used to create node affinity. //

false

resources

object

Resources is the cpu and memory resources for the cassandra container.

false

serverEncryptionStores

object

Internode encryption stores which are used by DSE.

false

serverImage

string

ServerImage is the image for the cassandra container. Note that this should be a management-api image. If left empty the operator will choose a default image based on ServerVersion.

false

serverVersion

string

ServerVersion is the Cassandra or DSE version. The following versions are supported: - Cassandra: 3.11.X, 4.X.X and 5.X.X - DSE: 6.8.X, 7.x.x

false

serviceAccount

string

The k8s service account to use for the Cassandra pods

false

softPodAntiAffinity

boolean

SoftPodAntiAffinity sets whether multiple Cassandra instances can be scheduled on the same node.

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

false

telemetry

object

Telemetry defines the desired state for telemetry resources in this datacenter.

false

tolerations

[]object

Tolerations applied to every Cassandra pod.

false

MissionControlCluster.spec.datacenters[index]

Name Type Description Required

size

integer

Size is the number DSE pods to deploy in this datacenter. This number does not include Stargate instances.

  • Format: int32

  • Minimum: 1

true

cdc

object

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

false

config

object

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

false

containers

[]object

Containers defines containers to be deployed in each Cassandra pod.

false

datacenterName

string

DatacenterName allows to override the name of the Cassandra datacenter. Kubernetes objects will be named after a sanitized version of it if set, and if not metadata.name.

false

dseWorkloads

object

false

extraVolumes

object

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

false

initContainers

[]object

InitContainers defines init-containers to be deployed in each Cassandra pod.

false

jmxInitContainerImage

object

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

false

k8sContext

string

false

managementApiAuth

object

ManagementApiAuth defines the authentication settings for the management API in the Cassandra pods.

false

metadata

object

false

mgmtAPIHeap

int or string

MgmtAPIHeap defines the amount of memory devoted to the management api heap.

false

networking

object

Networking enables host networking and configures a NodePort ports.

false

perNodeConfigInitContainerImage

string

The image to use in each Cassandra pod for the (short-lived) init container that merges global and perNodeConfig configuration. This is only useful when PerNodeConfigMapRef is set.

  • Default: mikefarah/yq:4

false

perNodeConfigMapRef

object

PerNodeConfigMapRef is a reference to a ConfigMap that contains per-node configuration for this DC. The ConfigMap is expected to have entries in the following form: <pod-name>_<file-name>.

false

podSecurityContext

object

PodSecurityContext defines the security context for the Cassandra pods.

false

racks

[]object

Racks is a list of named racks. Note that racks are used to create node affinity. //

false

resources

object

Resources is the cpu and memory resources for the cassandra container.

false

serverImage

string

ServerImage is the image for the cassandra container. Note that this should be a management-api image. If left empty the operator will choose a default image based on ServerVersion.

false

serverVersion

string

ServerVersion is the Cassandra or DSE version. The following versions are supported: - Cassandra: 3.11.X, 4.X.X and 5.X.X - DSE: 6.8.X, 7.x.x

false

serviceAccount

string

The k8s service account to use for the Cassandra pods

false

softPodAntiAffinity

boolean

SoftPodAntiAffinity sets whether multiple Cassandra instances can be scheduled on the same node.

false

stopped

boolean

Stopped means that the datacenter will be stopped. Use this for maintenance or for cost saving.

  • Default: false

false

storageConfig

object

StorageConfig is the persistent storage requirements for each Cassandra pod. This includes everything under /var/lib/cassandra, namely the commit log and data directories.

false

telemetry

object

Telemetry defines the desired state for telemetry resources in this datacenter.

false

tolerations

[]object

Tolerations applied to every Cassandra pod.

false

MissionControlCluster.spec.datacenters[index].cdc

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

Name Type Description Required

pulsarServiceUrl

string

true

cdcConcurrentProcessors

integer

false

cdcPollIntervalM

integer

false

cdcWorkingDir

string

false

errorCommitLogReprocessEnabled

boolean

false

pulsarAuthParams

string

false

pulsarAuthPluginClassName

string

false

pulsarBatchDelayInMs

integer

false

pulsarKeyBasedBatcher

boolean

false

pulsarMaxPendingMessages

integer

false

pulsarMaxPendingMessagesAcrossPartitions

integer

false

sslAllowInsecureConnection

string

false

sslCipherSuites

string

false

sslEnabledProtocols

string

false

sslHostnameVerificationEnable

string

false

sslKeystorePassword

string

false

sslKeystorePath

string

false

sslProvider

string

false

sslTruststorePassword

string

false

sslTruststorePath

string

false

sslTruststoreType

string

false

topicPrefix

string

false

MissionControlCluster.spec.datacenters[index].config

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

Name Type Description Required

cassandraYaml

object

false

dseYaml

object

false

jvmOptions

object

false

MissionControlCluster.spec.datacenters[index].config.jvmOptions

Name Type Description Required

additionalJvm11ServerOptions

[]string

Jvm11ServerOptions are additional options that will be passed on to the jvm11-server-options file.

false

additionalJvm8ServerOptions

[]string

Jvm8ServerOptions are additional options that will be passed on to the jvm8-server-options file.

false

additionalJvmServerOptions

[]string

JvmServerOptions are additional options that will be passed on to the jvm-server-options file.

false

additionalOptions

[]string

Additional, arbitrary JVM options which are written into the cassandra-env.sh file.

false

cassandra_available_processors

integer

Available CPU processors. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

cassandra_disable_auth_caches_remote_configuration

boolean

Disable remote configuration via JMX of auth caches. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.

false

cassandra_expiration_date_overflow_policy

string

Defines how to handle INSERT requests with TTL exceeding the maximum supported expiration date. Possible values include REJECT, CAP, CAP_NOWARN. Cass Config Builder: supported for Cassandra 4.

false

cassandra_force_3_0_protocol_version

boolean

Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Dcassandra.force_3_0_protocol_version=true.

false

cassandra_force_default_indexing_page_size

boolean

Disable dynamic calculation of the page size used when indexing an entire partition (during initial index build/rebuild). Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.

false

cassandra_max_hint_ttl_seconds

integer

Imposes an upper bound on hint lifetime below the normal min gc_grace_seconds. Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.

false

cassandra_metrics_reporter_config_file

string

Enable pluggable metrics reporter. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

cassandra_ring_delay_ms

integer

Amount of time in milliseconds that a node waits before joining the ring. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

false

cassandra_triggers_directory

string

Default location for the trigger JARs. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

cassandra_write_survey

boolean

For testing new compaction and compression strategies. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.

false

debug_disable_contended_annotations

boolean

Disable honoring user code @Contended annotations. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:-RestrictContended.

false

debug_enable_flight_recorder

boolean

Enable Flight Recorder (Use in production is subject to Oracle licensing). Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

false

debug_listen_remote_debuggers

boolean

Listen for JVM remote debuggers on port 1414. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.

false

debug_log_compilation

boolean

Make Cassandra JVM log internal method compilation (developers only). Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+LogCompilation.

false

debug_non_safepoints

boolean

Whether the compiler should generate the necessary metadata for the parts of the code not at safe points as well. For use with Flight Recorder. Enabled by default.

false

debug_preserve_frame_pointer

boolean

Preserve Frame Pointer. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+PreserveFramePointer.

false

debug_unlock_commercial_features

boolean

Unlock commercial features. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

debug_unlock_diagnostic_vm_options

boolean

Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UnlockDiagnosticVMOptions.

false

gc

enum

The name of the garbage collector to use. Depending on the Cassandra version, not all values are supported: Cassandra 3.11 supports only G1GC and CMS; Cassandra 4.

  • Enum: G1GC, CMS, ZGC, Shenandoah, Graal, Custom

  • Default: G1GC

false

gc_cms_heap_size_young_generation

int or string

Disabled by default. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Xmn.

false

gc_cms_initiating_occupancy_fraction

integer

Defaults to 75. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:CMSInitiatingOccupancyFraction.

  • Minimum: 0

  • Maximum: 100

false

gc_cms_max_tenuring_threshold

integer

Defaults to 1. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:MaxTenuringThreshold.

false

gc_cms_survivor_ratio

integer

Defaults to 8. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:SurvivorRatio.

false

gc_cms_wait_duration_ms

integer

Defaults to 10000. Can only be used when CMS garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:CMSWaitDuration.

false

gc_g1_conc_threads

integer

Concurrent GC Threads. Can only be used when G1 garbage collector is used. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

false

gc_g1_initiating_heap_occupancy_percent

integer

Initiating Heap Occupancy Percentage. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

  • Minimum: 0

  • Maximum: 100

false

gc_g1_max_gc_pause_ms

integer

G1GC Max GC Pause in milliseconds. Defaults to 500. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

false

gc_g1_parallel_threads

integer

Parallel GC Threads. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.

false

gc_g1_rset_updating_pause_time_percent

integer

G1GC Updating Pause Time Percentage. Defaults to 5. Can only be used when G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

  • Minimum: 0

  • Maximum: 100

false

gc_print_application_stopped_time

boolean

Print GC Application Stopped Time. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCApplicationStoppedTime.

false

gc_print_date_stamps

boolean

Print GC Date Stamps. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCDateStamps.

false

gc_print_details

boolean

Print GC details. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintGCDetails.

false

gc_print_flss_statistics

boolean

Print FLSS Statistics. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:PrintFLSStatistics=1.

false

gc_print_heap

boolean

Print Heap at GC. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintHeapAtGC.

false

gc_print_log_file_size

int or string

Size of each log file. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:GCLogFileSize.

false

gc_print_number_of_log_files

integer

Number of GC log files. Disabled by default. Can only be used when the G1 garbage collector is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

false

gc_print_promotion_failure

boolean

Print promotion failure. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintPromotionFailure.

false

gc_print_tenuring_distribution

boolean

Print tenuring distribution. Defaults to false. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+PrintTenuringDistribution.

false

gc_print_use_log_file

boolean

Whether to print GC logs to /var/log/cassandra/gc.log. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -Xloggc:/var/log/cassandra/gc.log.

false

gc_print_use_log_file_rotation

boolean

Use GC Log File Rotation. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Corresponds to: -XX:+UseGCLogFileRotation.

false

heapNewGenSize

int or string

Deprecated. Use gc_cms_heap_size_young_generation instead. Valid for CMS garbage collector only + Cassandra 3.11.

false

heapSize

int or string

Deprecated. Use heap_initial_size and heap_max_size instead. If this field is defined, it applies to both max_heap_size and initial_heap_size.

false

heap_initial_size

int or string

Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Xms.

false

heap_max_size

int or string

Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Xmx.

false

jdk_allow_attach_self

boolean

Allow the current VM to attach to itself. Defaults to true. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -Djdk.attach.allowAttachSelf=true.

false

jmx_connection_type

string

Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Possible values for 3.

false

jmx_port

integer

Disabled by default. Defaults to 7199. TODO Make Reaper aware of the JMX port if a non-default port is used. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

false

jmx_remote_ssl

boolean

Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Defaults to false.

false

jmx_remote_ssl_opts

string

Remote SSL options. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

jmx_remote_ssl_require_client_auth

boolean

Require Client Authentication for remote SSL? Defaults to false. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

netty_eventloop_maxpendingtasks

integer

Defaults to 65536. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dio.netty.eventLoop.maxPendingTasks.

false

netty_try_reflection_set_accessible

boolean

Netty setting io.netty.tryReflectionSetAccessible. Defaults to true. Cass Config Builder: supported for Cassandra 4.0 in jvm11-server.options. Corresponds to: -Dio.netty.

false

nio_align_direct_memory

boolean

Align direct memory allocations on page boundaries. Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dsun.nio.PageAlignDirectMemory=true.

false

nio_maxcachedbuffersize

int or string

Defaults to 1048576. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Djdk.nio.maxCachedBufferSize.

false

vm_always_pre_touch

boolean

Ensure all memory is faulted and zeroed on startup. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.

false

vm_crash_on_out_of_memory_error

boolean

Disabled by default. Requires exit_on_out_of_memory_error to be disabled.. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+CrashOnOutOfMemoryError.

false

vm_disable_biased_locking

boolean

Disable biased locking to avoid biased lock revocation pauses. Disabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.

false

vm_disable_perf_shared_mem

boolean

Disable hsperfdata mmap’ed file. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

vm_enable_assertions

boolean

Enable assertions. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -ea.

false

vm_enable_non_root_thread_priority

boolean

Enable lowering thread priority without being root on linux. See CASSANDRA-1181 for details. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

false

vm_enable_thread_priorities

boolean

Enable thread priorities. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

vm_exit_on_out_of_memory_error

boolean

Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+ExitOnOutOfMemoryError.

false

vm_guaranteed_safepoint_interval_ms

integer

Defaults to 300000 milliseconds. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:GuaranteedSafepointInterval.

false

vm_heap_dump_on_out_of_memory_error

boolean

Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

vm_per_thread_stack_size

int or string

Per-thread stack size. Defaults to 256Ki. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

vm_prefer_ipv4

boolean

Prefer binding to IPv4 network interfaces. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

vm_print_heap_histogram_on_out_of_memory_error

boolean

Disabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -Dcassandra.printHeapHistogramOnOutOfMemoryError.

false

vm_resize_tlab

boolean

Allow resizing of thread-local allocation blocks. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.

false

vm_string_table_size

int or string

The size of interned string table. Larger sizes are beneficial to gossip. Defaults to 1000003. Cass Config Builder: supported for Cassandra 3.11 in jvm.options.

false

vm_use_numa

boolean

Enabled by default. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options. Corresponds to: -XX:+UseNUMA.

false

vm_use_tlab

boolean

Enable thread-local allocation blocks. Enabled by default. Cass Config Builder: supported for Cassandra 3.11 in jvm.options. Cass Config Builder: supported for Cassandra 4.0 in jvm-server.options.

false

MissionControlCluster.spec.datacenters[index].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 container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment.

false

command

[]string

Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment.

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.

false

image

string

Container image name. More info: https://kubernetes.

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.

false

lifecycle

object

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

false

livenessProbe

object

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

false

ports

[]object

List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.

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.

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.

false

startupProbe

object

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully.

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.

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.

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.

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

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

false

valueFrom

object

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

false

MissionControlCluster.spec.datacenters[index].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['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.

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.

false

secretKeyRef

object

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

false

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

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

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

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

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

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

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

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

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

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

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.

false

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

Name Type Description Required

exec

object

Exec specifies the action to take.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

tcpSocket

object

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility.

false

MissionControlCluster.spec.datacenters[index].containers[index].lifecycle.postStart.exec

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.

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].containers[index].lifecycle.postStart.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility.

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

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

Name Type Description Required

exec

object

Exec specifies the action to take.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

tcpSocket

object

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility.

false

MissionControlCluster.spec.datacenters[index].containers[index].lifecycle.preStop.exec

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.

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].containers[index].lifecycle.preStop.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility.

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

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

Exec specifies the action to take.

false

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • Format: int32

false

grpc

object

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

initialDelaySeconds

integer

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • Format: int32

false

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • Format: int32

false

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

  • Format: int32

false

tcpSocket

object

TCPSocket specifies an action involving a TCP port.

false

terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure.

  • 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

MissionControlCluster.spec.datacenters[index].containers[index].livenessProbe.exec

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.

false

MissionControlCluster.spec.datacenters[index].containers[index].livenessProbe.grpc

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name Type Description Required

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

  • Format: int32

true

service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].containers[index].livenessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Name Type Description Required

port

int or string

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

host

string

Optional: Host name to connect to, defaults to the pod IP.

false

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

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

Name Type Description Required

exec

object

Exec specifies the action to take.

false

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • Format: int32

false

grpc

object

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

initialDelaySeconds

integer

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • Format: int32

false

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • Format: int32

false

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

  • Format: int32

false

tcpSocket

object

TCPSocket specifies an action involving a TCP port.

false

terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure.

  • 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

MissionControlCluster.spec.datacenters[index].containers[index].readinessProbe.exec

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.

false

MissionControlCluster.spec.datacenters[index].containers[index].readinessProbe.grpc

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name Type Description Required

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

  • Format: int32

true

service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].containers[index].readinessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Name Type Description Required

port

int or string

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

host

string

Optional: Host name to connect to, defaults to the pod IP.

false

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

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

false

limits

map[string]int or string

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

false

requests

map[string]int or string

Requests describes the minimum amount of compute resources required.

false

MissionControlCluster.spec.datacenters[index].containers[index].resources.claims[index]

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required

name

string

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

true

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

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.

false

capabilities

object

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

false

privileged

boolean

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

false

procMount

string

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths.

false

readOnlyRootFilesystem

boolean

Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

false

runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext.

  • Format: int64

false

runAsNonRoot

boolean

Indicates that the container must run as a non-root user.

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.

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

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.

false

MissionControlCluster.spec.datacenters[index].containers[index].securityContext.capabilities

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

Name Type Description Required

add

[]string

Added capabilities

false

drop

[]string

Removed capabilities

false

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

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

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

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.

false

MissionControlCluster.spec.datacenters[index].containers[index].securityContext.windowsOptions

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used.

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.

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.

false

MissionControlCluster.spec.datacenters[index].containers[index].startupProbe

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully.

Name Type Description Required

exec

object

Exec specifies the action to take.

false

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • Format: int32

false

grpc

object

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

initialDelaySeconds

integer

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • Format: int32

false

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • Format: int32

false

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

  • Format: int32

false

tcpSocket

object

TCPSocket specifies an action involving a TCP port.

false

terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure.

  • 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

MissionControlCluster.spec.datacenters[index].containers[index].startupProbe.exec

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.

false

MissionControlCluster.spec.datacenters[index].containers[index].startupProbe.grpc

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name Type Description Required

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

  • Format: int32

true

service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].containers[index].startupProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Name Type Description Required

port

int or string

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

host

string

Optional: Host name to connect to, defaults to the pod IP.

false

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

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

false

MissionControlCluster.spec.datacenters[index].dseWorkloads

Name Type Description Required

analyticsEnabled

boolean

false

graphEnabled

boolean

false

searchEnabled

boolean

false

MissionControlCluster.spec.datacenters[index].extraVolumes

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

Name Type Description Required

pvcs

[]object

PVCs defines additional volumes to be added to each Cassandra pod and managed by the statefulset. Such volumes are automatically mounted by cass-operator into the cassandra containers.

false

volumes

[]object

Volumes defines volumes to be added to each Cassandra pod.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index]

AdditionalVolumes defines additional storage configurations

Name Type Description Required

mountPath

string

Mount path into cassandra container

true

name

string

Name of the pvc / volume

true

pvcSpec

object

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

false

volumeSource

object

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

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].pvcSpec

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

Name Type Description Required

accessModes

[]string

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

false

dataSource

object

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.

false

dataSourceRef

object

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.

false

resources

object

resources represents the minimum resources the volume should have.

false

selector

object

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

false

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

false

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

false

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].pvcSpec.dataSource

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.

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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].pvcSpec.dataSourceRef

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.

Name Type Description Required

kind

string

Kind is the type of resource being referenced

true

name

string

Name is the name of resource being referenced

true

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

false

namespace

string

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].pvcSpec.resources

resources represents the minimum resources the volume should have.

Name Type Description Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

false

limits

map[string]int or string

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

false

requests

map[string]int or string

Requests describes the minimum amount of compute resources required.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].pvcSpec.resources.claims[index]

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required

name

string

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

true

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].pvcSpec.selector

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

Name Type Description Required

matchExpressions

[]object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

matchLabels

map[string]string

matchLabels is a map of {key,value} pairs.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[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.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource

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

Name Type Description Required

awsElasticBlockStore

object

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

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.

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.

false

gitRepo

object

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated.

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.

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.

false

photonPersistentDisk

object

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

false

portworxVolume

object

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

false

projected

object

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

false

quobyte

object

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

false

rbd

object

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

false

scaleIO

object

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

false

secret

object

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

false

storageos

object

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

false

vsphereVolume

object

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

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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.

Name Type Description Required

volumeID

string

volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

true

fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

false

partition

integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1".

  • Format: int32

false

readOnly

boolean

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.azureDisk

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

Name Type Description Required

diskName

string

diskName is the Name of the data disk in the blob storage

true

diskURI

string

diskURI is the URI of data disk in the blob storage

true

cachingMode

string

cachingMode is the Host Caching mode: None, Read Only, Read Write.

false

fsType

string

fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

kind

string

kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set).

false

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.azureFile

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

Name Type Description Required

secretName

string

secretName is the name of secret that contains Azure Storage Account Name and Key

true

shareName

string

shareName is the azure share Name

true

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.cephfs

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

Name Type Description Required

monitors

[]string

monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

true

path

string

path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

readOnly

boolean

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

false

secretFile

string

secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

false

secretRef

object

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

false

user

string

user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.cephfs.secretRef

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

Name Type Description Required

name

string

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

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

true

fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

false

secretRef

object

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

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.cinder.secretRef

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

Name Type Description Required

name

string

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

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.configMap

configMap represents a configMap that should populate this volume

Name Type Description Required

defaultMode

integer

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

items

[]object

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value.

false

name

string

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

false

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.configMap.items[index]

Maps a string key to a path within a volume.

Name Type Description Required

key

string

key is the key to project.

true

path

string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

false

nodePublishSecretRef

object

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls.

false

readOnly

boolean

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

false

volumeAttributes

map[string]string

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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.

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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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.

  • Format: int32

false

items

[]object

Items is a list of downward API volume file

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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.

  • 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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

medium represents what type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory.

false

sizeLimit

int or string

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral

ephemeral represents a volume that is handled by a cluster storage driver.

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.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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.

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.

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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template.

Name Type Description Required

accessModes

[]string

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

false

dataSource

object

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.

false

dataSourceRef

object

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.

false

resources

object

resources represents the minimum resources the volume should have.

false

selector

object

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

false

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

false

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

false

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

false

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

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.

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

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

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.

Name Type Description Required

kind

string

Kind is the type of resource being referenced

true

name

string

Name is the name of resource being referenced

true

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

false

namespace

string

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.

false

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

resources represents the minimum resources the volume should have.

Name Type Description Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

false

limits

map[string]int or string

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

false

requests

map[string]int or string

Requests describes the minimum amount of compute resources required.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.ephemeral.volumeClaimTemplate.spec.resources.claims[index]

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required

name

string

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

true

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

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

Name Type Description Required

matchExpressions

[]object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

matchLabels

map[string]string

matchLabels is a map of {key,value} pairs.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

lun

integer

lun is Optional: FC target lun number

  • Format: int32

false

readOnly

boolean

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

targetWWNs

[]string

targetWWNs is Optional: FC target worldwide names (WWNs)

false

wwids

[]string

wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

options

map[string]string

options is Optional: this field holds extra command options if any.

false

readOnly

boolean

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

secretRef

object

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.flexVolume.secretRef

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified.

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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

datasetName is Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

false

datasetUUID

string

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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.

Name Type Description Required

pdName

string

pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

true

fsType

string

fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

false

partition

integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1".

  • 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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.gitRepo

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated.

Name Type Description Required

repository

string

repository is the URL

true

directory

string

directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository.

false

revision

string

revision is the commit hash for the specified revision.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

true

path

string

path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

true

readOnly

boolean

readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.hostPath

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container.

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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

iqn is the target iSCSI Qualified Name.

true

lun

integer

lun represents iSCSI Target Lun number.

  • Format: int32

true

targetPortal

string

targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

true

chapAuthDiscovery

boolean

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

false

chapAuthSession

boolean

chapAuthSession defines whether support iSCSI Session CHAP authentication

false

fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

false

initiatorName

string

initiatorName is the custom iSCSI Initiator Name.

false

iscsiInterface

string

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

false

portals

[]string

portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

false

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

secretRef

object

secretRef is the CHAP Secret for iSCSI target and initiator authentication

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.iscsi.secretRef

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name Type Description Required

name

string

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

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.persistentVolumeClaim

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.

Name Type Description Required

claimName

string

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

true

readOnly

boolean

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.photonPersistentDisk

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

Name Type Description Required

pdID

string

pdID is the ID that identifies Photon Controller persistent disk

true

fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected

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

Name Type Description Required

defaultMode

integer

defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

sources

[]object

sources is the list of volume projections

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.projected.sources[index]

Projection that may be projected along with other supported volume types

Name Type Description Required

configMap

object

configMap information about the configMap data to project

false

downwardAPI

object

downwardAPI information about the downwardAPI data to project

false

secret

object

secret information about the secret data to project

false

serviceAccountToken

object

serviceAccountToken is information about the serviceAccountToken data to project

false

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

configMap information about the configMap data to project

Name Type Description Required

items

[]object

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value.

false

name

string

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

false

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

false

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

Maps a string key to a path within a volume.

Name Type Description Required

key

string

key is the key to project.

true

path

string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

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

downwardAPI information about the downwardAPI data to project

Name Type Description Required

items

[]object

Items is a list of DownwardAPIVolume file

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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.

  • 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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

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

secret information about the secret data to project

Name Type Description Required

items

[]object

items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value.

false

name

string

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

false

optional

boolean

optional field specify whether the Secret or its key must be defined

false

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

Maps a string key to a path within a volume.

Name Type Description Required

key

string

key is the key to project.

true

path

string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

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

serviceAccountToken is information about the serviceAccountToken data to project

Name Type Description Required

path

string

path is the path relative to the mount point of the file to project the token into.

true

audience

string

audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token.

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.

  • Format: int64

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

true

monitors

[]string

monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

true

fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

false

keyring

string

keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

false

pool

string

pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

false

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

false

secretRef

object

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

false

user

string

user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.scaleIO

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

Name Type Description Required

gateway

string

gateway is the host address of the ScaleIO API Gateway.

true

secretRef

object

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

true

system

string

system is the name of the storage system as configured in ScaleIO.

true

fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".

false

protectionDomain

string

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

false

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

sslEnabled

boolean

sslEnabled Flag enable/disable SSL communication with Gateway, default false

false

storageMode

string

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

false

storagePool

string

storagePool is the ScaleIO Storage Pool associated with the protection domain.

false

volumeName

string

volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

items

[]object

items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value.

false

optional

boolean

optional field specify whether the Secret or its keys must be defined

false

secretName

string

secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.secret.items[index]

Maps a string key to a path within a volume.

Name Type Description Required

key

string

key is the key to project.

true

path

string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.storageos

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

Name Type Description Required

fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

secretRef

object

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

false

volumeName

string

volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

false

volumeNamespace

string

volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.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

MissionControlCluster.spec.datacenters[index].extraVolumes.pvcs[index].volumeSource.vsphereVolume

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

Name Type Description Required

volumePath

string

volumePath is the path that identifies vSphere volume vmdk

true

fsType

string

fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

storagePolicyID

string

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

false

storagePolicyName

string

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

false

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

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

true

awsElasticBlockStore

object

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

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.

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.

false

gitRepo

object

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated.

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.

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.

false

photonPersistentDisk

object

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

false

portworxVolume

object

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

false

projected

object

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

false

quobyte

object

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

false

rbd

object

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

false

scaleIO

object

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

false

secret

object

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

false

storageos

object

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

false

vsphereVolume

object

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

false

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

Name Type Description Required

volumeID

string

volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

true

fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

false

partition

integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1".

  • Format: int32

false

readOnly

boolean

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

false

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

diskName is the Name of the data disk in the blob storage

true

diskURI

string

diskURI is the URI of data disk in the blob storage

true

cachingMode

string

cachingMode is the Host Caching mode: None, Read Only, Read Write.

false

fsType

string

fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

kind

string

kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set).

false

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

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

secretName is the name of secret that contains Azure Storage Account Name and Key

true

shareName

string

shareName is the azure share Name

true

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].cephfs

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

Name Type Description Required

monitors

[]string

monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

true

path

string

path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

readOnly

boolean

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

false

secretFile

string

secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

false

secretRef

object

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

false

user

string

user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].cephfs.secretRef

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

Name Type Description Required

name

string

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

false

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

volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

true

fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

false

secretRef

object

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

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].cinder.secretRef

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

Name Type Description Required

name

string

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

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].configMap

configMap represents a configMap that should populate this volume

Name Type Description Required

defaultMode

integer

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

items

[]object

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value.

false

name

string

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

false

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].configMap.items[index]

Maps a string key to a path within a volume.

Name Type Description Required

key

string

key is the key to project.

true

path

string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

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

fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

false

nodePublishSecretRef

object

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls.

false

readOnly

boolean

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

false

volumeAttributes

map[string]string

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.

false

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

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

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

  • Format: int32

false

items

[]object

Items is a list of downward API volume file

false

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

  • 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

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

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

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

medium represents what type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory.

false

sizeLimit

int or string

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].ephemeral

ephemeral represents a volume that is handled by a cluster storage driver.

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.

false

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

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.

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

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

Name Type Description Required

accessModes

[]string

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

false

dataSource

object

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.

false

dataSourceRef

object

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.

false

resources

object

resources represents the minimum resources the volume should have.

false

selector

object

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

false

storageClassName

string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

false

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

false

volumeName

string

volumeName is the binding reference to the PersistentVolume backing this claim.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.

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

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.

Name Type Description Required

kind

string

Kind is the type of resource being referenced

true

name

string

Name is the name of resource being referenced

true

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

false

namespace

string

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

resources represents the minimum resources the volume should have.

Name Type Description Required

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

false

limits

map[string]int or string

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

false

requests

map[string]int or string

Requests describes the minimum amount of compute resources required.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.resources.claims[index]

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required

name

string

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

true

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

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

Name Type Description Required

matchExpressions

[]object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

matchLabels

map[string]string

matchLabels is a map of {key,value} pairs.

false

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

false

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

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

lun

integer

lun is Optional: FC target lun number

  • Format: int32

false

readOnly

boolean

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

targetWWNs

[]string

targetWWNs is Optional: FC target worldwide names (WWNs)

false

wwids

[]string

wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

false

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

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

options

map[string]string

options is Optional: this field holds extra command options if any.

false

readOnly

boolean

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

secretRef

object

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].flexVolume.secretRef

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified.

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

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

datasetName is Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

false

datasetUUID

string

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

false

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

Name Type Description Required

pdName

string

pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

true

fsType

string

fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

false

partition

integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1".

  • 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

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].gitRepo

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated.

Name Type Description Required

repository

string

repository is the URL

true

directory

string

directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository.

false

revision

string

revision is the commit hash for the specified revision.

false

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

endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

true

path

string

path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

true

readOnly

boolean

readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].hostPath

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container.

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

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

iqn is the target iSCSI Qualified Name.

true

lun

integer

lun represents iSCSI Target Lun number.

  • Format: int32

true

targetPortal

string

targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

true

chapAuthDiscovery

boolean

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

false

chapAuthSession

boolean

chapAuthSession defines whether support iSCSI Session CHAP authentication

false

fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

false

initiatorName

string

initiatorName is the custom iSCSI Initiator Name.

false

iscsiInterface

string

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

false

portals

[]string

portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

false

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

secretRef

object

secretRef is the CHAP Secret for iSCSI target and initiator authentication

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].iscsi.secretRef

secretRef is the CHAP Secret for iSCSI target and initiator authentication

Name Type Description Required

name

string

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

false

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

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].persistentVolumeClaim

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.

Name Type Description Required

claimName

string

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

true

readOnly

boolean

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].photonPersistentDisk

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

Name Type Description Required

pdID

string

pdID is the ID that identifies Photon Controller persistent disk

true

fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

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

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].projected

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

Name Type Description Required

defaultMode

integer

defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

sources

[]object

sources is the list of volume projections

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].projected.sources[index]

Projection that may be projected along with other supported volume types

Name Type Description Required

configMap

object

configMap information about the configMap data to project

false

downwardAPI

object

downwardAPI information about the downwardAPI data to project

false

secret

object

secret information about the secret data to project

false

serviceAccountToken

object

serviceAccountToken is information about the serviceAccountToken data to project

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].projected.sources[index].configMap

configMap information about the configMap data to project

Name Type Description Required

items

[]object

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value.

false

name

string

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

false

optional

boolean

optional specify whether the ConfigMap or its keys must be defined

false

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

Maps a string key to a path within a volume.

Name Type Description Required

key

string

key is the key to project.

true

path

string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].projected.sources[index].downwardAPI

downwardAPI information about the downwardAPI data to project

Name Type Description Required

items

[]object

Items is a list of DownwardAPIVolume file

false

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

  • 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

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

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

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].projected.sources[index].secret

secret information about the secret data to project

Name Type Description Required

items

[]object

items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value.

false

name

string

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

false

optional

boolean

optional field specify whether the Secret or its key must be defined

false

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

Maps a string key to a path within a volume.

Name Type Description Required

key

string

key is the key to project.

true

path

string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].projected.sources[index].serviceAccountToken

serviceAccountToken is information about the serviceAccountToken data to project

Name Type Description Required

path

string

path is the path relative to the mount point of the file to project the token into.

true

audience

string

audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token.

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.

  • Format: int64

false

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

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

image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

true

monitors

[]string

monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

true

fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

false

keyring

string

keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

false

pool

string

pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

false

readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

false

secretRef

object

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

false

user

string

user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

false

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

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].scaleIO

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

Name Type Description Required

gateway

string

gateway is the host address of the ScaleIO API Gateway.

true

secretRef

object

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

true

system

string

system is the name of the storage system as configured in ScaleIO.

true

fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".

false

protectionDomain

string

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

false

readOnly

boolean

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

sslEnabled

boolean

sslEnabled Flag enable/disable SSL communication with Gateway, default false

false

storageMode

string

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

false

storagePool

string

storagePool is the ScaleIO Storage Pool associated with the protection domain.

false

volumeName

string

volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

false

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

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

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

items

[]object

items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value.

false

optional

boolean

optional field specify whether the Secret or its keys must be defined

false

secretName

string

secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].secret.items[index]

Maps a string key to a path within a volume.

Name Type Description Required

key

string

key is the key to project.

true

path

string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.

  • Format: int32

false

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].storageos

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

Name Type Description Required

fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

readOnly

boolean

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

secretRef

object

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

false

volumeName

string

volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

false

volumeNamespace

string

volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used.

false

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

MissionControlCluster.spec.datacenters[index].extraVolumes.volumes[index].vsphereVolume

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

Name Type Description Required

volumePath

string

volumePath is the path that identifies vSphere volume vmdk

true

fsType

string

fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

storagePolicyID

string

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

false

storagePolicyName

string

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

false

MissionControlCluster.spec.datacenters[index].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 container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment.

false

command

[]string

Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment.

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.

false

image

string

Container image name. More info: https://kubernetes.

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.

false

lifecycle

object

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

false

livenessProbe

object

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

false

ports

[]object

List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.

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.

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.

false

startupProbe

object

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully.

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.

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.

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.

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

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

false

valueFrom

object

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

false

MissionControlCluster.spec.datacenters[index].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['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.

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.

false

secretKeyRef

object

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

false

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

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

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

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

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

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

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

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

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

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

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.

false

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

Name Type Description Required

exec

object

Exec specifies the action to take.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

tcpSocket

object

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].lifecycle.postStart.exec

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.

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].initContainers[index].lifecycle.postStart.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility.

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

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

Name Type Description Required

exec

object

Exec specifies the action to take.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

tcpSocket

object

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].lifecycle.preStop.exec

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.

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].initContainers[index].lifecycle.preStop.tcpSocket

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility.

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

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

Exec specifies the action to take.

false

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • Format: int32

false

grpc

object

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

initialDelaySeconds

integer

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • Format: int32

false

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • Format: int32

false

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

  • Format: int32

false

tcpSocket

object

TCPSocket specifies an action involving a TCP port.

false

terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure.

  • 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

MissionControlCluster.spec.datacenters[index].initContainers[index].livenessProbe.exec

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.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].livenessProbe.grpc

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name Type Description Required

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

  • Format: int32

true

service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].initContainers[index].livenessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Name Type Description Required

port

int or string

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

host

string

Optional: Host name to connect to, defaults to the pod IP.

false

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

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

Name Type Description Required

exec

object

Exec specifies the action to take.

false

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • Format: int32

false

grpc

object

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

initialDelaySeconds

integer

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • Format: int32

false

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • Format: int32

false

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

  • Format: int32

false

tcpSocket

object

TCPSocket specifies an action involving a TCP port.

false

terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure.

  • 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

MissionControlCluster.spec.datacenters[index].initContainers[index].readinessProbe.exec

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.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].readinessProbe.grpc

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name Type Description Required

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

  • Format: int32

true

service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].initContainers[index].readinessProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Name Type Description Required

port

int or string

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

host

string

Optional: Host name to connect to, defaults to the pod IP.

false

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

claims

[]object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

false

limits

map[string]int or string

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

false

requests

map[string]int or string

Requests describes the minimum amount of compute resources required.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].resources.claims[index]

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required

name

string

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

true

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

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.

false

capabilities

object

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

false

privileged

boolean

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

false

procMount

string

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths.

false

readOnlyRootFilesystem

boolean

Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

false

runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext.

  • Format: int64

false

runAsNonRoot

boolean

Indicates that the container must run as a non-root user.

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.

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

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.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].securityContext.capabilities

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

Name Type Description Required

add

[]string

Added capabilities

false

drop

[]string

Removed capabilities

false

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

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

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

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.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].securityContext.windowsOptions

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used.

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.

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.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].startupProbe

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully.

Name Type Description Required

exec

object

Exec specifies the action to take.

false

failureThreshold

integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • Format: int32

false

grpc

object

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

false

httpGet

object

HTTPGet specifies the http request to perform.

false

initialDelaySeconds

integer

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

  • Format: int32

false

periodSeconds

integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • Format: int32

false

successThreshold

integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

  • Format: int32

false

tcpSocket

object

TCPSocket specifies an action involving a TCP port.

false

terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure.

  • 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

MissionControlCluster.spec.datacenters[index].initContainers[index].startupProbe.exec

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.

false

MissionControlCluster.spec.datacenters[index].initContainers[index].startupProbe.grpc

GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.

Name Type Description Required

port

integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

  • Format: int32

true

service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

false

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

MissionControlCluster.spec.datacenters[index].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. This will be canonicalized upon output, so case-variant names will be understood as the same header.

true

value

string

The header field value

true

MissionControlCluster.spec.datacenters[index].initContainers[index].startupProbe.tcpSocket

TCPSocket specifies an action involving a TCP port.

Name Type Description Required

port

int or string

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

host

string

Optional: Host name to connect to, defaults to the pod IP.

false

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

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

false

MissionControlCluster.spec.datacenters[index].jmxInitContainerImage

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

Name Type Description Required

name

string

The image name to use.

false

pullPolicy

enum

The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent".

  • Enum: Always, IfNotPresent, Never

false

pullSecretRef

object

The secret to use when pulling the image from private repositories. If specified, this secret will be passed to individual puller implementations for them to use.

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

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

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

MissionControlCluster.spec.datacenters[index].managementApiAuth

ManagementApiAuth defines the authentication settings for the management API in the Cassandra pods.

Name Type Description Required

insecure

object

false

manual

object

false

MissionControlCluster.spec.datacenters[index].managementApiAuth.manual

Name Type Description Required

clientSecretName

string

true

serverSecretName

string

true

skipSecretValidation

boolean

false

MissionControlCluster.spec.datacenters[index].metadata

Name Type Description Required

name

string

true

annotations

map[string]string

false

commonAnnotations

map[string]string

annotations that will be applied to all components created by the CRD

false

commonLabels

map[string]string

labels that will be applied to all components created by the CRD

false

labels

map[string]string

false

namespace

string

false

pods

object

labels/annotations for the pod components

false

services

object

labels/annotations for all of the CassandraDatacenter service components

false

MissionControlCluster.spec.datacenters[index].metadata.pods

labels/annotations for the pod components

Name Type Description Required

annotations

map[string]string

false

labels

map[string]string

false

MissionControlCluster.spec.datacenters[index].metadata.services

labels/annotations for all of the CassandraDatacenter service components

Name Type Description Required

additionalSeedService

object

false

allPodsService

object

false

dcService

object

false

nodePortService

object

false

seedService

object

false

MissionControlCluster.spec.datacenters[index].metadata.services.additionalSeedService

Name Type Description Required

annotations

map[string]string

false

labels

map[string]string

false

MissionControlCluster.spec.datacenters[index].metadata.services.allPodsService

Name Type Description Required

annotations

map[string]string

false

labels

map[string]string

false

MissionControlCluster.spec.datacenters[index].metadata.services.dcService

Name Type Description Required

annotations

map[string]string

false

labels

map[string]string

false

MissionControlCluster.spec.datacenters[index].metadata.services.nodePortService

Name Type Description Required

annotations

map[string]string

false

labels

map[string]string

false

MissionControlCluster.spec.datacenters[index].metadata.services.seedService

Name Type Description Required

annotations

map[string]string

false

labels

map[string]string

false

MissionControlCluster.spec.datacenters[index].networking

Networking enables host networking and configures a NodePort ports.

Name Type Description Required

hostNetwork

boolean

false

nodePort

object

false

MissionControlCluster.spec.datacenters[index].networking.nodePort

Name Type Description Required

internode

integer

false

internodeSSL

integer

false

native

integer

false

nativeSSL

integer

false

MissionControlCluster.spec.datacenters[index].perNodeConfigMapRef

PerNodeConfigMapRef is a reference to a ConfigMap that contains per-node configuration for this DC. The ConfigMap is expected to have entries in the following form: <pod-name>_<file-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

MissionControlCluster.spec.datacenters[index].podSecurityContext

PodSecurityContext defines the security context for the Cassandra pods.

Name Type Description Required

fsGroup

integer

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1.

  • Format: int64

false

fsGroupChangePolicy

string

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod.

false

runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext.

  • Format: int64

false

runAsNonRoot

boolean

Indicates that the container must run as a non-root user.

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.

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

false

seccompProfile

object

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

false

supplementalGroups

[]integer

A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for th

false

sysctls

[]object

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.

false

windowsOptions

object

The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used.

false

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

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

MissionControlCluster.spec.datacenters[index].podSecurityContext.seccompProfile

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name Type Description Required

type

string

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used.

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.

false

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

MissionControlCluster.spec.datacenters[index].podSecurityContext.windowsOptions

The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used.

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.

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.

false

MissionControlCluster.spec.datacenters[index].racks[index]

Rack …​

Name Type Description Required

name

string

The rack name

true

affinity

object

Affinity rules to set for this rack only. Merged with values from PodTemplateSpec Affinity as well as NodeAffinityLabels.

false

nodeAffinityLabels

map[string]string

NodeAffinityLabels to pin the rack, using node affinity

false

zone

string

Deprecated. Use nodeAffinityLabels instead. DeprecatedZone name to pin the rack, using node affinity

false

MissionControlCluster.spec.datacenters[index].racks[index].affinity

Affinity rules to set for this rack only. Merged with values from PodTemplateSpec Affinity as well as NodeAffinityLabels.

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

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

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.

false

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

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

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

false

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

false

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

Name Type Description Required

nodeSelectorTerms

[]object

Required. A list of node selector terms. The terms are ORed.

true

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

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

false

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

false

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

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.

false

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

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

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.

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.

false

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

false

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

false

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

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.

false

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

false

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

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

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.

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.

false

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

false

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

false

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

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.

false

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

false

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

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.

false

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

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

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.

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.

false

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

false

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