Skip to content
Snippets Groups Projects
Select Git revision
22 results Searching

cluster_manifest.md

user avatar
add resource annotation and ignore recovery type (#2817)
Felix Kunde authored and GitHub committed 
* add resource annotation and ignore recovery type
* Update docs/reference/cluster_manifest.md

---------

Co-authored-by: default avatarIda Novindasari <idanovinda@gmail.com>
80ef38f7
History
user avatar 80ef38f7
History
cluster_manifest.md 31.14 KiB

Cluster manifest reference

Individual Postgres clusters are described by the Kubernetes cluster manifest that has the structure defined by the postgresql CRD (custom resource definition). The following section describes the structure of the manifest and the purpose of individual keys. You can take a look at the examples of the minimal and the complete cluster manifests.

When Kubernetes resources, such as memory, CPU or volumes, are configured, their amount is usually described as a string together with the units of measurements. Please, refer to the Kubernetes documentation for the possible values of those.

❗ If both operator configmap/CRD and a Postgres cluster manifest define the same parameter, the value from the Postgres cluster manifest is applied.

Manifest structure

A Postgres manifest is a YAML document. On the top level both individual parameters and parameter groups can be defined. Parameter names are written in camelCase.

Cluster metadata

Those parameters are grouped under the metadata top-level key.

  • name the name of the cluster. Must start with the teamId followed by a dash. Changing it after the cluster creation is not supported. Required field.

  • namespace the namespace where the operator creates Kubernetes objects (i.e. pods, services, secrets) for the cluster. Changing it after the cluster creation results in deploying or updating a completely separate cluster in the target namespace. Optional (if present, should match the namespace where the manifest is applied).

  • labels if labels are matching one of the inherited_labels configured in the operator parameters, they will automatically be added to all the objects (StatefulSet, Service, Endpoints, etc.) that are created by the operator. Labels that are set here but not listed as inherited_labels in the operator parameters are ignored.

Top-level parameters