Was this page helpful?
Caution
You're viewing documentation for a previous version of Scylla Operator. Switch to the latest stable version.
ScyllaCluster defines a Scylla cluster.
Property |
Type |
Description |
---|---|---|
apiVersion |
string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kind |
string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
object |
||
object |
spec defines the desired state of this scylla cluster. |
|
object |
status is the current status of this scylla cluster. |
object
spec defines the desired state of this scylla cluster.
object
Property |
Type |
Description |
---|---|---|
agentRepository |
string |
agentRepository is the repository to pull the agent image from. |
agentVersion |
string |
agentVersion indicates the version of Scylla Manager Agent to use. |
object |
alternator designates this cluster an Alternator cluster. |
|
automaticOrphanedNodeCleanup |
boolean |
automaticOrphanedNodeCleanup controls if automatic orphan node cleanup should be performed. |
array (object) |
backups specifies backup tasks in Scylla Manager. When Scylla Manager is not installed, these will be ignored. |
|
cpuset |
boolean |
cpuset determines if the cluster will use cpu-pinning for max performance. |
object |
datacenter holds a specification of a datacenter. |
|
developerMode |
boolean |
developerMode determines if the cluster runs in developer-mode. |
dnsDomains |
array (string) |
dnsDomains is a list of DNS domains this cluster is reachable by. These domains are used when setting up the infrastructure, like certificates. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. |
object |
exposeOptions specifies options for exposing ScyllaCluster services. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. |
|
externalSeeds |
array (string) |
externalSeeds specifies the external seeds to propagate to ScyllaDB binary on startup as “seeds” parameter of seed-provider. |
forceRedeploymentReason |
string |
forceRedeploymentReason can be used to force a rolling update of all racks by providing a unique string. |
object |
genericUpgrade allows to configure behavior of generic upgrade logic. |
|
array (object) |
imagePullSecrets is an optional list of references to secrets in the same namespace used for pulling Scylla and Agent images. |
|
minReadySeconds |
integer |
minReadySeconds is the minimum number of seconds for which a newly created ScyllaDB node should be ready for it to be considered available. When used to control load balanced traffic, this can give the load balancer in front of a node enough time to notice that the node is ready and start forwarding traffic in time. Because it all depends on timing, the order is not guaranteed and, if possible, you should use readinessGates instead. If not provided, Operator will determine this value. |
minTerminationGracePeriodSeconds |
integer |
minTerminationGracePeriodSeconds specifies minimum duration in seconds to wait before every drained node is terminated. This gives time to potential load balancer in front of a node to notice that node is not ready anymore and stop forwarding new requests. This applies only when node is terminated gracefully. If not provided, Operator will determine this value. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. |
object |
network holds the networking config. |
|
object |
podMetadata controls shared metadata for all pods created based on this spec. |
|
array (object) |
readinessGates specifies custom readiness gates that will be evaluated for every ScyllaDB Pod readiness. It’s projected into every ScyllaDB Pod as its readinessGate. Refer to upstream documentation to learn more about readiness gates. |
|
array (object) |
repairs specify repair tasks in Scylla Manager. When Scylla Manager is not installed, these will be ignored. |
|
repository |
string |
repository is the image repository to pull the Scylla image from. |
scyllaArgs |
string |
scyllaArgs will be appended to Scylla binary during startup. This is supported from 4.2.0 Scylla version. |
sysctls |
array (string) |
sysctls holds the sysctl properties to be applied during initialization given as a list of key=value pairs. Example: fs.aio-max-nr=232323 |
version |
string |
version is a version tag of Scylla to use. |
alternator designates this cluster an Alternator cluster.
object
Property |
Type |
Description |
---|---|---|
insecureDisableAuthorization |
boolean |
insecureDisableAuthorization disables Alternator authorization. If not specified, the authorization is enabled. For backwards compatibility the authorization is disabled when this field is not specified and a manual port is used. |
insecureEnableHTTP |
boolean |
insecureEnableHTTP enables serving Alternator traffic also on insecure HTTP port. |
port |
integer |
port is the port number used to bind the Alternator API. Deprecated: port is deprecated and may be ignored in the future. Please make sure to avoid using hostNetworking and work with standard Kubernetes concepts like Services. |
object |
servingCertificate references a TLS certificate for serving secure traffic. |
|
writeIsolation |
string |
writeIsolation indicates the isolation level. |
servingCertificate references a TLS certificate for serving secure traffic.
object
Property |
Type |
Description |
---|---|---|
object |
operatorManagedOptions specifies options for certificates manged by the operator. |
|
type |
string |
type determines the source of this certificate. |
object |
userManagedOptions specifies options for certificates manged by users. |
operatorManagedOptions specifies options for certificates manged by the operator.
object
Property |
Type |
Description |
---|---|---|
additionalDNSNames |
array (string) |
additionalDNSNames represents external DNS names that the certificates should be signed for. |
additionalIPAddresses |
array (string) |
additionalIPAddresses represents external IP addresses that the certificates should be signed for. |
userManagedOptions specifies options for certificates manged by users.
object
Property |
Type |
Description |
---|---|---|
secretName |
string |
secretName references a kubernetes.io/tls type secret containing the TLS cert and key. |
object
Property |
Type |
Description |
---|---|---|
dc |
array (string) |
dc is a list of datacenter glob patterns, e.g. ‘dc1,!otherdc*’ used to specify the DCs to include or exclude from backup. |
interval |
string |
interval represents a task schedule interval e.g. 3d2h10m, valid units are d, h, m, s. |
keyspace |
array (string) |
keyspace is a list of keyspace/tables glob patterns, e.g. ‘keyspace,!keyspace.table_prefix_*’ used to include or exclude keyspaces from repair. |
location |
array (string) |
location is a list of backup locations in the format [<dc>:]<provider>:<name> ex. s3:my-bucket. The <dc>: part is optional and is only needed when different datacenters are being used to upload data to different locations. <name> must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden. The only supported storage <provider> at the moment are s3 and gcs. |
name |
string |
name is a unique name of a task. |
numRetries |
integer |
numRetries indicates how many times a scheduled task will be retried before failing. |
rateLimit |
array (string) |
rateLimit is a list of megabytes (MiB) per second rate limits expressed in the format [<dc>:]<limit>. The <dc>: part is optional and only needed when different datacenters need different upload limits. Set to 0 for no limit (default 100). |
retention |
integer |
retention is the number of backups which are to be stored. |
snapshotParallel |
array (string) |
snapshotParallel is a list of snapshot parallelism limits in the format [<dc>:]<limit>. The <dc>: part is optional and allows for specifying different limits in selected datacenters. If The <dc>: part is not set, the limit is global (e.g. ‘dc1:2,5’) the runs are parallel in n nodes (2 in dc1) and n nodes in all the other datacenters. |
startDate |
string |
startDate specifies the task start date expressed in the RFC3339 format or now[+duration], e.g. now+3d2h10m, valid units are d, h, m, s. |
uploadParallel |
array (string) |
uploadParallel is a list of upload parallelism limits in the format [<dc>:]<limit>. The <dc>: part is optional and allows for specifying different limits in selected datacenters. If The <dc>: part is not set the limit is global (e.g. ‘dc1:2,5’) the runs are parallel in n nodes (2 in dc1) and n nodes in all the other datacenters. |
datacenter holds a specification of a datacenter.
object
Property |
Type |
Description |
---|---|---|
name |
string |
name is the name of the scylla datacenter. Used in the cassandra-rackdc.properties file. |
array (object) |
racks specify the racks in the datacenter. |
RackSpec is the desired state for a Scylla Rack.
object
Property |
Type |
Description |
---|---|---|
object |
agentResources specify the resources for the Agent container. |
|
array (object) |
AgentVolumeMounts to be added to Agent container. |
|
members |
integer |
members is the number of Scylla instances in this rack. |
name |
string |
name is the name of the Scylla Rack. Used in the cassandra-rackdc.properties file. |
object |
placement describes restrictions for the nodes Scylla is scheduled on. |
|
object |
resources the Scylla container will use. |
|
scyllaAgentConfig |
string |
Scylla config map name to customize scylla manager agent |
scyllaConfig |
string |
Scylla config map name to customize scylla.yaml |
object |
storage describes the underlying storage that Scylla will consume. |
|
array (object) |
VolumeMounts to be added to Scylla container. |
|
array (object) |
Volumes added to Scylla Pod. |
agentResources specify the resources for the Agent container.
object
Property |
Type |
Description |
---|---|---|
array (object) |
|
|
object |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
object |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
ResourceClaim references one entry in PodSpec.ResourceClaims.
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
VolumeMount describes a mounting of a Volume within a container.
object
Property |
Type |
Description |
---|---|---|
mountPath |
string |
Path within the container at which the volume should be mounted. Must not contain ‘:’. |
mountPropagation |
string |
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. |
name |
string |
This must match the Name of a Volume. |
readOnly |
boolean |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
subPath |
string |
Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root). |
subPathExpr |
string |
Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
placement describes restrictions for the nodes Scylla is scheduled on.
object
Property |
Type |
Description |
---|---|---|
object |
nodeAffinity describes node affinity scheduling rules for the pod. |
|
object |
podAffinity describes pod affinity scheduling rules. |
|
object |
podAntiAffinity describes pod anti-affinity scheduling rules. |
|
array (object) |
tolerations allow the pod to tolerate any taint that matches the triple <key,value,effect> using the matching operator. |
nodeAffinity describes node affinity scheduling rules for the pod.
object
Property |
Type |
Description |
---|---|---|
array (object) |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
|
object |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
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).
object
Property |
Type |
Description |
---|---|---|
object |
A node selector term, associated with the corresponding weight. |
|
weight |
integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
A node selector term, associated with the corresponding weight.
object
Property |
Type |
Description |
---|---|---|
array (object) |
A list of node selector requirements by node’s labels. |
|
array (object) |
A list of node selector requirements by node’s fields. |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
The label key that the selector applies to. |
operator |
string |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
values |
array (string) |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
The label key that the selector applies to. |
operator |
string |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
values |
array (string) |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
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.
object
Property |
Type |
Description |
---|---|---|
array (object) |
Required. A list of node selector terms. The terms are ORed. |
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.
object
Property |
Type |
Description |
---|---|---|
array (object) |
A list of node selector requirements by node’s labels. |
|
array (object) |
A list of node selector requirements by node’s fields. |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
The label key that the selector applies to. |
operator |
string |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
values |
array (string) |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
The label key that the selector applies to. |
operator |
string |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
values |
array (string) |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
podAffinity describes pod affinity scheduling rules.
object
Property |
Type |
Description |
---|---|---|
array (object) |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
|
array (object) |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
object
Property |
Type |
Description |
---|---|---|
object |
Required. A pod affinity term, associated with the corresponding weight. |
|
weight |
integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
Required. A pod affinity term, associated with the corresponding weight.
object
Property |
Type |
Description |
---|---|---|
object |
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
matchLabelKeys |
array (string) |
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn’t set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
mismatchLabelKeys |
array (string) |
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn’t set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
object |
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces. |
|
namespaces |
array (string) |
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”. |
topologyKey |
string |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
object
Property |
Type |
Description |
---|---|---|
object |
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
matchLabelKeys |
array (string) |
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn’t set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
mismatchLabelKeys |
array (string) |
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn’t set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
object |
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces. |
|
namespaces |
array (string) |
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”. |
topologyKey |
string |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
podAntiAffinity describes pod anti-affinity scheduling rules.
object
Property |
Type |
Description |
---|---|---|
array (object) |
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
|
array (object) |
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
object
Property |
Type |
Description |
---|---|---|
object |
Required. A pod affinity term, associated with the corresponding weight. |
|
weight |
integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
Required. A pod affinity term, associated with the corresponding weight.
object
Property |
Type |
Description |
---|---|---|
object |
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
matchLabelKeys |
array (string) |
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn’t set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
mismatchLabelKeys |
array (string) |
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn’t set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
object |
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces. |
|
namespaces |
array (string) |
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”. |
topologyKey |
string |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
object
Property |
Type |
Description |
---|---|---|
object |
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods. |
|
matchLabelKeys |
array (string) |
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn’t set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
mismatchLabelKeys |
array (string) |
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with LabelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn’t set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. |
object |
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces. |
|
namespaces |
array (string) |
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”. |
topologyKey |
string |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
object
Property |
Type |
Description |
---|---|---|
effect |
string |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
key |
string |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
operator |
string |
Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
tolerationSeconds |
integer |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
value |
string |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
resources the Scylla container will use.
object
Property |
Type |
Description |
---|---|---|
array (object) |
|
|
object |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
object |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
ResourceClaim references one entry in PodSpec.ResourceClaims.
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
storage describes the underlying storage that Scylla will consume.
object
Property |
Type |
Description |
---|---|---|
capacity |
string |
capacity describes the requested size of each persistent volume. |
object |
metadata controls shared metadata for the volume claim for this rack. At this point, the values are applied only for the initial claim and are not reconciled during its lifetime. Note that this may get fixed in the future and this behaviour shouldn’t be relied on in any way. |
|
storageClassName |
string |
storageClassName is the name of a storageClass to request. |
metadata controls shared metadata for the volume claim for this rack. At this point, the values are applied only for the initial claim and are not reconciled during its lifetime. Note that this may get fixed in the future and this behaviour shouldn’t be relied on in any way.
object
Property |
Type |
Description |
---|---|---|
object |
annotations is a custom key value map that gets merged with managed object annotations. |
|
object |
labels is a custom key value map that gets merged with managed object labels. |
annotations is a custom key value map that gets merged with managed object annotations.
object
labels is a custom key value map that gets merged with managed object labels.
object
VolumeMount describes a mounting of a Volume within a container.
object
Property |
Type |
Description |
---|---|---|
mountPath |
string |
Path within the container at which the volume should be mounted. Must not contain ‘:’. |
mountPropagation |
string |
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. |
name |
string |
This must match the Name of a Volume. |
readOnly |
boolean |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
subPath |
string |
Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root). |
subPathExpr |
string |
Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive. |
Volume represents a named volume in a pod that may be accessed by any container in the pod.
object
Property |
Type |
Description |
---|---|---|
object |
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
object |
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
|
object |
azureFile represents an Azure File Service mount on the host and bind mount to the pod. |
|
object |
cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime |
|
object |
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
object |
configMap represents a configMap that should populate this volume |
|
object |
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). |
|
object |
downwardAPI represents downward API about the pod that should populate this volume |
|
object |
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
object |
|
|
object |
fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
|
object |
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
|
object |
flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running |
|
object |
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
object |
gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod’s container. |
|
object |
glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md |
|
object |
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. |
|
object |
iscsi represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md |
|
name |
string |
name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
object |
nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
object |
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
object |
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
|
object |
portworxVolume represents a portworx volume attached and mounted on kubelets host machine |
|
object |
projected items for all in one resources secrets, configmaps, and downward API |
|
object |
quobyte represents a Quobyte mount on the host that shares a pod’s lifetime |
|
object |
rbd represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md |
|
object |
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
|
object |
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
object |
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. |
|
object |
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
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
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine |
partition |
integer |
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty). |
readOnly |
boolean |
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
volumeID |
string |
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
object
Property |
Type |
Description |
---|---|---|
cachingMode |
string |
cachingMode is the Host Caching mode: None, Read Only, Read Write. |
diskName |
string |
diskName is the Name of the data disk in the blob storage |
diskURI |
string |
diskURI is the URI of data disk in the blob storage |
fsType |
string |
fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. |
kind |
string |
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared |
readOnly |
boolean |
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
object
Property |
Type |
Description |
---|---|---|
readOnly |
boolean |
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
secretName |
string |
secretName is the name of secret that contains Azure Storage Account Name and Key |
shareName |
string |
shareName is the azure share Name |
cephFS represents a Ceph FS mount on the host that shares a pod’s lifetime
object
Property |
Type |
Description |
---|---|---|
monitors |
array (string) |
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
path |
string |
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
readOnly |
boolean |
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
secretFile |
string |
secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
object |
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
user |
string |
user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
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
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |
readOnly |
boolean |
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |
object |
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. |
|
volumeID |
string |
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
configMap represents a configMap that should populate this volume
object
Property |
Type |
Description |
---|---|---|
defaultMode |
integer |
defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
array (object) |
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. 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 ‘..’. |
|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
optional |
boolean |
optional specify whether the ConfigMap or its keys must be defined |
Maps a string key to a path within a volume.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the key to project. |
mode |
integer |
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path |
string |
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’. |
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
object
Property |
Type |
Description |
---|---|---|
driver |
string |
driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. |
fsType |
string |
fsType to mount. Ex. “ext4”, “xfs”, “ntfs”. If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. |
object |
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. |
|
readOnly |
boolean |
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). |
object |
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values. |
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.
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.
object
downwardAPI represents downward API about the pod that should populate this volume
object
Property |
Type |
Description |
---|---|---|
defaultMode |
integer |
Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
array (object) |
Items is a list of downward API volume file |
DownwardAPIVolumeFile represents information to create the file containing the pod field
object
Property |
Type |
Description |
---|---|---|
object |
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
|
mode |
integer |
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path |
string |
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’ |
object |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
object
Property |
Type |
Description |
---|---|---|
apiVersion |
string |
Version of the schema the FieldPath is written in terms of, defaults to “v1”. |
fieldPath |
string |
Path of the field to select in the specified API version. |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
object
Property |
Type |
Description |
---|---|---|
containerName |
string |
Container name: required for volumes, optional for env vars |
divisor |
Specifies the output format of the exposed resources, defaults to “1” |
|
resource |
string |
Required: resource to select |
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
object
Property |
Type |
Description |
---|---|---|
medium |
string |
medium represents what type of storage medium should back this directory. The default is “” which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
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 |
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.
object
Property |
Type |
Description |
---|---|---|
object |
|
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.
object
Property |
Type |
Description |
---|---|---|
object |
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. |
|
object |
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |
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.
object
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
object
Property |
Type |
Description |
---|---|---|
accessModes |
array (string) |
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
object |
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. |
|
object |
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any 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, when namespace isn’t specified in dataSourceRef, 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. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three 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. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. |
|
object |
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
object |
selector is a label query over volumes to consider for binding. |
|
storageClassName |
string |
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
volumeAttributesClassName |
string |
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it’s not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled. |
volumeMode |
string |
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
volumeName |
string |
volumeName is the binding reference to the PersistentVolume backing this claim. |
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. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
object
Property |
Type |
Description |
---|---|---|
apiGroup |
string |
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
kind |
string |
Kind is the type of resource being referenced |
name |
string |
Name is the name of resource being referenced |
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any 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, when namespace isn’t specified in dataSourceRef, 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. When namespace is specified in dataSourceRef, dataSource isn’t set to the same value and must be empty. There are three 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. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
object
Property |
Type |
Description |
---|---|---|
apiGroup |
string |
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
kind |
string |
Kind is the type of resource being referenced |
name |
string |
Name is the name of resource being referenced |
namespace |
string |
Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace’s owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. |
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
object
Property |
Type |
Description |
---|---|---|
object |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
object |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
selector is a label query over volumes to consider for binding.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
fc represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine |
lun |
integer |
lun is Optional: FC target lun number |
readOnly |
boolean |
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
targetWWNs |
array (string) |
targetWWNs is Optional: FC target worldwide names (WWNs) |
wwids |
array (string) |
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
object
Property |
Type |
Description |
---|---|---|
driver |
string |
driver is the name of the driver to use for this volume. |
fsType |
string |
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. The default filesystem depends on FlexVolume script. |
object |
options is Optional: this field holds extra command options if any. |
|
readOnly |
boolean |
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
object |
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |
options is Optional: this field holds extra command options if any.
object
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running
object
Property |
Type |
Description |
---|---|---|
datasetName |
string |
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated |
datasetUUID |
string |
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset |
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
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine |
partition |
integer |
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as “1”. Similarly, the volume partition for /dev/sda is “0” (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
pdName |
string |
pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
readOnly |
boolean |
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
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.
object
Property |
Type |
Description |
---|---|---|
directory |
string |
directory is the target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
repository |
string |
repository is the URL |
revision |
string |
revision is the commit hash for the specified revision. |
glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
object
Property |
Type |
Description |
---|---|---|
endpoints |
string |
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
path |
string |
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
readOnly |
boolean |
readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
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.
object
Property |
Type |
Description |
---|---|---|
path |
string |
path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
type |
string |
type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
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
object
Property |
Type |
Description |
---|---|---|
chapAuthDiscovery |
boolean |
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication |
chapAuthSession |
boolean |
chapAuthSession defines whether support iSCSI Session CHAP authentication |
fsType |
string |
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine |
initiatorName |
string |
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. |
iqn |
string |
iqn is the target iSCSI Qualified Name. |
iscsiInterface |
string |
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp). |
lun |
integer |
lun represents iSCSI Target Lun number. |
portals |
array (string) |
portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
readOnly |
boolean |
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
object |
secretRef is the CHAP Secret for iSCSI target and initiator authentication |
|
targetPortal |
string |
targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
secretRef is the CHAP Secret for iSCSI target and initiator authentication
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
nfs represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
object
Property |
Type |
Description |
---|---|---|
path |
string |
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
readOnly |
boolean |
readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
server |
string |
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
object
Property |
Type |
Description |
---|---|---|
claimName |
string |
claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
readOnly |
boolean |
readOnly Will force the ReadOnly setting in VolumeMounts. Default false. |
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. |
pdID |
string |
pdID is the ID that identifies Photon Controller persistent disk |
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”. Implicitly inferred to be “ext4” if unspecified. |
readOnly |
boolean |
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
volumeID |
string |
volumeID uniquely identifies a Portworx volume |
projected items for all in one resources secrets, configmaps, and downward API
object
Property |
Type |
Description |
---|---|---|
defaultMode |
integer |
defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
array (object) |
sources is the list of volume projections |
Projection that may be projected along with other supported volume types
object
Property |
Type |
Description |
---|---|---|
object |
|
|
object |
configMap information about the configMap data to project |
|
object |
downwardAPI information about the downwardAPI data to project |
|
object |
secret information about the secret data to project |
|
object |
serviceAccountToken is information about the serviceAccountToken data to project |
Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
object
Property |
Type |
Description |
---|---|---|
object |
Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as “match nothing”. If set but empty, interpreted as “match everything”. |
|
name |
string |
Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector. |
optional |
boolean |
If true, don’t block pod startup if the referenced ClusterTrustBundle(s) aren’t available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles. |
path |
string |
Relative path from the volume root to write the bundle. |
signerName |
string |
Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated. |
Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as “match nothing”. If set but empty, interpreted as “match everything”.
object
Property |
Type |
Description |
---|---|---|
array (object) |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
object |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the label key that the selector applies to. |
operator |
string |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values |
array (string) |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
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.
object
configMap information about the configMap data to project
object
Property |
Type |
Description |
---|---|---|
array (object) |
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. 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 ‘..’. |
|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
optional |
boolean |
optional specify whether the ConfigMap or its keys must be defined |
Maps a string key to a path within a volume.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the key to project. |
mode |
integer |
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path |
string |
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’. |
downwardAPI information about the downwardAPI data to project
object
Property |
Type |
Description |
---|---|---|
array (object) |
Items is a list of DownwardAPIVolume file |
DownwardAPIVolumeFile represents information to create the file containing the pod field
object
Property |
Type |
Description |
---|---|---|
object |
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
|
mode |
integer |
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path |
string |
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’ |
object |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
object
Property |
Type |
Description |
---|---|---|
apiVersion |
string |
Version of the schema the FieldPath is written in terms of, defaults to “v1”. |
fieldPath |
string |
Path of the field to select in the specified API version. |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
object
Property |
Type |
Description |
---|---|---|
containerName |
string |
Container name: required for volumes, optional for env vars |
divisor |
Specifies the output format of the exposed resources, defaults to “1” |
|
resource |
string |
Required: resource to select |
secret information about the secret data to project
object
Property |
Type |
Description |
---|---|---|
array (object) |
items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. 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 ‘..’. |
|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
optional |
boolean |
optional field specify whether the Secret or its key must be defined |
Maps a string key to a path within a volume.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the key to project. |
mode |
integer |
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path |
string |
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’. |
serviceAccountToken is information about the serviceAccountToken data to project
object
Property |
Type |
Description |
---|---|---|
audience |
string |
audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
expirationSeconds |
integer |
expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
path |
string |
path is the path relative to the mount point of the file to project the token into. |
quobyte represents a Quobyte mount on the host that shares a pod’s lifetime
object
Property |
Type |
Description |
---|---|---|
group |
string |
group to map volume access to Default is no group |
readOnly |
boolean |
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
registry |
string |
registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
tenant |
string |
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin |
user |
string |
user to map volume access to Defaults to serivceaccount user |
volume |
string |
volume is a string that references an already created Quobyte volume by name. |
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
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine |
image |
string |
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
keyring |
string |
keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
monitors |
array (string) |
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
pool |
string |
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
readOnly |
boolean |
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
object |
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
user |
string |
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
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
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs”. |
gateway |
string |
gateway is the host address of the ScaleIO API Gateway. |
protectionDomain |
string |
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. |
readOnly |
boolean |
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
object |
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
|
sslEnabled |
boolean |
sslEnabled Flag enable/disable SSL communication with Gateway, default false |
storageMode |
string |
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
storagePool |
string |
storagePool is the ScaleIO Storage Pool associated with the protection domain. |
system |
string |
system is the name of the storage system as configured in ScaleIO. |
volumeName |
string |
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. |
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
object
Property |
Type |
Description |
---|---|---|
defaultMode |
integer |
defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
array (object) |
items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. 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 ‘..’. |
|
optional |
boolean |
optional field specify whether the Secret or its keys must be defined |
secretName |
string |
secretName is the name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
Maps a string key to a path within a volume.
object
Property |
Type |
Description |
---|---|---|
key |
string |
key is the key to project. |
mode |
integer |
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
path |
string |
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’. |
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. |
readOnly |
boolean |
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
object |
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
|
volumeName |
string |
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
volumeNamespace |
string |
volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to “default” if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
object
Property |
Type |
Description |
---|---|---|
fsType |
string |
fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Implicitly inferred to be “ext4” if unspecified. |
storagePolicyID |
string |
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. |
storagePolicyName |
string |
storagePolicyName is the storage Policy Based Management (SPBM) profile name. |
volumePath |
string |
volumePath is the path that identifies vSphere volume vmdk |
exposeOptions specifies options for exposing ScyllaCluster services. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field.
object
Property |
Type |
Description |
---|---|---|
object |
BroadcastOptions defines how ScyllaDB node publishes its IP address to other nodes and clients. |
|
object |
cql specifies expose options for CQL SSL backend. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. |
|
object |
nodeService controls properties of Service dedicated for each ScyllaCluster node. |
BroadcastOptions defines how ScyllaDB node publishes its IP address to other nodes and clients.
object
Property |
Type |
Description |
---|---|---|
object |
clients specifies options related to the address that is broadcasted for communication with clients. This field controls the broadcast_rpc_address value in ScyllaDB config. |
|
object |
nodes specifies options related to the address that is broadcasted for communication with other nodes. This field controls the broadcast_address value in ScyllaDB config. |
clients specifies options related to the address that is broadcasted for communication with clients. This field controls the broadcast_rpc_address value in ScyllaDB config.
object
Property |
Type |
Description |
---|---|---|
object |
podIP holds options related to Pod IP address. |
|
type |
string |
type of the address that is broadcasted. |
podIP holds options related to Pod IP address.
object
Property |
Type |
Description |
---|---|---|
source |
string |
sourceType specifies source of the Pod IP. |
nodes specifies options related to the address that is broadcasted for communication with other nodes. This field controls the broadcast_address value in ScyllaDB config.
object
Property |
Type |
Description |
---|---|---|
object |
podIP holds options related to Pod IP address. |
|
type |
string |
type of the address that is broadcasted. |
podIP holds options related to Pod IP address.
object
Property |
Type |
Description |
---|---|---|
source |
string |
sourceType specifies source of the Pod IP. |
cql specifies expose options for CQL SSL backend. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field.
object
Property |
Type |
Description |
---|---|---|
object |
ingress is an Ingress configuration options. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. |
ingress is an Ingress configuration options. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field.
object
Property |
Type |
Description |
---|---|---|
object |
annotations is a custom key value map that gets merged with managed object annotations. |
|
disabled |
boolean |
disabled controls if Ingress object creation is disabled. Unless disabled, there is an Ingress objects created for every Scylla node. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. |
ingressClassName |
string |
ingressClassName specifies Ingress class name. EXPERIMENTAL. Do not rely on any particular behaviour controlled by this field. |
object |
labels is a custom key value map that gets merged with managed object labels. |
annotations is a custom key value map that gets merged with managed object annotations.
object
labels is a custom key value map that gets merged with managed object labels.
object
nodeService controls properties of Service dedicated for each ScyllaCluster node.
object
Property |
Type |
Description |
---|---|---|
allocateLoadBalancerNodePorts |
boolean |
allocateLoadBalancerNodePorts controls value of service.spec.allocateLoadBalancerNodePorts of each node Service. Check Kubernetes corev1.Service documentation about semantic of this field. |
object |
annotations is a custom key value map that gets merged with managed object annotations. |
|
externalTrafficPolicy |
string |
externalTrafficPolicy controls value of service.spec.externalTrafficPolicy of each node Service. Check Kubernetes corev1.Service documentation about semantic of this field. |
internalTrafficPolicy |
string |
internalTrafficPolicy controls value of service.spec.internalTrafficPolicy of each node Service. Check Kubernetes corev1.Service documentation about semantic of this field. |
object |
labels is a custom key value map that gets merged with managed object labels. |
|
loadBalancerClass |
string |
loadBalancerClass controls value of service.spec.loadBalancerClass of each node Service. Check Kubernetes corev1.Service documentation about semantic of this field. |
type |
string |
type is the Kubernetes Service type. |
annotations is a custom key value map that gets merged with managed object annotations.
object
labels is a custom key value map that gets merged with managed object labels.
object
genericUpgrade allows to configure behavior of generic upgrade logic.
object
Property |
Type |
Description |
---|---|---|
failureStrategy |
string |
failureStrategy specifies which logic is executed when upgrade failure happens. Currently only Retry is supported. |
pollInterval |
string |
pollInterval specifies how often upgrade logic polls on state updates. Increasing this value should lower number of requests sent to apiserver, but it may affect overall time spent during upgrade. DEPRECATED. |
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
object
Property |
Type |
Description |
---|---|---|
name |
string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
network holds the networking config.
object
Property |
Type |
Description |
---|---|---|
dnsPolicy |
string |
dnsPolicy defines how a pod’s DNS will be configured. |
hostNetworking |
boolean |
hostNetworking determines if scylla uses the host’s network namespace. Setting this option avoids going through Kubernetes SDN and exposes scylla on node’s IP. |
podMetadata controls shared metadata for all pods created based on this spec.
object
Property |
Type |
Description |
---|---|---|
object |
annotations is a custom key value map that gets merged with managed object annotations. |
|
object |
labels is a custom key value map that gets merged with managed object labels. |
annotations is a custom key value map that gets merged with managed object annotations.
object
labels is a custom key value map that gets merged with managed object labels.
object
PodReadinessGate contains the reference to a pod condition
object
Property |
Type |
Description |
---|---|---|
conditionType |
string |
ConditionType refers to a condition in the pod’s condition list with matching type. |
object
Property |
Type |
Description |
---|---|---|
dc |
array (string) |
dc is a list of datacenter glob patterns, e.g. ‘dc1’, ‘!otherdc*’ used to specify the DCs to include or exclude from backup. |
failFast |
boolean |
failFast indicates if a repair should be stopped on first error. |
host |
string |
host specifies a host to repair. If empty, all hosts are repaired. |
intensity |
string |
intensity indicates how many token ranges (per shard) to repair in a single Scylla repair job. By default this is 1. If you set it to 0 the number of token ranges is adjusted to the maximum supported by node (see max_repair_ranges_in_parallel in Scylla logs). Valid values are 0 and integers >= 1. Higher values will result in increased cluster load and slightly faster repairs. Changing the intensity impacts repair granularity if you need to resume it, the higher the value the more work on resume. For Scylla clusters that do not support row-level repair, intensity can be a decimal between (0,1). In that case it specifies percent of shards that can be repaired in parallel on a repair master node. For Scylla clusters that are row-level repair enabled, setting intensity below 1 has the same effect as setting intensity 1. |
interval |
string |
interval represents a task schedule interval e.g. 3d2h10m, valid units are d, h, m, s. |
keyspace |
array (string) |
keyspace is a list of keyspace/tables glob patterns, e.g. ‘keyspace,!keyspace.table_prefix_*’ used to include or exclude keyspaces from repair. |
name |
string |
name is a unique name of a task. |
numRetries |
integer |
numRetries indicates how many times a scheduled task will be retried before failing. |
parallel |
integer |
parallel is the maximum number of Scylla repair jobs that can run at the same time (on different token ranges and replicas). Each node can take part in at most one repair at any given moment. By default the maximum possible parallelism is used. The effective parallelism depends on a keyspace replication factor (RF) and the number of nodes. The formula to calculate it is as follows: number of nodes / RF, ex. for 6 node cluster with RF=3 the maximum parallelism is 2. |
smallTableThreshold |
string |
smallTableThreshold enable small table optimization for tables of size lower than given threshold. Supported units [B, MiB, GiB, TiB]. |
startDate |
string |
startDate specifies the task start date expressed in the RFC3339 format or now[+duration], e.g. now+3d2h10m, valid units are d, h, m, s. |
status is the current status of this scylla cluster.
object
Property |
Type |
Description |
---|---|---|
availableMembers |
integer |
availableMembers is the number of ScyllaDB members in all racks that are available. |
array (object) |
backups reflects status of backup tasks. |
|
array (object) |
conditions hold conditions describing ScyllaCluster state. To determine whether a cluster rollout is finished, look for Available=True,Progressing=False,Degraded=False. |
|
managerId |
string |
managerId contains ID under which cluster was registered in Scylla Manager. |
members |
integer |
members is the number of ScyllaDB members in all racks. |
observedGeneration |
integer |
observedGeneration is the most recent generation observed for this ScyllaCluster. It corresponds to the ScyllaCluster’s generation, which is updated on mutation by the API Server. |
rackCount |
integer |
rackCount is the number of ScyllaDB racks in this cluster. |
object |
racks reflect status of cluster racks. |
|
readyMembers |
integer |
readyMembers is the number of ScyllaDB members in all racks that are ready. |
array (object) |
repairs reflects status of repair tasks. |
|
object |
upgrade reflects state of ongoing upgrade procedure. |
object
Property |
Type |
Description |
---|---|---|
dc |
array (string) |
dc is a list of datacenter glob patterns, e.g. ‘dc1,!otherdc*’ used to specify the DCs to include or exclude from backup. |
error |
string |
error holds the backup task error, if any. |
id |
string |
id is the identification number of the backup task. |
interval |
string |
interval represents a task schedule interval e.g. 3d2h10m, valid units are d, h, m, s. |
keyspace |
array (string) |
keyspace is a list of keyspace/tables glob patterns, e.g. ‘keyspace,!keyspace.table_prefix_*’ used to include or exclude keyspaces from repair. |
location |
array (string) |
location is a list of backup locations in the format [<dc>:]<provider>:<name> ex. s3:my-bucket. The <dc>: part is optional and is only needed when different datacenters are being used to upload data to different locations. <name> must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden. The only supported storage <provider> at the moment are s3 and gcs. |
name |
string |
name is a unique name of a task. |
numRetries |
integer |
numRetries indicates how many times a scheduled task will be retried before failing. |
rateLimit |
array (string) |
rateLimit is a list of megabytes (MiB) per second rate limits expressed in the format [<dc>:]<limit>. The <dc>: part is optional and only needed when different datacenters need different upload limits. Set to 0 for no limit (default 100). |
retention |
integer |
retention is the number of backups which are to be stored. |
snapshotParallel |
array (string) |
snapshotParallel is a list of snapshot parallelism limits in the format [<dc>:]<limit>. The <dc>: part is optional and allows for specifying different limits in selected datacenters. If The <dc>: part is not set, the limit is global (e.g. ‘dc1:2,5’) the runs are parallel in n nodes (2 in dc1) and n nodes in all the other datacenters. |
startDate |
string |
startDate specifies the task start date expressed in the RFC3339 format or now[+duration], e.g. now+3d2h10m, valid units are d, h, m, s. |
uploadParallel |
array (string) |
uploadParallel is a list of upload parallelism limits in the format [<dc>:]<limit>. The <dc>: part is optional and allows for specifying different limits in selected datacenters. If The <dc>: part is not set the limit is global (e.g. ‘dc1:2,5’) the runs are parallel in n nodes (2 in dc1) and n nodes in all the other datacenters. |
type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: “Available”, “Progressing”, and “Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:”conditions,omitempty” patchStrategy:”merge” patchMergeKey:”type” protobuf:”bytes,1,rep,name=conditions” // other fields }
object
Property |
Type |
Description |
---|---|---|
lastTransitionTime |
string |
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
message |
string |
message is a human readable message indicating details about the transition. This may be an empty string. |
observedGeneration |
integer |
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
reason |
string |
reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
status |
string |
status of the condition, one of True, False, Unknown. |
type |
string |
type of condition in CamelCase or in foo.example.com/CamelCase. — Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |
racks reflect status of cluster racks.
object
object
Property |
Type |
Description |
---|---|---|
dc |
array (string) |
dc is a list of datacenter glob patterns, e.g. ‘dc1’, ‘!otherdc*’ used to specify the DCs to include or exclude from backup. |
error |
string |
error holds the repair task error, if any. |
failFast |
boolean |
failFast indicates if a repair should be stopped on first error. |
host |
string |
host specifies a host to repair. If empty, all hosts are repaired. |
id |
string |
id is the identification number of the repair task. |
intensity |
string |
intensity indicates how many token ranges (per shard) to repair in a single Scylla repair job. By default this is 1. If you set it to 0 the number of token ranges is adjusted to the maximum supported by node (see max_repair_ranges_in_parallel in Scylla logs). Valid values are 0 and integers >= 1. Higher values will result in increased cluster load and slightly faster repairs. Changing the intensity impacts repair granularity if you need to resume it, the higher the value the more work on resume. For Scylla clusters that do not support row-level repair, intensity can be a decimal between (0,1). In that case it specifies percent of shards that can be repaired in parallel on a repair master node. For Scylla clusters that are row-level repair enabled, setting intensity below 1 has the same effect as setting intensity 1. |
interval |
string |
interval represents a task schedule interval e.g. 3d2h10m, valid units are d, h, m, s. |
keyspace |
array (string) |
keyspace is a list of keyspace/tables glob patterns, e.g. ‘keyspace,!keyspace.table_prefix_*’ used to include or exclude keyspaces from repair. |
name |
string |
name is a unique name of a task. |
numRetries |
integer |
numRetries indicates how many times a scheduled task will be retried before failing. |
parallel |
integer |
parallel is the maximum number of Scylla repair jobs that can run at the same time (on different token ranges and replicas). Each node can take part in at most one repair at any given moment. By default the maximum possible parallelism is used. The effective parallelism depends on a keyspace replication factor (RF) and the number of nodes. The formula to calculate it is as follows: number of nodes / RF, ex. for 6 node cluster with RF=3 the maximum parallelism is 2. |
smallTableThreshold |
string |
smallTableThreshold enable small table optimization for tables of size lower than given threshold. Supported units [B, MiB, GiB, TiB]. |
startDate |
string |
startDate specifies the task start date expressed in the RFC3339 format or now[+duration], e.g. now+3d2h10m, valid units are d, h, m, s. |
upgrade reflects state of ongoing upgrade procedure.
object
Property |
Type |
Description |
---|---|---|
currentNode |
string |
currentNode node under upgrade. DEPRECATED. |
currentRack |
string |
currentRack rack under upgrade. DEPRECATED. |
dataSnapshotTag |
string |
dataSnapshotTag is the snapshot tag of data keyspaces. |
fromVersion |
string |
fromVersion reflects from which version ScyllaCluster is being upgraded. |
state |
string |
state reflects current upgrade state. |
systemSnapshotTag |
string |
systemSnapshotTag is the snapshot tag of system keyspaces. |
toVersion |
string |
toVersion reflects to which version ScyllaCluster is being upgraded. |
On this page