Skip to content

docs: document cluster prerequisites (default StorageClass + CSI driver) #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agustincelentano merged 1 commit into from
Apr 22, 2026
+8 −0
Merged

docs: document cluster prerequisites (default StorageClass + CSI driver) #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ This repository packages the full lifecycle of a PostgreSQL database as a nullpl
| Category | Database / Relational |
| Helm chart | `bitnami/postgresql` |

## Cluster Prerequisites

The Kubernetes cluster where this service runs must have:

- A **default `StorageClass`** — the chart requests a `PersistentVolumeClaim` without specifying `storageClassName`. Without a default, the postgres pod will stay `Pending` forever.
- A **running CSI driver** backing that StorageClass, with IAM permissions to create volumes in your cloud. Managed Kubernetes offerings don't all ship one by default (notably AWS EKS requires the `aws-ebs-csi-driver` addon).
- An **nullplatform agent** with RBAC to create `ConfigMap`, `Secret` and `Pod` resources in the `postgres-db` namespace, and to install Helm releases there (the standard agent chart already grants these).

## Architecture

```
Expand Down