Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
EdwardAngert merged 4 commits intomainfromfix-postgres-url-docs
Jul 8, 2025

Conversation

blink-so[bot]
Copy link
Contributor

@blink-soblink-sobot commentedJul 4, 2025
edited
Loading

Fixes#18751

Usepostgresql as the Helm release name instead ofcoder-db to make the service name more intuitive and eliminate confusion entirely.

Changes

  • Changedhelm install coder-db bitnami/postgresql tohelm install postgresql bitnami/postgresql
  • Updated PostgreSQL URLs fromcoder-db-postgresql.coder.svc.cluster.local topostgresql.coder.svc.cluster.local
  • Removed explanatory notes about service naming (no longer needed)

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

  • Verified thathelm install postgresql bitnami/postgresql creates service namedpostgresql
  • Confirmed this approach works with the connection URLpostgresql.coder.svc.cluster.local

Suggested by@EdwardAngert as a cleaner solution than explaining the service naming dependency.

The PostgreSQL service name depends on the Helm release name used duringinstallation. Added notes to clarify that users need to adjust the servicename in the connection URL based on their actual release name.Fixes#18751Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
@EdwardAngertEdwardAngert added the docsArea: coder.com/docs labelJul 7, 2025
@EdwardAngert
Copy link
Contributor

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

blink-so[bot] reacted with thumbs up emoji

@ericpaulsen
Copy link
Member

@EdwardAngert - i think the simpler fix here is to set the URL as

postgres://coder:coder@coder-db.coder.svc.cluster.local:5432/coder?sslmode=disable

thoughts?

@blink-soblink.so
Copy link
ContributorAuthor

blink-sobot commentedJul 8, 2025

Hi@ericpaulsen! I tested this earlier and when usinghelm install coder-db bitnami/postgresql, the Bitnami chart creates a service namedcoder-db-postgresql, notcoder-db.

Here's what I verified:

  • helm install coder-db bitnami/postgresql → Service:coder-db-postgresql
  • helm install postgresql bitnami/postgresql → Service:postgresql

The service naming follows the pattern{release-name}-postgresql (unless the release name already contains "postgresql").

Are you thinking of a different approach, or did you find thatcoder-db service exists in addition tocoder-db-postgresql? I'd be happy to test any specific scenario you have in mind!

@EdwardAngert
Copy link
Contributor

EdwardAngert commentedJul 8, 2025
edited
Loading

@ericpaulsen

@EdwardAngert - i think the simpler fix here is to set the URL as

postgres://coder:coder@coder-db.coder.svc.cluster.local:5432/coder?sslmode=disable

thoughts?

I'm super unfamiliar with kubernetes and helm, so I defer to you and@sharkymark.

If all we need to do is removecoder-db from the examples to make it work both as a proof-of-concept and for use cases like@sharkymark's (CI?) then I prefer more universally applicable examples--my goal is to make the examples in the docs work without too much modification, regardless of what docs examples the user started with and goes on to.

so

L47:

- helm install coder-db bitnami/postgresql \+ helm install postgresql bitnami/postgresql \

L58:

- postgres://coder:coder@coder-db-postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable+ postgres://coder:coder@postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable

LL80-81:

kubectl create secret generic coder-db-url -n coder \-  --from-literal=url="postgres://coder:coder@coder-db-postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable"+  --from-literal=url="postgres://coder:coder@postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable"

would that work?

blink-so[bot] reacted with thumbs up emoji

@blink-soblink.so
Copy link
ContributorAuthor

blink-sobot commentedJul 8, 2025

That's a great approach@EdwardAngert! Usingpostgresql as the release name is indeed more universal and simpler. It eliminates the confusion entirely by making the service name match the most intuitive expectation.

Your suggested changes would:
✅ Make the examples work out-of-the-box for most users
✅ Eliminate the need for explanatory notes about service naming
✅ Use the most straightforward release name

I'll update the PR to implement these changes instead of the current approach. This is definitely cleaner!

EdwardAngert reacted with eyes emoji

Use 'postgresql' as the Helm release name instead of 'coder-db' to makethe 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 namingSuggested-by: EdwardAngert <edward@coder.com>Fixes#18751Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
@blink-soblink-sobot changed the titledocs: clarify PostgreSQL service naming in Kubernetes installationdocs: simplify PostgreSQL setup by using 'postgresql' as release nameJul 8, 2025
@blink-soblink.so
Copy link
ContributorAuthor

blink-sobot commentedJul 8, 2025

Changes implemented!

I've updated the PR to implement@EdwardAngert's suggested approach:

Changes made:

  • helm install coder-db bitnami/postgresqlhelm install postgresql bitnami/postgresql
  • coder-db-postgresql.coder.svc.cluster.localpostgresql.coder.svc.cluster.local
  • Removed all explanatory notes (no longer needed)

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! 🎉

Copy link
Member

@matifalimatifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM.

@blink-soblink.so
Copy link
ContributorAuthor

blink-sobot commentedJul 8, 2025

Thanks for the review@matifali! 🙏

blink-so[bot] reacted with hooray emoji

@EdwardAngertEdwardAngert merged commit39ed0c3 intomainJul 8, 2025
34 checks passed
@EdwardAngertEdwardAngert deleted the fix-postgres-url-docs branchJuly 8, 2025 17:20
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsJul 8, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@matifalimatifalimatifali approved these changes

@bpmctbpmctAwaiting requested review from bpmct

@stirbystirbyAwaiting requested review from stirby

@ericpaulsenericpaulsenAwaiting requested review from ericpaulsen

Assignees

@EdwardAngertEdwardAngert

Labels
docsArea: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: inaccurate in-cluster Postgres URL
3 participants
@EdwardAngert@ericpaulsen@matifali

[8]ページ先頭

©2009-2025 Movatter.jp