SGCluster

Kind: SGCluster

listKind: SGClusterList

plural: sgclusters

singular: sgcluster

shortNames sgclu

StackGres PostgreSQL cluster can be created using an SGCluster Custom Resource.

Example:

apiVersion: stackgres.io/v1
kind: SGCluster
metadata:
  name: stackgres
spec:
  instances: 1
  postgres:
    version: 'latest'
  pods:
    persistentVolume:
      size: '5Gi'
  sgInstanceProfile: 'size-s'

See also Cluster Creation section.

SGCluster.spec

^{↩ Parent}

Specification of the desired behavior of a StackGres cluster.

SGCluster.spec.pods

^{↩ Parent}

Cluster pod’s configuration.

SGCluster.spec.pods.persistentVolume

^{↩ Parent}

Pod’s persistent volume configuration.

Example:

apiVersion: stackgres.io/v1
kind: SGCluster
metadata:
  name: stackgres
spec:
  pods:
    persistentVolume:
      size: '5Gi'
      storageClass: default

SGCluster.spec.pods.customInitVolumeMounts[key][index] ^{↩ Parent}

VolumeMount describes a mounting of a Volume within a container.

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

SGCluster.spec.pods.customVolumeMounts[key][index] ^{↩ Parent}

VolumeMount describes a mounting of a Volume within a container.

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

SGCluster.spec.pods.resources

^{↩ Parent}

Pod custom resources configuration.

SGCluster.spec.pods.scheduling

^{↩ Parent}

Pod custom scheduling, affinity and topology spread constratins configuration.

Changing this field may require a restart.

SGCluster.spec.pods.scheduling.backup

^{↩ Parent}

Backup Pod custom scheduling and affinity configuration.

SGCluster.spec.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.28/#nodeaffinity-v1-core

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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.28/#podaffinity-v1-core

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

SGCluster.spec.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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.28/#podantiaffinity-v1-core

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

SGCluster.spec.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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.pods.scheduling.backup.tolerations[index]

^{↩ Parent}

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

SGCluster.spec.pods.scheduling.nodeAffinity

^{↩ Parent}

Node affinity is a group of node affinity scheduling rules.

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

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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.28/#podaffinity-v1-core

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

SGCluster.spec.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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.28/#podantiaffinity-v1-core

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

SGCluster.spec.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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.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 .

SGCluster.spec.pods.scheduling.topologySpreadConstraints[index]

^{↩ Parent}

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

SGCluster.spec.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.

SGCluster.spec.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.

SGCluster.spec.postgres

^{↩ Parent}

This section allows to configure Postgres features

SGCluster.spec.postgres.extensions[index]

^{↩ Parent}

SGCluster.spec.postgres.ssl

^{↩ Parent}

This section allows to use SSL when connecting to Postgres

Example:

apiVersion: stackgres.io/v1
kind: SGCluster
metadata:
  name: stackgres
spec:
  postgres:
    ssl:
      enabled: true
      certificateSecretKeySelector:
        name: stackgres-secrets
        key: cert
      privateKeySecretKeySelector:
        name: stackgres-secrets
        key: key

SGCluster.spec.postgres.ssl.certificateSecretKeySelector

^{↩ Parent}

Secret key selector for the certificate or certificate chain used for SSL connections.

SGCluster.spec.postgres.ssl.privateKeySecretKeySelector

^{↩ Parent}

Secret key selector for the private key used for SSL connections.

SGCluster.spec.autoscaling

^{↩ Parent}

This section allows to configure horizontal and vertical Pod autoscaling for the SGCluster’s Pods.

Horizontal Pod Autoscaling will use replicas connections usage (active connections / max connections) as the metric to control the upscale or downscale of the replicas. Horizontal Pod Autoscaling require the KEDA operator to be installed in the Kuberentes cluster.

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 Kuberentes cluster.

SGCluster.spec.autoscaling.horizontal

^{↩ Parent}

Section to configure horizontal Pod autoscaling aspects.

SGCluster.spec.autoscaling.maxAllowed

^{↩ Parent}

Allow to define the higher bound for Pod resources of patroni, pgbouncer and envoy containers

SGCluster.spec.autoscaling.maxAllowed.envoy

^{↩ Parent}

Allow to define the higher bound for Pod resources of envoy container

SGCluster.spec.autoscaling.maxAllowed.patroni

^{↩ Parent}

Allow to define the higher bound for Pod resources of patroni container

SGCluster.spec.autoscaling.maxAllowed.pgbouncer

^{↩ Parent}

Allow to define the higher bound for Pod resources of pgbouncer container

SGCluster.spec.autoscaling.minAllowed

^{↩ Parent}

Allow to define the lower bound for Pod resources of patroni, pgbouncer and envoy containers

SGCluster.spec.autoscaling.minAllowed.envoy

^{↩ Parent}

Allow to define the lower bound for Pod resources of envoy container

SGCluster.spec.autoscaling.minAllowed.patroni

^{↩ Parent}

Allow to define the lower bound for Pod resources of patroni container

SGCluster.spec.autoscaling.minAllowed.pgbouncer

^{↩ Parent}

Allow to define the lower bound for Pod resources of pgbouncer container

SGCluster.spec.autoscaling.vertical

^{↩ Parent}

Section to configure vertical Pod autoscaling aspects.

SGCluster.spec.configurations

^{↩ Parent}

Cluster custom configurations.

Example:

apiVersion: stackgres.io/v1
kind: SGCluster
metadata:
  name: stackgres
spec:
  configurations:
    sgPostgresConfig: 'postgresconf'
    sgPoolingConfig: 'pgbouncerconf'
    backups:
    - sgObjectStorage: 'backupconf'

SGCluster.spec.configurations.backups[index]

^{↩ Parent}

Backup configuration for this SGCluster

SGCluster.spec.configurations.backups[index].performance

^{↩ Parent}

Configuration that affects the backup network and disk usage performance.

SGCluster.spec.configurations.binding

^{↩ Parent}

This section allows to specify the properties of Service Binding spec for provisioned service. If not specified, then some default will be used.

For more information see https://servicebinding.io/spec/core/1.0.0/

SGCluster.spec.configurations.binding.password

^{↩ Parent}

Allow to reference Secret that contains the user’s password. If not specified, then the superuser password will be used.

SGCluster.spec.configurations.credentials

^{↩ Parent}

Allow to specify custom credentials for Postgres users and Patroni REST API

CREATE ROLE postgres;

ALTER ROLE postgres WITH SUPERUSER INHERIT CREATEROLE CREATEDB LOGIN REPLICATION BYPASSRLS PASSWORD '***';

CREATE ROLE replicator;

ALTER ROLE replicator WITH NOSUPERUSER INHERIT NOCREATEROLE NOCREATEDB LOGIN REPLICATION NOBYPASSRLS PASSWORD '***';

CREATE ROLE authenticator;

ALTER ROLE authenticator WITH SUPERUSER INHERIT NOCREATEROLE NOCREATEDB LOGIN NOREPLICATION NOBYPASSRLS PASSWORD '***';

SGCluster.spec.configurations.credentials.patroni

^{↩ Parent}

Kubernetes SecretKeySelectors that contains the credentials for patroni REST API.

Changing this field may require a restart.

SGCluster.spec.configurations.credentials.patroni.restApiPassword

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the password for the patroni REST API.

SGCluster.spec.configurations.credentials.users

^{↩ Parent}

Kubernetes SecretKeySelectors that contains the credentials of the users.

Changing this field may require a manual modification of the database users to reflect the new values specified.

In particular you may have to create those users if username is changed or alter password if it is changed. Here are the SQL commands to perform such operation (replace default usernames with the new ones and *** with their respective passwords):

• Superuser username changed:

CREATE ROLE postgres;

• Superuser password changed:

ALTER ROLE postgres WITH SUPERUSER INHERIT CREATEROLE CREATEDB LOGIN REPLICATION BYPASSRLS PASSWORD '***';

• Replication username changed:

CREATE ROLE replicator;

• Replication password changed:

ALTER ROLE replicator WITH NOSUPERUSER INHERIT NOCREATEROLE NOCREATEDB LOGIN REPLICATION NOBYPASSRLS PASSWORD '***';

• Authenticator username changed:

CREATE ROLE authenticator;

• Authenticator password changed:

ALTER ROLE authenticator WITH SUPERUSER INHERIT NOCREATEROLE NOCREATEDB LOGIN NOREPLICATION NOBYPASSRLS PASSWORD '***';

Changing this field may require a restart.

SGCluster.spec.configurations.credentials.users.authenticator

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the credentials of the authenticator user used by pgbouncer to authenticate other users.

SGCluster.spec.configurations.credentials.users.authenticator.password

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the password of the user.

SGCluster.spec.configurations.credentials.users.authenticator.username

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the username of the user.

SGCluster.spec.configurations.credentials.users.replication

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the credentials of the replication user used to replicate from the primary cluster and from replicas of this cluster.

SGCluster.spec.configurations.credentials.users.replication.password

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the password of the user.

SGCluster.spec.configurations.credentials.users.replication.username

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the username of the user.

SGCluster.spec.configurations.credentials.users.superuser

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the credentials of the superuser (usually the postgres user).

SGCluster.spec.configurations.credentials.users.superuser.password

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the password of the user.

SGCluster.spec.configurations.credentials.users.superuser.username

^{↩ Parent}

A Kubernetes SecretKeySelector that contains the username of the user.

SGCluster.spec.configurations.patroni

^{↩ Parent}

Allow to specify Patroni configuration that will extend the generated one

SGCluster.spec.distributedLogs

^{↩ Parent}

StackGres features a functionality for all pods to send Postgres, Patroni and PgBouncer logs to a central (distributed) location, which is in turn another Postgres database. Logs can then be accessed via SQL interface or from the web UI. This section controls whether to enable this feature or not. If not enabled, logs are send to the pod’s standard output.

Example:

apiVersion: stackgres.io/v1
kind: SGCluster
metadata:
  name: stackgres
spec:
  distributedLogs:
    sgDistributedLogs: distributedlogs

SGCluster.spec.initialData

^{↩ Parent}

Cluster initialization data options. Cluster may be initialized empty, or from a backup restoration.

This field can only be set on creation.

SGCluster.spec.initialData.restore

^{↩ Parent}

This section allows to restore a cluster from an existing copy of the metadata and data.

SGCluster.spec.initialData.restore.fromBackup

^{↩ Parent}

From which backup to restore and how the process is configured

Example:

apiVersion: stackgres.io/v1
kind: SGCluster
metadata:
  name: stackgres
spec:
  initialData:
    restore:
      fromBackup:
        name: stackgres-backup
      downloadDiskConcurrency: 1

SGCluster.spec.initialData.restore.fromBackup.pointInTimeRecovery

^{↩ Parent}

Using Point-in-Time Recovery (PITR) it is possible to restore the database to its state at any moment in the past by setting restoreToTimestamp to a value between the timestamps at which your chosen SGBackup and the subsequent one were taken. If the chosen SGBackup is the latest one, the restoreToTimestamp value can be between the timestamps at which that last SGBackup was taken and the current one.

See also: https://www.postgresql.org/docs/current/continuous-archiving.html