StackGres Docs > CRD Reference > SGShardedDbOps

SGShardedDbOps

Kind: SGShardedDbOps

listKind: SGShardedDbOpsList

plural: sgshardeddbops

singular: sgshardeddbops

shortNames sgsdo

The SGShardedDbOps custom resource represents database operations that are performed on a Postgres sharded cluster.

Example:

apiVersion: stackgres.io/v1
kind: SGShardedDbOps
metadata:
  name: restart
spec:
 sgShardedCluster: my-cluster
 op: restart
 maxRetries: 1
 restart:
   mode: InPlace

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
apiVersion	✓		string	stackgres.io/v1
kind	✓		string	SGShardedDbOps
metadata	✓	✓	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.
spec	✓	✓	object
status		✓	object

SGShardedDbOps.spec

^{^{↩ Parent}}

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
op	✓	✓	string	The kind of operation that will be performed on the SGCluster. Available operations are: `resharding`: perform a resharding of the cluster. `restart`: perform a restart of the cluster. `securityUpgrade`: perform a security upgrade of the cluster.
sgShardedCluster	✓	✓	string	The name of SGShardedCluster on which the operation will be performed.
maxRetries		✓	integer	The maximum number of retries the operation is allowed to do after a failure. A value of `0` (zero) means no retries are made. Can not be greater than `10`. Defaults to: `0`.
resharding		✓	object	Configuration for resharding. Resharding a sharded cluster is the operation that moves the data among shards in order to try to balance the disk space used in each shard. See also https://docs.citusdata.com/en/stable/develop/api_udf.html#citus-rebalance-start
restart		✓	object	Configuration of restart
runAt		✓	string	An ISO 8601 date, that holds UTC scheduled date of the operation execution. If not specified or if the date it’s in the past, it will be interpreted ASAP.
scheduling		✓	object	Pod custom node scheduling and affinity configuration
securityUpgrade		✓	object	Configuration of security upgrade
timeout		✓	string	An ISO 8601 duration in the format `PnDTnHnMn.nS`, that specifies a timeout after which the operation execution will be canceled. If the operation can not be performed due to timeout expiration, the condition `Failed` will have a status of `True` and the reason will be `OperationTimedOut`. If not specified the operation will never fail for timeout expiration.

SGShardedDbOps.spec.resharding

^{^{↩ Parent}}

Configuration for resharding. Resharding a sharded cluster is the operation that moves the data among shards in order to try to balance the disk space used in each shard. See also https://docs.citusdata.com/en/stable/develop/api_udf.html#citus-rebalance-start

Property	Required	Updatable	May Require Restart	Type	Description
					Workaround for hugo bug not rendering first table row
citus		✓		object	Citus specific resharding parameters

SGShardedDbOps.spec.resharding.citus

^{^{↩ Parent}}

Citus specific resharding parameters

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
drainOnly	✓	boolean	A float number between 0.0 and 1.0 which indicates the maximum difference ratio of node utilization from average utilization. See also https://docs.citusdata.com/en/stable/develop/api_udf.html#citus-rebalance-start
rebalanceStrategy	✓	string	The name of a strategy in Rebalancer strategy table. Will pick a default one if not specified See also https://docs.citusdata.com/en/stable/develop/api_udf.html#citus-rebalance-start
threshold	✓	number	A float number between 0.0 and 1.0 which indicates the maximum difference ratio of node utilization from average utilization. See also https://docs.citusdata.com/en/stable/develop/api_udf.html#citus-rebalance-start

SGShardedDbOps.spec.restart

^{^{↩ Parent}}

Configuration of restart

Property

Required

Updatable

May Require Restart

Type

Description

Workaround for hugo bug not rendering first table row

method

✓

string

The method used to perform the restart operation. Available methods are:

InPlace: the in-place method does not require more resources than those that are available. In case only an instance of the StackGres cluster for the coordinator or any shard is present this mean the service disruption will last longer so we encourage use the reduced impact restart and especially for a production environment.
ReducedImpact: this procedure is the same as the in-place method but require additional resources in order to spawn a new updated replica that will be removed when the procedure completes.

onlyPendingRestart ✓ boolean By default all Pods are restarted. Setting this option to true allow to restart only those Pods which are in pending restart state as detected by the operation. Defaults to: false.

SGShardedDbOps.spec.scheduling

^{^{↩ Parent}}

Pod custom node scheduling and affinity configuration

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
nodeAffinity	✓	object	Node affinity is a group of node affinity scheduling rules. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#nodeaffinity-v1-core
nodeSelector	✓	map[string]string	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
podAffinity	✓	object	Pod affinity is a group of inter pod affinity scheduling rules. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podaffinity-v1-core
podAntiAffinity	✓	object	Pod anti affinity is a group of inter pod anti affinity scheduling rules. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podantiaffinity-v1-core
priorityClassName	✓	string	If specified, indicates the pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
tolerations	✓	[]object	If specified, the pod’s tolerations. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core

SGShardedDbOps.spec.scheduling.nodeAffinity

^{^{↩ Parent}}

Node affinity is a group of node affinity scheduling rules.

See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#nodeaffinity-v1-core

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
preferredDuringSchedulingIgnoredDuringExecution	✓	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. 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.
requiredDuringSchedulingIgnoredDuringExecution	✓	object	A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

SGShardedDbOps.spec.scheduling.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
preference	✓	✓	object	A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
weight	✓	✓	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32

SGShardedDbOps.spec.scheduling.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

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.

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	A list of node selector requirements by node’s labels.
matchFields	✓	[]object	A list of node selector requirements by node’s fields.

SGShardedDbOps.spec.scheduling.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

Property	Required	Updatable	May Require Restart	Type	Description
					Workaround for hugo bug not rendering first table row
nodeSelectorTerms	✓	✓		[]object	Required. A list of node selector terms. The terms are ORed.

SGShardedDbOps.spec.scheduling.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

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.

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	A list of node selector requirements by node’s labels.
matchFields	✓	[]object	A list of node selector requirements by node’s fields.

SGShardedDbOps.spec.scheduling.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.podAffinity

^{^{↩ Parent}}

Pod affinity is a group of inter pod affinity scheduling rules.

See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podaffinity-v1-core

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
preferredDuringSchedulingIgnoredDuringExecution	✓	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. 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.
requiredDuringSchedulingIgnoredDuringExecution	✓	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to 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.

SGShardedDbOps.spec.scheduling.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
podAffinityTerm	✓	✓	object	Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running
weight	✓	✓	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32

SGShardedDbOps.spec.scheduling.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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.
labelSelector		✓	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namespaceSelector		✓	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namespaces		✓	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

SGShardedDbOps.spec.scheduling.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	✓	map[string]string	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.

SGShardedDbOps.spec.scheduling.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	✓	map[string]string	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.

SGShardedDbOps.spec.scheduling.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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.
labelSelector		✓	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namespaceSelector		✓	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namespaces		✓	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

SGShardedDbOps.spec.scheduling.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	✓	map[string]string	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.

SGShardedDbOps.spec.scheduling.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	✓	map[string]string	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.

SGShardedDbOps.spec.scheduling.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.podAntiAffinity

^{^{↩ Parent}}

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podantiaffinity-v1-core

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
preferredDuringSchedulingIgnoredDuringExecution	✓	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. 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.
requiredDuringSchedulingIgnoredDuringExecution	✓	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. 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.

SGShardedDbOps.spec.scheduling.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
podAffinityTerm	✓	✓	object	Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running
weight	✓	✓	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32

SGShardedDbOps.spec.scheduling.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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.
labelSelector		✓	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namespaceSelector		✓	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namespaces		✓	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

SGShardedDbOps.spec.scheduling.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	✓	map[string]string	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.

SGShardedDbOps.spec.scheduling.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	✓	map[string]string	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.

SGShardedDbOps.spec.scheduling.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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.
labelSelector		✓	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namespaceSelector		✓	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
namespaces		✓	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.

SGShardedDbOps.spec.scheduling.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	✓	map[string]string	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.

SGShardedDbOps.spec.scheduling.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
matchExpressions	✓	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	✓	map[string]string	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.

SGShardedDbOps.spec.scheduling.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

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

Property	Required	Updatable	Type	Description
				Workaround for hugo bug not rendering first table row
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		✓	[]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.

SGShardedDbOps.spec.scheduling.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
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. Format: int64
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.

SGShardedDbOps.spec.securityUpgrade

^{^{↩ Parent}}

Configuration of security upgrade

Property

Required

Updatable

May Require Restart

Type

Description

Workaround for hugo bug not rendering first table row

method

✓

string

The method used to perform the security upgrade operation. Available methods are:

InPlace: the in-place method does not require more resources than those that are available. In case only an instance of the StackGres cluster is present this mean the service disruption will last longer so we encourage use the reduced impact restart and especially for a production environment.
ReducedImpact: this procedure is the same as the in-place method but require additional resources in order to spawn a new updated replica that will be removed when the procedure completes.

SGShardedDbOps.status

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
conditions	✓	[]object	Possible conditions are: Running: to indicate when the operation is actually running Completed: to indicate when the operation has completed successfully Failed: to indicate when the operation has failed
opRetries	✓	integer	The number of retries performed by the operation
opStarted	✓	string	The ISO 8601 timestamp of when the operation started running
restart	✓	object	The results of a restart
securityUpgrade	✓	object	The results of a security upgrade

SGShardedDbOps.status.conditions[index]

^{^{↩ Parent}}

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
lastTransitionTime	✓	string	Last time the condition transitioned from one status to another.
message	✓	string	A human-readable message indicating details about the transition.
reason	✓	string	The reason for the condition last transition.
status	✓	string	Status of the condition, one of `True`, `False` or `Unknown`.
type	✓	string	Type of deployment condition.

SGShardedDbOps.status.restart

^{^{↩ Parent}}

The results of a restart

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
failure	✓	string	A failure message (when available)
pendingToRestartSgClusters	✓	[]string	The SGClusters that are pending to be restarted
restartedSgClusters	✓	[]string	The SGClusters that have been restarted

SGShardedDbOps.status.securityUpgrade

^{^{↩ Parent}}

The results of a security upgrade

Property	Updatable	Type	Description
			Workaround for hugo bug not rendering first table row
failure	✓	string	A failure message (when available)
pendingToRestartSgClusters	✓	[]string	The SGClusters that are pending to be restarted
restartedSgClusters	✓	[]string	The SGClusters that have been restarted