docs(postgres): fix incorrect commands and fields found by executing the guides#951
Conversation
… stale PG functions found by executing the guides Signed-off-by: Tamal Saha <tamal@appscode.com>
…me/sts/stale outputs Signed-off-by: Tamal Saha <tamal@appscode.com>
…t reads in scaling guides Signed-off-by: Tamal Saha <tamal@appscode.com>
Signed-off-by: Tamal Saha <tamal@appscode.com>
…/secret name Signed-off-by: Tamal Saha <tamal@appscode.com>
Signed-off-by: Tamal Saha <tamal@appscode.com>
… version Signed-off-by: Tamal Saha <tamal@appscode.com>
Signed-off-by: Tamal Saha <tamal@appscode.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (18)
📝 WalkthroughWalkthroughThis PR updates KubeDB Postgres documentation and example manifests: renaming StatefulSet references to PetSet, changing auth Secret keys from POSTGRES_USER/POSTGRES_PASSWORD to username/password with kubernetes.io/basic-auth type, correcting RBAC API groups/resource names, refreshing example versions, and updating synchronous replication descriptions. ChangesPostgres documentation updates
Estimated code review effort: 2 (Simple) | ~10 minutes Sequence Diagram(s)sequenceDiagram
participant User
participant kubectl
participant Secret
User->>kubectl: get secret -o jsonpath='.data.username'
kubectl->>Secret: fetch data.username
Secret-->>kubectl: base64 username
User->>kubectl: get secret -o jsonpath='.data.password'
kubectl->>Secret: fetch data.password
Secret-->>kubectl: base64 password
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Visit the preview URL for this PR (updated for commit 1dabb9b): https://kubedb-v2-hugo--pr951-docs-refresh-postgre-nvx60wpo.web.app (expires Fri, 10 Jul 2026 15:23:53 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
Postgres docs refresher: fixes found by executing the guides
Every fix below was found by running the postgres guides on a live KubeDB cluster (v2026.6.19, PostgreSQL 18.3) and comparing real output to what the docs claim. Each was confirmed against the source of truth (apimachinery API types,
kubectl api-resources, or observed cluster behavior) and re-verified after the fix.Auth secret keys (wrong key names returned empty)
quickstart/quickstart.md,initialization/script_source.md,clustering/streaming_replication.md: the auth secret was read withPOSTGRES_USER/POSTGRES_PASSWORDkeys, which return nothing. The real keys areusername/password(secret typekubernetes.io/basic-auth, keyscore.BasicAuthUsernameKey/BasicAuthPasswordKey). Fixed the read commands, the example secret YAML, and thekubectl dba describeoutput (Type: Opaque->kubernetes.io/basic-auth).StatefulSet -> PetSet
update-version,scaling/vertical-scaling,scaling/horizontal-scaling,tls/configure,volume-expansion/standalone,volume-expansion/ha-cluster:kubectl get sts -n demo <db>returnsstatefulsets.apps "..." not found. KubeDB manages a PetSet; changedsts->petset.Clustering (streaming_replication.md)
kubedb.com/role=standby, notreplica.<db>-standby(all-pods service is<db>-pods); the doc's<db>-replicasservice does not exist. Fixed the service listing and the hot-standby connection host.select pg_last_xlog_receive_location();errors on PG18 (function removed); replaced withpg_last_wal_receive_lsn().version: "10.2"-v5->version: "18.3".Broken paths / URLs (404)
update-version:yamls/update_version.yaml->yamls/upgrade_version.yaml.scaling/horizontal-scaling: deploy path was missing/yamls/.configuration/using-config-file: thecurlURL usedraw.githubusercontent.com/.../raw/...(404); removed the extra/raw/. Thekubectl applypath pointed to a non-existentconfiguration/pg-configuration.yaml; pointed it to the realcustom-config/pg-custom-config.yamland aligned that file'ssecretNametopg-configuration.rotate-authentication
quick-postgres-user-auth-new, which does not exist. The rotated secret isquick-postgres-user-auth.custom-rbac
petsetsunder apiGroupapps; PetSets are inapps.k8s.appscode.com. Fixed the group in the doc and both example role YAMLs (which were even staler, usingstatefulsets). Also fixed theminiute-postgrestypo ->minute-postgres.Stale output that no longer matches
synchronous: default is now quorum-based (synchronous_standby_names = ANY 1 (...)); replicas reportsync_state = quorum, notsync/potential.configuration/pgtune: generated config header shows# DB Version: 18for a 18.3 database (doc said17).update-version: before/after version-verify outputs showed11.11/13.2, contradicting the guide's own 17.9 -> 18.3 flow.reconfigure/cluster: one explanatory bullet saidspec.configuration.secretNamewhile the ops YAML usesspec.configuration.configSecret.name.Verification
All fixes were re-run on the cluster and produce the documented result (readiness reached, ops requests
Successful, corrected commands return the expected values). No em-dashes were introduced. Some guides were blocked by missing cluster infrastructure (no expandable StorageClass for volume expansion, no prometheus-operator, no object storage for backup/pitr, no gitops operator, no second cluster for remote-replica) and were not modified.Summary by CodeRabbit
username/passwordkeys and basic-auth secret types.petsetwhere applicable.