-
Notifications
You must be signed in to change notification settings - Fork 936
docs: simplify PostgreSQL setup by using 'postgresql' as release name #18754
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.
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
Conversation
The PostgreSQL service name depends on the Helm release name used during installation. Added notes to clarify that users need to adjust the service name in the connection URL based on their actual release name. Fixes #18751 Co-authored-by: matifali <[email protected]>
thanks for starting this, @matifali (and for reporting, @sharkymark! ) I tried setting up a quick (it ended up not being quick 😭 ) 3-node kubernetes cluster and ran through without errors, so I think a breakdown of the commands should be alright. @sharkymark , if this feels like an alright solution, I'll edit the copy and we can merge it |
@EdwardAngert - i think the simpler fix here is to set the URL as
thoughts? |
Hi @ericpaulsen! I tested this earlier and when using Here's what I verified:
The service naming follows the pattern Are you thinking of a different approach, or did you find that |
I'm super unfamiliar with kubernetes and helm, so I defer to you and @sharkymark. If all we need to do is remove so L47: - helm install coder-db bitnami/postgresql \
+ helm install postgresql bitnami/postgresql \ L58: - postgres://coder:[email protected]:5432/coder?sslmode=disable
+ postgres://coder:[email protected]:5432/coder?sslmode=disable kubectl create secret generic coder-db-url -n coder \
- --from-literal=url="postgres://coder:[email protected]:5432/coder?sslmode=disable"
+ --from-literal=url="postgres://coder:[email protected]:5432/coder?sslmode=disable" would that work? |
That's a great approach @EdwardAngert! Using Your suggested changes would: I'll update the PR to implement these changes instead of the current approach. This is definitely cleaner! |
Use 'postgresql' as the Helm release name instead of 'coder-db' to make the service name more intuitive and eliminate confusion. This approach: - Makes examples work out-of-the-box for most users - Uses the most straightforward release name - Eliminates need for explanatory notes about service naming Suggested-by: EdwardAngert <[email protected]> Fixes #18751 Co-authored-by: matifali <[email protected]>
✅ Changes implemented! I've updated the PR to implement @EdwardAngert's suggested approach: Changes made:
This is much cleaner and eliminates the confusion entirely. The examples now work out-of-the-box with the most intuitive service name. Thanks for the great suggestion! 🎉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Thanks for the review @matifali! 🙏 |
Fixes #18751
Use
postgresql
as the Helm release name instead ofcoder-db
to make the service name more intuitive and eliminate confusion entirely.Changes
helm install coder-db bitnami/postgresql
tohelm install postgresql bitnami/postgresql
coder-db-postgresql.coder.svc.cluster.local
topostgresql.coder.svc.cluster.local
Benefits
✅ Makes examples work out-of-the-box for most users
✅ Uses the most straightforward and intuitive release name
✅ Eliminates confusion about service naming entirely
✅ Simpler documentation without complex explanations
Testing
helm install postgresql bitnami/postgresql
creates service namedpostgresql
postgresql.coder.svc.cluster.local
Suggested by @EdwardAngert as a cleaner solution than explaining the service naming dependency.