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:
    method: InPlace

Property	Description
	Workaround for hugo bug not rendering first table row
apiVersion string	stackgres.io/v1 Constraints: required, immutable
kind string	SGShardedDbOps Constraints: required, immutable
metadata object	Refer to the Kubernetes API documentation for the fields of the `metadata` field. Constraints: required, updatable
spec object	Constraints: required, updatable
status object	Constraints: optional, updatable

SGShardedDbOps.spec

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
op string	The kind of operation that will be performed on the SGShardedCluster. 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. `majorVersionUpgrade`: perform a major version upgrade of PostgreSQL. `minorVersionUpgrade`: perform a minor version upgrade of PostgreSQL. Constraints: required, updatable
sgShardedCluster string	The name of SGShardedCluster on which the operation will be performed. Constraints: required, updatable
majorVersionUpgrade object	Configuration of major version upgrade (see also `pg_upgrade` command) Constraints: optional, updatable
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. Defaults to: `0`. Constraints: optional, updatable
minorVersionUpgrade object	Configuration of minor version upgrade Constraints: optional, updatable
resharding object	Configuration for resharding. Resharding a sharded cluster is the operation that moves the data among workers in order to try to balance the disk space used in each worker. See also https://docs.citusdata.com/en/stable/develop/api_udf.html#citus-rebalance-start Constraints: optional, updatable
restart object	Configuration of restart Constraints: optional, updatable
retryDelay string	An ISO 8601 duration in the format `PnDTnHnMn.nS`, that specifies the initial delay used by the exponential backoff applied when a command run by the operation script is retried and in general by unbounded retries and in some cases without exponential backoff. Defaults to: `PT1S`. Constraints: optional, updatable
retryLimit integer	The maximum number of times a command run by the operation script is retried before failing. Defaults to: `10`. Constraints: optional, updatable
retryMaxDelay string	An ISO 8601 duration in the format `PnDTnHnMn.nS`, that specifies the maximum delay the exponential backoff is allowed to reach when a command run by the operation script is retried. Defaults to: `PT1M`. Constraints: optional, updatable
runAt string	An ISO 8601 date, that holds UTC scheduled date of the operation execution. If not specified or if the date is in the past, it will be interpreted ASAP. Constraints: optional, updatable
scheduling object	Pod custom node scheduling and affinity configuration Constraints: optional, updatable
securityUpgrade object	Configuration of security upgrade Constraints: optional, updatable
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 cannot 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. Constraints: optional, updatable

SGShardedDbOps.spec.majorVersionUpgrade

^{^{↩ Parent}}

Configuration of major version upgrade (see also pg_upgrade command)

Property	Description
	Workaround for hugo bug not rendering first table row
backupPaths []string	The paths were the backups for the coordinator and each shard are stored. If not set this field is filled up by the operator. When provided will indicate were the backups and WAL files will be stored. The path should be different from the current `.spec.configurations.backupPath` value for the target `SGCluster` in order to avoid mixing WAL files of two distinct major versions of postgres. Constraints: optional, updatable
check boolean	If true does some checks to see if the cluster can perform a major version upgrade without changing any data. Defaults to: `false`. Constraints: optional, updatable
clone boolean	If true use efficient file cloning (also known as “reflinks” on some systems) instead of copying files to the new cluster. This can result in near-instantaneous copying of the data files, giving the speed advantages of `link` while leaving the old cluster untouched. This option is mutually exclusive with `link`. Defaults to: `false`. File cloning is only supported on some operating systems and file systems. If it is selected but not supported, the pg_upgrade run will error. At present, it is supported on Linux (kernel 4.5 or later) with Btrfs and XFS (on file systems created with reflink support), and on macOS with APFS. Constraints: optional, updatable
link boolean	If true use hard links instead of copying files to the new cluster. This option is mutually exclusive with `clone`. Defaults to: `false`. Constraints: optional, updatable
manualRollback boolean	When set to `true` the SGShardedDbOps waits for a rollback decision to be set on its own `.status.majorVersionUpgrade.rollback` whenever one of the child SGDbOps it created pauses (it always creates the child SGDbOps with `manualRollback: true`). The operator raises the `WaitingRollback` condition while waiting. The decision is then propagated to the waiting child SGDbOps. When `false` the decision for each child is taken automatically: a failed child is rolled back and a succeeded child is cleaned up. Constraints: optional, updatable Default: false
maxErrorsAfterContinueOnFailure integer	Propagated to each child SGDbOps. See the `maxErrorsAfterContinueOnFailure` field of SGDbOps major version upgrade. Constraints: optional, updatable Default: 0
maxErrorsAfterUpgrade integer	Indicates the number of errors that the operation can tolerate after the upgrade is performed in order to wait for the Pod to become ready and set the operation as completed. Constraints: optional, updatable Default: 6
postgresExtensions []object	A major version upgrade can not be performed if a required extension is not present for the target major version of the upgrade. In those cases you will have to provide the target extension version of the extension for the target major version of postgres. Beware that in some cases it is not possible to upgrade an extension alongside postgres. This is the case for PostGIS or timescaledb. In such cases you will have to upgrade the extension before or after the major version upgrade. Please make sure you read the documentation of each extension in order to understand if it is possible to upgrade it during a major version upgrade of postgres. Constraints: optional, updatable
postgresVersion string	The target postgres version that must have the same major version of the target SGShardedCluster. Constraints: optional, updatable
sgPostgresConfig string	The postgres config that must have the same major version of the target postgres version. Constraints: optional, updatable
toInstallPostgresExtensions []object	The list of Postgres extensions to install. This section is filled by the operator. Constraints: optional, updatable

SGShardedDbOps.spec.majorVersionUpgrade.postgresExtensions[index]

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
name string	The name of the extension to deploy. Constraints: required, updatable
publisher string	The id of the publisher of the extension to deploy. If not specified `com.ongres` will be used by default. Constraints: optional, updatable Default: com.ongres
repository string	The repository base URL from where to obtain the extension to deploy. This section is filled by the operator. Constraints: optional, updatable
version string	The version of the extension to deploy. If not specified version of `stable` channel will be used by default and if only a version is available that one will be used. Constraints: optional, updatable

SGShardedDbOps.spec.majorVersionUpgrade.toInstallPostgresExtensions[index]

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
name string	The name of the extension to install. Constraints: required, updatable
postgresVersion string	The postgres major version of the extension to install. Constraints: required, updatable
publisher string	The id of the publisher of the extension to install. Constraints: required, updatable
repository string	The repository base URL from where the extension will be installed from. Constraints: required, updatable
version string	The version of the extension to install. Constraints: required, updatable
build string	The build version of the extension to install. Constraints: optional, updatable
extraMounts []string	The extra mounts of the extension to install. Constraints: optional, updatable

SGShardedDbOps.spec.minorVersionUpgrade

^{^{↩ Parent}}

Configuration of minor version upgrade

Property	Description
	Workaround for hugo bug not rendering first table row
method string	The method used to perform the minor version 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 means the service disruption will last longer so we encourage using the reduced impact restart and especially for a production environment. `ReducedImpact`: this procedure is the same as the in-place method but requires additional resources in order to spawn a new updated replica that will be removed when the procedure completes. Constraints: optional, updatable
postgresVersion string	The target postgres version that must have the same major version of the target SGShardedCluster. Constraints: optional, updatable

SGShardedDbOps.spec.resharding

^{^{↩ Parent}}

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

Property	Description
	Workaround for hugo bug not rendering first table row
citus object	Citus specific resharding parameters Constraints: optional, updatable

SGShardedDbOps.spec.resharding.citus

^{^{↩ Parent}}

Citus specific resharding parameters

Property	Description
	Workaround for hugo bug not rendering first table row
drainOnly boolean	When set to `true`, shard groups will be moved off nodes that have `shouldhaveshards` set to false. When set to `false` (the default), all shard groups will be balanced across nodes. See also https://docs.citusdata.com/en/stable/develop/api_udf.html#citus-rebalance-start Constraints: optional, updatable
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 Constraints: optional, updatable
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 Constraints: optional, updatable

SGShardedDbOps.spec.restart

^{^{↩ Parent}}

Configuration of restart

Property	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 means the service disruption will last longer so we encourage using the reduced impact restart and especially for a production environment. `ReducedImpact`: this procedure is the same as the in-place method but requires additional resources in order to spawn a new updated replica that will be removed when the procedure completes. Constraints: optional, updatable
onlyPendingRestart boolean	By default all Pods are restarted. Setting this option to `true` allows restarting only those Pods which are in pending restart state as detected by the operation. Defaults to: `false`. Constraints: optional, updatable

SGShardedDbOps.spec.scheduling

^{^{↩ Parent}}

Pod custom node scheduling and affinity configuration

Property	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.36/#nodeaffinity-v1-core Constraints: optional, updatable
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/ Constraints: optional, updatable
podAffinity object	Pod affinity is a group of inter pod affinity scheduling rules. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#podaffinity-v1-core Constraints: optional, updatable
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.36/#podantiaffinity-v1-core Constraints: optional, updatable
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. Constraints: optional, updatable
tolerations []object	If specified, the pod’s tolerations. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#toleration-v1-core Constraints: optional, updatable

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.36/#nodeaffinity-v1-core

Property	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. Constraints: optional, updatable
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. Constraints: optional, updatable

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	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. Constraints: required, updatable
weight integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Constraints: required, updatable 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	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	A list of node selector requirements by node’s labels. Constraints: optional, updatable
matchFields []object	A list of node selector requirements by node’s fields. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	The label key that the selector applies to. Constraints: required, updatable
operator string	Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. Constraints: required, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	The label key that the selector applies to. Constraints: required, updatable
operator string	Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. Constraints: required, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
nodeSelectorTerms []object	Required. A list of node selector terms. The terms are ORed. Constraints: required, updatable

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	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	A list of node selector requirements by node’s labels. Constraints: optional, updatable
matchFields []object	A list of node selector requirements by node’s fields. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	The label key that the selector applies to. Constraints: required, updatable
operator string	Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. Constraints: required, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	The label key that the selector applies to. Constraints: required, updatable
operator string	Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. Constraints: required, updatable
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. Constraints: optional, updatable

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.36/#podaffinity-v1-core

Property	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. Constraints: optional, updatable
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. Constraints: optional, updatable

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	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 Constraints: required, updatable
weight integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Constraints: required, updatable 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	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. Constraints: required, updatable
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. Constraints: optional, updatable
matchLabelKeys []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. Constraints: optional, updatable
mismatchLabelKeys []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. Constraints: optional, updatable
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. Constraints: optional, updatable
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”. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	matchExpressions is a list of label selector requirements. The requirements are ANDed. Constraints: optional, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	key is the label key that the selector applies to. Constraints: required, updatable
operator string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. Constraints: required, updatable
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. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	matchExpressions is a list of label selector requirements. The requirements are ANDed. Constraints: optional, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	key is the label key that the selector applies to. Constraints: required, updatable
operator string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. Constraints: required, updatable
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. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	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. Constraints: required, updatable
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. Constraints: optional, updatable
matchLabelKeys []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. Constraints: optional, updatable
mismatchLabelKeys []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. Constraints: optional, updatable
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. Constraints: optional, updatable
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”. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	matchExpressions is a list of label selector requirements. The requirements are ANDed. Constraints: optional, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	key is the label key that the selector applies to. Constraints: required, updatable
operator string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. Constraints: required, updatable
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. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	matchExpressions is a list of label selector requirements. The requirements are ANDed. Constraints: optional, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	key is the label key that the selector applies to. Constraints: required, updatable
operator string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. Constraints: required, updatable
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. Constraints: optional, updatable

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.36/#podantiaffinity-v1-core

Property	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 subtracting “weight” from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. Constraints: optional, updatable
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. Constraints: optional, updatable

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	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 Constraints: required, updatable
weight integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Constraints: required, updatable Format: int32

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

^{^{↩ Parent}}

Property	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. Constraints: required, updatable
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. Constraints: optional, updatable
matchLabelKeys []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. Constraints: optional, updatable
mismatchLabelKeys []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. Constraints: optional, updatable
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. Constraints: optional, updatable
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”. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	matchExpressions is a list of label selector requirements. The requirements are ANDed. Constraints: optional, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	key is the label key that the selector applies to. Constraints: required, updatable
operator string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. Constraints: required, updatable
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. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	matchExpressions is a list of label selector requirements. The requirements are ANDed. Constraints: optional, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	key is the label key that the selector applies to. Constraints: required, updatable
operator string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. Constraints: required, updatable
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. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	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. Constraints: required, updatable
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. Constraints: optional, updatable
matchLabelKeys []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. Constraints: optional, updatable
mismatchLabelKeys []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. Constraints: optional, updatable
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. Constraints: optional, updatable
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”. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	matchExpressions is a list of label selector requirements. The requirements are ANDed. Constraints: optional, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	key is the label key that the selector applies to. Constraints: required, updatable
operator string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. Constraints: required, updatable
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. Constraints: optional, updatable

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

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
matchExpressions []object	matchExpressions is a list of label selector requirements. The requirements are ANDed. Constraints: optional, updatable
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. Constraints: optional, updatable

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	Description
	Workaround for hugo bug not rendering first table row
key string	key is the label key that the selector applies to. Constraints: required, updatable
operator string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. Constraints: required, updatable
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. Constraints: optional, updatable

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	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. Constraints: optional, updatable
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. Constraints: optional, updatable
operator string	Operator represents a key’s relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators). Constraints: optional, updatable
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. Constraints: optional, updatable 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. Constraints: optional, updatable

SGShardedDbOps.spec.securityUpgrade

^{^{↩ Parent}}

Configuration of security upgrade

Property

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 means the service disruption will last longer so we encourage using the reduced impact restart and especially for a production environment.
ReducedImpact: this procedure is the same as the in-place method but requires additional resources in order to spawn a new updated replica that will be removed when the procedure completes.

Constraints: optional, updatable

SGShardedDbOps.status

^{^{↩ Parent}}

Property	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 Constraints: optional, updatable
majorVersionUpgrade object	The results of a major version upgrade Constraints: optional, updatable
minorVersionUpgrade object	The results of a minor version upgrade Constraints: optional, updatable
opRetries integer	The number of retries performed by the operation Constraints: optional, updatable
opStarted string	The ISO 8601 timestamp of when the operation started running Constraints: optional, updatable
restart object	The results of a restart Constraints: optional, updatable
securityUpgrade object	The results of a security upgrade Constraints: optional, updatable

SGShardedDbOps.status.conditions[index]

^{^{↩ Parent}}

Property	Description
	Workaround for hugo bug not rendering first table row
lastTransitionTime string	Last time the condition transitioned from one status to another. Constraints: optional, updatable
message string	A human-readable message indicating details about the transition. Constraints: optional, updatable
observedGeneration integer	The .metadata.generation the condition was computed against. Constraints: optional, updatable Format: int64
reason string	The reason for the condition last transition. Constraints: optional, updatable
status string	Status of the condition, one of `True`, `False` or `Unknown`. Constraints: optional, updatable
type string	Type of deployment condition. Constraints: optional, updatable

SGShardedDbOps.status.majorVersionUpgrade

^{^{↩ Parent}}

The results of a major version upgrade

Property	Description
	Workaround for hugo bug not rendering first table row
failure string	A failure message (when available) Constraints: optional, updatable
pendingToRestartSgClusters []string	The SGClusters that are pending to be restarted Constraints: optional, updatable
restartedSgClusters []string	The SGClusters that have been restarted Constraints: optional, updatable
rollback boolean	Set when `manualRollback` is `true` to resolve a paused SGShardedDbOps. The value is propagated to the waiting child SGDbOps `.status.majorVersionUpgrade.rollback`: `false` continues (assuming the upgrade was performed manually), `true` performs a rollback. Constraints: optional, updatable
sourcePostgresVersion string	The postgres version currently used by the primary instance Constraints: optional, updatable
status string	Set when `manualRollback` is `true` and the SGShardedDbOps is waiting for a rollback decision because one of its child SGDbOps paused. Indicates whether that child had `failed` or `succeeded`. Constraints: optional, updatable
targetPostgresVersion string	The postgres version that the cluster will be upgraded to Constraints: optional, updatable

SGShardedDbOps.status.minorVersionUpgrade

^{^{↩ Parent}}

The results of a minor version upgrade

Property	Description
	Workaround for hugo bug not rendering first table row
failure string	A failure message (when available) Constraints: optional, updatable
pendingToRestartSgClusters []string	The SGClusters that are pending to be restarted Constraints: optional, updatable
restartedSgClusters []string	The SGClusters that have been restarted Constraints: optional, updatable
sourcePostgresVersion string	The postgres version currently used by the primary instance Constraints: optional, updatable
targetPostgresVersion string	The postgres version that the cluster will be upgraded (or downgraded) to Constraints: optional, updatable

SGShardedDbOps.status.restart

^{^{↩ Parent}}

The results of a restart

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

SGShardedDbOps.status.securityUpgrade

^{^{↩ Parent}}

The results of a security upgrade

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