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
May Require Restart
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
May Require Restart
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
Required
Updatable
May Require Restart
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
Required
Updatable
May Require Restart
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 Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible.
tolerations ✓ []object If specified, the pod’s tolerations.

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

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
Required
Updatable
May Require Restart
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
Required
Updatable
May Require Restart
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
Required
Updatable
May Require Restart
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
Required
Updatable
May Require Restart
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