Skip to content

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

Merged
agustincelentano merged 1 commit intomainfrom
docs/cluster-prerequisites
Apr 22, 2026
Merged

docs: document cluster prerequisites (default StorageClass + CSI driver)#3
agustincelentano merged 1 commit intomainfrom
docs/cluster-prerequisites

Conversation

@agustincelentano
Copy link
Copy Markdown
Contributor

Summary

Add a Cluster Prerequisites section to the README listing the 3 cluster-level requirements needed for this service to work:

  • A default StorageClass
  • A running CSI driver backing it
  • Agent RBAC for ConfigMap/Secret/Pod + Helm installs in the postgres-db namespace

Motivation

When registering this service on a fresh EKS cluster with no default StorageClass (or no CSI driver), the postgres pod silently stays Pending forever and every create-postgres-db / create-database-user action fails without an obvious error. The troubleshooting table already mentions "PVC availability" but doesn't point users at the root cause up front.

Test plan

  • README renders correctly on GitHub preview

@agustincelentano agustincelentano merged commit baa8fb6 into main Apr 22, 2026
1 check passed
@agustincelentano agustincelentano deleted the docs/cluster-prerequisites branch April 22, 2026 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant