KsqlDB CRD schema reference (group kafka.banzaicloud.io)
KsqlDB
KsqlDB is the Schema for the ksqldbs API
Version v1beta1
Properties
.apiVersion
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
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
.spec
KsqlDBSpec defines the desired state of KsqlDB
.spec.MTLS
Controls whether mTLS is enforced between ksqlDB and client applications (default: true)
.spec.affinity
Affinity settings for ksqlDB pods https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
.spec.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
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.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*]
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.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference
A node selector term, associated with the corresponding weight.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions
A list of node selector requirements by node’s labels.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].key
The label key that the selector applies to.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].values
An array of string values. If the operator 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.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchExpressions[*].values[*]
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields
A list of node selector requirements by node’s fields.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].key
The label key that the selector applies to.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].values
An array of string values. If the operator 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.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].preference.matchFields[*].values[*]
.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].weight
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
Required. A list of node selector terms. The terms are ORed.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*]
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.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions
A list of node selector requirements by node’s labels.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].key
The label key that the selector applies to.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].values
An array of string values. If the operator 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.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchExpressions[*].values[*]
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields
A list of node selector requirements by node’s fields.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*]
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].key
The label key that the selector applies to.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].values
An array of string values. If the operator 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.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[*].matchFields[*].values[*]
.spec.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
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.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values
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.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values[*]
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchLabels
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.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values
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.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values[*]
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchLabels
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.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces
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.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces[*]
.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.topologyKey
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.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].weight
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to 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.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*]
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
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector
A label query over a set of resources, in this case pods.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].values
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.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].values[*]
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchLabels
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.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].values
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.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].values[*]
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchLabels
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.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaces
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.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaces[*]
.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].topologyKey
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.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
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.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*]
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values
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.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchExpressions[*].values[*]
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.labelSelector.matchLabels
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.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values
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.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchExpressions[*].values[*]
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaceSelector.matchLabels
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.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces
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.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.namespaces[*]
.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].podAffinityTerm.topologyKey
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.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[*].weight
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
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.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*]
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
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector
A label query over a set of resources, in this case pods.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].values
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.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchExpressions[*].values[*]
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].labelSelector.matchLabels
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.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].values
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.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchExpressions[*].values[*]
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaceSelector.matchLabels
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.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaces
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.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].namespaces[*]
.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[*].topologyKey
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.authorizations
Controls the list of principals who are authorized to access the ksqlDB REST API
.spec.authorizations[*]
Authorization defines the principal that is authorized to access KsqlDB REST API when KsqlDB runs in interactive mode.
.spec.authorizations[*].principal
KsqlDBPrincipalReference contains information about a Kubernetes resource that corresponds to a KsqlDB principal.
.spec.authorizations[*].principal.kind
The type of the principal
.spec.authorizations[*].principal.name
Name of the principal. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
.spec.authorizations[*].principal.namespace
Namespace of the principal. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
.spec.clusterRef
Name of the KafkaCluster custom resource that represents the Kafka cluster this ksqlDB instance to connect to
.spec.clusterRef.name
.spec.externalEndpoint
Settings for exposing ksqlDB REST API outside the Kubernetes cluster when running in interactive mode
.spec.externalEndpoint.enabled
Controls whether to expose KsqlDB outside the Kubernetes cluster (default: false)
.spec.externalEndpoint.istioControlPlane
IstioControlPlane specifies the namespace and name of the IstioControlPlane custom resource which represents the Istio control plane the istio ingress uses to expose ksqlDB outside the Kubernetes cluster.
.spec.externalEndpoint.istioControlPlane.name
.spec.externalEndpoint.istioControlPlane.namespace
.spec.externalEndpoint.istioIngressConfig
Configuration for the ingress controller when KsqlDB running in interactive mode is exposed outside the Kubernetes cluster
.spec.externalEndpoint.istioIngressConfig.annotations
.spec.externalEndpoint.istioIngressConfig.nodeSelector
.spec.externalEndpoint.istioIngressConfig.replicas
.spec.externalEndpoint.istioIngressConfig.resourceRequirements
ResourceRequirements describes the compute resource requirements.
.spec.externalEndpoint.istioIngressConfig.resourceRequirements.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
.spec.externalEndpoint.istioIngressConfig.resourceRequirements.requests
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.externalEndpoint.istioIngressConfig.tolerations
.spec.externalEndpoint.istioIngressConfig.tolerations[*]
The pod this Toleration is attached to tolerates any taint that matches the triple
.spec.externalEndpoint.istioIngressConfig.tolerations[*].effect
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
.spec.externalEndpoint.istioIngressConfig.tolerations[*].key
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.externalEndpoint.istioIngressConfig.tolerations[*].operator
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.externalEndpoint.istioIngressConfig.tolerations[*].tolerationSeconds
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.externalEndpoint.istioIngressConfig.tolerations[*].value
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.externalEndpoint.istioIngressConfig.virtualServiceAnnotations
.spec.headless
Controls whether the ksqlDB is running in headless or interactive mode (default: false)
.spec.heapOpts
Heap settings for ksqlDB (default: -Xms512M -Xmx2G)
.spec.image
.spec.imagePullPolicy
PullPolicy describes a policy for if/when to pull a container image
.spec.imagePullSecrets
.spec.imagePullSecrets[*]
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
.spec.imagePullSecrets[*].name
Name 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.inputTopics
Input topics to be used in ksql queries for reading
.spec.inputTopics[*]
.spec.jmxExporter
JmxExporterSpec defines the configuration for jmx exporter
.spec.jmxExporter.config
.spec.jmxExporter.image
.spec.jmxExporter.imagePullPolicy
PullPolicy describes a policy for if/when to pull a container image
.spec.jmxExporter.srcJarPath
.spec.kafkaConnectRef
Name of the KafkaConnect custom resource that represents the Kafka Connect to be made available for ksqlDB
.spec.kafkaConnectRef.name
.spec.ksqlDBConfig
Defines the config values for ksqlDB
.spec.nodeSelector
Node selector setting for ksqlDB pods https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector
.spec.outputTopics
Output topics to be used in ksql queries for write and create
.spec.outputTopics[*]
.spec.podAnnotations
Annotations to be applied to ksqlDB pod
.spec.podLabels
Labels to be applied to ksqlDB pod
.spec.queryConfigMapName
Controls the name of the configmap which contains the ksqldb queries executed in headless mode. (default: queries.sql
.spec.resources
Resources describes the compute resource requirements default: requests: cpu: 1 memory: 1.5Gi limits: cpu: 2 memory: 2.5Gi
.spec.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
.spec.resources.requests
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.scaling
Defines HPA configurations
.spec.scaling.maxValue
Maximum number of replicas (default: 5)
.spec.scaling.minValue
Minimum number of replicas (default: 1)
.spec.scaling.prometheusUrl
URL to the prometheus service that will be used for scaling defaults to http://prometheus-operator-prometheus.supertubes-system.svc:9090
.spec.scaling.streams
Name of the ksqldb streams that the PrometheusMetric will be filtered by
.spec.scaling.streams[*]
.spec.scaling.threshold
Threshold for the hpa to activate (default: 30)
.spec.schemaRegistryRef
Name of the SchemaRegistry custom resource that represents the Schema registry to be made available for ksqlDB
.spec.schemaRegistryRef.name
.spec.serviceAccountName
Service account for ksqlDB pod
.spec.serviceAnnotations
Annotations to be applied on the service that exposes ksqlDB API on port ServicePort
.spec.serviceLabels
Labels to be applied to the service that exposes ksqlDB API on port ServicePort
.spec.servicePort
The port ksqlDB listens for REST API requests
.spec.tolerations
Toleration settings for ksqlDB pods (https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)
.spec.tolerations[*]
The pod this Toleration is attached to tolerates any taint that matches the triple
.spec.tolerations[*].effect
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
.spec.tolerations[*].key
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.tolerations[*].operator
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.tolerations[*].tolerationSeconds
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.tolerations[*].value
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.volumeMounts
Volume mounts for ksqlDB pods (https://kubernetes.io/docs/concepts/storage/volumes/)
.spec.volumeMounts[*]
VolumeMount describes a mounting of a Volume within a container.
.spec.volumeMounts[*].mountPath
Path within the container at which the volume should be mounted. Must not contain ‘:’.
.spec.volumeMounts[*].mountPropagation
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.volumeMounts[*].name
This must match the Name of a Volume.
.spec.volumeMounts[*].readOnly
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
.spec.volumeMounts[*].subPath
Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).
.spec.volumeMounts[*].subPathExpr
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.volumes
Volumes for ksqlDB pods (https://kubernetes.io/docs/concepts/storage/volumes/)
.spec.volumes[*]
Volume represents a named volume in a pod that may be accessed by any container in the pod.
.spec.volumes[*].awsElasticBlockStore
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
.spec.volumes[*].awsElasticBlockStore.fsType
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.volumes[*].awsElasticBlockStore.partition
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.volumes[*].awsElasticBlockStore.readOnly
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
.spec.volumes[*].awsElasticBlockStore.volumeID
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.volumes[*].azureDisk
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
.spec.volumes[*].azureDisk.cachingMode
cachingMode is the Host Caching mode: None, Read Only, Read Write.
.spec.volumes[*].azureDisk.diskName
diskName is the Name of the data disk in the blob storage
.spec.volumes[*].azureDisk.diskURI
diskURI is the URI of data disk in the blob storage
.spec.volumes[*].azureDisk.fsType
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.volumes[*].azureDisk.kind
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.volumes[*].azureDisk.readOnly
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
.spec.volumes[*].azureFile
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
.spec.volumes[*].azureFile.readOnly
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
.spec.volumes[*].azureFile.secretName
secretName is the name of secret that contains Azure Storage Account Name and Key
.spec.volumes[*].azureFile.shareName
shareName is the azure share Name
.spec.volumes[*].cephfs
cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime
.spec.volumes[*].cephfs.monitors
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.volumes[*].cephfs.monitors[*]
.spec.volumes[*].cephfs.path
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
.spec.volumes[*].cephfs.readOnly
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.volumes[*].cephfs.secretFile
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.volumes[*].cephfs.secretRef
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
.spec.volumes[*].cephfs.secretRef.name
Name 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.volumes[*].cephfs.user
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.volumes[*].cinder
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
.spec.volumes[*].cinder.fsType
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.volumes[*].cinder.readOnly
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.volumes[*].cinder.secretRef
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
.spec.volumes[*].cinder.secretRef.name
Name 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.volumes[*].cinder.volumeID
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
.spec.volumes[*].configMap
configMap represents a configMap that should populate this volume
.spec.volumes[*].configMap.defaultMode
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.volumes[*].configMap.items
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.volumes[*].configMap.items[*]
Maps a string key to a path within a volume.
.spec.volumes[*].configMap.items[*].key
key is the key to project.
.spec.volumes[*].configMap.items[*].mode
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.volumes[*].configMap.items[*].path
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.volumes[*].configMap.name
Name 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.volumes[*].configMap.optional
optional specify whether the ConfigMap or its keys must be defined
.spec.volumes[*].csi
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
.spec.volumes[*].csi.driver
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.volumes[*].csi.fsType
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.volumes[*].csi.nodePublishSecretRef
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
.spec.volumes[*].csi.nodePublishSecretRef.name
Name 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.volumes[*].csi.readOnly
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
.spec.volumes[*].csi.volumeAttributes
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.
.spec.volumes[*].downwardAPI
downwardAPI represents downward API about the pod that should populate this volume
.spec.volumes[*].downwardAPI.defaultMode
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.volumes[*].downwardAPI.items
Items is a list of downward API volume file
.spec.volumes[*].downwardAPI.items[*]
DownwardAPIVolumeFile represents information to create the file containing the pod field
.spec.volumes[*].downwardAPI.items[*].fieldRef
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
.spec.volumes[*].downwardAPI.items[*].fieldRef.apiVersion
Version of the schema the FieldPath is written in terms of, defaults to “v1”.
.spec.volumes[*].downwardAPI.items[*].fieldRef.fieldPath
Path of the field to select in the specified API version.
.spec.volumes[*].downwardAPI.items[*].mode
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.volumes[*].downwardAPI.items[*].path
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.volumes[*].downwardAPI.items[*].resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
.spec.volumes[*].downwardAPI.items[*].resourceFieldRef.containerName
Container name: required for volumes, optional for env vars
.spec.volumes[*].downwardAPI.items[*].resourceFieldRef.divisor
Specifies the output format of the exposed resources, defaults to “1”
.spec.volumes[*].downwardAPI.items[*].resourceFieldRef.resource
Required: resource to select
.spec.volumes[*].emptyDir
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
.spec.volumes[*].emptyDir.medium
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.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: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
.spec.volumes[*].ephemeral
ephemeral represents a volume that is handled by a cluster storage driver. The volume’s lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.
.spec.volumes[*].ephemeral.volumeClaimTemplate
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name>
where <volume name>
is the name from the PodSpec.Volumes
array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).
An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
.spec.volumes[*].ephemeral.volumeClaimTemplate.metadata
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.volumes[*].ephemeral.volumeClaimTemplate.spec
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.accessModes
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.accessModes[*]
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource
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.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.apiGroup
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.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.kind
Kind is the type of resource being referenced
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSource.name
Name is the name of resource being referenced
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef
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.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.apiGroup
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.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.kind
Kind is the type of resource being referenced
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.dataSourceRef.name
Name is the name of resource being referenced
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.resources
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.volumes[*].ephemeral.volumeClaimTemplate.spec.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.resources.requests
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.volumes[*].ephemeral.volumeClaimTemplate.spec.selector
selector is a label query over volumes to consider for binding.
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].key
key is the label key that the selector applies to.
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].values
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.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[*].values[*]
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.selector.matchLabels
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.volumes[*].ephemeral.volumeClaimTemplate.spec.storageClassName
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.volumeMode
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
.spec.volumes[*].ephemeral.volumeClaimTemplate.spec.volumeName
volumeName is the binding reference to the PersistentVolume backing this claim.
.spec.volumes[*].fc
fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
.spec.volumes[*].fc.fsType
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.volumes[*].fc.lun
lun is Optional: FC target lun number
.spec.volumes[*].fc.readOnly
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
.spec.volumes[*].fc.targetWWNs
targetWWNs is Optional: FC target worldwide names (WWNs)
.spec.volumes[*].fc.targetWWNs[*]
.spec.volumes[*].fc.wwids
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
.spec.volumes[*].fc.wwids[*]
.spec.volumes[*].flexVolume
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
.spec.volumes[*].flexVolume.driver
driver is the name of the driver to use for this volume.
.spec.volumes[*].flexVolume.fsType
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.volumes[*].flexVolume.options
options is Optional: this field holds extra command options if any.
.spec.volumes[*].flexVolume.readOnly
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
.spec.volumes[*].flexVolume.secretRef
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
.spec.volumes[*].flexVolume.secretRef.name
Name 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.volumes[*].flocker
flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running
.spec.volumes[*].flocker.datasetName
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
.spec.volumes[*].flocker.datasetUUID
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
.spec.volumes[*].gcePersistentDisk
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
.spec.volumes[*].gcePersistentDisk.fsType
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.volumes[*].gcePersistentDisk.partition
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.volumes[*].gcePersistentDisk.pdName
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.volumes[*].gcePersistentDisk.readOnly
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
.spec.volumes[*].gitRepo
gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container.
.spec.volumes[*].gitRepo.directory
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.volumes[*].gitRepo.repository
repository is the URL
.spec.volumes[*].gitRepo.revision
revision is the commit hash for the specified revision.
.spec.volumes[*].glusterfs
glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
.spec.volumes[*].glusterfs.endpoints
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
.spec.volumes[*].glusterfs.path
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
.spec.volumes[*].glusterfs.readOnly
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.volumes[*].hostPath
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.
.spec.volumes[*].hostPath.path
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.volumes[*].hostPath.type
type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
.spec.volumes[*].iscsi
iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
.spec.volumes[*].iscsi.chapAuthDiscovery
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
.spec.volumes[*].iscsi.chapAuthSession
chapAuthSession defines whether support iSCSI Session CHAP authentication
.spec.volumes[*].iscsi.fsType
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.volumes[*].iscsi.initiatorName
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
.spec.volumes[*].iscsi.iqn
iqn is the target iSCSI Qualified Name.
.spec.volumes[*].iscsi.iscsiInterface
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).
.spec.volumes[*].iscsi.lun
lun represents iSCSI Target Lun number.
.spec.volumes[*].iscsi.portals
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.volumes[*].iscsi.portals[*]
.spec.volumes[*].iscsi.readOnly
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
.spec.volumes[*].iscsi.secretRef
secretRef is the CHAP Secret for iSCSI target and initiator authentication
.spec.volumes[*].iscsi.secretRef.name
Name 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.volumes[*].iscsi.targetPortal
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.volumes[*].name
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.volumes[*].nfs
nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
.spec.volumes[*].nfs.path
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
.spec.volumes[*].nfs.readOnly
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.volumes[*].nfs.server
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
.spec.volumes[*].persistentVolumeClaim
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
.spec.volumes[*].persistentVolumeClaim.claimName
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.volumes[*].persistentVolumeClaim.readOnly
readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
.spec.volumes[*].photonPersistentDisk
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
.spec.volumes[*].photonPersistentDisk.fsType
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.volumes[*].photonPersistentDisk.pdID
pdID is the ID that identifies Photon Controller persistent disk
.spec.volumes[*].portworxVolume
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
.spec.volumes[*].portworxVolume.fsType
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.volumes[*].portworxVolume.readOnly
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
.spec.volumes[*].portworxVolume.volumeID
volumeID uniquely identifies a Portworx volume
.spec.volumes[*].projected
projected items for all in one resources secrets, configmaps, and downward API
.spec.volumes[*].projected.defaultMode
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.volumes[*].projected.sources
sources is the list of volume projections
.spec.volumes[*].projected.sources[*]
Projection that may be projected along with other supported volume types
.spec.volumes[*].projected.sources[*].configMap
configMap information about the configMap data to project
.spec.volumes[*].projected.sources[*].configMap.items
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.volumes[*].projected.sources[*].configMap.items[*]
Maps a string key to a path within a volume.
.spec.volumes[*].projected.sources[*].configMap.items[*].key
key is the key to project.
.spec.volumes[*].projected.sources[*].configMap.items[*].mode
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.volumes[*].projected.sources[*].configMap.items[*].path
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.volumes[*].projected.sources[*].configMap.name
Name 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.volumes[*].projected.sources[*].configMap.optional
optional specify whether the ConfigMap or its keys must be defined
.spec.volumes[*].projected.sources[*].downwardAPI
downwardAPI information about the downwardAPI data to project
.spec.volumes[*].projected.sources[*].downwardAPI.items
Items is a list of DownwardAPIVolume file
.spec.volumes[*].projected.sources[*].downwardAPI.items[*]
DownwardAPIVolumeFile represents information to create the file containing the pod field
.spec.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
.spec.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef.apiVersion
Version of the schema the FieldPath is written in terms of, defaults to “v1”.
.spec.volumes[*].projected.sources[*].downwardAPI.items[*].fieldRef.fieldPath
Path of the field to select in the specified API version.
.spec.volumes[*].projected.sources[*].downwardAPI.items[*].mode
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.volumes[*].projected.sources[*].downwardAPI.items[*].path
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.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
.spec.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.containerName
Container name: required for volumes, optional for env vars
.spec.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.divisor
Specifies the output format of the exposed resources, defaults to “1”
.spec.volumes[*].projected.sources[*].downwardAPI.items[*].resourceFieldRef.resource
Required: resource to select
.spec.volumes[*].projected.sources[*].secret
secret information about the secret data to project
.spec.volumes[*].projected.sources[*].secret.items
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.volumes[*].projected.sources[*].secret.items[*]
Maps a string key to a path within a volume.
.spec.volumes[*].projected.sources[*].secret.items[*].key
key is the key to project.
.spec.volumes[*].projected.sources[*].secret.items[*].mode
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.volumes[*].projected.sources[*].secret.items[*].path
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.volumes[*].projected.sources[*].secret.name
Name 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.volumes[*].projected.sources[*].secret.optional
optional field specify whether the Secret or its key must be defined
.spec.volumes[*].projected.sources[*].serviceAccountToken
serviceAccountToken is information about the serviceAccountToken data to project
.spec.volumes[*].projected.sources[*].serviceAccountToken.audience
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.volumes[*].projected.sources[*].serviceAccountToken.expirationSeconds
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.volumes[*].projected.sources[*].serviceAccountToken.path
path is the path relative to the mount point of the file to project the token into.
.spec.volumes[*].quobyte
quobyte represents a Quobyte mount on the host that shares a pod’s lifetime
.spec.volumes[*].quobyte.group
group to map volume access to Default is no group
.spec.volumes[*].quobyte.readOnly
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
.spec.volumes[*].quobyte.registry
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.volumes[*].quobyte.tenant
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
.spec.volumes[*].quobyte.user
user to map volume access to Defaults to serivceaccount user
.spec.volumes[*].quobyte.volume
volume is a string that references an already created Quobyte volume by name.
.spec.volumes[*].rbd
rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
.spec.volumes[*].rbd.fsType
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.volumes[*].rbd.image
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
.spec.volumes[*].rbd.keyring
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.volumes[*].rbd.monitors
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
.spec.volumes[*].rbd.monitors[*]
.spec.volumes[*].rbd.pool
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
.spec.volumes[*].rbd.readOnly
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.volumes[*].rbd.secretRef
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
.spec.volumes[*].rbd.secretRef.name
Name 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.volumes[*].rbd.user
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
.spec.volumes[*].scaleIO
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
.spec.volumes[*].scaleIO.fsType
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.volumes[*].scaleIO.gateway
gateway is the host address of the ScaleIO API Gateway.
.spec.volumes[*].scaleIO.protectionDomain
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
.spec.volumes[*].scaleIO.readOnly
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
.spec.volumes[*].scaleIO.secretRef
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
.spec.volumes[*].scaleIO.secretRef.name
Name 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.volumes[*].scaleIO.sslEnabled
sslEnabled Flag enable/disable SSL communication with Gateway, default false
.spec.volumes[*].scaleIO.storageMode
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
.spec.volumes[*].scaleIO.storagePool
storagePool is the ScaleIO Storage Pool associated with the protection domain.
.spec.volumes[*].scaleIO.system
system is the name of the storage system as configured in ScaleIO.
.spec.volumes[*].scaleIO.volumeName
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
.spec.volumes[*].secret
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
.spec.volumes[*].secret.defaultMode
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.volumes[*].secret.items
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.volumes[*].secret.items[*]
Maps a string key to a path within a volume.
.spec.volumes[*].secret.items[*].key
key is the key to project.
.spec.volumes[*].secret.items[*].mode
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.volumes[*].secret.items[*].path
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.volumes[*].secret.optional
optional field specify whether the Secret or its keys must be defined
.spec.volumes[*].secret.secretName
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.volumes[*].storageos
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
.spec.volumes[*].storageos.fsType
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.volumes[*].storageos.readOnly
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
.spec.volumes[*].storageos.secretRef
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
.spec.volumes[*].storageos.secretRef.name
Name 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.volumes[*].storageos.volumeName
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
.spec.volumes[*].storageos.volumeNamespace
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.volumes[*].vsphereVolume
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
.spec.volumes[*].vsphereVolume.fsType
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.volumes[*].vsphereVolume.storagePolicyID
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
.spec.volumes[*].vsphereVolume.storagePolicyName
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
.spec.volumes[*].vsphereVolume.volumePath
volumePath is the path that identifies vSphere volume vmdk
.status
KsqlDBStatus defines the observed state of KsqlDB