mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-31 13:59:04 +00:00
e853c19868
* chore(deps): update helm chart common to v2.2.0 * Remove node taints * [CI] Remove taints * docs: update helm-docs * Update README.md * fix: bump non-common charts by patch * fix: update whoogle to new common version Co-authored-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: ᗪєνιη ᗷυнʟ <onedr0p@users.noreply.github.com> Co-authored-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev> Co-authored-by: Devin Buhl <devin.kray@gmail.com>
142 lines
6.5 KiB
Markdown
142 lines
6.5 KiB
Markdown
# zalando-postgres-cluster
|
|
|
|
 
|
|
|
|
Creates a postgres cluster using the Zalando Postgres operator and local storage
|
|
|
|
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
|
|
## Source Code
|
|
|
|
* <https://github.com/zalando/postgres-operator>
|
|
|
|
## Requirements
|
|
|
|
## Dependencies
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| https://library-charts.k8s-at-home.com | common | 2.2.0 |
|
|
|
|
## TL;DR
|
|
|
|
```console
|
|
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
helm repo update
|
|
helm install zalando-postgres-cluster k8s-at-home/zalando-postgres-cluster
|
|
```
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `zalando-postgres-cluster`
|
|
|
|
```console
|
|
helm install zalando-postgres-cluster k8s-at-home/zalando-postgres-cluster
|
|
```
|
|
|
|
## Uninstalling the Chart
|
|
|
|
To uninstall the `zalando-postgres-cluster` deployment
|
|
|
|
```console
|
|
helm uninstall zalando-postgres-cluster
|
|
```
|
|
|
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
|
|
## Configuration
|
|
|
|
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
|
|
```console
|
|
helm install zalando-postgres-cluster \
|
|
--set env.TZ="America/New York" \
|
|
k8s-at-home/zalando-postgres-cluster
|
|
```
|
|
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
|
|
```console
|
|
helm install zalando-postgres-cluster k8s-at-home/zalando-postgres-cluster -f values.yaml
|
|
```
|
|
|
|
## Custom configuration
|
|
|
|
This chart is a wrapper for the [Zalando postgres operator](https://github.com/zalando/postgres-operator) to create
|
|
a high available Postgres cluster using nodes local storage.
|
|
|
|
Features added by this wrapper:
|
|
- creates an storage class using local storage in the nodes specified in `persistentVolumes.replicaNodes`. These replicas survive
|
|
a tear-down and tear-up of the cluster.
|
|
- (optional) does sql dumps to an existing PVC with K8S cronjobs. The Operator only supports backups to cloud, not NFS PVC for example.
|
|
- Define the password for the DB so that it can be used accross tear-down and tear-up of the cluster.
|
|
|
|
## Values
|
|
|
|
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| controllerType | string | `""` | |
|
|
| dumpBackup.existingClaim | string | `nil` | |
|
|
| dumpBackup.image.pullPolicy | string | `"IfNotPresent"` | |
|
|
| dumpBackup.image.repository | string | `"postgres"` | |
|
|
| dumpBackup.image.tag | string | `"latest"` | |
|
|
| dumpBackup.resources.requests.cpu | string | `"5m"` | |
|
|
| dumpBackup.resources.requests.memory | string | `"10Mi"` | |
|
|
| dumpBackup.schedule | string | `"@daily"` | Backup schedule for postgres dumps |
|
|
| dumpBackup.subpath | string | `nil` | Persistent volume claim subpath for the backups @default: <subpathPrefix/<release-name> |
|
|
| dumpBackup.subpathPrefix | string | `"backup/db"` | Persistent volume claim subpath prefix for the backups |
|
|
| persistentVolumes.accessModes[0] | string | `"ReadWriteOnce"` | |
|
|
| persistentVolumes.annotations | object | `{}` | |
|
|
| persistentVolumes.hostPath | string | `nil` | Local path for the persistent volumes @default: <hostPathPrefix/<release-name> |
|
|
| persistentVolumes.hostPathPrefix | string | `"/run/db"` | Local prefix for persistent volumes NOTE: The default is in tempfs - you should change to a persistent place for production!!! |
|
|
| persistentVolumes.labels | object | `{}` | |
|
|
| persistentVolumes.reclaimPolicy | string | `"Retain"` | persistentVolumeReclaimPolicy for the persistent volumes Recicle will delete content once DB is deleted while Retain (default) will keep it. |
|
|
| persistentVolumes.replicaNodes | list | `["node1.example.com","node2.example.com"]` | Replica nodes Must set with at least 2 nodes for the cluster to be highly available |
|
|
| postgresql.databases | object | `{"postgres":"postgres"}` | databases to create and their user |
|
|
| postgresql.numberOfInstances | string | `nil` | Number of replicas It will be automatically set with the number of replicaNodes so any values set here are ignored. |
|
|
| postgresql.postgresql.version | string | `"13"` | Postgres version to deploy - see which versions are supported by the operator |
|
|
| postgresql.teamId | string | `nil` | team Id for the DB cluster |
|
|
| postgresql.users | object | `{"postgres":["superuser","createdb"]}` | DB users to create (see operator) |
|
|
| postgresql.volume.size | string | `"1Gi"` | Size of the persistance volume to allocate |
|
|
| postgresql.volume.storageClass | string | `nil` | Name of the storage class |
|
|
| service.enabled | bool | `false` | |
|
|
| superuser.password | string | `nil` | Superuser password |
|
|
| superuser.secret | string | `nil` | Superuser k8s secret name. It must match the patter used by the operator |
|
|
| superuser.user | string | `nil` | Superuser user used for cronjobs |
|
|
|
|
## Changelog
|
|
|
|
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/commonREADME.md#Changelog).
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
### [1.0.0]
|
|
|
|
#### Added
|
|
|
|
- N/A
|
|
|
|
#### Changed
|
|
|
|
- N/A
|
|
|
|
#### Removed
|
|
|
|
- N/A
|
|
|
|
[1.0.0]: #1.0.0
|
|
|
|
## Support
|
|
|
|
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
|
|
----------------------------------------------
|
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) |