bitnamicharts/cloudnative-pg repository overview

⁠Bitnami Secure Images Helm chart for CloudNativePG

CloudNativePG is an open-source tool for managing PostgreSQL databases on Kubernetes, from setup to ongoing upkeep.

Overview of CloudNativePG⁠

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

⁠ TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/cloudnative-pg

⁠ Introduction

This chart bootstraps a CloudNativePG⁠ deployment on a Kubernetes⁠ cluster using the Helm⁠ package manager.

⁠ Before you begin

• Kubernetes 1.23+
• Helm 3.8.0+

⁠ Installing the Chart

To install the chart with the release name my-release:

helm install my-release REGISTRY_NAME/REPOSITORY_NAME/cloudnative-pg

The command deploys CloudNativePG on the Kubernetes cluster in the default configuration. The Parameters⁠ section lists the parameters that can be configured during installation.

⁠ Configuration and installation details

This section describes credentials, configuration, and other installation options.

⁠ Operator configuration

The Bitnami CloudNativePG chart allows configuring the operator⁠ using ConfigMaps and Secrets. This is done using the operator.configuration and operator.secretConfiguration parameters. Both are values are compatible, and the configuration in the operator.secretConfiguration section takes precedence over the operator.configuration section. In the example below we add extra configuration parameters to the operator:

operator:
  configuration:
    EXPIRING_CHECK_THRESHOLD: 12
  secretConfiguration:
    CERTIFICATE_DURATION: 120

It is also possible to use existing ConfigMaps and Secrets using the operator.existingConfigMap and operator.existingSecret parameters (note that these are not compatible with the operator.configuration and operator.secretConfiguration parameters).

⁠ Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the *.resources (under the operator and pluginBarmanCloud sections) value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the *.resourcesPreset (under the operator and pluginBarmanCloud sections) values, which automatically sets the *.resources (under the operator and pluginBarmanCloud sections) section according to different presets. Check these presets in the bitnami/common chart⁠. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation⁠.

⁠ Backup and restore

The Bitnami CloudNativePG chart includes the plugin-barman-cloud⁠ for performing backup operations. This is enabled by setting pluginBarmanCloud.enabled=true:

pluginBarmanCloud:
  enabled: true

Check the upstream plugin-barman-cloud⁠ on how to deploy BarmanObjectStore objects and enabling backup operations.

⁠ Prometheus metrics

This chart can be integrated with Prometheus by setting *.metrics.enabled (under the operator and pluginBarmanCloud sections) to true. This will expose the cloudnative-pg native Prometheus endpoint in a metrics service, which can be configured under the *.metrics.service (under the operator and pluginBarmanCloud sections) section. It will have the necessary annotations to be automatically scraped by Prometheus.

For the PostgreSQL instances themselves, the chart deploys a monitoring queries ConfigMap or Secret with basic queries. These can be configured under the operator.metrics.monitoringQueries section.

⁠Prometheus requirements

It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart⁠ or the Bitnami Kube Prometheus helm chart⁠ to easily have a working Prometheus in your cluster.

⁠Integration with Prometheus Operator

The chart can deploy ServiceMonitor objects for integration with Prometheus Operator installations. To do so, set the value *.metrics.serviceMonitor.enabled=true (under the operator and pluginBarmanCloud sections). Ensure that the Prometheus Operator CustomResourceDefinitions are installed in the cluster or it will fail with the following error:

no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

Install the Bitnami Kube Prometheus helm chart⁠ for having the necessary CRDs and the Prometheus Operator.

⁠ Rolling VS Immutable tags⁠

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

⁠ Additional environment variables

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property inside the operator and pluginBarmanCloud sections:

operator:
  extraEnvVars:
    - name: LOG_LEVEL
      value: error

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values inside the operator and pluginBarmanCloud sections.

⁠ Sidecars

If additional containers are needed in the same pod as cloudnative-pg (such as additional metrics or logging exporters), they can be defined using the sidecars parameter inside the operator and pluginBarmanCloud sections:

operator:
  sidecars:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
    - name: portname
      containerPort: 1234

If these sidecars export extra ports, extra port definitions can be added using the *.service.extraPorts parameter (where available), as shown in the example below:

operator:
  service:
    extraPorts:
    - name: extraPort
      port: 11311
      targetPort: 11311

If additional init containers are needed in the same pod, they can be defined using the initContainers parameter inside the operator and pluginBarmanCloud sections. Here is an example:

initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

Learn more about sidecar containers⁠ and init containers⁠.

⁠ Deploying extra resources

Apart from the Operator, you may want to deploy PostgreSQL Cluster, ImageCatalog or other operator objects. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy parameter. The following example would creates a PostgreSQL Cluster object with a secret containing the credentials of a role:

extraDeploy:
- apiVersion: v1
  kind: Secret
  metadata:
    name: my-cluster-example-user
    labels:
      cnpg.io/reload: "true"
  type: kubernetes.io/basic-auth
  stringData:
    username: my_user
    password: bitnami1234
- apiVersion: postgresql.cnpg.io/v1
  kind: Cluster
  metadata:
    name: my-cluster-example
  spec:
    instances: 3
    storage:
      size: 1Gi
    managed:
      roles:
        - name: my_user
          ensure: present
          comment: MY User
          login: true
          superuser: true
          passwordSecret:
            name: my-cluster-example-user

Check the CloudNativePG official documentation⁠ for the list of available objects.

⁠ Pod affinity

This chart allows you to set your custom affinity using the affinity parameter inside the operator and pluginBarmanCloud sections. Find more information about Pod affinity in the kubernetes documentation⁠.

As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common⁠ chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters inside the operator and pluginBarmanCloud sections.

⁠ FIPS parameters

The FIPS parameters only have effect if you are using images from the Bitnami Secure Images catalog⁠.

For more information on this new support, please refer to the FIPS Compliance section⁠.

⁠ Parameters

The following subsections list global, common, and component-specific parameters.

⁠ Global parameters

⁠ Common parameters

⁠ cloudnative-pg operator parameters

Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://techdocs.broadcom.com/us/en/vmware-tanzu/bitnami-secure-images/bitnami-secure-images/services/bsi-app-doc/apps-charts-cloudnative-pg-index.html⁠