README.md

PostgreSQL

Changelog

see RELEASENOTES.md

A Helm chart for PostgreSQL on Kubernetes

⚠️ Warning

There is no automatic database upgrade from PostgreSQL 13.x (Chart version 0.2.x) to PostgreSQL 14.x (Chart version 0.3.x) or Postgres 14.x to Postgres 15.x (Chart version 0.4.x) and upgrade deployment will fail in case of a major version change.

TL;DR

helm repo add groundhog2k https://groundhog2k.github.io/helm-charts/
helm install my-release groundhog2k/postgres

Introduction

This chart uses the original PostgreSQL image from Docker Hub to deploy a stateful PostgreSQL instance in a Kubernetes cluster.

It fully supports deployment of the multi-architecture docker image.

Prerequisites

• Kubernetes 1.12+
• Helm 3.x
• PV provisioner support in the underlying infrastructure

Installing the Chart

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

helm install my-release groundhog2k/postgres

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm uninstall my-release

Common parameters

Key	Type	Default	Description
fullnameOverride	string	""	Fully override the deployment name
nameOverride	string	""	Partially override the deployment name

Deployment parameters

Key	Type	Default	Description
image.pullPolicy	string	"IfNotPresent"	Image pull policy
image.registry	string	"docker.io"	Image registry
image.repository	string	"postgres"	Image name
image.tag	string	""	Image tag
imagePullSecrets	list	[]	Image pull secrets
extraInitContainers	list	[]	Extra init containers
extaContainers	list	[]	Extra containers for usage as sidecars
startupProbe	object	see values.yaml	Startup probe configuration
livenessProbe	object	see values.yaml	Liveness probe configuration
readinessProbe	object	see values.yaml	Readiness probe configuration
customStartupProbe	object	{}	Custom startup probe (overwrites default startup probe configuration)
customLivenessProbe	object	{}	Custom liveness probe (overwrites default liveness probe configuration)
customReadinessProbe	object	{}	Custom readiness probe (overwrites default readiness probe configuration)
resources	object	{}	Resource limits and requests
nodeSelector	object	{}	Deployment node selector
podAnnotations	object	{}	Additional pod annotations
podSecurityContext	object	see values.yaml	Pod security context
securityContext	object	see values.yaml	Container security context
env	list	[]	Additional container environmment variables
args	list	[]	Arguments for the container entrypoint process
serviceAccount.annotations	object	{}	Additional service account annotations
serviceAccount.create	bool	false	Enable service account creation
serviceAccount.name	string	""	Name of the service account
affinity	object	{}
tolerations	list	[]
podManagementPolicy	string	"OrderedReady"	Pod management policy
updateStrategyType	string	"RollingUpdate"	Pod update strategy
revisionHistoryLimit	int	nil	Maximum number of revisions maintained in revision history

Service paramters

Key	Type	Default	Description
service.type	string	"ClusterIP"	Service type
service.port	int	5432	PostreSQL service port
service.nodePort	int	nil	The node port (only relevant for type LoadBalancer or NodePort)
service.clusterIP	string	nil	The cluster ip address (only relevant for type LoadBalancer or NodePort)
service.loadBalancerIP	string	nil	The load balancer ip address (only relevant for type LoadBalancer)
service.annotations	object	{}	Additional service annotations

Storage parameters

Key	Type	Default	Description
storage.accessModes[0]	string	"ReadWriteOnce"	Storage access mode
storage.persistentVolumeClaimName	string	nil	PVC name when existing storage volume should be used
storage.volumeName	string	"postgres-data"	Internal volume name and prefix of a created PVC
storage.requestedSize	string	nil	Size for new PVC, when no existing PVC is used
storage.className	string	nil	Storage class name
storage.keepPvc	bool	false	Keep a created Persistent volume claim when uninstalling the helm chart (only for option useDeployment: true)

PostgreSQL parameters

Key	Type	Default	Description
useDeployment	bool	false	Use Kubernetes Deployment instead of StatefulSet
settings.authMethod	string	nil	Postgres database authentication method
settings.initDbArgs	string	nil	Optional init database arguments
settings.superuser	string	nil	Superuser name
settings.superuserPassword	string	nil	Password of superuser
userDatabase	object	{}	Optional PostgreSQL user database
userDatabase.name	string	nil	Name of the user database
userDatabase.user	string	nil	User name with full access to user database
userDatabase.password	string	nil	Password of created user
customConfig	string	nil	Optional custom configuration block that will be mounted as file in /etc/postgresql/postgresql.conf
extraEnvSecrets	list	[]	A list of existing secrets that will be mounted into the container as environment variables
extraSecretConfigs	string	nil	An existing secret with files that will be added to the postgres configuration in addition to /etc/postgresql/postgresql.conf
customScripts	object	nil	Optional custom scripts that can be defined inline and will be mounted as files in /docker-entrypoint-initdb.d
extraScripts	string	nil	An existing configMap with files that will be mounted into the container as script files (*.sql, *.sh) in /docker-entrypoint-initdb.d
extraSecrets	list	[]	A list of additional existing secrets that will be mounted into the container
extraSecrets[].name	string	nil	Name of the existing K8s secret
extraSecrets[].mountPath	string	nil	Mount path where the secret should be mounted into the container (f.e. /mysecretfolder)