Skip to content

feat: connecting an external postgres #302

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

Merged
merged 5 commits into from
Apr 30, 2021
Merged

Conversation

ericpaulsen
Copy link
Member

adding docs for hooking up an external (to the cluster) postgres, as it is our recommended approach for production Coder deployments.

this is intended as an MVP, as I expect us to iterate on this as we continue to get customer feedback. open to thoughts & suggestions.

@ericpaulsen ericpaulsen added the docs 📝 Improvements or additions to documentation label Apr 23, 2021
@ericpaulsen ericpaulsen self-assigned this Apr 23, 2021
@ericpaulsen ericpaulsen requested review from mterhar and removed request for sharkymark April 23, 2021 20:06
@github-actions
Copy link
Contributor

github-actions bot commented Apr 23, 2021

✨ Coder.com for PR #302 deployed! It will be updated on every commit.

Copy link
Contributor

@sreya sreya left a comment

Choose a reason for hiding this comment

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

I'll leave others to review grammar but content-wise this seems ok. I think for this guide to be valuable it should mainly be about how to setup a Postgres instance. We already have documentation for how to reference postgres in the helm here on step 4.

Comment on lines 30 to 33
```console
kubectl create secret generic <YOUR-DB-SECRET> \
--from-literal=password=<YOUR-DATABASE-PASSWORD> \
```
Copy link
Contributor

Choose a reason for hiding this comment

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

This is fine but we should encourage people to create passwords in a way where the secret isn't recorded in your shell history. For example this is a more security-conscious way to create a secret on the cmd line

kubectl create secret generic <NAME> --from-file=test=/dev/stdin

Copy link
Member Author

Choose a reason for hiding this comment

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

I can update the sample command in Step 4.

deployments, and hosting it external to the cluster. Below are the steps to do
so:

1. Spin up a PostgreSQL instance if you have not already done so
Copy link
Contributor

Choose a reason for hiding this comment

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

This step should be the bulk of the guide. This page does not otherwise provide much beyond the existing documentation for referencing a postgres instance in the helm.

@ericpaulsen
Copy link
Member Author

I'll leave others to review grammar but content-wise this seems ok. I think for this guide to be valuable it should mainly be about how to setup a Postgres instance. We already have documentation for how to reference postgres in the helm here on step 4.

Good point - since there are many ways someone can setup a postgres, should we focus on documenting how to set up a postgres within each cloud provider?

@khorne3
Copy link
Contributor

khorne3 commented Apr 27, 2021

@ericpaulsen Do you think it makes sense to link to the tutorials instead (e.g., GKE's PostgreSQL docs)?

@ericpaulsen
Copy link
Member Author

@ericpaulsen Do you think it makes sense to link to the tutorials instead (e.g., GKE's PostgreSQL docs)?

Yes, as long as we include links for each of the 3 major cloud providers.

@ericpaulsen ericpaulsen merged commit 3122d9e into master Apr 30, 2021
@ericpaulsen ericpaulsen deleted the ericpaulsen/postgres branch April 30, 2021 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs 📝 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants