PostgreSQL Operator

A Carvel package for CloudNativePG, a Kubernetes operator that covers the full lifecycle of a PostgreSQL database cluster with a primary/standby architecture, using native streaming replication.

🚀  Getting Started

Prerequisites

• Kubernetes 1.33+

• Carvel kctrl CLI.

• Carvel kapp-controller deployed in your Kubernetes cluster. You can install it with Carvel kapp (recommended choice) or kubectl.

  kapp deploy -a kapp-controller -y \
    -f https://github.com/carvel-dev/kapp-controller/releases/latest/download/release.yml

Installation

Add the Kadras package repository to your Kubernetes cluster:

kctrl package repository add -r kadras-packages \
  --url ghcr.io/kadras-io/kadras-packages \
  -n kadras-system --create-namespace

Installation without package repository

The recommended way of installing the PostgreSQL Operator package is via the Kadras package repository. If you prefer not using the repository, you can add the package definition directly using kapp or kubectl.

kubectl create namespace kadras-system
kapp deploy -a postgresql-operator-package -n kadras-system -y \
  -f https://github.com/kadras-io/package-for-postgresql-operator/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/package-for-postgresql-operator/releases/latest/download/package.yml

Install the PostgreSQL Operator package:

kctrl package install -i postgresql-operator \
  -p postgresql-operator.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-system

Note You can find the ${VERSION} value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.

kctrl package available list -p postgresql-operator.packages.kadras.io -n kadras-system

Verify the installed packages and their status:

kctrl package installed list -n kadras-system

📙  Documentation

Documentation, tutorials and examples for this package are available in the docs folder. For documentation specific to CloudNativePG, check out cloudnative-pg.io/docs.

🎯  Configuration

The PostgreSQL Operator package can be customized via a values.yml file.

prometheus:
  enabled: true

Reference the values.yml file from the kctrl command when installing or upgrading the package.

kctrl package install -i postgresql-operator \
  -p postgresql-operator.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-system \
  --values-file values.yml

Values

The PostgreSQL Operator package has the following configurable properties.

Configurable properties

Settings for Prometheus metrics.

Config	Default	Description
prometheus.enabled	true	Whether to enable Prometheus annotations for automatic scraping of PostgreSQL Operator metrics.

🛡️  Security

The security process for reporting vulnerabilities is described in SECURITY.md.

🖊️  License

This project is licensed under the Apache License 2.0. See LICENSE for more information.