README.md

PostgreSQL

A Helm chart for PostgreSQL on Kubernetes

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.repository	string	"postgres"	Image name
image.tag	string	""	Image tag
imagePullSecrets	list	[]	Image pull secrets
livenessProbe	object	see values.yaml	Liveness probe configuration
readinessProbe	object	see values.yaml	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	[]

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)

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.requestedSize	string	nil	Size for new PVC, when no existing PVC is used
storage.className	string	nil	Storage class name

PostgreSQL parameters

Key	Type	Default	Description
customConfig	string	nil	Optional custom configuration block that will be mounted as file in /etc/postgresql/postgresql.conf
settings.authMethod	string	"md5"	Postgres database authentication method
settings.initDbArgs	string	nil	Optional init database arguments
settings.superuserPassword	string	nil	Password of superuser (Random value if not specified)
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 (Random value if not specified)