PostgresCluster

PostgresCluster is the Schema for the postgresclusters API

name	type	required	description
apiVersion	`string`	✅	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	`string`	✅	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	`object`	✅	Refer to the Kubernetes API documentation for the fields of the `metadata` field.
spec	`object`	❌	PostgresClusterSpec defines the desired state of PostgresCluster
status	`object`	❌	PostgresClusterStatus defines the observed state of PostgresCluster

↩ ParentPostgresCluster.spec

PostgresClusterSpec defines the desired state of PostgresCluster

name	type	required	description
backups	`object`	✅	PostgreSQL backup configuration
customReplicationTLSSecret	`object`	❌	The secret containing the replication client certificates and keys for secure connections to the PostgreSQL server. It will need to contain the client TLS certificate, TLS key and the Certificate Authority certificate with the data keys set to tls.crt, tls.key and ca.crt, respectively. NOTE: If CustomReplicationClientTLSSecret is provided, CustomTLSSecret MUST be provided and the ca.crt provided must be the same.
customTLSSecret	`object`	❌	The secret containing the Certificates and Keys to encrypt PostgreSQL traffic will need to contain the server TLS certificate, TLS key and the Certificate Authority certificate with the data keys set to tls.crt, tls.key and ca.crt, respectively. It will then be mounted as a volume projection to the '/pgconf/tls' directory. For more information on Kubernetes secret projections, please see https://k8s.io/docs/concepts/configuration/secret/#projection-of-secret-keys-to-specific-paths NOTE: If CustomTLSSecret is provided, CustomReplicationClientTLSSecret MUST be provided and the ca.crt provided must be the same.
dataSource	`object`	❌	Specifies a data source for bootstrapping the PostgreSQL cluster.
databaseInitSQL	`object`	❌	DatabaseInitSQL defines a ConfigMap containing custom SQL that will be run after the cluster is initialized. This ConfigMap must be in the same namespace as the cluster.
disableDefaultPodScheduling	`boolean`	❌	Whether or not the PostgreSQL cluster should use the defined default scheduling constraints. If the field is unset or false, the default scheduling constraints will be used in addition to any custom constraints provided.
image	`string`	❌	The image name to use for PostgreSQL containers. When omitted, the value comes from an operator environment variable. For standard PostgreSQL images, the format is RELATED_IMAGE_POSTGRES_`{postgresVersion}`, e.g. RELATED_IMAGE_POSTGRES_13. For PostGIS enabled PostgreSQL images, the format is RELATED_IMAGE_POSTGRES_`{postgresVersion}`GIS`{postGISVersion}`, e.g. RELATED_IMAGE_POSTGRES_13_GIS_3.1.
imagePullPolicy	`Always`, `Never`, `IfNotPresent`	❌	ImagePullPolicy is used to determine when Kubernetes will attempt to pull (download) container images. More info: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy
imagePullSecrets	`[]object`	❌	The image pull secrets used to pull from a private registry Changing this value causes all running pods to restart. https://k8s.io/docs/tasks/configure-pod-container/pull-image-private-registry/
instances	`[]object`	✅	Specifies one or more sets of PostgreSQL pods that replicate data for this cluster.
metadata	`object`	❌	Metadata contains metadata for PostgresCluster resources
monitoring	`object`	❌	The specification of monitoring tools that connect to PostgreSQL
openshift	`boolean`	❌	Whether or not the PostgreSQL cluster is being deployed to an OpenShift environment. If the field is unset, the operator will automatically detect the environment.
patroni	`object`	❌	undefined
port	`integer`	❌	The port on which PostgreSQL should listen.
postGISVersion	`string`	❌	The PostGIS extension version installed in the PostgreSQL image. When image is not set, indicates a PostGIS enabled image will be used.
postgresVersion	`integer`	✅	The major version of PostgreSQL installed in the PostgreSQL image
proxy	`object`	❌	The specification of a proxy that connects to PostgreSQL.
service	`object`	❌	Specification of the service that exposes the PostgreSQL primary instance.
shutdown	`boolean`	❌	Whether or not the PostgreSQL cluster should be stopped. When this is true, workloads are scaled to zero and CronJobs are suspended. Other resources, such as Services and Volumes, remain in place.
standby	`object`	❌	Run this cluster as a read-only copy of an existing cluster or archive.
supplementalGroups	`[]integer`	❌	A list of group IDs applied to the process of a container. These can be useful when accessing shared file systems with constrained permissions. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context
users	`[]object`	❌	Users to create inside PostgreSQL and the databases they should access. The default creates one user that can access one database matching the PostgresCluster name. An empty list creates no users. Removing a user from this list does NOT drop the user nor revoke their access.

↩ ParentPostgresCluster.spec.backups

PostgreSQL backup configuration

name	type	required	description
pgbackrest	`object`	✅	pgBackRest archive configuration

↩ ParentPostgresCluster.spec.backups.pgbackrest

pgBackRest archive configuration

name	type	required	description
configuration	`[]object`	❌	Projected volumes containing custom pgBackRest configuration. These files are mounted under "/etc/pgbackrest/conf.d" alongside any pgBackRest configuration generated by the PostgreSQL Operator: https://pgbackrest.org/configuration.html
global	`map[string]: string`	❌	Global pgBackRest configuration settings. These settings are included in the "global" section of the pgBackRest configuration generated by the PostgreSQL Operator, and then mounted under "/etc/pgbackrest/conf.d": https://pgbackrest.org/configuration.html
image	`string`	❌	The image name to use for pgBackRest containers. Utilized to run pgBackRest repository hosts and backups. The image may also be set using the RELATED_IMAGE_PGBACKREST environment variable
jobs	`object`	❌	Jobs field allows configuration for all backup jobs
manual	`object`	❌	Defines details for manual pgBackRest backup Jobs
metadata	`object`	❌	Metadata contains metadata for PostgresCluster resources
repoHost	`object`	❌	Defines configuration for a pgBackRest dedicated repository host. This section is only applicable if at least one "volume" (i.e. PVC-based) repository is defined in the "repos" section, therefore enabling a dedicated repository host Deployment.
repos	`[]object`	✅	Defines a pgBackRest repository
restore	`object`	❌	Defines details for performing an in-place restore using pgBackRest
sidecars	`object`	❌	Configuration for pgBackRest sidecar containers

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index]

Projected volumes containing custom pgBackRest configuration. These files are mounted under "/etc/pgbackrest/conf.d" alongside any pgBackRest configuration generated by the PostgreSQL Operator: https://pgbackrest.org/configuration.html

name	type	required	description
configMap	`object`	❌	information about the configMap data to project
downwardAPI	`object`	❌	information about the downwardAPI data to project
secret	`object`	❌	information about the secret data to project
serviceAccountToken	`object`	❌	information about the serviceAccountToken data to project

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].configMap

information about the configMap data to project

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the ConfigMap or its keys must be defined

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].configMap.items[index]

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].downwardAPI

information about the downwardAPI data to project

name	type	required	description
items	`[]object`	❌	Items is a list of DownwardAPIVolume file

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].downwardAPI.items[index]

Items is a list of DownwardAPIVolume file

name	type	required	description
fieldRef	`object`	❌	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef	`object`	❌	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].downwardAPI.items[index].fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

name	type	required	description
apiVersion	`string`	❌	Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath	`string`	✅	Path of the field to select in the specified API version.

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].downwardAPI.items[index].resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

name	type	required	description
containerName	`string`	❌	Container name: required for volumes, optional for env vars
divisor	`int or string`	❌	Specifies the output format of the exposed resources, defaults to "1"
resource	`string`	✅	Required: resource to select

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].secret

information about the secret data to project

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the Secret or its key must be defined

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].secret.items[index]

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.backups.pgbackrest.configuration[index].serviceAccountToken

information about the serviceAccountToken data to project

name	type	required	description
audience	`string`	❌	Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds	`integer`	❌	ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path	`string`	✅	Path is the path relative to the mount point of the file to project the token into.

↩ ParentPostgresCluster.spec.backups.pgbackrest.jobs

Jobs field allows configuration for all backup jobs

name	type	required	description
priorityClassName	`string`	❌	Priority class name for the pgBackRest backup Job pods. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/
resources	`object`	❌	Resource limits for backup jobs. Includes manual, scheduled and replica create backups

↩ ParentPostgresCluster.spec.backups.pgbackrest.jobs.resources

Resource limits for backup jobs. Includes manual, scheduled and replica create backups

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.backups.pgbackrest.manual

Defines details for manual pgBackRest backup Jobs

name	type	required	description
options	`[]string`	❌	Command line options to include when running the pgBackRest backup command. https://pgbackrest.org/command.html#command-backup
repoName	`string`	✅	The name of the pgBackRest repo to run the backup command against.

↩ ParentPostgresCluster.spec.backups.pgbackrest.metadata

Metadata contains metadata for PostgresCluster resources

name	type	required	description
annotations	`map[string]: string`	❌	undefined
labels	`map[string]: string`	❌	undefined

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost

Defines configuration for a pgBackRest dedicated repository host. This section is only applicable if at least one "volume" (i.e. PVC-based) repository is defined in the "repos" section, therefore enabling a dedicated repository host Deployment.

name	type	required	description
affinity	`object`	❌	Scheduling constraints of the Dedicated repo host pod. Changing this value causes repo host to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node
priorityClassName	`string`	❌	Priority class name for the pgBackRest repo host pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/
resources	`object`	❌	Resource requirements for a pgBackRest repository host
sshConfigMap	`object`	❌	ConfigMap containing custom SSH configuration
sshSecret	`object`	❌	Secret containing custom SSH keys
tolerations	`[]object`	❌	Tolerations of a PgBackRest repo host pod. Changing this value causes a restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration
topologySpreadConstraints	`[]object`	❌	Topology spread constraints of a Dedicated repo host pod. Changing this value causes the repo host to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity

Scheduling constraints of the Dedicated repo host pod. Changing this value causes repo host to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node

name	type	required	description
nodeAffinity	`object`	❌	Describes node affinity scheduling rules for the pod.
podAffinity	`object`	❌	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity	`object`	❌	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity

Describes node affinity scheduling rules for the pod.

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`object`	❌	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 an update), the system may or may not try to eventually evict the pod from its node.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
preference	`object`	✅	A node selector term, associated with the corresponding weight.
weight	`integer`	✅	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

A node selector term, associated with the corresponding weight.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

name	type	required	description
nodeSelectorTerms	`[]object`	✅	Required. A list of node selector terms. The terms are ORed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Required. A list of node selector terms. The terms are ORed.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAffinity

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAntiAffinity

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.resources

Resource requirements for a pgBackRest repository host

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.sshConfigMap

ConfigMap containing custom SSH configuration

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the ConfigMap or its keys must be defined

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.sshConfigMap.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.sshSecret

Secret containing custom SSH keys

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the Secret or its key must be defined

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.sshSecret.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.tolerations[index]

Tolerations of a PgBackRest repo host pod. Changing this value causes a restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

name	type	required	description
effect	`string`	❌	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key	`string`	❌	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator	`string`	❌	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds	`integer`	❌	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.topologySpreadConstraints[index]

Topology spread constraints of a Dedicated repo host pod. Changing this value causes the repo host to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/

name	type	required	description
labelSelector	`object`	❌	LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
maxSkew	`integer`	✅	MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0:
topologyKey	`string`	✅	TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each `<key, value>` as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
whenUnsatisfiable	`string`	✅	WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1:

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.topologySpreadConstraints[index].labelSelector

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repoHost.topologySpreadConstraints[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index]

Defines a pgBackRest repository

name	type	required	description
azure	`object`	❌	Represents a pgBackRest repository that is created using Azure storage
gcs	`object`	❌	Represents a pgBackRest repository that is created using Google Cloud Storage
name	`string`	✅	The name of the the repository
s3	`object`	❌	RepoS3 represents a pgBackRest repository that is created using AWS S3 (or S3-compatible) storage
schedules	`object`	❌	Defines the schedules for the pgBackRest backups Full, Differential and Incremental backup types are supported: https://pgbackrest.org/user-guide.html#concept/backup
volume	`object`	❌	Represents a pgBackRest repository that is created using a PersistentVolumeClaim

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].azure

Represents a pgBackRest repository that is created using Azure storage

name	type	required	description
container	`string`	✅	The Azure container utilized for the repository

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].gcs

Represents a pgBackRest repository that is created using Google Cloud Storage

name	type	required	description
bucket	`string`	✅	The GCS bucket utilized for the repository

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].s3

RepoS3 represents a pgBackRest repository that is created using AWS S3 (or S3-compatible) storage

name	type	required	description
bucket	`string`	✅	The S3 bucket utilized for the repository
endpoint	`string`	✅	A valid endpoint corresponding to the specified region
region	`string`	✅	The region corresponding to the S3 bucket

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].schedules

Defines the schedules for the pgBackRest backups Full, Differential and Incremental backup types are supported: https://pgbackrest.org/user-guide.html#concept/backup

name	type	required	description
differential	`string`	❌	Defines the Cron schedule for a differential pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
full	`string`	❌	Defines the Cron schedule for a full pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
incremental	`string`	❌	Defines the Cron schedule for an incremental pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].volume

Represents a pgBackRest repository that is created using a PersistentVolumeClaim

name	type	required	description
volumeClaimSpec	`object`	✅	Defines a PersistentVolumeClaim spec used to create and/or bind a volume

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].volume.volumeClaimSpec

Defines a PersistentVolumeClaim spec used to create and/or bind a volume

name	type	required	description
accessModes	`[]string`	✅	AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource	`object`	❌	This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
resources	`object`	✅	Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector	`object`	❌	A label query over volumes to consider for binding.
storageClassName	`string`	❌	Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode	`string`	❌	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeName	`string`	❌	VolumeName is the binding reference to the PersistentVolume backing this claim.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].volume.volumeClaimSpec.dataSource

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.

name	type	required	description
apiGroup	`string`	❌	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind	`string`	✅	Kind is the type of resource being referenced
name	`string`	✅	Name is the name of resource being referenced

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].volume.volumeClaimSpec.resources

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	✅	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].volume.volumeClaimSpec.selector

A label query over volumes to consider for binding.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.repos[index].volume.volumeClaimSpec.selector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore

Defines details for performing an in-place restore using pgBackRest

name	type	required	description
affinity	`object`	❌	Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node
clusterName	`string`	❌	The name of an existing PostgresCluster to use as the data source for the new PostgresCluster. Defaults to the name of the PostgresCluster being created if not provided.
clusterNamespace	`string`	❌	The namespace of the cluster specified as the data source using the clusterName field. Defaults to the namespace of the PostgresCluster being created if not provided.
enabled	`boolean`	✅	Whether or not in-place pgBackRest restores are enabled for this PostgresCluster.
options	`[]string`	❌	Command line options to include when running the pgBackRest restore command. https://pgbackrest.org/command.html#command-restore
priorityClassName	`string`	❌	Priority class name for the pgBackRest restore Job pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/
repoName	`string`	✅	The name of the pgBackRest repo within the source PostgresCluster that contains the backups that should be utilized to perform a pgBackRest restore when initializing the data source for the new PostgresCluster.
resources	`object`	❌	Resource requirements for the pgBackRest restore Job.
tolerations	`[]object`	❌	Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity

Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node

name	type	required	description
nodeAffinity	`object`	❌	Describes node affinity scheduling rules for the pod.
podAffinity	`object`	❌	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity	`object`	❌	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity

Describes node affinity scheduling rules for the pod.

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`object`	❌	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 an update), the system may or may not try to eventually evict the pod from its node.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
preference	`object`	✅	A node selector term, associated with the corresponding weight.
weight	`integer`	✅	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

A node selector term, associated with the corresponding weight.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

name	type	required	description
nodeSelectorTerms	`[]object`	✅	Required. A list of node selector terms. The terms are ORed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Required. A list of node selector terms. The terms are ORed.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAffinity

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAntiAffinity

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.resources

Resource requirements for the pgBackRest restore Job.

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.backups.pgbackrest.restore.tolerations[index]

Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

name	type	required	description
effect	`string`	❌	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key	`string`	❌	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator	`string`	❌	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds	`integer`	❌	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
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.

↩ ParentPostgresCluster.spec.backups.pgbackrest.sidecars

Configuration for pgBackRest sidecar containers

name	type	required	description
pgbackrest	`object`	❌	Defines the configuration for the pgBackRest sidecar container

↩ ParentPostgresCluster.spec.backups.pgbackrest.sidecars.pgbackrest

Defines the configuration for the pgBackRest sidecar container

name	type	required	description
resources	`object`	❌	Resource requirements for a sidecar container

↩ ParentPostgresCluster.spec.backups.pgbackrest.sidecars.pgbackrest.resources

Resource requirements for a sidecar container

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.customReplicationTLSSecret

The secret containing the replication client certificates and keys for secure connections to the PostgreSQL server. It will need to contain the client TLS certificate, TLS key and the Certificate Authority certificate with the data keys set to tls.crt, tls.key and ca.crt, respectively. NOTE: If CustomReplicationClientTLSSecret is provided, CustomTLSSecret MUST be provided and the ca.crt provided must be the same.

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the Secret or its key must be defined

↩ ParentPostgresCluster.spec.customReplicationTLSSecret.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.customTLSSecret

The secret containing the Certificates and Keys to encrypt PostgreSQL traffic will need to contain the server TLS certificate, TLS key and the Certificate Authority certificate with the data keys set to tls.crt, tls.key and ca.crt, respectively. It will then be mounted as a volume projection to the '/pgconf/tls' directory. For more information on Kubernetes secret projections, please see https://k8s.io/docs/concepts/configuration/secret/#projection-of-secret-keys-to-specific-paths NOTE: If CustomTLSSecret is provided, CustomReplicationClientTLSSecret MUST be provided and the ca.crt provided must be the same.

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the Secret or its key must be defined

↩ ParentPostgresCluster.spec.customTLSSecret.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.dataSource

Specifies a data source for bootstrapping the PostgreSQL cluster.

name	type	required	description
pgbackrest	`object`	❌	Defines a pgBackRest cloud-based data source that can be used to pre-populate the the PostgreSQL data directory for a new PostgreSQL cluster using a pgBackRest restore. The PGBackRest field is incompatible with the PostgresCluster field: only one data source can be used for pre-populating a new PostgreSQL cluster
postgresCluster	`object`	❌	Defines a pgBackRest data source that can be used to pre-populate the PostgreSQL data directory for a new PostgreSQL cluster using a pgBackRest restore. The PGBackRest field is incompatible with the PostgresCluster field: only one data source can be used for pre-populating a new PostgreSQL cluster
volumes	`object`	❌	Defines any existing volumes to reuse for this PostgresCluster.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest

Defines a pgBackRest cloud-based data source that can be used to pre-populate the the PostgreSQL data directory for a new PostgreSQL cluster using a pgBackRest restore. The PGBackRest field is incompatible with the PostgresCluster field: only one data source can be used for pre-populating a new PostgreSQL cluster

name	type	required	description
affinity	`object`	❌	Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node
configuration	`[]object`	❌	Projected volumes containing custom pgBackRest configuration. These files are mounted under "/etc/pgbackrest/conf.d" alongside any pgBackRest configuration generated by the PostgreSQL Operator: https://pgbackrest.org/configuration.html
global	`map[string]: string`	❌	Global pgBackRest configuration settings. These settings are included in the "global" section of the pgBackRest configuration generated by the PostgreSQL Operator, and then mounted under "/etc/pgbackrest/conf.d": https://pgbackrest.org/configuration.html
options	`[]string`	❌	Command line options to include when running the pgBackRest restore command. https://pgbackrest.org/command.html#command-restore
priorityClassName	`string`	❌	Priority class name for the pgBackRest restore Job pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/
repo	`object`	✅	Defines a pgBackRest repository
resources	`object`	❌	Resource requirements for the pgBackRest restore Job.
stanza	`string`	✅	The name of an existing pgBackRest stanza to use as the data source for the new PostgresCluster. Defaults to `db` if not provided.
tolerations	`[]object`	❌	Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity

Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node

name	type	required	description
nodeAffinity	`object`	❌	Describes node affinity scheduling rules for the pod.
podAffinity	`object`	❌	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity	`object`	❌	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity

Describes node affinity scheduling rules for the pod.

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`object`	❌	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 an update), the system may or may not try to eventually evict the pod from its node.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
preference	`object`	✅	A node selector term, associated with the corresponding weight.
weight	`integer`	✅	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

A node selector term, associated with the corresponding weight.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

name	type	required	description
nodeSelectorTerms	`[]object`	✅	Required. A list of node selector terms. The terms are ORed.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Required. A list of node selector terms. The terms are ORed.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAffinity

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAntiAffinity

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index]

name	type	required	description
configMap	`object`	❌	information about the configMap data to project
downwardAPI	`object`	❌	information about the downwardAPI data to project
secret	`object`	❌	information about the secret data to project
serviceAccountToken	`object`	❌	information about the serviceAccountToken data to project

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].configMap

information about the configMap data to project

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the ConfigMap or its keys must be defined

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].configMap.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].downwardAPI

information about the downwardAPI data to project

name	type	required	description
items	`[]object`	❌	Items is a list of DownwardAPIVolume file

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].downwardAPI.items[index]

Items is a list of DownwardAPIVolume file

name	type	required	description
fieldRef	`object`	❌	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef	`object`	❌	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].downwardAPI.items[index].fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

name	type	required	description
apiVersion	`string`	❌	Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath	`string`	✅	Path of the field to select in the specified API version.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].downwardAPI.items[index].resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

name	type	required	description
containerName	`string`	❌	Container name: required for volumes, optional for env vars
divisor	`int or string`	❌	Specifies the output format of the exposed resources, defaults to "1"
resource	`string`	✅	Required: resource to select

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].secret

information about the secret data to project

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the Secret or its key must be defined

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].secret.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.configuration[index].serviceAccountToken

information about the serviceAccountToken data to project

name	type	required	description
audience	`string`	❌	Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds	`integer`	❌	ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path	`string`	✅	Path is the path relative to the mount point of the file to project the token into.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo

Defines a pgBackRest repository

name	type	required	description
azure	`object`	❌	Represents a pgBackRest repository that is created using Azure storage
gcs	`object`	❌	Represents a pgBackRest repository that is created using Google Cloud Storage
name	`string`	✅	The name of the the repository
s3	`object`	❌	RepoS3 represents a pgBackRest repository that is created using AWS S3 (or S3-compatible) storage
schedules	`object`	❌	Defines the schedules for the pgBackRest backups Full, Differential and Incremental backup types are supported: https://pgbackrest.org/user-guide.html#concept/backup
volume	`object`	❌	Represents a pgBackRest repository that is created using a PersistentVolumeClaim

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.azure

Represents a pgBackRest repository that is created using Azure storage

name	type	required	description
container	`string`	✅	The Azure container utilized for the repository

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.gcs

Represents a pgBackRest repository that is created using Google Cloud Storage

name	type	required	description
bucket	`string`	✅	The GCS bucket utilized for the repository

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.s3

RepoS3 represents a pgBackRest repository that is created using AWS S3 (or S3-compatible) storage

name	type	required	description
bucket	`string`	✅	The S3 bucket utilized for the repository
endpoint	`string`	✅	A valid endpoint corresponding to the specified region
region	`string`	✅	The region corresponding to the S3 bucket

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.schedules

Defines the schedules for the pgBackRest backups Full, Differential and Incremental backup types are supported: https://pgbackrest.org/user-guide.html#concept/backup

name	type	required	description
differential	`string`	❌	Defines the Cron schedule for a differential pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
full	`string`	❌	Defines the Cron schedule for a full pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
incremental	`string`	❌	Defines the Cron schedule for an incremental pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.volume

Represents a pgBackRest repository that is created using a PersistentVolumeClaim

name	type	required	description
volumeClaimSpec	`object`	✅	Defines a PersistentVolumeClaim spec used to create and/or bind a volume

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.volume.volumeClaimSpec

Defines a PersistentVolumeClaim spec used to create and/or bind a volume

name	type	required	description
accessModes	`[]string`	❌	AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource	`object`	❌	This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
resources	`object`	❌	Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector	`object`	❌	A label query over volumes to consider for binding.
storageClassName	`string`	❌	Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode	`string`	❌	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeName	`string`	❌	VolumeName is the binding reference to the PersistentVolume backing this claim.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.volume.volumeClaimSpec.dataSource

name	type	required	description
apiGroup	`string`	❌	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind	`string`	✅	Kind is the type of resource being referenced
name	`string`	✅	Name is the name of resource being referenced

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.volume.volumeClaimSpec.resources

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.volume.volumeClaimSpec.selector

A label query over volumes to consider for binding.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.repo.volume.volumeClaimSpec.selector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.resources

Resource requirements for the pgBackRest restore Job.

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.dataSource.pgbackrest.tolerations[index]

Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

name	type	required	description
effect	`string`	❌	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key	`string`	❌	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator	`string`	❌	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds	`integer`	❌	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
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.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster

Defines a pgBackRest data source that can be used to pre-populate the PostgreSQL data directory for a new PostgreSQL cluster using a pgBackRest restore. The PGBackRest field is incompatible with the PostgresCluster field: only one data source can be used for pre-populating a new PostgreSQL cluster

name	type	required	description
affinity	`object`	❌	Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node
clusterName	`string`	❌	The name of an existing PostgresCluster to use as the data source for the new PostgresCluster. Defaults to the name of the PostgresCluster being created if not provided.
clusterNamespace	`string`	❌	The namespace of the cluster specified as the data source using the clusterName field. Defaults to the namespace of the PostgresCluster being created if not provided.
options	`[]string`	❌	Command line options to include when running the pgBackRest restore command. https://pgbackrest.org/command.html#command-restore
priorityClassName	`string`	❌	Priority class name for the pgBackRest restore Job pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/
repoName	`string`	✅	The name of the pgBackRest repo within the source PostgresCluster that contains the backups that should be utilized to perform a pgBackRest restore when initializing the data source for the new PostgresCluster.
resources	`object`	❌	Resource requirements for the pgBackRest restore Job.
tolerations	`[]object`	❌	Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity

Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node

name	type	required	description
nodeAffinity	`object`	❌	Describes node affinity scheduling rules for the pod.
podAffinity	`object`	❌	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity	`object`	❌	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity

Describes node affinity scheduling rules for the pod.

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`object`	❌	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 an update), the system may or may not try to eventually evict the pod from its node.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
preference	`object`	✅	A node selector term, associated with the corresponding weight.
weight	`integer`	✅	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

A node selector term, associated with the corresponding weight.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

name	type	required	description
nodeSelectorTerms	`[]object`	✅	Required. A list of node selector terms. The terms are ORed.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Required. A list of node selector terms. The terms are ORed.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAffinity

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAntiAffinity

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.resources

Resource requirements for the pgBackRest restore Job.

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.dataSource.postgresCluster.tolerations[index]

Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

name	type	required	description
effect	`string`	❌	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key	`string`	❌	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator	`string`	❌	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds	`integer`	❌	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
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.

↩ ParentPostgresCluster.spec.dataSource.volumes

Defines any existing volumes to reuse for this PostgresCluster.

name	type	required	description
pgBackRestVolume	`object`	❌	Defines the existing pgBackRest repo volume and directory to use in the current PostgresCluster.
pgDataVolume	`object`	❌	Defines the existing pgData volume and directory to use in the current PostgresCluster.
pgWALVolume	`object`	❌	Defines the existing pg_wal volume and directory to use in the current PostgresCluster. Note that a defined pg_wal volume MUST be accompanied by a pgData volume.

↩ ParentPostgresCluster.spec.dataSource.volumes.pgBackRestVolume

Defines the existing pgBackRest repo volume and directory to use in the current PostgresCluster.

name	type	required	description
directory	`string`	❌	The existing directory. When not set, a move Job is not created for the associated volume.
pvcName	`string`	✅	The existing PVC name.

↩ ParentPostgresCluster.spec.dataSource.volumes.pgDataVolume

Defines the existing pgData volume and directory to use in the current PostgresCluster.

name	type	required	description
directory	`string`	❌	The existing directory. When not set, a move Job is not created for the associated volume.
pvcName	`string`	✅	The existing PVC name.

↩ ParentPostgresCluster.spec.dataSource.volumes.pgWALVolume

Defines the existing pg_wal volume and directory to use in the current PostgresCluster. Note that a defined pg_wal volume MUST be accompanied by a pgData volume.

name	type	required	description
directory	`string`	❌	The existing directory. When not set, a move Job is not created for the associated volume.
pvcName	`string`	✅	The existing PVC name.

↩ ParentPostgresCluster.spec.databaseInitSQL

DatabaseInitSQL defines a ConfigMap containing custom SQL that will be run after the cluster is initialized. This ConfigMap must be in the same namespace as the cluster.

name	type	required	description
key	`string`	✅	Key is the ConfigMap data key that points to a SQL string
name	`string`	✅	Name is the name of a ConfigMap

↩ ParentPostgresCluster.spec.imagePullSecrets[index]

The image pull secrets used to pull from a private registry Changing this value causes all running pods to restart. https://k8s.io/docs/tasks/configure-pod-container/pull-image-private-registry/

name	type	required	description
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

↩ ParentPostgresCluster.spec.instances[index]

Specifies one or more sets of PostgreSQL pods that replicate data for this cluster.

name	type	required	description
affinity	`object`	❌	Scheduling constraints of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node
dataVolumeClaimSpec	`object`	✅	Defines a PersistentVolumeClaim for PostgreSQL data. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
metadata	`object`	❌	Metadata contains metadata for PostgresCluster resources
name	`string`	❌	Name that associates this set of PostgreSQL pods. This field is optional when only one instance set is defined. Each instance set in a cluster must have a unique name. The combined length of this and the cluster name must be 46 characters or less.
priorityClassName	`string`	❌	Priority class name for the PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/
replicas	`integer`	❌	Number of desired PostgreSQL pods.
resources	`object`	❌	Compute resources of a PostgreSQL container.
sidecars	`object`	❌	Configuration for instance sidecar containers
tolerations	`[]object`	❌	Tolerations of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration
topologySpreadConstraints	`[]object`	❌	Topology spread constraints of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
walVolumeClaimSpec	`object`	❌	Defines a separate PersistentVolumeClaim for PostgreSQL's write-ahead log. More info: https://www.postgresql.org/docs/current/wal.html

↩ ParentPostgresCluster.spec.instances[index].affinity

Scheduling constraints of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node

name	type	required	description
nodeAffinity	`object`	❌	Describes node affinity scheduling rules for the pod.
podAffinity	`object`	❌	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity	`object`	❌	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity

Describes node affinity scheduling rules for the pod.

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`object`	❌	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 an update), the system may or may not try to eventually evict the pod from its node.

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
preference	`object`	✅	A node selector term, associated with the corresponding weight.
weight	`integer`	✅	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

A node selector term, associated with the corresponding weight.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

name	type	required	description
nodeSelectorTerms	`[]object`	✅	Required. A list of node selector terms. The terms are ORed.

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Required. A list of node selector terms. The terms are ORed.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAffinity

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAntiAffinity

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.instances[index].affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].dataVolumeClaimSpec

Defines a PersistentVolumeClaim for PostgreSQL data. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

name	type	required	description
accessModes	`[]string`	✅	AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource	`object`	❌	This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
resources	`object`	✅	Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector	`object`	❌	A label query over volumes to consider for binding.
storageClassName	`string`	❌	Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode	`string`	❌	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeName	`string`	❌	VolumeName is the binding reference to the PersistentVolume backing this claim.

↩ ParentPostgresCluster.spec.instances[index].dataVolumeClaimSpec.dataSource

name	type	required	description
apiGroup	`string`	❌	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind	`string`	✅	Kind is the type of resource being referenced
name	`string`	✅	Name is the name of resource being referenced

↩ ParentPostgresCluster.spec.instances[index].dataVolumeClaimSpec.resources

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	✅	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.instances[index].dataVolumeClaimSpec.selector

A label query over volumes to consider for binding.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.instances[index].dataVolumeClaimSpec.selector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].metadata

Metadata contains metadata for PostgresCluster resources

name	type	required	description
annotations	`map[string]: string`	❌	undefined
labels	`map[string]: string`	❌	undefined

↩ ParentPostgresCluster.spec.instances[index].resources

Compute resources of a PostgreSQL container.

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.instances[index].sidecars

Configuration for instance sidecar containers

name	type	required	description
replicaCertCopy	`object`	❌	Defines the configuration for the replica cert copy sidecar container

↩ ParentPostgresCluster.spec.instances[index].sidecars.replicaCertCopy

Defines the configuration for the replica cert copy sidecar container

name	type	required	description
resources	`object`	❌	Resource requirements for a sidecar container

↩ ParentPostgresCluster.spec.instances[index].sidecars.replicaCertCopy.resources

Resource requirements for a sidecar container

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.instances[index].tolerations[index]

Tolerations of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

name	type	required	description
effect	`string`	❌	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key	`string`	❌	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator	`string`	❌	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds	`integer`	❌	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
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.

↩ ParentPostgresCluster.spec.instances[index].topologySpreadConstraints[index]

Topology spread constraints of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/

name	type	required	description
labelSelector	`object`	❌	LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
maxSkew	`integer`	✅	MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0:
topologyKey	`string`	✅	TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each `<key, value>` as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
whenUnsatisfiable	`string`	✅	WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1:

↩ ParentPostgresCluster.spec.instances[index].topologySpreadConstraints[index].labelSelector

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.instances[index].topologySpreadConstraints[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.instances[index].walVolumeClaimSpec

Defines a separate PersistentVolumeClaim for PostgreSQL's write-ahead log. More info: https://www.postgresql.org/docs/current/wal.html

name	type	required	description
accessModes	`[]string`	✅	AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource	`object`	❌	This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
resources	`object`	✅	Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector	`object`	❌	A label query over volumes to consider for binding.
storageClassName	`string`	❌	Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode	`string`	❌	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeName	`string`	❌	VolumeName is the binding reference to the PersistentVolume backing this claim.

↩ ParentPostgresCluster.spec.instances[index].walVolumeClaimSpec.dataSource

name	type	required	description
apiGroup	`string`	❌	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind	`string`	✅	Kind is the type of resource being referenced
name	`string`	✅	Name is the name of resource being referenced

↩ ParentPostgresCluster.spec.instances[index].walVolumeClaimSpec.resources

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	✅	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.instances[index].walVolumeClaimSpec.selector

A label query over volumes to consider for binding.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.instances[index].walVolumeClaimSpec.selector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.metadata

Metadata contains metadata for PostgresCluster resources

name	type	required	description
annotations	`map[string]: string`	❌	undefined
labels	`map[string]: string`	❌	undefined

↩ ParentPostgresCluster.spec.monitoring

The specification of monitoring tools that connect to PostgreSQL

name	type	required	description
pgmonitor	`object`	❌	PGMonitorSpec defines the desired state of the pgMonitor tool suite

↩ ParentPostgresCluster.spec.monitoring.pgmonitor

PGMonitorSpec defines the desired state of the pgMonitor tool suite

name	type	required	description
exporter	`object`	❌	undefined

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter

name	type	required	description
configuration	`[]object`	❌	Projected volumes containing custom PostgreSQL Exporter configuration. Currently supports the customization of PostgreSQL Exporter queries. If a "queries.yaml" file is detected in any volume projected using this field, it will be loaded using the "extend.query-path" flag: https://github.com/prometheus-community/postgres_exporter#flags Changing the values of field causes PostgreSQL and the exporter to restart.
image	`string`	❌	The image name to use for crunchy-postgres-exporter containers. The image may also be set using the RELATED_IMAGE_PGEXPORTER environment variable.
resources	`object`	❌	Changing this value causes PostgreSQL and the exporter to restart. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index]

Projected volumes containing custom PostgreSQL Exporter configuration. Currently supports the customization of PostgreSQL Exporter queries. If a "queries.yaml" file is detected in any volume projected using this field, it will be loaded using the "extend.query-path" flag: https://github.com/prometheus-community/postgres_exporter#flags Changing the values of field causes PostgreSQL and the exporter to restart.

name	type	required	description
configMap	`object`	❌	information about the configMap data to project
downwardAPI	`object`	❌	information about the downwardAPI data to project
secret	`object`	❌	information about the secret data to project
serviceAccountToken	`object`	❌	information about the serviceAccountToken data to project

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].configMap

information about the configMap data to project

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the ConfigMap or its keys must be defined

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].configMap.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].downwardAPI

information about the downwardAPI data to project

name	type	required	description
items	`[]object`	❌	Items is a list of DownwardAPIVolume file

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].downwardAPI.items[index]

Items is a list of DownwardAPIVolume file

name	type	required	description
fieldRef	`object`	❌	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef	`object`	❌	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].downwardAPI.items[index].fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

name	type	required	description
apiVersion	`string`	❌	Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath	`string`	✅	Path of the field to select in the specified API version.

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].downwardAPI.items[index].resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

name	type	required	description
containerName	`string`	❌	Container name: required for volumes, optional for env vars
divisor	`int or string`	❌	Specifies the output format of the exposed resources, defaults to "1"
resource	`string`	✅	Required: resource to select

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].secret

information about the secret data to project

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the Secret or its key must be defined

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].secret.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.configuration[index].serviceAccountToken

information about the serviceAccountToken data to project

name	type	required	description
audience	`string`	❌	Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds	`integer`	❌	ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path	`string`	✅	Path is the path relative to the mount point of the file to project the token into.

↩ ParentPostgresCluster.spec.monitoring.pgmonitor.exporter.resources

Changing this value causes PostgreSQL and the exporter to restart. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.patroni

name	type	required	description
dynamicConfiguration	`object`	❌	undefined
leaderLeaseDurationSeconds	`integer`	❌	TTL of the cluster leader lock. "Think of it as the length of time before initiation of the automatic failover process."
port	`integer`	❌	The port on which Patroni should listen.
syncPeriodSeconds	`integer`	❌	The interval for refreshing the leader lock and applying dynamicConfiguration. Must be less than leaderLeaseDurationSeconds.

↩ ParentPostgresCluster.spec.proxy

The specification of a proxy that connects to PostgreSQL.

name	type	required	description
pgBouncer	`object`	✅	Defines a PgBouncer proxy and connection pooler.

↩ ParentPostgresCluster.spec.proxy.pgBouncer

Defines a PgBouncer proxy and connection pooler.

name	type	required	description
affinity	`object`	❌	Scheduling constraints of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node
config	`object`	❌	Configuration settings for the PgBouncer process. Changes to any of these values will be automatically reloaded without validation. Be careful, as you may put PgBouncer into an unusable state. More info: https://www.pgbouncer.org/usage.html#reload
customTLSSecret	`object`	❌	A secret projection containing a certificate and key with which to encrypt connections to PgBouncer. The "tls.crt", "tls.key", and "ca.crt" paths must be PEM-encoded certificates and keys. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/configuration/secret/#projection-of-secret-keys-to-specific-paths
image	`string`	❌	Name of a container image that can run PgBouncer 1.15 or newer. Changing this value causes PgBouncer to restart. The image may also be set using the RELATED_IMAGE_PGBOUNCER environment variable. More info: https://kubernetes.io/docs/concepts/containers/images
metadata	`object`	❌	Metadata contains metadata for PostgresCluster resources
port	`integer`	❌	Port on which PgBouncer should listen for client connections. Changing this value causes PgBouncer to restart.
priorityClassName	`string`	❌	Priority class name for the pgBouncer pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/
replicas	`integer`	❌	Number of desired PgBouncer pods.
resources	`object`	❌	Compute resources of a PgBouncer container. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers
service	`object`	❌	Specification of the service that exposes PgBouncer.
sidecars	`object`	❌	Configuration for pgBouncer sidecar containers
tolerations	`[]object`	❌	Tolerations of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration
topologySpreadConstraints	`[]object`	❌	Topology spread constraints of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity

Scheduling constraints of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node

name	type	required	description
nodeAffinity	`object`	❌	Describes node affinity scheduling rules for the pod.
podAffinity	`object`	❌	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity	`object`	❌	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity

Describes node affinity scheduling rules for the pod.

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`object`	❌	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 an update), the system may or may not try to eventually evict the pod from its node.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
preference	`object`	✅	A node selector term, associated with the corresponding weight.
weight	`integer`	✅	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

A node selector term, associated with the corresponding weight.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

name	type	required	description
nodeSelectorTerms	`[]object`	✅	Required. A list of node selector terms. The terms are ORed.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

Required. A list of node selector terms. The terms are ORed.

name	type	required	description
matchExpressions	`[]object`	❌	A list of node selector requirements by node's labels.
matchFields	`[]object`	❌	A list of node selector requirements by node's fields.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

A list of node selector requirements by node's labels.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

A list of node selector requirements by node's fields.

name	type	required	description
key	`string`	✅	The label key that the selector applies to.
operator	`string`	✅	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	`[]string`	❌	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAffinity

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

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.

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAntiAffinity

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

name	type	required	description
preferredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	`[]object`	❌	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
podAffinityTerm	`object`	✅	Required. A pod affinity term, associated with the corresponding weight.
weight	`integer`	✅	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

Required. A pod affinity term, associated with the corresponding weight.

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

name	type	required	description
labelSelector	`object`	❌	A label query over a set of resources, in this case pods.
namespaces	`[]string`	❌	namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
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.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

A label query over a set of resources, in this case pods.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config

Configuration settings for the PgBouncer process. Changes to any of these values will be automatically reloaded without validation. Be careful, as you may put PgBouncer into an unusable state. More info: https://www.pgbouncer.org/usage.html#reload

name	type	required	description
databases	`map[string]: string`	❌	PgBouncer database definitions. The key is the database requested by a client while the value is a libpq-styled connection string. The special key "" acts as a fallback. When this field is empty, PgBouncer is configured with a single "" entry that connects to the primary PostgreSQL instance. More info: https://www.pgbouncer.org/config.html#section-databases
files	`[]object`	❌	Files to mount under "/etc/pgbouncer". When specified, settings in the "pgbouncer.ini" file are loaded before all others. From there, other files may be included by absolute path. Changing these references causes PgBouncer to restart, but changes to the file contents are automatically reloaded. More info: https://www.pgbouncer.org/config.html#include-directive
global	`map[string]: string`	❌	Settings that apply to the entire PgBouncer process. More info: https://www.pgbouncer.org/config.html
users	`map[string]: string`	❌	Connection settings specific to particular users. More info: https://www.pgbouncer.org/config.html#section-users

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index]

Files to mount under "/etc/pgbouncer". When specified, settings in the "pgbouncer.ini" file are loaded before all others. From there, other files may be included by absolute path. Changing these references causes PgBouncer to restart, but changes to the file contents are automatically reloaded. More info: https://www.pgbouncer.org/config.html#include-directive

name	type	required	description
configMap	`object`	❌	information about the configMap data to project
downwardAPI	`object`	❌	information about the downwardAPI data to project
secret	`object`	❌	information about the secret data to project
serviceAccountToken	`object`	❌	information about the serviceAccountToken data to project

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].configMap

information about the configMap data to project

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the ConfigMap or its keys must be defined

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].configMap.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].downwardAPI

information about the downwardAPI data to project

name	type	required	description
items	`[]object`	❌	Items is a list of DownwardAPIVolume file

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].downwardAPI.items[index]

Items is a list of DownwardAPIVolume file

name	type	required	description
fieldRef	`object`	❌	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef	`object`	❌	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].downwardAPI.items[index].fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

name	type	required	description
apiVersion	`string`	❌	Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath	`string`	✅	Path of the field to select in the specified API version.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].downwardAPI.items[index].resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

name	type	required	description
containerName	`string`	❌	Container name: required for volumes, optional for env vars
divisor	`int or string`	❌	Specifies the output format of the exposed resources, defaults to "1"
resource	`string`	✅	Required: resource to select

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].secret

information about the secret data to project

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the Secret or its key must be defined

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].secret.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.config.files[index].serviceAccountToken

information about the serviceAccountToken data to project

name	type	required	description
audience	`string`	❌	Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds	`integer`	❌	ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path	`string`	✅	Path is the path relative to the mount point of the file to project the token into.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.customTLSSecret

A secret projection containing a certificate and key with which to encrypt connections to PgBouncer. The "tls.crt", "tls.key", and "ca.crt" paths must be PEM-encoded certificates and keys. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/configuration/secret/#projection-of-secret-keys-to-specific-paths

name	type	required	description
items	`[]object`	❌	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	`string`	❌	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional	`boolean`	❌	Specify whether the Secret or its key must be defined

↩ ParentPostgresCluster.spec.proxy.pgBouncer.customTLSSecret.items[index]

name	type	required	description
key	`string`	✅	The key to project.
mode	`integer`	❌	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	`string`	✅	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.metadata

Metadata contains metadata for PostgresCluster resources

name	type	required	description
annotations	`map[string]: string`	❌	undefined
labels	`map[string]: string`	❌	undefined

↩ ParentPostgresCluster.spec.proxy.pgBouncer.resources

Compute resources of a PgBouncer container. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.proxy.pgBouncer.service

Specification of the service that exposes PgBouncer.

name	type	required	description
type	`ClusterIP`, `NodePort`, `LoadBalancer`	✅	More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

↩ ParentPostgresCluster.spec.proxy.pgBouncer.sidecars

Configuration for pgBouncer sidecar containers

name	type	required	description
pgbouncerConfig	`object`	❌	Defines the configuration for the pgBouncer config sidecar container

↩ ParentPostgresCluster.spec.proxy.pgBouncer.sidecars.pgbouncerConfig

Defines the configuration for the pgBouncer config sidecar container

name	type	required	description
resources	`object`	❌	Resource requirements for a sidecar container

↩ ParentPostgresCluster.spec.proxy.pgBouncer.sidecars.pgbouncerConfig.resources

Resource requirements for a sidecar container

name	type	required	description
limits	`map[string]: int or string`	❌	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests	`map[string]: int or string`	❌	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

↩ ParentPostgresCluster.spec.proxy.pgBouncer.tolerations[index]

Tolerations of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration

name	type	required	description
effect	`string`	❌	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key	`string`	❌	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator	`string`	❌	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds	`integer`	❌	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
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.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.topologySpreadConstraints[index]

Topology spread constraints of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/

name	type	required	description
labelSelector	`object`	❌	LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
maxSkew	`integer`	✅	MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0:
topologyKey	`string`	✅	TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each `<key, value>` as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
whenUnsatisfiable	`string`	✅	WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1:

↩ ParentPostgresCluster.spec.proxy.pgBouncer.topologySpreadConstraints[index].labelSelector

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

name	type	required	description
matchExpressions	`[]object`	❌	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels	`map[string]: string`	❌	matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

↩ ParentPostgresCluster.spec.proxy.pgBouncer.topologySpreadConstraints[index].labelSelector.matchExpressions[index]

matchExpressions is a list of label selector requirements. The requirements are ANDed.

name	type	required	description
key	`string`	✅	key is the label key that the selector applies to.
operator	`string`	✅	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	`[]string`	❌	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

↩ ParentPostgresCluster.spec.service

Specification of the service that exposes the PostgreSQL primary instance.

name	type	required	description
type	`ClusterIP`, `NodePort`, `LoadBalancer`	✅	More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

↩ ParentPostgresCluster.spec.standby

Run this cluster as a read-only copy of an existing cluster or archive.

name	type	required	description
enabled	`boolean`	❌	Whether or not the PostgreSQL cluster should be read-only. When this is true, WAL files are applied from the pgBackRest repository.
repoName	`string`	✅	The name of the pgBackRest repository to follow for WAL files.

↩ ParentPostgresCluster.spec.users[index]

Users to create inside PostgreSQL and the databases they should access. The default creates one user that can access one database matching the PostgresCluster name. An empty list creates no users. Removing a user from this list does NOT drop the user nor revoke their access.

name	type	required	description
databases	`[]string`	❌	Databases to which this user can connect and create objects. Removing a database from this list does NOT revoke access. This field is ignored for the "postgres" user.
name	`string`	✅	The name of this PostgreSQL user. The value may contain only lowercase letters, numbers, and hyphen so that it fits into Kubernetes metadata.
options	`string`	❌	ALTER ROLE options except for PASSWORD. This field is ignored for the "postgres" user. More info: https://www.postgresql.org/docs/current/role-attributes.html

↩ ParentPostgresCluster.status

PostgresClusterStatus defines the observed state of PostgresCluster

name	type	required	description
conditions	`[]object`	❌	conditions represent the observations of postgrescluster's current state. Known .status.conditions.type are: "PersistentVolumeResizing", "ProxyAvailable"
databaseInitSQL	`string`	❌	DatabaseInitSQL state of custom database initialization in the cluster
databaseRevision	`string`	❌	Identifies the databases that have been installed into PostgreSQL.
instances	`[]object`	❌	Current state of PostgreSQL instances.
monitoring	`object`	❌	Current state of PostgreSQL cluster monitoring tool configuration
observedGeneration	`integer`	❌	observedGeneration represents the .metadata.generation on which the status was based.
patroni	`object`	❌	undefined
pgbackrest	`object`	❌	Status information for pgBackRest
proxy	`object`	❌	Current state of the PostgreSQL proxy.
startupInstance	`string`	❌	The instance that should be started first when bootstrapping and/or starting a PostgresCluster.
startupInstanceSet	`string`	❌	The instance set associated with the startupInstance
usersRevision	`string`	❌	Identifies the users that have been installed into PostgreSQL.

↩ ParentPostgresCluster.status.conditions[index]

conditions represent the observations of postgrescluster's current state. Known .status.conditions.type are: "PersistentVolumeResizing", "ProxyAvailable"

name	type	required	description
lastTransitionTime	`string`	✅	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	`string`	✅	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	`integer`	❌	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	`string`	✅	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	`True`, `False`, `Unknown`	✅	status of the condition, one of True, False, Unknown.
type	`string`	✅	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

↩ ParentPostgresCluster.status.instances[index]

Current state of PostgreSQL instances.

name	type	required	description
name	`string`	✅	undefined
readyReplicas	`integer`	❌	Total number of ready pods.
replicas	`integer`	❌	Total number of non-terminated pods.
updatedReplicas	`integer`	❌	Total number of non-terminated pods that have the desired specification.

↩ ParentPostgresCluster.status.monitoring

Current state of PostgreSQL cluster monitoring tool configuration

name	type	required	description
exporterConfiguration	`string`	❌	undefined

↩ ParentPostgresCluster.status.patroni

name	type	required	description
systemIdentifier	`string`	❌	The PostgreSQL system identifier reported by Patroni.

↩ ParentPostgresCluster.status.pgbackrest

Status information for pgBackRest

name	type	required	description
manualBackup	`object`	❌	Status information for manual backups
repoHost	`object`	❌	Status information for the pgBackRest dedicated repository host
repos	`[]object`	❌	Status information for pgBackRest repositories
restore	`object`	❌	Status information for in-place restores
scheduledBackups	`[]object`	❌	Status information for scheduled backups

↩ ParentPostgresCluster.status.pgbackrest.manualBackup

Status information for manual backups

name	type	required	description
active	`integer`	❌	The number of actively running manual backup Pods.
completionTime	`string`	❌	Represents the time the manual backup Job was determined by the Job controller to be completed. This field is only set if the backup completed successfully. Additionally, it is represented in RFC3339 form and is in UTC.
failed	`integer`	❌	The number of Pods for the manual backup Job that reached the "Failed" phase.
finished	`boolean`	✅	Specifies whether or not the Job is finished executing (does not indicate success or failure).
id	`string`	✅	A unique identifier for the manual backup as provided using the "pgbackrest-backup" annotation when initiating a backup.
startTime	`string`	❌	Represents the time the manual backup Job was acknowledged by the Job controller. It is represented in RFC3339 form and is in UTC.
succeeded	`integer`	❌	The number of Pods for the manual backup Job that reached the "Succeeded" phase.

↩ ParentPostgresCluster.status.pgbackrest.repoHost

Status information for the pgBackRest dedicated repository host

name	type	required	description
apiVersion	`string`	❌	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	`string`	❌	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
ready	`boolean`	❌	Whether or not the pgBackRest repository host is ready for use

↩ ParentPostgresCluster.status.pgbackrest.repos[index]

Status information for pgBackRest repositories

name	type	required	description
bound	`boolean`	❌	Whether or not the pgBackRest repository PersistentVolumeClaim is bound to a volume
name	`string`	✅	The name of the pgBackRest repository
replicaCreateBackupComplete	`boolean`	❌	ReplicaCreateBackupReady indicates whether a backup exists in the repository as needed to bootstrap replicas.
repoOptionsHash	`string`	❌	A hash of the required fields in the spec for defining an Azure, GCS or S3 repository, Utilizd to detect changes to these fields and then execute pgBackRest stanza-create commands accordingly.
stanzaCreated	`boolean`	❌	Specifies whether or not a stanza has been successfully created for the repository
volume	`string`	❌	The name of the volume the containing the pgBackRest repository

↩ ParentPostgresCluster.status.pgbackrest.restore

Status information for in-place restores

name	type	required	description
active	`integer`	❌	The number of actively running manual backup Pods.
completionTime	`string`	❌	Represents the time the manual backup Job was determined by the Job controller to be completed. This field is only set if the backup completed successfully. Additionally, it is represented in RFC3339 form and is in UTC.
failed	`integer`	❌	The number of Pods for the manual backup Job that reached the "Failed" phase.
finished	`boolean`	✅	Specifies whether or not the Job is finished executing (does not indicate success or failure).
id	`string`	✅	A unique identifier for the manual backup as provided using the "pgbackrest-backup" annotation when initiating a backup.
startTime	`string`	❌	Represents the time the manual backup Job was acknowledged by the Job controller. It is represented in RFC3339 form and is in UTC.
succeeded	`integer`	❌	The number of Pods for the manual backup Job that reached the "Succeeded" phase.

↩ ParentPostgresCluster.status.pgbackrest.scheduledBackups[index]

Status information for scheduled backups

name	type	required	description
active	`integer`	❌	The number of actively running manual backup Pods.
completionTime	`string`	❌	Represents the time the manual backup Job was determined by the Job controller to be completed. This field is only set if the backup completed successfully. Additionally, it is represented in RFC3339 form and is in UTC.
cronJobName	`string`	❌	The name of the associated pgBackRest scheduled backup CronJob
failed	`integer`	❌	The number of Pods for the manual backup Job that reached the "Failed" phase.
repo	`string`	❌	The name of the associated pgBackRest repository
startTime	`string`	❌	Represents the time the manual backup Job was acknowledged by the Job controller. It is represented in RFC3339 form and is in UTC.
succeeded	`integer`	❌	The number of Pods for the manual backup Job that reached the "Succeeded" phase.
type	`string`	❌	The pgBackRest backup type for this Job

↩ ParentPostgresCluster.status.proxy

Current state of the PostgreSQL proxy.

name	type	required	description
pgBouncer	`object`	❌	undefined

↩ ParentPostgresCluster.status.proxy.pgBouncer

name	type	required	description
postgresRevision	`string`	❌	Identifies the revision of PgBouncer assets that have been installed into PostgreSQL.
readyReplicas	`integer`	❌	Total number of ready pods.
replicas	`integer`	❌	Total number of non-terminated pods.