SGShardedCluster

Kind: SGShardedCluster

listKind: SGShardedClusterList

plural: sgshardedclusters

singular: sgshardedcluster

shortNames sgscl

StackGres PostgreSQL sharded clusters are created using the SGShardedCluster Custom Resource.

Example:

apiVersion: stackgres.io/v1alpha1
kind: SGShardedCluster
metadata:
  name: stackgres
spec:
  postgres:
    version: 'latest'
  type: citus
  database: database
  coordinator:
    instances: 1
    pods:
      persistentVolume:
        size: '5Gi'
  shards:
    clusters: 2
    instancesPerCluster: 1
    pods:
      persistentVolume:
        size: '5Gi'

See also Sharded Cluster Creation section.

SGShardedCluster.spec

^{↩ Parent}

Specification of the desired behavior of a StackGres sharded cluster.

SGShardedCluster.spec.coordinator

^{↩ Parent}

The coordinator is a StackGres cluster responsible for coordinating data storage and access from the shards.

SELECT * FROM dblink('shardingsphere', 'SHOW STORAGE UNITS')
  AS _(name text, type text, host text, port int, db text,
    connection_timeout_milliseconds int, idle_timeout_milliseconds int,
    max_lifetime_milliseconds int, max_pool_size int, min_pool_size int,
    read_only boolean, other_attributes text);

SGShardedCluster.spec.coordinator.pods

^{↩ Parent}

Cluster pod’s configuration.

If sharding type is shardingsphere then this section will apply to the ComputeNode.

SGShardedCluster.spec.coordinator.pods.persistentVolume

^{↩ Parent}

Pod’s persistent volume configuration.

If sharding type is shardingsphere then this section is ignored.

SGShardedCluster.spec.coordinator.pods.livenessProbe

^{↩ Parent}

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

SGShardedCluster.spec.coordinator.pods.readinessProbe

^{↩ Parent}

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

SGShardedCluster.spec.coordinator.pods.resources

^{↩ Parent}

Pod custom resources configuration.

SGShardedCluster.spec.coordinator.pods.resources.containers[key]

^{↩ Parent}

ResourceRequirements describes the compute resource requirements.

SGShardedCluster.spec.coordinator.pods.resources.containers[key].claims[index]

^{↩ Parent}

ResourceClaim references one entry in PodSpec.ResourceClaims.

SGShardedCluster.spec.coordinator.pods.resources.initContainers[key]

^{↩ Parent}

ResourceRequirements describes the compute resource requirements.

SGShardedCluster.spec.coordinator.pods.resources.initContainers[key].claims[index]

^{↩ Parent}

ResourceClaim references one entry in PodSpec.ResourceClaims.

SGShardedCluster.spec.coordinator.pods.scheduling

^{↩ Parent}

Pod custom scheduling, affinity and topology spread constratins configuration.

Changing this field may require a restart.

SGShardedCluster.spec.coordinator.pods.scheduling.backup

^{↩ Parent}

Backup Pod custom scheduling and affinity configuration.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeAffinity

^{↩ Parent}

Node affinity is a group of node affinity scheduling rules.

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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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).

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector

^{↩ Parent}

Node affinity is a group of node affinity scheduling rules.

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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector.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).

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.nodeSelector.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAffinity

^{↩ Parent}

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

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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{↩ Parent}

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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{↩ 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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{↩ 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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{↩ 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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.35/#podantiaffinity-v1-core

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{↩ Parent}

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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAntiAffinity.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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAntiAffinity.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{↩ 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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{↩ 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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{↩ 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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations

^{↩ Parent}

Node affinity is a group of node affinity scheduling rules.

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

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations.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).

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations.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.

SGShardedCluster.spec.coordinator.pods.scheduling.backup.tolerations.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.

SGShardedCluster.spec.coordinator.pods.scheduling.nodeAffinity

^{↩ Parent}

Node affinity is a group of node affinity scheduling rules.

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

SGShardedCluster.spec.coordinator.pods.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).

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.scheduling.podAffinity

^{↩ Parent}

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

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

SGShardedCluster.spec.coordinator.pods.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)

SGShardedCluster.spec.coordinator.pods.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

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.scheduling.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{↩ 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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.scheduling.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{↩ 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

SGShardedCluster.spec.coordinator.pods.scheduling.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.scheduling.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{↩ 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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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.35/#podantiaffinity-v1-core

SGShardedCluster.spec.coordinator.pods.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)

SGShardedCluster.spec.coordinator.pods.scheduling.podAntiAffinity.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

SGShardedCluster.spec.coordinator.pods.scheduling.podAntiAffinity.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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.scheduling.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{↩ 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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.scheduling.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{↩ 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

SGShardedCluster.spec.coordinator.pods.scheduling.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.scheduling.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{↩ 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.

SGShardedCluster.spec.coordinator.pods.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.

SGShardedCluster.spec.coordinator.pods.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 .

SGShardedCluster.spec.coordinator.pods.scheduling.topologySpreadConstraints[index]

^{↩ Parent}

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

SGShardedCluster.spec.coordinator.pods.scheduling.topologySpreadConstraints[index].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.

SGShardedCluster.spec.coordinator.pods.scheduling.topologySpreadConstraints[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.

SGShardedCluster.spec.coordinator.pods.updateStrategy

^{↩ Parent}

This section indicates the strategy that the SGCluster controller will use to perform updates.

It includes any additional parameters necessary to perform the update for the indicated strategy.

SGShardedCluster.spec.coordinator.pods.updateStrategy.schedule[index]

^{↩ Parent}

Indicates a window of time where an update can be performed.

SGShardedCluster.spec.coordinator.autoscaling

^{↩ Parent}

This section allows configuring vertical Pod autoscaling for the SGCluster’s Pods.

Vertical Pod Autoscaling will use cpu and memory usage as the metric to control the upscale or downscale of the Pod requests and limits resources. Vertical Pod Autoscaling requires the Vertical Pod Autoscaler operator to be installed in the Kubernetes cluster.

SGShardedCluster.spec.coordinator.autoscaling.horizontal

^{↩ Parent}

Section to configure horizontal Pod autoscaling aspects.

SGShardedCluster.spec.coordinator.autoscaling.maxAllowed

^{↩ Parent}

Defines the higher bound for Pod resources of patroni, pgbouncer and envoy containers

SGShardedCluster.spec.coordinator.autoscaling.maxAllowed.envoy

^{↩ Parent}

Defines the higher bound for Pod resources of envoy container

SGShardedCluster.spec.coordinator.autoscaling.maxAllowed.patroni

^{↩ Parent}

Defines the higher bound for Pod resources of patroni container

SGShardedCluster.spec.coordinator.autoscaling.maxAllowed.pgbouncer

^{↩ Parent}

Defines the higher bound for Pod resources of pgbouncer container

SGShardedCluster.spec.coordinator.autoscaling.minAllowed

^{↩ Parent}

Defines the lower bound for Pod resources of patroni, pgbouncer and envoy containers

SGShardedCluster.spec.coordinator.autoscaling.minAllowed.envoy

^{↩ Parent}

Defines the lower bound for Pod resources of envoy container

SGShardedCluster.spec.coordinator.autoscaling.minAllowed.patroni

^{↩ Parent}

Defines the lower bound for Pod resources of patroni container

SGShardedCluster.spec.coordinator.autoscaling.minAllowed.pgbouncer

^{↩ Parent}

Defines the lower bound for Pod resources of pgbouncer container

SGShardedCluster.spec.coordinator.autoscaling.vertical

^{↩ Parent}

Section to configure vertical Pod autoscaling aspects.

SGShardedCluster.spec.coordinator.configurations

^{↩ Parent}

Coordinator custom configurations.

SGShardedCluster.spec.coordinator.configurations.patroni

^{↩ Parent}

Allows specifying Patroni configuration that will extend the generated one

If sharding type is shardingsphere then this section is ignored.

SGShardedCluster.spec.coordinator.configurations.pooling

^{↩ Parent}

SGShardedCluster.spec.coordinator.configurations.pooling.pgBouncer

^{↩ Parent}

SGShardedCluster.spec.coordinator.configurations.pooling.pgBouncer.pgbouncer.ini

^{↩ Parent}

The pgbouncer.ini parameters that overwrite those specified in the referenced SGPoolingConfig.

Changing this field may require a restart.

SGShardedCluster.spec.coordinator.configurations.postgres

^{↩ Parent}

Section for postgres configuration.

SGShardedCluster.spec.coordinator.configurations.postgresExporter

^{↩ Parent}

Section to configure the postgres_exporter component.

SGShardedCluster.spec.coordinator.configurations.shardingSphere

^{↩ Parent}

Allows specifying Sharding Sphere Proxy configuration that will extend the generated one.

This section is required when sharding type is shardingsphere otherwise is ignored.

SGShardedCluster.spec.coordinator.configurations.shardingSphere.mode

^{↩ Parent}

Allows configuring the Sharding Sphere Proxy mode.

SGShardedCluster.spec.coordinator.configurations.shardingSphere.mode.repository

^{↩ Parent}

SGShardedCluster.spec.coordinator.configurations.shardingSphere.mode.repository.etcd

^{↩ Parent}

Allows configuring Etcd repository for Sharding Sphere Proxy.

SGShardedCluster.spec.coordinator.configurations.shardingSphere.mode.repository.zooKeeper

^{↩ Parent}

Allows configuring ZooKeeper repository for Sharding Sphere Proxy.

SGShardedCluster.spec.coordinator.configurations.shardingSphere.authority

^{↩ Parent}

Allows configuring the Sharding Sphere Proxy authority.

SGShardedCluster.spec.coordinator.configurations.shardingSphere.authority.privilege

^{↩ Parent}

Allows configuring the Sharding Sphere Proxy authority privilege.

SGShardedCluster.spec.coordinator.configurations.shardingSphere.authority.users[index]

^{↩ Parent}

Allows configuring an extra user other than the superuser (by default superuser username is postgres).

SGShardedCluster.spec.coordinator.configurations.shardingSphere.authority.users[index].password

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the password of the user.

SGShardedCluster.spec.coordinator.configurations.shardingSphere.authority.users[index].user

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the username of the user.

SGShardedCluster.spec.coordinator.configurations.shardingSphere.serviceAccount

^{↩ Parent}

Section to configure ServiceAccount used by ShardingSphere operator.

You may configure a global value under operator configuration section SGConfig.spec.shardingSphere.serviceAccount.

SGShardedCluster.spec.coordinator.managedSql

^{↩ Parent}

This section allows referencing SQL scripts that will be applied to the cluster live.

If sharding type is shardingsphere then this section will be applied to the first cluster shard. In this case the database postgres will also provide a foreign server called shardingsphere and the superuser user mappings that will allow running DistQL queries using command like the following:

SELECT * FROM dblink('shardingsphere', 'SHOW STORAGE UNITS')
  AS _(name text, type text, host text, port int, db text,
    connection_timeout_milliseconds int, idle_timeout_milliseconds int,
    max_lifetime_milliseconds int, max_pool_size int, min_pool_size int,
    read_only boolean, other_attributes text);

See https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql

SGShardedCluster.spec.coordinator.managedSql.scripts[index]

^{↩ Parent}

A script reference. Each version of each entry of the script referenced will be executed exactly once following the sequence defined in the referenced script and skipping any script entry that have already been executed.

SGShardedCluster.spec.coordinator.metadata

^{↩ Parent}

Metadata information from coordinator cluster created resources.

If sharding type is shardingsphere then this section is applied to the ComputeNode.

SGShardedCluster.spec.coordinator.metadata.annotations

^{↩ Parent}

Custom Kubernetes annotations to be passed to resources created and managed by StackGres.

SGShardedCluster.spec.coordinator.metadata.labels

^{↩ Parent}

Custom Kubernetes labels to be passed to resources created and managed by StackGres.

SGShardedCluster.spec.coordinator.replication

^{↩ Parent}

This section allows to configure the global Postgres replication mode.

The main replication group is implicit and contains the total number of instances less the sum of all instances in other replication groups.

The total number of instances is always specified by .spec.instances.

If sharding type is shardingsphere then this section is ignored.

SGShardedCluster.spec.coordinator.replication.initialization

^{↩ Parent}

Allows specifying how the replicas are initialized.