crdb.cockroachlabs.com / v1alpha1 / CrdbCluster

• string

  .apiVersion

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

• string

  .kind

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

• object

  .metadata

• object

  .spec

  CrdbClusterSpec defines the desired state of a CockroachDB Cluster that the operator maintains.

• object

  .spec .additionalAnnotations

  (Optional) Additional custom resource annotations that are added to all resources. Changing AdditionalAnnotations field will result in cockroachDB cluster restart.

• array

  .spec .additionalArgs

  (Optional) Additional command line arguments for the cockroach binary Default: “”

• object

  .spec .additionalLabels

  (Optional) Additional custom resource labels that are added to all resources

• object

  .spec .affinity

  (Optional) If specified, the pod’s scheduling constraints

• object

  .spec .affinity .nodeAffinity

  Describes node affinity scheduling rules for the pod.

• array

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution

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

• object required

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference

  A node selector term, associated with the corresponding weight.

• array

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions

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

• string required

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .key

  The label key that the selector applies to.

• string required

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .operator

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

• array

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .values

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

• array

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields

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

• string required

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .key

  The label key that the selector applies to.

• string required

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .operator

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

• array

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .values

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

• integer required

  .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

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

• object

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution

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

• array required

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms

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

• array

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions

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

• string required

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .key

  The label key that the selector applies to.

• string required

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .operator

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

• array

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .values

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

• array

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields

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

• string required

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .key

  The label key that the selector applies to.

• string required

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .operator

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

• array

  .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .values

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

• object

  .spec .affinity .podAffinity

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

• array

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution

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

• object required

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm

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

• object

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector

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

• array

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions

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

• string required

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator

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

• array

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .values

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

• object

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchLabels

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

• object

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector

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

• array

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions

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

• string required

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator

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

• array

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .values

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

• object

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchLabels

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

• array

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaces

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

• string required

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey

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

• integer required

  .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

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

• array

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution

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

• object

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector

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

• array

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions

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

• string required

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator

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

• array

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .values

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

• object

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchLabels

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

• object

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector

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

• array

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions

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

• string required

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator

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

• array

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .values

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

• object

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchLabels

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

• array

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaces

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

• string required

  .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey

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

• object

  .spec .affinity .podAntiAffinity

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

• array

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution

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

• object required

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm

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

• object

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector

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

• array

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions

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

• string required

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator

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

• array

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .values

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

• object

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchLabels

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

• object

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector

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

• array

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions

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

• string required

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator

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

• array

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .values

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

• object

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchLabels

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

• array

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaces

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

• string required

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey

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

• integer required

  .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight

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

• array

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution

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

• object

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector

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

• array

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions

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

• string required

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator

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

• array

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .values

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

• object

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchLabels

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

• object

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector

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

• array

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions

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

• string required

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator

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

• array

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .values

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

• object

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchLabels

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

• array

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaces

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

• string required

  .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey

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

• boolean

  .spec .automountServiceAccountToken

  (Optional) AutomountServiceAccountToken determines whether or not the stateful set pods should automount the service account token. This is the default behavior in Kubernetes. For backward compatibility reasons, this value defaults to false here. Default: false

• string

  .spec .cache

  (Optional) The total size for caches (--cache command line parameter) Default: “25%”

• string

  .spec .clientTLSSecret

  (Optional) The secret with a certificate and a private key for root database user Default: “”

• string

  .spec .cockroachDBVersion

  (Optional) CockroachDBVersion sets the explicit version of the cockroachDB image Default: “”

• object required

  .spec .dataStore

  Database disk storage configuration

• object

  .spec .dataStore .hostPath

  (Optional) Directory from the host node’s filesystem

• string required

  .spec .dataStore .hostPath .path

  Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

• string

  .spec .dataStore .hostPath .type

  Type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

• object

  .spec .dataStore .pvc

  (Optional) Persistent volume to use

• object

  .spec .dataStore .pvc .source

  (Optional) Existing PVC in the same namespace

• string required

  .spec .dataStore .pvc .source .claimName

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

• boolean

  .spec .dataStore .pvc .source .readOnly

  Will force the ReadOnly setting in VolumeMounts. Default false.

• object

  .spec .dataStore .pvc .spec

  (Optional) PVC to request a new persistent volume

• array

  .spec .dataStore .pvc .spec .accessModes

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

• object

  .spec .dataStore .pvc .spec .dataSource

  This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.

• string

  .spec .dataStore .pvc .spec .dataSource .apiGroup

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

• string required

  .spec .dataStore .pvc .spec .dataSource .kind

  Kind is the type of resource being referenced

• string required

  .spec .dataStore .pvc .spec .dataSource .name

  Name is the name of resource being referenced

• object

  .spec .dataStore .pvc .spec .resources

  Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

• object

  .spec .dataStore .pvc .spec .resources .limits

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

• object

  .spec .dataStore .pvc .spec .resources .requests

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

• object

  .spec .dataStore .pvc .spec .selector

  A label query over volumes to consider for binding.

• array

  .spec .dataStore .pvc .spec .selector .matchExpressions

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

• string required

  .spec .dataStore .pvc .spec .selector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .dataStore .pvc .spec .selector .matchExpressions[] .operator

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

• array

  .spec .dataStore .pvc .spec .selector .matchExpressions[] .values

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

• object

  .spec .dataStore .pvc .spec .selector .matchLabels

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

• string

  .spec .dataStore .pvc .spec .storageClassName

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

• string

  .spec .dataStore .pvc .spec .volumeMode

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

• string

  .spec .dataStore .pvc .spec .volumeName

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

• boolean

  .spec .dataStore .supportsAutoResize

  (Optional) SupportsAutoResize marks that a PVC will resize without restarting the entire cluster Default: false

• integer

  .spec .grpcPort

  (Optional) The database port (--port CLI parameter when starting the service) Default: 26258

• integer

  .spec .httpPort

  (Optional) The web UI port (--http-port CLI parameter when starting the service) Default: 8080

• object

  .spec .image

  (Optional) Container image information

• string required

  .spec .image .name

  Container image with supported CockroachDB version. This defaults to the version pinned to the operator and requires a full container and tag/sha name. For instance: cockroachdb/cockroachdb:v20.1

• string

  .spec .image .pullPolicy

  (Optional) PullPolicy for the image, which defaults to IfNotPresent. Default: IfNotPresent

• string

  .spec .image .pullSecret

  (Optional) Secret name containing the dockerconfig to use for a registry that requires authentication. The secret must be configured first by the user.

• object

  .spec .ingress

  (Optional) Ingress defines the Ingress configuration used to expose the services using Ingress

• object

  .spec .ingress .sql

  (Optional) Ingress options for SQL connections Adding/changing the SQL host will result in rolling update of the crdb cluster nodes

• object

  .spec .ingress .sql .annotations

  (Optional) Annotations related to ingress resource

• string required

  .spec .ingress .sql .host

  host is host to be used for exposing service

• string

  .spec .ingress .sql .ingressClassName

  (Optional) IngressClassName to be used by ingress resource

• array

  .spec .ingress .sql .tls

  (Optional) TLS describes the TLS certificate info

• array

  .spec .ingress .sql .tls[] .hosts

  Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.

• string

  .spec .ingress .sql .tls[] .secretName

  SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the “Host” header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

• object

  .spec .ingress .ui

  (Optional) Ingress options for UI (HTTP) connections

• object

  .spec .ingress .ui .annotations

  (Optional) Annotations related to ingress resource

• string required

  .spec .ingress .ui .host

  host is host to be used for exposing service

• string

  .spec .ingress .ui .ingressClassName

  (Optional) IngressClassName to be used by ingress resource

• array

  .spec .ingress .ui .tls

  (Optional) TLS describes the TLS certificate info

• array

  .spec .ingress .ui .tls[] .hosts

  Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.

• string

  .spec .ingress .ui .tls[] .secretName

  SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the “Host” header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

• string

  .spec .logConfigMap

  (Optional) LogConfigMap define the config map which contains log configuration used to send the logs through the proper channels in the cockroachdb. Logging configuration is available for cockroach version v21.1.0 onwards. The logging configuration is taken in format of yaml file, you can check the logging configuration here (https://www.cockroachlabs.com/docs/stable/configure-logs.html#default-logging-configuration) The default logging for cockroach version v20.x or less is stderr, logging API is ignored for older versions. NOTE: The data field of map must contain an entry called logging.yaml that contains config options.

• string

  .spec .maxSQLMemory

  (Optional) The maximum in-memory storage capacity available to store temporary data for SQL queries (--max-sql-memory parameter) Default: “25%”

• integer

  .spec .maxUnavailable

  (Optional) The maximum number of pods that can be unavailable during a rolling update. This number is set in the PodDistruptionBudget and defaults to 1.

• integer

  .spec .minAvailable

  (Optional) The min number of pods that can be unavailable during a rolling update. This number is set in the PodDistruptionBudget and defaults to 1.

• object

  .spec .nodeSelector

  (Optional) If specified, the pod’s nodeSelector

• string

  .spec .nodeTLSSecret

  (Optional) The secret with certificates and a private key for the TLS endpoint on the database port. The standard naming of files is expected (tls.key, tls.crt, ca.crt) Default: “”

• integer required

  .spec .nodes

  Number of nodes (pods) in the cluster

• array

  .spec .podEnvVariables

  (Optional) PodEnvVariables is a slice of environment variables that are added to the pods Default: (empty list)

• string required

  .spec .podEnvVariables[] .name

  Name of the environment variable. Must be a C_IDENTIFIER.

• string

  .spec .podEnvVariables[] .value

  Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

• object

  .spec .podEnvVariables[] .valueFrom

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

• object

  .spec .podEnvVariables[] .valueFrom .configMapKeyRef

  Selects a key of a ConfigMap.

• string required

  .spec .podEnvVariables[] .valueFrom .configMapKeyRef .key

  The key to select.

• string

  .spec .podEnvVariables[] .valueFrom .configMapKeyRef .name

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

• boolean

  .spec .podEnvVariables[] .valueFrom .configMapKeyRef .optional

  Specify whether the ConfigMap or its key must be defined

• object

  .spec .podEnvVariables[] .valueFrom .fieldRef

  Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

• string

  .spec .podEnvVariables[] .valueFrom .fieldRef .apiVersion

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

• string required

  .spec .podEnvVariables[] .valueFrom .fieldRef .fieldPath

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

• object

  .spec .podEnvVariables[] .valueFrom .resourceFieldRef

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

• string

  .spec .podEnvVariables[] .valueFrom .resourceFieldRef .containerName

  Container name: required for volumes, optional for env vars

• integer | string

  .spec .podEnvVariables[] .valueFrom .resourceFieldRef .divisor

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

• string required

  .spec .podEnvVariables[] .valueFrom .resourceFieldRef .resource

  Required: resource to select

• object

  .spec .podEnvVariables[] .valueFrom .secretKeyRef

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

• string required

  .spec .podEnvVariables[] .valueFrom .secretKeyRef .key

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

• string

  .spec .podEnvVariables[] .valueFrom .secretKeyRef .name

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

• boolean

  .spec .podEnvVariables[] .valueFrom .secretKeyRef .optional

  Specify whether the Secret or its key must be defined

• object

  .spec .resources

  (Optional) Database container resource limits. Any container limits can be specified. Default: (not specified)

• object

  .spec .resources .limits

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

• object

  .spec .resources .requests

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

• integer

  .spec .sqlPort

  (Optional) The SQL Port number Default: 26257

• integer

  .spec .terminationGracePeriodSecs

  (Optional) The grace period in seconds prior to the container being forcibly terminated when marked for deletion or restarted. Default : 300

• boolean

  .spec .tlsEnabled

  (Optional) TLSEnabled determines if TLS is enabled for your CockroachDB Cluster

• array

  .spec .tolerations

  (Optional) Tolerations for scheduling pods onto some dedicated nodes

• string

  .spec .tolerations[] .effect

  Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

• string

  .spec .tolerations[] .key

  Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

• string

  .spec .tolerations[] .operator

  Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

• integer

  .spec .tolerations[] .tolerationSeconds

  TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

• string

  .spec .tolerations[] .value

  Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

• array

  .spec .topologySpreadConstraints

  (Optional) If specified, the pod’s topology spread constraints

• object

  .spec .topologySpreadConstraints[] .labelSelector

  LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

• array

  .spec .topologySpreadConstraints[] .labelSelector .matchExpressions

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

• string required

  .spec .topologySpreadConstraints[] .labelSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .topologySpreadConstraints[] .labelSelector .matchExpressions[] .operator

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

• array

  .spec .topologySpreadConstraints[] .labelSelector .matchExpressions[] .values

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

• object

  .spec .topologySpreadConstraints[] .labelSelector .matchLabels

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

• integer required

  .spec .topologySpreadConstraints[] .maxSkew

  MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It’s a required field. Default value is 1 and 0 is not allowed.

• string required

  .spec .topologySpreadConstraints[] .topologyKey

  TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a “bucket”, and try to put balanced number of pods into each bucket. It’s a required field.

• string required

  .spec .topologySpreadConstraints[] .whenUnsatisfiable

  WhenUnsatisfiable indicates how to deal with a pod if it doesn’t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered “Unsatisfiable” for an incoming pod if and only if every possible node assigment for that pod would violate “MaxSkew” on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won’t make it more imbalanced. It’s a required field.

• object

  .status

  CrdbClusterStatus defines the observed state of Cluster

• string

  .status .clusterStatus

  OperatorStatus represent the status of the operator(Failed, Starting, Running or Other)

• array

  .status .conditions

  List of conditions representing the current status of the cluster resource.

• string required

  .status .conditions[] .lastTransitionTime

  The time when the condition was updated

• string required

  .status .conditions[] .status

  Condition status: True, False or Unknown

• string required

  .status .conditions[] .type

  Type/Name of the condition

• string

  .status .crdbcontainerimage

  CrdbContainerImage is the container that will be installed

• array

  .status .operatorActions

• string required

  .status .operatorActions[] .lastTransitionTime

  The time when the condition was updated

• string

  .status .operatorActions[] .message

  (Optional) Message related to the status of the action

• string required

  .status .operatorActions[] .status

  Action status: Failed, Finished or Unknown

• string required

  .status .operatorActions[] .type

  Type/Name of the action

• string

  .status .sqlHost

  SQLHost is the host to be used with SQL ingress

• string

  .status .version

  Database service version. Not populated and is just a placeholder currently.