KafkaCluster CRD schema reference (group kafka.banzaicloud.io)

KafkaCluster is the Schema for the kafkaclusters API

KafkaCluster

KafkaCluster is the Schema for the kafkaclusters API

Full name:
kafkaclusters.kafka.banzaicloud.io
Group:
kafka.banzaicloud.io
Singular name:
kafkacluster
Plural name:
kafkaclusters
Scope:
Namespaced
Versions:
v1beta1

Version v1beta1

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object

KafkaClusterSpec defines the desired state of KafkaCluster

.spec.alertManagerConfig

object

AlertManagerConfig defines configuration for alert manager

.spec.alertManagerConfig.downScaleLimit

integer

DownScaleLimit the limit for auto-downscaling the Kafka cluster. Once the size of the cluster (number of brokers) reaches or falls below this limit the auto-downscaling triggered by alerts is disabled until the cluster size exceeds this limit. This limit is not enforced if this field is omitted or is <= 0.

.spec.alertManagerConfig.upScaleLimit

integer

UpScaleLimit the limit for auto-upscaling the Kafka cluster. Once the size of the cluster (number of brokers) reaches or exceeds this limit the auto-upscaling triggered by alerts is disabled until the cluster size falls below this limit. This limit is not enforced if this field is omitted or is <= 0.

.spec.brokerConfigGroups

object

.spec.brokers

array Required

.spec.brokers[*]

object

Broker defines the broker basic configuration

.spec.brokers[*].brokerConfig

object

BrokerConfig defines the broker configuration

.spec.brokers[*].brokerConfig.affinity

object

Any definition received through this field will override the default behaviour of OneBrokerPerNode flag and the operator supposes that the user is aware of how scheduling is done by kubernetes Affinity could be set through brokerConfigGroups definitions and can be set for individual brokers as well where letter setting will override the group setting

.spec.brokers[*].brokerConfig.affinity.nodeAffinity

object

Describes node affinity scheduling rules for the pod.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

array

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*]

object

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

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference

object Required

A node selector term, associated with the corresponding weight.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions

array

A list of node selector requirements by node’s labels.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].key

string Required

The label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].operator

string Required

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].values

array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields

array

A list of node selector requirements by node’s fields.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*]

object

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

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].key

string Required

The label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].operator

string Required

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].values

array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].weight

integer Required

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

object

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

array Required

Required. A list of node selector terms. The terms are ORed.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*]

object

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.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions

array

A list of node selector requirements by node’s labels.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].key

string Required

The label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].operator

string Required

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].values

array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields

array

A list of node selector requirements by node’s fields.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*]

object

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

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].key

string Required

The label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].operator

string Required

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].values

array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAffinity

object

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

array

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm

object Required

Required. A pod affinity term, associated with the corresponding weight.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector

object

A label query over a set of resources, in this case pods.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector

object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces

array

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces[*]

string

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.topologyKey

string Required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

.spec.brokers[*].brokerConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].weight

integer Required

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

array

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector

object

A label query over a set of resources, in this case pods.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector

object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaces

array

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaces[*]

string

.spec.brokers[*].brokerConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].topologyKey

string Required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

.spec.brokers[*].brokerConfig.affinity.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)).

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

array

The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm

object Required

Required. A pod affinity term, associated with the corresponding weight.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector

object

A label query over a set of resources, in this case pods.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector

object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces

array

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces[*]

string

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.topologyKey

string Required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].weight

integer Required

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

array

If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector

object

A label query over a set of resources, in this case pods.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector

object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaces

array

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaces[*]

string

.spec.brokers[*].brokerConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].topologyKey

string Required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

.spec.brokers[*].brokerConfig.brokerAnnotations

object

Custom annotations for the broker pods - e.g.: Prometheus scraping annotations: prometheus.io/scrape: “true” prometheus.io/port: “9020”

.spec.brokers[*].brokerConfig.brokerIngressMapping

array

BrokerIngressMapping allows to set specific ingress to a specific broker mappings. If left empty, all broker will inherit the default one specified under external listeners config Only used when ExternalListeners.Config is populated

.spec.brokers[*].brokerConfig.brokerIngressMapping[*]

string

.spec.brokers[*].brokerConfig.brokerLabels

object

Custom labels for the broker pods, example use case: for Prometheus monitoring to capture the group for each broker as a label, e.g.: kafka_broker_group: “default_group” these labels will not override the reserved labels that the operator relies on, for example, “app”, “brokerId”, and “kafka_cr”

.spec.brokers[*].brokerConfig.config

string

.spec.brokers[*].brokerConfig.containers

array

Containers add extra Containers to the Kafka broker pod

.spec.brokers[*].brokerConfig.containers[*]

object

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

.spec.brokers[*].brokerConfig.containers[*].args

array

Arguments to the entrypoint. The container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

.spec.brokers[*].brokerConfig.containers[*].args[*]

string

.spec.brokers[*].brokerConfig.containers[*].command

array

Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

.spec.brokers[*].brokerConfig.containers[*].command[*]

string

.spec.brokers[*].brokerConfig.containers[*].env

array

List of environment variables to set in the container. Cannot be updated.

.spec.brokers[*].brokerConfig.containers[*].envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

.spec.brokers[*].brokerConfig.containers[*].envFrom[*]

object

EnvFromSource represents the source of a set of ConfigMaps

.spec.brokers[*].brokerConfig.containers[*].envFrom[*].configMapRef

object

The ConfigMap to select from

.spec.brokers[*].brokerConfig.containers[*].envFrom[*].configMapRef.name

string

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

.spec.brokers[*].brokerConfig.containers[*].envFrom[*].configMapRef.optional

boolean

Specify whether the ConfigMap must be defined

.spec.brokers[*].brokerConfig.containers[*].envFrom[*].prefix

string

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

.spec.brokers[*].brokerConfig.containers[*].envFrom[*].secretRef

object

The Secret to select from

.spec.brokers[*].brokerConfig.containers[*].envFrom[*].secretRef.name

string

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

.spec.brokers[*].brokerConfig.containers[*].envFrom[*].secretRef.optional

boolean

Specify whether the Secret must be defined

.spec.brokers[*].brokerConfig.containers[*].env[*]

object

EnvVar represents an environment variable present in a Container.

.spec.brokers[*].brokerConfig.containers[*].env[*].name

string Required

Name of the environment variable. Must be a C_IDENTIFIER.

.spec.brokers[*].brokerConfig.containers[*].env[*].value

string

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom

object

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

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.configMapKeyRef

object

Selects a key of a ConfigMap.

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.configMapKeyRef.key

string Required

The key to select.

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.configMapKeyRef.name

string

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

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.configMapKeyRef.optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.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.podIP, status.podIPs.

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.fieldRef.apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.fieldRef.fieldPath

string Required

Path of the field to select in the specified API version.

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.resourceFieldRef

object

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

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.resourceFieldRef.containerName

string

Container name: required for volumes, optional for env vars

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.resourceFieldRef.resource

string Required

Required: resource to select

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.secretKeyRef

object

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

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.secretKeyRef.key

string Required

The key of the secret to select from. Must be a valid secret key.

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.secretKeyRef.name

string

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

.spec.brokers[*].brokerConfig.containers[*].env[*].valueFrom.secretKeyRef.optional

boolean

Specify whether the Secret or its key must be defined

.spec.brokers[*].brokerConfig.containers[*].image

string

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

.spec.brokers[*].brokerConfig.containers[*].imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

.spec.brokers[*].brokerConfig.containers[*].lifecycle

object

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart

object

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.exec.command

array

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.exec.command[*]

string

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.tcpSocket

object

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.postStart.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop

object

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.exec.command

array

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.exec.command[*]

string

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.tcpSocket

object

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.containers[*].lifecycle.preStop.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].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

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.exec.command

array

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

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.exec.command[*]

string

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.failureThreshold

integer

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

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.grpc

object

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

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.grpc.port

integer Required

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

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.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

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.periodSeconds

integer

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

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.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.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.brokers[*].brokerConfig.containers[*].livenessProbe.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

.spec.brokers[*].brokerConfig.containers[*].name

string Required

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

.spec.brokers[*].brokerConfig.containers[*].ports

array

List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.

.spec.brokers[*].brokerConfig.containers[*].ports[*]

object

ContainerPort represents a network port in a single container.

.spec.brokers[*].brokerConfig.containers[*].ports[*].containerPort

integer Required

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

.spec.brokers[*].brokerConfig.containers[*].ports[*].hostIP

string

What host IP to bind the external port to.

.spec.brokers[*].brokerConfig.containers[*].ports[*].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.

.spec.brokers[*].brokerConfig.containers[*].ports[*].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.

.spec.brokers[*].brokerConfig.containers[*].ports[*].protocol

string

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe

object

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

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.exec.command

array

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

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.exec.command[*]

string

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.failureThreshold

integer

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

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.grpc

object

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

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.grpc.port

integer Required

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

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.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

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.periodSeconds

integer

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

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.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.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.brokers[*].brokerConfig.containers[*].readinessProbe.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

.spec.brokers[*].brokerConfig.containers[*].resources

object

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

.spec.brokers[*].brokerConfig.containers[*].resources.limits

object

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

.spec.brokers[*].brokerConfig.containers[*].resources.requests

object

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

.spec.brokers[*].brokerConfig.containers[*].securityContext

object

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

.spec.brokers[*].brokerConfig.containers[*].securityContext.allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.containers[*].securityContext.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.

.spec.brokers[*].brokerConfig.containers[*].securityContext.capabilities.add

array

Added capabilities

.spec.brokers[*].brokerConfig.containers[*].securityContext.capabilities.add[*]

string

Capability represent POSIX capabilities type

.spec.brokers[*].brokerConfig.containers[*].securityContext.capabilities.drop

array

Removed capabilities

.spec.brokers[*].brokerConfig.containers[*].securityContext.capabilities.drop[*]

string

Capability represent POSIX capabilities type

.spec.brokers[*].brokerConfig.containers[*].securityContext.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.

.spec.brokers[*].brokerConfig.containers[*].securityContext.procMount

string

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.containers[*].securityContext.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.

.spec.brokers[*].brokerConfig.containers[*].securityContext.runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.containers[*].securityContext.runAsNonRoot

boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.brokers[*].brokerConfig.containers[*].securityContext.runAsUser

integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.containers[*].securityContext.seLinuxOptions

object

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

.spec.brokers[*].brokerConfig.containers[*].securityContext.seLinuxOptions.level

string

Level is SELinux level label that applies to the container.

.spec.brokers[*].brokerConfig.containers[*].securityContext.seLinuxOptions.role

string

Role is a SELinux role label that applies to the container.

.spec.brokers[*].brokerConfig.containers[*].securityContext.seLinuxOptions.type

string

Type is a SELinux type label that applies to the container.

.spec.brokers[*].brokerConfig.containers[*].securityContext.seLinuxOptions.user

string

User is a SELinux user label that applies to the container.

.spec.brokers[*].brokerConfig.containers[*].securityContext.seccompProfile

object

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

.spec.brokers[*].brokerConfig.containers[*].securityContext.seccompProfile.localhostProfile

string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is “Localhost”.

.spec.brokers[*].brokerConfig.containers[*].securityContext.seccompProfile.type

string Required

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.brokers[*].brokerConfig.containers[*].securityContext.windowsOptions

object

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

.spec.brokers[*].brokerConfig.containers[*].securityContext.windowsOptions.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.

.spec.brokers[*].brokerConfig.containers[*].securityContext.windowsOptions.gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

.spec.brokers[*].brokerConfig.containers[*].securityContext.windowsOptions.hostProcess

boolean

HostProcess determines if a container should be run as a ‘Host Process’ container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

.spec.brokers[*].brokerConfig.containers[*].securityContext.windowsOptions.runAsUserName

string

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.brokers[*].brokerConfig.containers[*].startupProbe

object

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

.spec.brokers[*].brokerConfig.containers[*].startupProbe.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.exec.command

array

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

.spec.brokers[*].brokerConfig.containers[*].startupProbe.exec.command[*]

string

.spec.brokers[*].brokerConfig.containers[*].startupProbe.failureThreshold

integer

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

.spec.brokers[*].brokerConfig.containers[*].startupProbe.grpc

object

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

.spec.brokers[*].brokerConfig.containers[*].startupProbe.grpc.port

integer Required

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

.spec.brokers[*].brokerConfig.containers[*].startupProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.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

.spec.brokers[*].brokerConfig.containers[*].startupProbe.periodSeconds

integer

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

.spec.brokers[*].brokerConfig.containers[*].startupProbe.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.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.containers[*].startupProbe.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.brokers[*].brokerConfig.containers[*].startupProbe.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

.spec.brokers[*].brokerConfig.containers[*].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.

.spec.brokers[*].brokerConfig.containers[*].stdinOnce

boolean

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

.spec.brokers[*].brokerConfig.containers[*].terminationMessagePath

string

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

.spec.brokers[*].brokerConfig.containers[*].terminationMessagePolicy

string

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

.spec.brokers[*].brokerConfig.containers[*].tty

boolean

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

.spec.brokers[*].brokerConfig.containers[*].volumeDevices

array

volumeDevices is the list of block devices to be used by the container.

.spec.brokers[*].brokerConfig.containers[*].volumeDevices[*]

object

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

.spec.brokers[*].brokerConfig.containers[*].volumeDevices[*].devicePath

string Required

devicePath is the path inside of the container that the device will be mapped to.

.spec.brokers[*].brokerConfig.containers[*].volumeDevices[*].name

string Required

name must match the name of a persistentVolumeClaim in the pod

.spec.brokers[*].brokerConfig.containers[*].volumeMounts

array

Pod volumes to mount into the container’s filesystem. Cannot be updated.

.spec.brokers[*].brokerConfig.containers[*].volumeMounts[*]

object

VolumeMount describes a mounting of a Volume within a container.

.spec.brokers[*].brokerConfig.containers[*].volumeMounts[*].mountPath

string Required

Path within the container at which the volume should be mounted. Must not contain ‘:’.

.spec.brokers[*].brokerConfig.containers[*].volumeMounts[*].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.

.spec.brokers[*].brokerConfig.containers[*].volumeMounts[*].name

string Required

This must match the Name of a Volume.

.spec.brokers[*].brokerConfig.containers[*].volumeMounts[*].readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

.spec.brokers[*].brokerConfig.containers[*].volumeMounts[*].subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

.spec.brokers[*].brokerConfig.containers[*].volumeMounts[*].subPathExpr

string

Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.

.spec.brokers[*].brokerConfig.containers[*].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.

.spec.brokers[*].brokerConfig.envs

array

Envs defines environment variables for Kafka broker Pods. Adding the “+” prefix to the name prepends the value to that environment variable instead of overwriting it. Add the “+” suffix to append.

.spec.brokers[*].brokerConfig.envs[*]

object

EnvVar represents an environment variable present in a Container.

.spec.brokers[*].brokerConfig.envs[*].name

string Required

Name of the environment variable. Must be a C_IDENTIFIER.

.spec.brokers[*].brokerConfig.envs[*].value

string

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

.spec.brokers[*].brokerConfig.envs[*].valueFrom

object

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

.spec.brokers[*].brokerConfig.envs[*].valueFrom.configMapKeyRef

object

Selects a key of a ConfigMap.

.spec.brokers[*].brokerConfig.envs[*].valueFrom.configMapKeyRef.key

string Required

The key to select.

.spec.brokers[*].brokerConfig.envs[*].valueFrom.configMapKeyRef.name

string

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

.spec.brokers[*].brokerConfig.envs[*].valueFrom.configMapKeyRef.optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.brokers[*].brokerConfig.envs[*].valueFrom.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.podIP, status.podIPs.

.spec.brokers[*].brokerConfig.envs[*].valueFrom.fieldRef.apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

.spec.brokers[*].brokerConfig.envs[*].valueFrom.fieldRef.fieldPath

string Required

Path of the field to select in the specified API version.

.spec.brokers[*].brokerConfig.envs[*].valueFrom.resourceFieldRef

object

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

.spec.brokers[*].brokerConfig.envs[*].valueFrom.resourceFieldRef.containerName

string

Container name: required for volumes, optional for env vars

.spec.brokers[*].brokerConfig.envs[*].valueFrom.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

.spec.brokers[*].brokerConfig.envs[*].valueFrom.resourceFieldRef.resource

string Required

Required: resource to select

.spec.brokers[*].brokerConfig.envs[*].valueFrom.secretKeyRef

object

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

.spec.brokers[*].brokerConfig.envs[*].valueFrom.secretKeyRef.key

string Required

The key of the secret to select from. Must be a valid secret key.

.spec.brokers[*].brokerConfig.envs[*].valueFrom.secretKeyRef.name

string

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

.spec.brokers[*].brokerConfig.envs[*].valueFrom.secretKeyRef.optional

boolean

Specify whether the Secret or its key must be defined

.spec.brokers[*].brokerConfig.image

string

.spec.brokers[*].brokerConfig.imagePullSecrets

array

.spec.brokers[*].brokerConfig.imagePullSecrets[*]

object

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

.spec.brokers[*].brokerConfig.imagePullSecrets[*].name

string

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

.spec.brokers[*].brokerConfig.initContainers

array

InitContainers add extra initContainers to the Kafka broker pod

.spec.brokers[*].brokerConfig.initContainers[*]

object

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

.spec.brokers[*].brokerConfig.initContainers[*].args

array

Arguments to the entrypoint. The container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

.spec.brokers[*].brokerConfig.initContainers[*].args[*]

string

.spec.brokers[*].brokerConfig.initContainers[*].command

array

Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

.spec.brokers[*].brokerConfig.initContainers[*].command[*]

string

.spec.brokers[*].brokerConfig.initContainers[*].env

array

List of environment variables to set in the container. Cannot be updated.

.spec.brokers[*].brokerConfig.initContainers[*].envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

.spec.brokers[*].brokerConfig.initContainers[*].envFrom[*]

object

EnvFromSource represents the source of a set of ConfigMaps

.spec.brokers[*].brokerConfig.initContainers[*].envFrom[*].configMapRef

object

The ConfigMap to select from

.spec.brokers[*].brokerConfig.initContainers[*].envFrom[*].configMapRef.name

string

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

.spec.brokers[*].brokerConfig.initContainers[*].envFrom[*].configMapRef.optional

boolean

Specify whether the ConfigMap must be defined

.spec.brokers[*].brokerConfig.initContainers[*].envFrom[*].prefix

string

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

.spec.brokers[*].brokerConfig.initContainers[*].envFrom[*].secretRef

object

The Secret to select from

.spec.brokers[*].brokerConfig.initContainers[*].envFrom[*].secretRef.name

string

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

.spec.brokers[*].brokerConfig.initContainers[*].envFrom[*].secretRef.optional

boolean

Specify whether the Secret must be defined

.spec.brokers[*].brokerConfig.initContainers[*].env[*]

object

EnvVar represents an environment variable present in a Container.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].name

string Required

Name of the environment variable. Must be a C_IDENTIFIER.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].value

string

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom

object

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

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.configMapKeyRef

object

Selects a key of a ConfigMap.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.configMapKeyRef.key

string Required

The key to select.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.configMapKeyRef.name

string

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

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.configMapKeyRef.optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.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.podIP, status.podIPs.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.fieldRef.apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.fieldRef.fieldPath

string Required

Path of the field to select in the specified API version.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.resourceFieldRef

object

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

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.resourceFieldRef.containerName

string

Container name: required for volumes, optional for env vars

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.resourceFieldRef.resource

string Required

Required: resource to select

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.secretKeyRef

object

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

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.secretKeyRef.key

string Required

The key of the secret to select from. Must be a valid secret key.

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.secretKeyRef.name

string

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

.spec.brokers[*].brokerConfig.initContainers[*].env[*].valueFrom.secretKeyRef.optional

boolean

Specify whether the Secret or its key must be defined

.spec.brokers[*].brokerConfig.initContainers[*].image

string

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

.spec.brokers[*].brokerConfig.initContainers[*].imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle

object

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart

object

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.exec.command

array

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.exec.command[*]

string

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.tcpSocket

object

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.postStart.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop

object

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.exec.command

array

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.exec.command[*]

string

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.tcpSocket

object

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.initContainers[*].lifecycle.preStop.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].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

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.exec.command

array

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

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.exec.command[*]

string

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.failureThreshold

integer

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

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.grpc

object

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

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.grpc.port

integer Required

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

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.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

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.periodSeconds

integer

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

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.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.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.brokers[*].brokerConfig.initContainers[*].livenessProbe.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

.spec.brokers[*].brokerConfig.initContainers[*].name

string Required

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

.spec.brokers[*].brokerConfig.initContainers[*].ports

array

List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.

.spec.brokers[*].brokerConfig.initContainers[*].ports[*]

object

ContainerPort represents a network port in a single container.

.spec.brokers[*].brokerConfig.initContainers[*].ports[*].containerPort

integer Required

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

.spec.brokers[*].brokerConfig.initContainers[*].ports[*].hostIP

string

What host IP to bind the external port to.

.spec.brokers[*].brokerConfig.initContainers[*].ports[*].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.

.spec.brokers[*].brokerConfig.initContainers[*].ports[*].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.

.spec.brokers[*].brokerConfig.initContainers[*].ports[*].protocol

string

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe

object

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

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.exec.command

array

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

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.exec.command[*]

string

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.failureThreshold

integer

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

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.grpc

object

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

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.grpc.port

integer Required

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

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.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

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.periodSeconds

integer

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

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.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.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.brokers[*].brokerConfig.initContainers[*].readinessProbe.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

.spec.brokers[*].brokerConfig.initContainers[*].resources

object

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

.spec.brokers[*].brokerConfig.initContainers[*].resources.limits

object

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

.spec.brokers[*].brokerConfig.initContainers[*].resources.requests

object

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

.spec.brokers[*].brokerConfig.initContainers[*].securityContext

object

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

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.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.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.capabilities.add

array

Added capabilities

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.capabilities.add[*]

string

Capability represent POSIX capabilities type

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.capabilities.drop

array

Removed capabilities

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.capabilities.drop[*]

string

Capability represent POSIX capabilities type

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.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.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.procMount

string

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.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.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.runAsNonRoot

boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.runAsUser

integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.seLinuxOptions

object

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

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.seLinuxOptions.level

string

Level is SELinux level label that applies to the container.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.seLinuxOptions.role

string

Role is a SELinux role label that applies to the container.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.seLinuxOptions.type

string

Type is a SELinux type label that applies to the container.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.seLinuxOptions.user

string

User is a SELinux user label that applies to the container.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.seccompProfile

object

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

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.seccompProfile.localhostProfile

string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is “Localhost”.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.seccompProfile.type

string Required

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.windowsOptions

object

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

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.windowsOptions.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.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.windowsOptions.gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.windowsOptions.hostProcess

boolean

HostProcess determines if a container should be run as a ‘Host Process’ container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

.spec.brokers[*].brokerConfig.initContainers[*].securityContext.windowsOptions.runAsUserName

string

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe

object

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

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.exec

object

Exec specifies the action to take.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.exec.command

array

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

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.exec.command[*]

string

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.failureThreshold

integer

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

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.grpc

object

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

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.grpc.port

integer Required

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

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.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

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.periodSeconds

integer

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

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.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.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.tcpSocket.host

string

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

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.tcpSocket.port

Required

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.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.brokers[*].brokerConfig.initContainers[*].startupProbe.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

.spec.brokers[*].brokerConfig.initContainers[*].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.

.spec.brokers[*].brokerConfig.initContainers[*].stdinOnce

boolean

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

.spec.brokers[*].brokerConfig.initContainers[*].terminationMessagePath

string

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

.spec.brokers[*].brokerConfig.initContainers[*].terminationMessagePolicy

string

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

.spec.brokers[*].brokerConfig.initContainers[*].tty

boolean

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

.spec.brokers[*].brokerConfig.initContainers[*].volumeDevices

array

volumeDevices is the list of block devices to be used by the container.

.spec.brokers[*].brokerConfig.initContainers[*].volumeDevices[*]

object

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

.spec.brokers[*].brokerConfig.initContainers[*].volumeDevices[*].devicePath

string Required

devicePath is the path inside of the container that the device will be mapped to.

.spec.brokers[*].brokerConfig.initContainers[*].volumeDevices[*].name

string Required

name must match the name of a persistentVolumeClaim in the pod

.spec.brokers[*].brokerConfig.initContainers[*].volumeMounts

array

Pod volumes to mount into the container’s filesystem. Cannot be updated.

.spec.brokers[*].brokerConfig.initContainers[*].volumeMounts[*]

object

VolumeMount describes a mounting of a Volume within a container.

.spec.brokers[*].brokerConfig.initContainers[*].volumeMounts[*].mountPath

string Required

Path within the container at which the volume should be mounted. Must not contain ‘:’.

.spec.brokers[*].brokerConfig.initContainers[*].volumeMounts[*].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.

.spec.brokers[*].brokerConfig.initContainers[*].volumeMounts[*].name

string Required

This must match the Name of a Volume.

.spec.brokers[*].brokerConfig.initContainers[*].volumeMounts[*].readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

.spec.brokers[*].brokerConfig.initContainers[*].volumeMounts[*].subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

.spec.brokers[*].brokerConfig.initContainers[*].volumeMounts[*].subPathExpr

string

Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.

.spec.brokers[*].brokerConfig.initContainers[*].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.

.spec.brokers[*].brokerConfig.kafkaHeapOpts

string

.spec.brokers[*].brokerConfig.kafkaJvmPerfOpts

string

.spec.brokers[*].brokerConfig.log4jConfig

string

Override for the default log4j configuration

.spec.brokers[*].brokerConfig.metricsReporterImage

string

.spec.brokers[*].brokerConfig.networkConfig

object

Network throughput information in kB/s used by Cruise Control to determine broker network capacity. By default it is set to 125000 which means 1Gbit/s in network throughput.

.spec.brokers[*].brokerConfig.networkConfig.incomingNetworkThroughPut

string

.spec.brokers[*].brokerConfig.networkConfig.outgoingNetworkThroughPut

string

.spec.brokers[*].brokerConfig.nodePortExternalIP

object

External listeners that use NodePort type service to expose the broker outside the Kubernetes clusterT and their external IP to advertise Kafka broker external listener. The external IP value is ignored in case of external listeners that use LoadBalancer type service to expose the broker outside the Kubernetes cluster. Also, when “hostnameOverride” field of the external listener is set it will override the broker’s external listener advertise address according to the description of the “hostnameOverride” field.

.spec.brokers[*].brokerConfig.nodeSelector

object

.spec.brokers[*].brokerConfig.podSecurityContext

object

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

.spec.brokers[*].brokerConfig.podSecurityContext.fsGroup

integer

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw—- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.podSecurityContext.fsGroupChangePolicy

string

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.podSecurityContext.runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.podSecurityContext.runAsNonRoot

boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.brokers[*].brokerConfig.podSecurityContext.runAsUser

integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.podSecurityContext.seLinuxOptions

object

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

.spec.brokers[*].brokerConfig.podSecurityContext.seLinuxOptions.level

string

Level is SELinux level label that applies to the container.

.spec.brokers[*].brokerConfig.podSecurityContext.seLinuxOptions.role

string

Role is a SELinux role label that applies to the container.

.spec.brokers[*].brokerConfig.podSecurityContext.seLinuxOptions.type

string

Type is a SELinux type label that applies to the container.

.spec.brokers[*].brokerConfig.podSecurityContext.seLinuxOptions.user

string

User is a SELinux user label that applies to the container.

.spec.brokers[*].brokerConfig.podSecurityContext.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.

.spec.brokers[*].brokerConfig.podSecurityContext.seccompProfile.localhostProfile

string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is “Localhost”.

.spec.brokers[*].brokerConfig.podSecurityContext.seccompProfile.type

string Required

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.brokers[*].brokerConfig.podSecurityContext.supplementalGroups

array

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.podSecurityContext.supplementalGroups[*]

integer

.spec.brokers[*].brokerConfig.podSecurityContext.sysctls

array

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.podSecurityContext.sysctls[*]

object

Sysctl defines a kernel parameter to be set

.spec.brokers[*].brokerConfig.podSecurityContext.sysctls[*].name

string Required

Name of a property to set

.spec.brokers[*].brokerConfig.podSecurityContext.sysctls[*].value

string Required

Value of a property to set

.spec.brokers[*].brokerConfig.podSecurityContext.windowsOptions

object

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

.spec.brokers[*].brokerConfig.podSecurityContext.windowsOptions.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.

.spec.brokers[*].brokerConfig.podSecurityContext.windowsOptions.gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

.spec.brokers[*].brokerConfig.podSecurityContext.windowsOptions.hostProcess

boolean

HostProcess determines if a container should be run as a ‘Host Process’ container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

.spec.brokers[*].brokerConfig.podSecurityContext.windowsOptions.runAsUserName

string

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.brokers[*].brokerConfig.priorityClassName

string

PriorityClassName specifies the priority class name for a broker pod(s). If specified, the PriorityClass resource with this PriorityClassName must be created beforehand. If not specified, the broker pods’ priority is default to zero.

.spec.brokers[*].brokerConfig.resourceRequirements

object

ResourceRequirements describes the compute resource requirements.

.spec.brokers[*].brokerConfig.resourceRequirements.limits

object

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

.spec.brokers[*].brokerConfig.resourceRequirements.requests

object

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

.spec.brokers[*].brokerConfig.securityContext

object

SecurityContext allows to set security context for the kafka container

.spec.brokers[*].brokerConfig.securityContext.allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.securityContext.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.

.spec.brokers[*].brokerConfig.securityContext.capabilities.add

array

Added capabilities

.spec.brokers[*].brokerConfig.securityContext.capabilities.add[*]

string

Capability represent POSIX capabilities type

.spec.brokers[*].brokerConfig.securityContext.capabilities.drop

array

Removed capabilities

.spec.brokers[*].brokerConfig.securityContext.capabilities.drop[*]

string

Capability represent POSIX capabilities type

.spec.brokers[*].brokerConfig.securityContext.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.

.spec.brokers[*].brokerConfig.securityContext.procMount

string

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.securityContext.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.

.spec.brokers[*].brokerConfig.securityContext.runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.securityContext.runAsNonRoot

boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.brokers[*].brokerConfig.securityContext.runAsUser

integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.brokers[*].brokerConfig.securityContext.seLinuxOptions

object

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

.spec.brokers[*].brokerConfig.securityContext.seLinuxOptions.level

string

Level is SELinux level label that applies to the container.

.spec.brokers[*].brokerConfig.securityContext.seLinuxOptions.role

string

Role is a SELinux role label that applies to the container.

.spec.brokers[*].brokerConfig.securityContext.seLinuxOptions.type

string

Type is a SELinux type label that applies to the container.

.spec.brokers[*].brokerConfig.securityContext.seLinuxOptions.user

string

User is a SELinux user label that applies to the container.

.spec.brokers[*].brokerConfig.securityContext.seccompProfile

object

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

.spec.brokers[*].brokerConfig.securityContext.seccompProfile.localhostProfile

string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is “Localhost”.

.spec.brokers[*].brokerConfig.securityContext.seccompProfile.type

string Required

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.brokers[*].brokerConfig.securityContext.windowsOptions

object

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

.spec.brokers[*].brokerConfig.securityContext.windowsOptions.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.

.spec.brokers[*].brokerConfig.securityContext.windowsOptions.gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

.spec.brokers[*].brokerConfig.securityContext.windowsOptions.hostProcess

boolean

HostProcess determines if a container should be run as a ‘Host Process’ container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

.spec.brokers[*].brokerConfig.securityContext.windowsOptions.runAsUserName

string

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.brokers[*].brokerConfig.serviceAccountName

string

.spec.brokers[*].brokerConfig.storageConfigs

array

.spec.brokers[*].brokerConfig.storageConfigs[*]

object

StorageConfig defines the broker storage configuration

.spec.brokers[*].brokerConfig.storageConfigs[*].emptyDir

object

If set https://kubernetes.io/docs/concepts/storage/volumes#emptydir is used as storage for Kafka broker log dirs. The use of empty dir as Kafka broker storage is useful in development environments where data loss is not a concern as data stored on emptydir backed storage is lost at pod restarts. Either pvcSpec or emptyDir has to be set. When both pvcSpec and emptyDir fields are set the pvcSpec is used by default.

.spec.brokers[*].brokerConfig.storageConfigs[*].emptyDir.medium

string

medium represents what type of storage medium should back this directory. The default is “” which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

.spec.brokers[*].brokerConfig.storageConfigs[*].emptyDir.sizeLimit

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

.spec.brokers[*].brokerConfig.storageConfigs[*].mountPath

string Required

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec

object

If set https://kubernetes.io/docs/concepts/storage/volumes/#persistentvolumeclaim is used as storage for Kafka broker log dirs. Either pvcSpec or emptyDir has to be set. When both pvcSpec and emptyDir fields are set the pvcSpec is used by default.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.accessModes

array

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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.accessModes[*]

string

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.dataSource

object

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.dataSource.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.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.dataSource.kind

string Required

Kind is the type of resource being referenced

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.dataSource.name

string Required

Name is the name of resource being referenced

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.dataSourceRef

object

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.dataSourceRef.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.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.dataSourceRef.kind

string Required

Kind is the type of resource being referenced

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.dataSourceRef.name

string Required

Name is the name of resource being referenced

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.resources

object

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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.resources.limits

object

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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.resources.requests

object

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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.selector

object

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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.selector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.selector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.selector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.selector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.selector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.selector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.selector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.volumeMode

string

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

.spec.brokers[*].brokerConfig.storageConfigs[*].pvcSpec.volumeName

string

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

.spec.brokers[*].brokerConfig.terminationGracePeriodSeconds

integer

TerminationGracePeriod defines the pod termination grace period

.spec.brokers[*].brokerConfig.tolerations

array

.spec.brokers[*].brokerConfig.tolerations[*]

object

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

.spec.brokers[*].brokerConfig.tolerations[*].effect

string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

.spec.brokers[*].brokerConfig.tolerations[*].key

string

Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

.spec.brokers[*].brokerConfig.tolerations[*].operator

string

Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

.spec.brokers[*].brokerConfig.tolerations[*].tolerationSeconds

integer

TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

.spec.brokers[*].brokerConfig.tolerations[*].value

string

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

.spec.brokers[*].brokerConfig.volumeMounts

array

VolumeMounts define some extra Kubernetes VolumeMounts for the Kafka broker Pods.

.spec.brokers[*].brokerConfig.volumeMounts[*]

object

VolumeMount describes a mounting of a Volume within a container.

.spec.brokers[*].brokerConfig.volumeMounts[*].mountPath

string Required

Path within the container at which the volume should be mounted. Must not contain ‘:’.

.spec.brokers[*].brokerConfig.volumeMounts[*].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.

.spec.brokers[*].brokerConfig.volumeMounts[*].name

string Required

This must match the Name of a Volume.

.spec.brokers[*].brokerConfig.volumeMounts[*].readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

.spec.brokers[*].brokerConfig.volumeMounts[*].subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

.spec.brokers[*].brokerConfig.volumeMounts[*].subPathExpr

string

Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.

.spec.brokers[*].brokerConfig.volumes

array

Volumes define some extra Kubernetes Volumes for the Kafka broker Pods.

.spec.brokers[*].brokerConfig.volumes[*]

object

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

.spec.brokers[*].brokerConfig.volumes[*].awsElasticBlockStore

object

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

.spec.brokers[*].brokerConfig.volumes[*].awsElasticBlockStore.fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.brokers[*].brokerConfig.volumes[*].awsElasticBlockStore.partition

integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty).

.spec.brokers[*].brokerConfig.volumes[*].awsElasticBlockStore.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].awsElasticBlockStore.volumeID

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].azureDisk

object

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

.spec.brokers[*].brokerConfig.volumes[*].azureDisk.cachingMode

string

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

.spec.brokers[*].brokerConfig.volumes[*].azureDisk.diskName

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].azureDisk.diskURI

string Required

diskURI is the URI of data disk in the blob storage

.spec.brokers[*].brokerConfig.volumes[*].azureDisk.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.

.spec.brokers[*].brokerConfig.volumes[*].azureDisk.kind

string

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

.spec.brokers[*].brokerConfig.volumes[*].azureDisk.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].azureFile

object

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

.spec.brokers[*].brokerConfig.volumes[*].azureFile.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].azureFile.secretName

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].azureFile.shareName

string Required

shareName is the azure share Name

.spec.brokers[*].brokerConfig.volumes[*].cephfs

object

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

.spec.brokers[*].brokerConfig.volumes[*].cephfs.monitors

array Required

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

.spec.brokers[*].brokerConfig.volumes[*].cephfs.monitors[*]

string

.spec.brokers[*].brokerConfig.volumes[*].cephfs.path

string

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

.spec.brokers[*].brokerConfig.volumes[*].cephfs.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

.spec.brokers[*].brokerConfig.volumes[*].cephfs.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

.spec.brokers[*].brokerConfig.volumes[*].cephfs.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

.spec.brokers[*].brokerConfig.volumes[*].cephfs.secretRef.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].cephfs.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

.spec.brokers[*].brokerConfig.volumes[*].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

.spec.brokers[*].brokerConfig.volumes[*].cinder.fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

.spec.brokers[*].brokerConfig.volumes[*].cinder.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

.spec.brokers[*].brokerConfig.volumes[*].cinder.secretRef

object

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

.spec.brokers[*].brokerConfig.volumes[*].cinder.secretRef.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].cinder.volumeID

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].configMap

object

configMap represents a configMap that should populate this volume

.spec.brokers[*].brokerConfig.volumes[*].configMap.defaultMode

integer

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].configMap.items

array

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.

.spec.brokers[*].brokerConfig.volumes[*].configMap.items[*]

object

Maps a string key to a path within a volume.

.spec.brokers[*].brokerConfig.volumes[*].configMap.items[*].key

string Required

key is the key to project.

.spec.brokers[*].brokerConfig.volumes[*].configMap.items[*].mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].configMap.items[*].path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].configMap.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].configMap.optional

boolean

optional specify whether the ConfigMap or its keys must be defined

.spec.brokers[*].brokerConfig.volumes[*].csi

object

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

.spec.brokers[*].brokerConfig.volumes[*].csi.driver

string Required

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.

.spec.brokers[*].brokerConfig.volumes[*].csi.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.

.spec.brokers[*].brokerConfig.volumes[*].csi.nodePublishSecretRef

object

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

.spec.brokers[*].brokerConfig.volumes[*].csi.nodePublishSecretRef.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].csi.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].csi.volumeAttributes

object

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

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI

object

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

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.defaultMode

integer

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items

array

Items is a list of downward API volume file

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].fieldRef

object

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

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].fieldRef.apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].fieldRef.fieldPath

string Required

Path of the field to select in the specified API version.

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].mode

integer

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].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.

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].resourceFieldRef.containerName

string

Container name: required for volumes, optional for env vars

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

.spec.brokers[*].brokerConfig.volumes[*].downwardAPI.items[*].resourceFieldRef.resource

string Required

Required: resource to select

.spec.brokers[*].brokerConfig.volumes[*].emptyDir

object

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

.spec.brokers[*].brokerConfig.volumes[*].emptyDir.medium

string

medium represents what type of storage medium should back this directory. The default is “” which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

.spec.brokers[*].brokerConfig.volumes[*].emptyDir.sizeLimit

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

.spec.brokers[*].brokerConfig.volumes[*].ephemeral

object

ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate

object

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.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.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec

object Required

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.accessModes

array

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.accessModes[*]

string

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource

object

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.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.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.kind

string Required

Kind is the type of resource being referenced

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.name

string Required

Name is the name of resource being referenced

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef

object

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.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.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.kind

string Required

Kind is the type of resource being referenced

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.name

string Required

Name is the name of resource being referenced

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.resources

object

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.resources.limits

object

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.resources.requests

object

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector

object

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

array

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*]

object

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].values[*]

string

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.volumeMode

string

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

.spec.brokers[*].brokerConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.volumeName

string

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

.spec.brokers[*].brokerConfig.volumes[*].fc

object

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

.spec.brokers[*].brokerConfig.volumes[*].fc.fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.brokers[*].brokerConfig.volumes[*].fc.lun

integer

lun is Optional: FC target lun number

.spec.brokers[*].brokerConfig.volumes[*].fc.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].fc.targetWWNs

array

targetWWNs is Optional: FC target worldwide names (WWNs)

.spec.brokers[*].brokerConfig.volumes[*].fc.targetWWNs[*]

string

.spec.brokers[*].brokerConfig.volumes[*].fc.wwids

array

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

.spec.brokers[*].brokerConfig.volumes[*].fc.wwids[*]

string

.spec.brokers[*].brokerConfig.volumes[*].flexVolume

object

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

.spec.brokers[*].brokerConfig.volumes[*].flexVolume.driver

string Required

driver is the name of the driver to use for this volume.

.spec.brokers[*].brokerConfig.volumes[*].flexVolume.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.

.spec.brokers[*].brokerConfig.volumes[*].flexVolume.options

object

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

.spec.brokers[*].brokerConfig.volumes[*].flexVolume.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].flexVolume.secretRef

object

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

.spec.brokers[*].brokerConfig.volumes[*].flexVolume.secretRef.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].flocker

object

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

.spec.brokers[*].brokerConfig.volumes[*].flocker.datasetName

string

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

.spec.brokers[*].brokerConfig.volumes[*].flocker.datasetUUID

string

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

.spec.brokers[*].brokerConfig.volumes[*].gcePersistentDisk

object

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

.spec.brokers[*].brokerConfig.volumes[*].gcePersistentDisk.fsType

string

fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.brokers[*].brokerConfig.volumes[*].gcePersistentDisk.partition

integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

.spec.brokers[*].brokerConfig.volumes[*].gcePersistentDisk.pdName

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].gcePersistentDisk.readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

.spec.brokers[*].brokerConfig.volumes[*].gitRepo

object

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

.spec.brokers[*].brokerConfig.volumes[*].gitRepo.directory

string

directory is the target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

.spec.brokers[*].brokerConfig.volumes[*].gitRepo.repository

string Required

repository is the URL

.spec.brokers[*].brokerConfig.volumes[*].gitRepo.revision

string

revision is the commit hash for the specified revision.

.spec.brokers[*].brokerConfig.volumes[*].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

.spec.brokers[*].brokerConfig.volumes[*].glusterfs.endpoints

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].glusterfs.path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].glusterfs.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

.spec.brokers[*].brokerConfig.volumes[*].hostPath

object

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

.spec.brokers[*].brokerConfig.volumes[*].hostPath.path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].hostPath.type

string

type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

.spec.brokers[*].brokerConfig.volumes[*].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

.spec.brokers[*].brokerConfig.volumes[*].iscsi.chapAuthDiscovery

boolean

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

.spec.brokers[*].brokerConfig.volumes[*].iscsi.chapAuthSession

boolean

chapAuthSession defines whether support iSCSI Session CHAP authentication

.spec.brokers[*].brokerConfig.volumes[*].iscsi.fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.brokers[*].brokerConfig.volumes[*].iscsi.initiatorName

string

initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.

.spec.brokers[*].brokerConfig.volumes[*].iscsi.iqn

string Required

iqn is the target iSCSI Qualified Name.

.spec.brokers[*].brokerConfig.volumes[*].iscsi.iscsiInterface

string

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

.spec.brokers[*].brokerConfig.volumes[*].iscsi.lun

integer Required

lun represents iSCSI Target Lun number.

.spec.brokers[*].brokerConfig.volumes[*].iscsi.portals

array

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

.spec.brokers[*].brokerConfig.volumes[*].iscsi.portals[*]

string

.spec.brokers[*].brokerConfig.volumes[*].iscsi.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].iscsi.secretRef

object

secretRef is the CHAP Secret for iSCSI target and initiator authentication

.spec.brokers[*].brokerConfig.volumes[*].iscsi.secretRef.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].iscsi.targetPortal

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].name

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].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

.spec.brokers[*].brokerConfig.volumes[*].nfs.path

string Required

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

.spec.brokers[*].brokerConfig.volumes[*].nfs.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

.spec.brokers[*].brokerConfig.volumes[*].nfs.server

string Required

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

.spec.brokers[*].brokerConfig.volumes[*].persistentVolumeClaim

object

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

.spec.brokers[*].brokerConfig.volumes[*].persistentVolumeClaim.claimName

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].persistentVolumeClaim.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].photonPersistentDisk

object

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

.spec.brokers[*].brokerConfig.volumes[*].photonPersistentDisk.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.

.spec.brokers[*].brokerConfig.volumes[*].photonPersistentDisk.pdID

string Required

pdID is the ID that identifies Photon Controller persistent disk

.spec.brokers[*].brokerConfig.volumes[*].portworxVolume

object

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

.spec.brokers[*].brokerConfig.volumes[*].portworxVolume.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.

.spec.brokers[*].brokerConfig.volumes[*].portworxVolume.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].portworxVolume.volumeID

string Required

volumeID uniquely identifies a Portworx volume

.spec.brokers[*].brokerConfig.volumes[*].projected

object

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

.spec.brokers[*].brokerConfig.volumes[*].projected.defaultMode

integer

defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources

array

sources is the list of volume projections

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*]

object

Projection that may be projected along with other supported volume types

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].configMap

object

configMap information about the configMap data to project

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].configMap.items

array

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].configMap.items[*]

object

Maps a string key to a path within a volume.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].configMap.items[*].key

string Required

key is the key to project.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].configMap.items[*].mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].configMap.items[*].path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].configMap.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].configMap.optional

boolean

optional specify whether the ConfigMap or its keys must be defined

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI

object

downwardAPI information about the downwardAPI data to project

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items

array

Items is a list of DownwardAPIVolume file

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef

object

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

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef.apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef.fieldPath

string Required

Path of the field to select in the specified API version.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].mode

integer

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].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.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.containerName

string

Container name: required for volumes, optional for env vars

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.resource

string Required

Required: resource to select

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].secret

object

secret information about the secret data to project

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].secret.items

array

items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].secret.items[*]

object

Maps a string key to a path within a volume.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].secret.items[*].key

string Required

key is the key to project.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].secret.items[*].mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].secret.items[*].path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].secret.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].secret.optional

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].serviceAccountToken

object

serviceAccountToken is information about the serviceAccountToken data to project

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].serviceAccountToken.audience

string

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

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].serviceAccountToken.expirationSeconds

integer

expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

.spec.brokers[*].brokerConfig.volumes[*].projected.sources[*].serviceAccountToken.path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].quobyte

object

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

.spec.brokers[*].brokerConfig.volumes[*].quobyte.group

string

group to map volume access to Default is no group

.spec.brokers[*].brokerConfig.volumes[*].quobyte.readOnly

boolean

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

.spec.brokers[*].brokerConfig.volumes[*].quobyte.registry

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].quobyte.tenant

string

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

.spec.brokers[*].brokerConfig.volumes[*].quobyte.user

string

user to map volume access to Defaults to serivceaccount user

.spec.brokers[*].brokerConfig.volumes[*].quobyte.volume

string Required

volume is a string that references an already created Quobyte volume by name.

.spec.brokers[*].brokerConfig.volumes[*].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

.spec.brokers[*].brokerConfig.volumes[*].rbd.fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.brokers[*].brokerConfig.volumes[*].rbd.image

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].rbd.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

.spec.brokers[*].brokerConfig.volumes[*].rbd.monitors

array Required

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

.spec.brokers[*].brokerConfig.volumes[*].rbd.monitors[*]

string

.spec.brokers[*].brokerConfig.volumes[*].rbd.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

.spec.brokers[*].brokerConfig.volumes[*].rbd.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

.spec.brokers[*].brokerConfig.volumes[*].rbd.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

.spec.brokers[*].brokerConfig.volumes[*].rbd.secretRef.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].rbd.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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO

object

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.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”.

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.gateway

string Required

gateway is the host address of the ScaleIO API Gateway.

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.protectionDomain

string

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.secretRef

object Required

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.secretRef.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.sslEnabled

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.storageMode

string

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.storagePool

string

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.system

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].scaleIO.volumeName

string

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

.spec.brokers[*].brokerConfig.volumes[*].secret

object

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

.spec.brokers[*].brokerConfig.volumes[*].secret.defaultMode

integer

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].secret.items

array

items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.

.spec.brokers[*].brokerConfig.volumes[*].secret.items[*]

object

Maps a string key to a path within a volume.

.spec.brokers[*].brokerConfig.volumes[*].secret.items[*].key

string Required

key is the key to project.

.spec.brokers[*].brokerConfig.volumes[*].secret.items[*].mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.brokers[*].brokerConfig.volumes[*].secret.items[*].path

string Required

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

.spec.brokers[*].brokerConfig.volumes[*].secret.optional

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].secret.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

.spec.brokers[*].brokerConfig.volumes[*].storageos

object

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

.spec.brokers[*].brokerConfig.volumes[*].storageos.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.

.spec.brokers[*].brokerConfig.volumes[*].storageos.readOnly

boolean

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

.spec.brokers[*].brokerConfig.volumes[*].storageos.secretRef

object

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

.spec.brokers[*].brokerConfig.volumes[*].storageos.secretRef.name

string

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

.spec.brokers[*].brokerConfig.volumes[*].storageos.volumeName

string

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

.spec.brokers[*].brokerConfig.volumes[*].storageos.volumeNamespace

string

volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to “default” if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

.spec.brokers[*].brokerConfig.volumes[*].vsphereVolume

object

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

.spec.brokers[*].brokerConfig.volumes[*].vsphereVolume.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.

.spec.brokers[*].brokerConfig.volumes[*].vsphereVolume.storagePolicyID

string

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

.spec.brokers[*].brokerConfig.volumes[*].vsphereVolume.storagePolicyName

string

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

.spec.brokers[*].brokerConfig.volumes[*].vsphereVolume.volumePath

string Required

volumePath is the path that identifies vSphere volume vmdk

.spec.brokers[*].brokerConfigGroup

string

.spec.brokers[*].id

integer Required

.spec.brokers[*].readOnlyConfig

string

.spec.clientSSLCertSecret

object

ClientSSLCertSecret is a reference to the Kubernetes secret where custom client SSL certificate can be provided. It will be used by the koperator, cruise control, cruise control metrics reporter to communicate on SSL with that internal listener which is used for interbroker communication. The client certificate must share the same chain of trust as the server certificate used by the corresponding internal listener. The secret must contain the keystore, truststore jks files and the password for them in base64 encoded format under the keystore.jks, truststore.jks, password data fields.

.spec.clientSSLCertSecret.name

string

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

.spec.clusterImage

string

.spec.clusterMetricsReporterImage

string

.spec.clusterWideConfig

string

.spec.cruiseControlConfig

object Required

CruiseControlConfig defines the config for Cruise Control

.spec.cruiseControlConfig.capacityConfig

string

.spec.cruiseControlConfig.clusterConfig

string

.spec.cruiseControlConfig.config

string

.spec.cruiseControlConfig.cruiseControlAnnotations

object

Annotations to be applied to CruiseControl pod

.spec.cruiseControlConfig.cruiseControlEndpoint

string

.spec.cruiseControlConfig.cruiseControlOperationSpec

object

CruiseControlOperationSpec specifies the configuration of the CruiseControlOperation handling

.spec.cruiseControlConfig.cruiseControlOperationSpec.ttlSecondsAfterFinished

integer

When TTLSecondsAfterFinished is specified, the created and finished (completed successfully or completedWithError and errorPolicy: ignore) cruiseControlOperation custom resource will be deleted after the given time elapsed. When it is 0 then the resource is going to be deleted instantly after the operation is finished. When it is not specified the resource is not going to be removed. Value can be only zero and positive integers.

.spec.cruiseControlConfig.cruiseControlTaskSpec

object

CruiseControlTaskSpec specifies the configuration of the CC Tasks

.spec.cruiseControlConfig.cruiseControlTaskSpec.RetryDurationMinutes

integer Required

RetryDurationMinutes describes the amount of time the Operator waits for the task

.spec.cruiseControlConfig.image

string

.spec.cruiseControlConfig.imagePullSecrets

array

.spec.cruiseControlConfig.imagePullSecrets[*]

object

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

.spec.cruiseControlConfig.imagePullSecrets[*].name

string

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

.spec.cruiseControlConfig.initContainers

array

InitContainers add extra initContainers to CruiseControl pod

.spec.cruiseControlConfig.initContainers[*]

object

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

.spec.cruiseControlConfig.initContainers[*].args

array

Arguments to the entrypoint. The container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

.spec.cruiseControlConfig.initContainers[*].args[*]

string

.spec.cruiseControlConfig.initContainers[*].command

array

Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

.spec.cruiseControlConfig.initContainers[*].command[*]

string

.spec.cruiseControlConfig.initContainers[*].env

array

List of environment variables to set in the container. Cannot be updated.

.spec.cruiseControlConfig.initContainers[*].envFrom

array

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

.spec.cruiseControlConfig.initContainers[*].envFrom[*]

object

EnvFromSource represents the source of a set of ConfigMaps

.spec.cruiseControlConfig.initContainers[*].envFrom[*].configMapRef

object

The ConfigMap to select from

.spec.cruiseControlConfig.initContainers[*].envFrom[*].configMapRef.name

string

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

.spec.cruiseControlConfig.initContainers[*].envFrom[*].configMapRef.optional

boolean

Specify whether the ConfigMap must be defined

.spec.cruiseControlConfig.initContainers[*].envFrom[*].prefix

string

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

.spec.cruiseControlConfig.initContainers[*].envFrom[*].secretRef

object

The Secret to select from

.spec.cruiseControlConfig.initContainers[*].envFrom[*].secretRef.name

string

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

.spec.cruiseControlConfig.initContainers[*].envFrom[*].secretRef.optional

boolean

Specify whether the Secret must be defined

.spec.cruiseControlConfig.initContainers[*].env[*]

object

EnvVar represents an environment variable present in a Container.

.spec.cruiseControlConfig.initContainers[*].env[*].name

string Required

Name of the environment variable. Must be a C_IDENTIFIER.

.spec.cruiseControlConfig.initContainers[*].env[*].value

string

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom

object

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

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.configMapKeyRef

object

Selects a key of a ConfigMap.

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.configMapKeyRef.key

string Required

The key to select.

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.configMapKeyRef.name

string

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

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.configMapKeyRef.optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.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.podIP, status.podIPs.

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.fieldRef.apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.fieldRef.fieldPath

string Required

Path of the field to select in the specified API version.

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.resourceFieldRef

object

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

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.resourceFieldRef.containerName

string

Container name: required for volumes, optional for env vars

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.resourceFieldRef.resource

string Required

Required: resource to select

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.secretKeyRef

object

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

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.secretKeyRef.key

string Required

The key of the secret to select from. Must be a valid secret key.

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.secretKeyRef.name

string

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

.spec.cruiseControlConfig.initContainers[*].env[*].valueFrom.secretKeyRef.optional

boolean

Specify whether the Secret or its key must be defined

.spec.cruiseControlConfig.initContainers[*].image

string

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

.spec.cruiseControlConfig.initContainers[*].imagePullPolicy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

.spec.cruiseControlConfig.initContainers[*].lifecycle

object

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart

object

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.exec

object

Exec specifies the action to take.

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.exec.command

array

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.exec.command[*]

string

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet

object

HTTPGet specifies the http request to perform.

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet.path

string

Path to access on the HTTP server.

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.tcpSocket

object

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.tcpSocket.host

string

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.postStart.tcpSocket.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop

object

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.exec

object

Exec specifies the action to take.

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.exec.command

array

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.exec.command[*]

string

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet

object

HTTPGet specifies the http request to perform.

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet.path

string

Path to access on the HTTP server.

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.tcpSocket

object

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.tcpSocket.host

string

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

.spec.cruiseControlConfig.initContainers[*].lifecycle.preStop.tcpSocket.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].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

.spec.cruiseControlConfig.initContainers[*].livenessProbe.exec

object

Exec specifies the action to take.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.exec.command

array

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

.spec.cruiseControlConfig.initContainers[*].livenessProbe.exec.command[*]

string

.spec.cruiseControlConfig.initContainers[*].livenessProbe.failureThreshold

integer

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

.spec.cruiseControlConfig.initContainers[*].livenessProbe.grpc

object

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

.spec.cruiseControlConfig.initContainers[*].livenessProbe.grpc.port

integer Required

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

.spec.cruiseControlConfig.initContainers[*].livenessProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.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

.spec.cruiseControlConfig.initContainers[*].livenessProbe.periodSeconds

integer

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

.spec.cruiseControlConfig.initContainers[*].livenessProbe.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.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.tcpSocket.host

string

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

.spec.cruiseControlConfig.initContainers[*].livenessProbe.tcpSocket.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.cruiseControlConfig.initContainers[*].livenessProbe.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

.spec.cruiseControlConfig.initContainers[*].name

string Required

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

.spec.cruiseControlConfig.initContainers[*].ports

array

List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.

.spec.cruiseControlConfig.initContainers[*].ports[*]

object

ContainerPort represents a network port in a single container.

.spec.cruiseControlConfig.initContainers[*].ports[*].containerPort

integer Required

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

.spec.cruiseControlConfig.initContainers[*].ports[*].hostIP

string

What host IP to bind the external port to.

.spec.cruiseControlConfig.initContainers[*].ports[*].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.

.spec.cruiseControlConfig.initContainers[*].ports[*].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.

.spec.cruiseControlConfig.initContainers[*].ports[*].protocol

string

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.

.spec.cruiseControlConfig.initContainers[*].readinessProbe

object

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

.spec.cruiseControlConfig.initContainers[*].readinessProbe.exec

object

Exec specifies the action to take.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.exec.command

array

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

.spec.cruiseControlConfig.initContainers[*].readinessProbe.exec.command[*]

string

.spec.cruiseControlConfig.initContainers[*].readinessProbe.failureThreshold

integer

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

.spec.cruiseControlConfig.initContainers[*].readinessProbe.grpc

object

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

.spec.cruiseControlConfig.initContainers[*].readinessProbe.grpc.port

integer Required

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

.spec.cruiseControlConfig.initContainers[*].readinessProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.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

.spec.cruiseControlConfig.initContainers[*].readinessProbe.periodSeconds

integer

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

.spec.cruiseControlConfig.initContainers[*].readinessProbe.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.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.tcpSocket.host

string

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

.spec.cruiseControlConfig.initContainers[*].readinessProbe.tcpSocket.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.cruiseControlConfig.initContainers[*].readinessProbe.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

.spec.cruiseControlConfig.initContainers[*].resources

object

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

.spec.cruiseControlConfig.initContainers[*].resources.limits

object

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

.spec.cruiseControlConfig.initContainers[*].resources.requests

object

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

.spec.cruiseControlConfig.initContainers[*].securityContext

object

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

.spec.cruiseControlConfig.initContainers[*].securityContext.allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.initContainers[*].securityContext.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.

.spec.cruiseControlConfig.initContainers[*].securityContext.capabilities.add

array

Added capabilities

.spec.cruiseControlConfig.initContainers[*].securityContext.capabilities.add[*]

string

Capability represent POSIX capabilities type

.spec.cruiseControlConfig.initContainers[*].securityContext.capabilities.drop

array

Removed capabilities

.spec.cruiseControlConfig.initContainers[*].securityContext.capabilities.drop[*]

string

Capability represent POSIX capabilities type

.spec.cruiseControlConfig.initContainers[*].securityContext.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.

.spec.cruiseControlConfig.initContainers[*].securityContext.procMount

string

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.initContainers[*].securityContext.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.

.spec.cruiseControlConfig.initContainers[*].securityContext.runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.initContainers[*].securityContext.runAsNonRoot

boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.cruiseControlConfig.initContainers[*].securityContext.runAsUser

integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.initContainers[*].securityContext.seLinuxOptions

object

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

.spec.cruiseControlConfig.initContainers[*].securityContext.seLinuxOptions.level

string

Level is SELinux level label that applies to the container.

.spec.cruiseControlConfig.initContainers[*].securityContext.seLinuxOptions.role

string

Role is a SELinux role label that applies to the container.

.spec.cruiseControlConfig.initContainers[*].securityContext.seLinuxOptions.type

string

Type is a SELinux type label that applies to the container.

.spec.cruiseControlConfig.initContainers[*].securityContext.seLinuxOptions.user

string

User is a SELinux user label that applies to the container.

.spec.cruiseControlConfig.initContainers[*].securityContext.seccompProfile

object

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

.spec.cruiseControlConfig.initContainers[*].securityContext.seccompProfile.localhostProfile

string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is “Localhost”.

.spec.cruiseControlConfig.initContainers[*].securityContext.seccompProfile.type

string Required

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.cruiseControlConfig.initContainers[*].securityContext.windowsOptions

object

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

.spec.cruiseControlConfig.initContainers[*].securityContext.windowsOptions.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.

.spec.cruiseControlConfig.initContainers[*].securityContext.windowsOptions.gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

.spec.cruiseControlConfig.initContainers[*].securityContext.windowsOptions.hostProcess

boolean

HostProcess determines if a container should be run as a ‘Host Process’ container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

.spec.cruiseControlConfig.initContainers[*].securityContext.windowsOptions.runAsUserName

string

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.cruiseControlConfig.initContainers[*].startupProbe

object

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

.spec.cruiseControlConfig.initContainers[*].startupProbe.exec

object

Exec specifies the action to take.

.spec.cruiseControlConfig.initContainers[*].startupProbe.exec.command

array

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

.spec.cruiseControlConfig.initContainers[*].startupProbe.exec.command[*]

string

.spec.cruiseControlConfig.initContainers[*].startupProbe.failureThreshold

integer

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

.spec.cruiseControlConfig.initContainers[*].startupProbe.grpc

object

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

.spec.cruiseControlConfig.initContainers[*].startupProbe.grpc.port

integer Required

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

.spec.cruiseControlConfig.initContainers[*].startupProbe.grpc.service

string

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet

object

HTTPGet specifies the http request to perform.

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet.host

string

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet.httpHeaders

array

Custom headers to set in the request. HTTP allows repeated headers.

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet.httpHeaders[*]

object

HTTPHeader describes a custom header to be used in HTTP probes

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet.httpHeaders[*].name

string Required

The header field name

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet.httpHeaders[*].value

string Required

The header field value

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet.path

string

Path to access on the HTTP server.

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].startupProbe.httpGet.scheme

string

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.cruiseControlConfig.initContainers[*].startupProbe.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

.spec.cruiseControlConfig.initContainers[*].startupProbe.periodSeconds

integer

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

.spec.cruiseControlConfig.initContainers[*].startupProbe.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.

.spec.cruiseControlConfig.initContainers[*].startupProbe.tcpSocket

object

TCPSocket specifies an action involving a TCP port.

.spec.cruiseControlConfig.initContainers[*].startupProbe.tcpSocket.host

string

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

.spec.cruiseControlConfig.initContainers[*].startupProbe.tcpSocket.port

Required

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.

.spec.cruiseControlConfig.initContainers[*].startupProbe.terminationGracePeriodSeconds

integer

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

.spec.cruiseControlConfig.initContainers[*].startupProbe.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

.spec.cruiseControlConfig.initContainers[*].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.

.spec.cruiseControlConfig.initContainers[*].stdinOnce

boolean

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

.spec.cruiseControlConfig.initContainers[*].terminationMessagePath

string

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

.spec.cruiseControlConfig.initContainers[*].terminationMessagePolicy

string

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

.spec.cruiseControlConfig.initContainers[*].tty

boolean

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

.spec.cruiseControlConfig.initContainers[*].volumeDevices

array

volumeDevices is the list of block devices to be used by the container.

.spec.cruiseControlConfig.initContainers[*].volumeDevices[*]

object

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

.spec.cruiseControlConfig.initContainers[*].volumeDevices[*].devicePath

string Required

devicePath is the path inside of the container that the device will be mapped to.

.spec.cruiseControlConfig.initContainers[*].volumeDevices[*].name

string Required

name must match the name of a persistentVolumeClaim in the pod

.spec.cruiseControlConfig.initContainers[*].volumeMounts

array

Pod volumes to mount into the container’s filesystem. Cannot be updated.

.spec.cruiseControlConfig.initContainers[*].volumeMounts[*]

object

VolumeMount describes a mounting of a Volume within a container.

.spec.cruiseControlConfig.initContainers[*].volumeMounts[*].mountPath

string Required

Path within the container at which the volume should be mounted. Must not contain ‘:’.

.spec.cruiseControlConfig.initContainers[*].volumeMounts[*].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.

.spec.cruiseControlConfig.initContainers[*].volumeMounts[*].name

string Required

This must match the Name of a Volume.

.spec.cruiseControlConfig.initContainers[*].volumeMounts[*].readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

.spec.cruiseControlConfig.initContainers[*].volumeMounts[*].subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

.spec.cruiseControlConfig.initContainers[*].volumeMounts[*].subPathExpr

string

Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.

.spec.cruiseControlConfig.initContainers[*].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.

.spec.cruiseControlConfig.log4jConfig

string

.spec.cruiseControlConfig.nodeSelector

object

.spec.cruiseControlConfig.podSecurityContext

object

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

.spec.cruiseControlConfig.podSecurityContext.fsGroup

integer

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw—- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.podSecurityContext.fsGroupChangePolicy

string

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.podSecurityContext.runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.podSecurityContext.runAsNonRoot

boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.cruiseControlConfig.podSecurityContext.runAsUser

integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.podSecurityContext.seLinuxOptions

object

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

.spec.cruiseControlConfig.podSecurityContext.seLinuxOptions.level

string

Level is SELinux level label that applies to the container.

.spec.cruiseControlConfig.podSecurityContext.seLinuxOptions.role

string

Role is a SELinux role label that applies to the container.

.spec.cruiseControlConfig.podSecurityContext.seLinuxOptions.type

string

Type is a SELinux type label that applies to the container.

.spec.cruiseControlConfig.podSecurityContext.seLinuxOptions.user

string

User is a SELinux user label that applies to the container.

.spec.cruiseControlConfig.podSecurityContext.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.

.spec.cruiseControlConfig.podSecurityContext.seccompProfile.localhostProfile

string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is “Localhost”.

.spec.cruiseControlConfig.podSecurityContext.seccompProfile.type

string Required

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.cruiseControlConfig.podSecurityContext.supplementalGroups

array

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.podSecurityContext.supplementalGroups[*]

integer

.spec.cruiseControlConfig.podSecurityContext.sysctls

array

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.podSecurityContext.sysctls[*]

object

Sysctl defines a kernel parameter to be set

.spec.cruiseControlConfig.podSecurityContext.sysctls[*].name

string Required

Name of a property to set

.spec.cruiseControlConfig.podSecurityContext.sysctls[*].value

string Required

Value of a property to set

.spec.cruiseControlConfig.podSecurityContext.windowsOptions

object

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

.spec.cruiseControlConfig.podSecurityContext.windowsOptions.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.

.spec.cruiseControlConfig.podSecurityContext.windowsOptions.gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

.spec.cruiseControlConfig.podSecurityContext.windowsOptions.hostProcess

boolean

HostProcess determines if a container should be run as a ‘Host Process’ container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

.spec.cruiseControlConfig.podSecurityContext.windowsOptions.runAsUserName

string

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.cruiseControlConfig.priorityClassName

string

PriorityClassName specifies the priority class name for the CruiseControl pod. If specified, the PriorityClass resource with this PriorityClassName must be created beforehand. If not specified, the CruiseControl pod’s priority is default to zero.

.spec.cruiseControlConfig.resourceRequirements

object

ResourceRequirements describes the compute resource requirements.

.spec.cruiseControlConfig.resourceRequirements.limits

object

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

.spec.cruiseControlConfig.resourceRequirements.requests

object

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

.spec.cruiseControlConfig.securityContext

object

SecurityContext allows to set security context for the CruiseControl container

.spec.cruiseControlConfig.securityContext.allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.securityContext.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.

.spec.cruiseControlConfig.securityContext.capabilities.add

array

Added capabilities

.spec.cruiseControlConfig.securityContext.capabilities.add[*]

string

Capability represent POSIX capabilities type

.spec.cruiseControlConfig.securityContext.capabilities.drop

array

Removed capabilities

.spec.cruiseControlConfig.securityContext.capabilities.drop[*]

string

Capability represent POSIX capabilities type

.spec.cruiseControlConfig.securityContext.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.

.spec.cruiseControlConfig.securityContext.procMount

string

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.securityContext.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.

.spec.cruiseControlConfig.securityContext.runAsGroup

integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.securityContext.runAsNonRoot

boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.cruiseControlConfig.securityContext.runAsUser

integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

.spec.cruiseControlConfig.securityContext.seLinuxOptions

object

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

.spec.cruiseControlConfig.securityContext.seLinuxOptions.level

string

Level is SELinux level label that applies to the container.

.spec.cruiseControlConfig.securityContext.seLinuxOptions.role

string

Role is a SELinux role label that applies to the container.

.spec.cruiseControlConfig.securityContext.seLinuxOptions.type

string

Type is a SELinux type label that applies to the container.

.spec.cruiseControlConfig.securityContext.seLinuxOptions.user

string

User is a SELinux user label that applies to the container.

.spec.cruiseControlConfig.securityContext.seccompProfile

object

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

.spec.cruiseControlConfig.securityContext.seccompProfile.localhostProfile

string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must only be set if type is “Localhost”.

.spec.cruiseControlConfig.securityContext.seccompProfile.type

string Required

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.cruiseControlConfig.securityContext.windowsOptions

object

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

.spec.cruiseControlConfig.securityContext.windowsOptions.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.

.spec.cruiseControlConfig.securityContext.windowsOptions.gmsaCredentialSpecName

string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

.spec.cruiseControlConfig.securityContext.windowsOptions.hostProcess

boolean

HostProcess determines if a container should be run as a ‘Host Process’ container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod’s containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

.spec.cruiseControlConfig.securityContext.windowsOptions.runAsUserName

string

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

.spec.cruiseControlConfig.serviceAccountName

string

.spec.cruiseControlConfig.tolerations

array

.spec.cruiseControlConfig.tolerations[*]

object

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

.spec.cruiseControlConfig.tolerations[*].effect

string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

.spec.cruiseControlConfig.tolerations[*].key

string

Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

.spec.cruiseControlConfig.tolerations[*].operator

string

Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

.spec.cruiseControlConfig.tolerations[*].tolerationSeconds

integer

TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

.spec.cruiseControlConfig.tolerations[*].value

string

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

.spec.cruiseControlConfig.topicConfig

object

TopicConfig holds info for topic configuration regarding partitions and replicationFactor

.spec.cruiseControlConfig.topicConfig.partitions

integer Required

.spec.cruiseControlConfig.topicConfig.replicationFactor

integer Required

.spec.cruiseControlConfig.volumeMounts

array

VolumeMounts define some extra Kubernetes Volume mounts for the CruiseControl Pods.

.spec.cruiseControlConfig.volumeMounts[*]

object

VolumeMount describes a mounting of a Volume within a container.

.spec.cruiseControlConfig.volumeMounts[*].mountPath

string Required

Path within the container at which the volume should be mounted. Must not contain ‘:’.

.spec.cruiseControlConfig.volumeMounts[*].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.

.spec.cruiseControlConfig.volumeMounts[*].name

string Required

This must match the Name of a Volume.

.spec.cruiseControlConfig.volumeMounts[*].readOnly

boolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

.spec.cruiseControlConfig.volumeMounts[*].subPath

string

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

.spec.cruiseControlConfig.volumeMounts[*].subPathExpr

string

Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.

.spec.cruiseControlConfig.volumes

array

Volumes define some extra Kubernetes Volumes for the CruiseControl Pods.

.spec.cruiseControlConfig.volumes[*]

object

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

.spec.cruiseControlConfig.volumes[*].awsElasticBlockStore

object

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

.spec.cruiseControlConfig.volumes[*].awsElasticBlockStore.fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.cruiseControlConfig.volumes[*].awsElasticBlockStore.partition

integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty).

.spec.cruiseControlConfig.volumes[*].awsElasticBlockStore.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].awsElasticBlockStore.volumeID

string Required

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

.spec.cruiseControlConfig.volumes[*].azureDisk

object

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

.spec.cruiseControlConfig.volumes[*].azureDisk.cachingMode

string

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

.spec.cruiseControlConfig.volumes[*].azureDisk.diskName

string Required

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

.spec.cruiseControlConfig.volumes[*].azureDisk.diskURI

string Required

diskURI is the URI of data disk in the blob storage

.spec.cruiseControlConfig.volumes[*].azureDisk.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.

.spec.cruiseControlConfig.volumes[*].azureDisk.kind

string

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

.spec.cruiseControlConfig.volumes[*].azureDisk.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].azureFile

object

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

.spec.cruiseControlConfig.volumes[*].azureFile.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].azureFile.secretName

string Required

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

.spec.cruiseControlConfig.volumes[*].azureFile.shareName

string Required

shareName is the azure share Name

.spec.cruiseControlConfig.volumes[*].cephfs

object

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

.spec.cruiseControlConfig.volumes[*].cephfs.monitors

array Required

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

.spec.cruiseControlConfig.volumes[*].cephfs.monitors[*]

string

.spec.cruiseControlConfig.volumes[*].cephfs.path

string

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

.spec.cruiseControlConfig.volumes[*].cephfs.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

.spec.cruiseControlConfig.volumes[*].cephfs.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

.spec.cruiseControlConfig.volumes[*].cephfs.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

.spec.cruiseControlConfig.volumes[*].cephfs.secretRef.name

string

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

.spec.cruiseControlConfig.volumes[*].cephfs.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

.spec.cruiseControlConfig.volumes[*].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

.spec.cruiseControlConfig.volumes[*].cinder.fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

.spec.cruiseControlConfig.volumes[*].cinder.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

.spec.cruiseControlConfig.volumes[*].cinder.secretRef

object

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

.spec.cruiseControlConfig.volumes[*].cinder.secretRef.name

string

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

.spec.cruiseControlConfig.volumes[*].cinder.volumeID

string Required

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

.spec.cruiseControlConfig.volumes[*].configMap

object

configMap represents a configMap that should populate this volume

.spec.cruiseControlConfig.volumes[*].configMap.defaultMode

integer

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].configMap.items

array

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.

.spec.cruiseControlConfig.volumes[*].configMap.items[*]

object

Maps a string key to a path within a volume.

.spec.cruiseControlConfig.volumes[*].configMap.items[*].key

string Required

key is the key to project.

.spec.cruiseControlConfig.volumes[*].configMap.items[*].mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].configMap.items[*].path

string Required

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

.spec.cruiseControlConfig.volumes[*].configMap.name

string

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

.spec.cruiseControlConfig.volumes[*].configMap.optional

boolean

optional specify whether the ConfigMap or its keys must be defined

.spec.cruiseControlConfig.volumes[*].csi

object

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

.spec.cruiseControlConfig.volumes[*].csi.driver

string Required

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.

.spec.cruiseControlConfig.volumes[*].csi.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.

.spec.cruiseControlConfig.volumes[*].csi.nodePublishSecretRef

object

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

.spec.cruiseControlConfig.volumes[*].csi.nodePublishSecretRef.name

string

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

.spec.cruiseControlConfig.volumes[*].csi.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].csi.volumeAttributes

object

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

.spec.cruiseControlConfig.volumes[*].downwardAPI

object

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

.spec.cruiseControlConfig.volumes[*].downwardAPI.defaultMode

integer

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].downwardAPI.items

array

Items is a list of downward API volume file

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].fieldRef

object

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

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].fieldRef.apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].fieldRef.fieldPath

string Required

Path of the field to select in the specified API version.

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].mode

integer

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].path

string Required

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

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].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.

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].resourceFieldRef.containerName

string

Container name: required for volumes, optional for env vars

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

.spec.cruiseControlConfig.volumes[*].downwardAPI.items[*].resourceFieldRef.resource

string Required

Required: resource to select

.spec.cruiseControlConfig.volumes[*].emptyDir

object

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

.spec.cruiseControlConfig.volumes[*].emptyDir.medium

string

medium represents what type of storage medium should back this directory. The default is “” which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

.spec.cruiseControlConfig.volumes[*].emptyDir.sizeLimit

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

.spec.cruiseControlConfig.volumes[*].ephemeral

object

ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate

object

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.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.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec

object Required

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.accessModes

array

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.accessModes[*]

string

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource

object

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.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.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.kind

string Required

Kind is the type of resource being referenced

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.name

string Required

Name is the name of resource being referenced

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef

object

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.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.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.kind

string Required

Kind is the type of resource being referenced

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.name

string Required

Name is the name of resource being referenced

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.resources

object

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.resources.limits

object

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.resources.requests

object

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector

object

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

array

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*]

object

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].values[*]

string

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.volumeMode

string

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

.spec.cruiseControlConfig.volumes[*].ephemeral.volumeClaimTemplate.spec.volumeName

string

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

.spec.cruiseControlConfig.volumes[*].fc

object

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

.spec.cruiseControlConfig.volumes[*].fc.fsType

string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.cruiseControlConfig.volumes[*].fc.lun

integer

lun is Optional: FC target lun number

.spec.cruiseControlConfig.volumes[*].fc.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].fc.targetWWNs

array

targetWWNs is Optional: FC target worldwide names (WWNs)

.spec.cruiseControlConfig.volumes[*].fc.targetWWNs[*]

string

.spec.cruiseControlConfig.volumes[*].fc.wwids

array

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

.spec.cruiseControlConfig.volumes[*].fc.wwids[*]

string

.spec.cruiseControlConfig.volumes[*].flexVolume

object

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

.spec.cruiseControlConfig.volumes[*].flexVolume.driver

string Required

driver is the name of the driver to use for this volume.

.spec.cruiseControlConfig.volumes[*].flexVolume.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.

.spec.cruiseControlConfig.volumes[*].flexVolume.options

object

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

.spec.cruiseControlConfig.volumes[*].flexVolume.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].flexVolume.secretRef

object

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

.spec.cruiseControlConfig.volumes[*].flexVolume.secretRef.name

string

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

.spec.cruiseControlConfig.volumes[*].flocker

object

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

.spec.cruiseControlConfig.volumes[*].flocker.datasetName

string

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

.spec.cruiseControlConfig.volumes[*].flocker.datasetUUID

string

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

.spec.cruiseControlConfig.volumes[*].gcePersistentDisk

object

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

.spec.cruiseControlConfig.volumes[*].gcePersistentDisk.fsType

string

fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.cruiseControlConfig.volumes[*].gcePersistentDisk.partition

integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

.spec.cruiseControlConfig.volumes[*].gcePersistentDisk.pdName

string Required

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

.spec.cruiseControlConfig.volumes[*].gcePersistentDisk.readOnly

boolean

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

.spec.cruiseControlConfig.volumes[*].gitRepo

object

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

.spec.cruiseControlConfig.volumes[*].gitRepo.directory

string

directory is the target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

.spec.cruiseControlConfig.volumes[*].gitRepo.repository

string Required

repository is the URL

.spec.cruiseControlConfig.volumes[*].gitRepo.revision

string

revision is the commit hash for the specified revision.

.spec.cruiseControlConfig.volumes[*].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

.spec.cruiseControlConfig.volumes[*].glusterfs.endpoints

string Required

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

.spec.cruiseControlConfig.volumes[*].glusterfs.path

string Required

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

.spec.cruiseControlConfig.volumes[*].glusterfs.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

.spec.cruiseControlConfig.volumes[*].hostPath

object

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

.spec.cruiseControlConfig.volumes[*].hostPath.path

string Required

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

.spec.cruiseControlConfig.volumes[*].hostPath.type

string

type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

.spec.cruiseControlConfig.volumes[*].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

.spec.cruiseControlConfig.volumes[*].iscsi.chapAuthDiscovery

boolean

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

.spec.cruiseControlConfig.volumes[*].iscsi.chapAuthSession

boolean

chapAuthSession defines whether support iSCSI Session CHAP authentication

.spec.cruiseControlConfig.volumes[*].iscsi.fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.cruiseControlConfig.volumes[*].iscsi.initiatorName

string

initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.

.spec.cruiseControlConfig.volumes[*].iscsi.iqn

string Required

iqn is the target iSCSI Qualified Name.

.spec.cruiseControlConfig.volumes[*].iscsi.iscsiInterface

string

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

.spec.cruiseControlConfig.volumes[*].iscsi.lun

integer Required

lun represents iSCSI Target Lun number.

.spec.cruiseControlConfig.volumes[*].iscsi.portals

array

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

.spec.cruiseControlConfig.volumes[*].iscsi.portals[*]

string

.spec.cruiseControlConfig.volumes[*].iscsi.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].iscsi.secretRef

object

secretRef is the CHAP Secret for iSCSI target and initiator authentication

.spec.cruiseControlConfig.volumes[*].iscsi.secretRef.name

string

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

.spec.cruiseControlConfig.volumes[*].iscsi.targetPortal

string Required

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

.spec.cruiseControlConfig.volumes[*].name

string Required

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

.spec.cruiseControlConfig.volumes[*].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

.spec.cruiseControlConfig.volumes[*].nfs.path

string Required

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

.spec.cruiseControlConfig.volumes[*].nfs.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

.spec.cruiseControlConfig.volumes[*].nfs.server

string Required

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

.spec.cruiseControlConfig.volumes[*].persistentVolumeClaim

object

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

.spec.cruiseControlConfig.volumes[*].persistentVolumeClaim.claimName

string Required

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

.spec.cruiseControlConfig.volumes[*].persistentVolumeClaim.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].photonPersistentDisk

object

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

.spec.cruiseControlConfig.volumes[*].photonPersistentDisk.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.

.spec.cruiseControlConfig.volumes[*].photonPersistentDisk.pdID

string Required

pdID is the ID that identifies Photon Controller persistent disk

.spec.cruiseControlConfig.volumes[*].portworxVolume

object

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

.spec.cruiseControlConfig.volumes[*].portworxVolume.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.

.spec.cruiseControlConfig.volumes[*].portworxVolume.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].portworxVolume.volumeID

string Required

volumeID uniquely identifies a Portworx volume

.spec.cruiseControlConfig.volumes[*].projected

object

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

.spec.cruiseControlConfig.volumes[*].projected.defaultMode

integer

defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].projected.sources

array

sources is the list of volume projections

.spec.cruiseControlConfig.volumes[*].projected.sources[*]

object

Projection that may be projected along with other supported volume types

.spec.cruiseControlConfig.volumes[*].projected.sources[*].configMap

object

configMap information about the configMap data to project

.spec.cruiseControlConfig.volumes[*].projected.sources[*].configMap.items

array

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].configMap.items[*]

object

Maps a string key to a path within a volume.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].configMap.items[*].key

string Required

key is the key to project.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].configMap.items[*].mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].configMap.items[*].path

string Required

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

.spec.cruiseControlConfig.volumes[*].projected.sources[*].configMap.name

string

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

.spec.cruiseControlConfig.volumes[*].projected.sources[*].configMap.optional

boolean

optional specify whether the ConfigMap or its keys must be defined

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI

object

downwardAPI information about the downwardAPI data to project

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items

array

Items is a list of DownwardAPIVolume file

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*]

object

DownwardAPIVolumeFile represents information to create the file containing the pod field

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef

object

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

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef.apiVersion

string

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef.fieldPath

string Required

Path of the field to select in the specified API version.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].mode

integer

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].path

string Required

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

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].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.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.containerName

string

Container name: required for volumes, optional for env vars

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.divisor

Specifies the output format of the exposed resources, defaults to “1”

.spec.cruiseControlConfig.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.resource

string Required

Required: resource to select

.spec.cruiseControlConfig.volumes[*].projected.sources[*].secret

object

secret information about the secret data to project

.spec.cruiseControlConfig.volumes[*].projected.sources[*].secret.items

array

items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].secret.items[*]

object

Maps a string key to a path within a volume.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].secret.items[*].key

string Required

key is the key to project.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].secret.items[*].mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].secret.items[*].path

string Required

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

.spec.cruiseControlConfig.volumes[*].projected.sources[*].secret.name

string

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

.spec.cruiseControlConfig.volumes[*].projected.sources[*].secret.optional

boolean

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

.spec.cruiseControlConfig.volumes[*].projected.sources[*].serviceAccountToken

object

serviceAccountToken is information about the serviceAccountToken data to project

.spec.cruiseControlConfig.volumes[*].projected.sources[*].serviceAccountToken.audience

string

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

.spec.cruiseControlConfig.volumes[*].projected.sources[*].serviceAccountToken.expirationSeconds

integer

expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

.spec.cruiseControlConfig.volumes[*].projected.sources[*].serviceAccountToken.path

string Required

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

.spec.cruiseControlConfig.volumes[*].quobyte

object

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

.spec.cruiseControlConfig.volumes[*].quobyte.group

string

group to map volume access to Default is no group

.spec.cruiseControlConfig.volumes[*].quobyte.readOnly

boolean

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

.spec.cruiseControlConfig.volumes[*].quobyte.registry

string Required

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

.spec.cruiseControlConfig.volumes[*].quobyte.tenant

string

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

.spec.cruiseControlConfig.volumes[*].quobyte.user

string

user to map volume access to Defaults to serivceaccount user

.spec.cruiseControlConfig.volumes[*].quobyte.volume

string Required

volume is a string that references an already created Quobyte volume by name.

.spec.cruiseControlConfig.volumes[*].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

.spec.cruiseControlConfig.volumes[*].rbd.fsType

string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine

.spec.cruiseControlConfig.volumes[*].rbd.image

string Required

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

.spec.cruiseControlConfig.volumes[*].rbd.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

.spec.cruiseControlConfig.volumes[*].rbd.monitors

array Required

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

.spec.cruiseControlConfig.volumes[*].rbd.monitors[*]

string

.spec.cruiseControlConfig.volumes[*].rbd.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

.spec.cruiseControlConfig.volumes[*].rbd.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

.spec.cruiseControlConfig.volumes[*].rbd.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

.spec.cruiseControlConfig.volumes[*].rbd.secretRef.name

string

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

.spec.cruiseControlConfig.volumes[*].rbd.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

.spec.cruiseControlConfig.volumes[*].scaleIO

object

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

.spec.cruiseControlConfig.volumes[*].scaleIO.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”.

.spec.cruiseControlConfig.volumes[*].scaleIO.gateway

string Required

gateway is the host address of the ScaleIO API Gateway.

.spec.cruiseControlConfig.volumes[*].scaleIO.protectionDomain

string

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

.spec.cruiseControlConfig.volumes[*].scaleIO.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].scaleIO.secretRef

object Required

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

.spec.cruiseControlConfig.volumes[*].scaleIO.secretRef.name

string

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

.spec.cruiseControlConfig.volumes[*].scaleIO.sslEnabled

boolean

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

.spec.cruiseControlConfig.volumes[*].scaleIO.storageMode

string

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

.spec.cruiseControlConfig.volumes[*].scaleIO.storagePool

string

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

.spec.cruiseControlConfig.volumes[*].scaleIO.system

string Required

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

.spec.cruiseControlConfig.volumes[*].scaleIO.volumeName

string

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

.spec.cruiseControlConfig.volumes[*].secret

object

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

.spec.cruiseControlConfig.volumes[*].secret.defaultMode

integer

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].secret.items

array

items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.

.spec.cruiseControlConfig.volumes[*].secret.items[*]

object

Maps a string key to a path within a volume.

.spec.cruiseControlConfig.volumes[*].secret.items[*].key

string Required

key is the key to project.

.spec.cruiseControlConfig.volumes[*].secret.items[*].mode

integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

.spec.cruiseControlConfig.volumes[*].secret.items[*].path

string Required

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

.spec.cruiseControlConfig.volumes[*].secret.optional

boolean

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

.spec.cruiseControlConfig.volumes[*].secret.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

.spec.cruiseControlConfig.volumes[*].storageos

object

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

.spec.cruiseControlConfig.volumes[*].storageos.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.

.spec.cruiseControlConfig.volumes[*].storageos.readOnly

boolean

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

.spec.cruiseControlConfig.volumes[*].storageos.secretRef

object

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

.spec.cruiseControlConfig.volumes[*].storageos.secretRef.name

string

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

.spec.cruiseControlConfig.volumes[*].storageos.volumeName

string

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

.spec.cruiseControlConfig.volumes[*].storageos.volumeNamespace

string

volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to “default” if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

.spec.cruiseControlConfig.volumes[*].vsphereVolume

object

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

.spec.cruiseControlConfig.volumes[*].vsphereVolume.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.

.spec.cruiseControlConfig.volumes[*].vsphereVolume.storagePolicyID

string

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

.spec.cruiseControlConfig.volumes[*].vsphereVolume.storagePolicyName

string

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

.spec.cruiseControlConfig.volumes[*].vsphereVolume.volumePath

string Required

volumePath is the path that identifies vSphere volume vmdk

.spec.disruptionBudget

object

DisruptionBudget defines the configuration for PodDisruptionBudget where the workload is managed by the kafka-operator

.spec.disruptionBudget.budget

string

The budget to set for the PDB, can either be static number or a percentage

.spec.disruptionBudget.create

boolean

If set to true, will create a podDisruptionBudget

.spec.envoyConfig

object

EnvoyConfig defines the config for Envoy

.spec.envoyConfig.adminPort

integer

Envoy admin port

.spec.envoyConfig.affinity

object

Affinity is a group of affinity scheduling rules.

.spec.envoyConfig.affinity.nodeAffinity

object

Describes node affinity scheduling rules for the pod.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

array

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*]

object

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

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference

object Required

A node selector term, associated with the corresponding weight.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions

array

A list of node selector requirements by node’s labels.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*]

object

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

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].key

string Required

The label key that the selector applies to.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].operator

string Required

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].values

array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].values[*]

string

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields

array

A list of node selector requirements by node’s fields.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*]

object

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

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].key

string Required

The label key that the selector applies to.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].operator

string Required

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].values

array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].values[*]

string

.spec.envoyConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].weight

integer Required

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

object

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

array Required

Required. A list of node selector terms. The terms are ORed.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*]

object

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.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions

array

A list of node selector requirements by node’s labels.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*]

object

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

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].key

string Required

The label key that the selector applies to.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].operator

string Required

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].values

array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].values[*]

string

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields

array

A list of node selector requirements by node’s fields.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*]

object

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

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].key

string Required

The label key that the selector applies to.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].operator

string Required

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].values

array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

.spec.envoyConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].values[*]

string

.spec.envoyConfig.affinity.podAffinity

object

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

array

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*]

object

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm

object Required

Required. A pod affinity term, associated with the corresponding weight.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector

object

A label query over a set of resources, in this case pods.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions

array

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

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*]

object

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

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values[*]

string

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector

object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions

array

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

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*]

object

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

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values[*]

string

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces

array

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces[*]

string

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.topologyKey

string Required

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

.spec.envoyConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].weight

integer Required

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

.spec.envoyConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

array

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

.spec.envoyConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*]

object

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

.spec.envoyConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector

object

A label query over a set of resources, in this case pods.

.spec.envoyConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions

array

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

.spec.envoyCo