-
Notifications
You must be signed in to change notification settings - Fork 892
docs: add steps for postgres server verification #12072
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Configure Coder to connect to PostgreSQL using SSL | ||
|
|
||
| <div> | ||
| <a href="https://github.com/ericpaulsen" style="text-decoration: none; color: inherit;"> | ||
| <span style="vertical-align:middle;">Eric Paulsen</span> | ||
| <img src="https://github.com/ericpaulsen.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/> | ||
| </a> | ||
| </div> | ||
| February 24, 2024 | ||
|
|
||
| --- | ||
|
|
||
| Your organization may require connecting to the database instance over SSL. To | ||
| supply Coder with the appropriate certificates, and have it connect over SSL, | ||
| follow the steps below: | ||
|
|
||
| ## Client verification (server verifies the client) | ||
|
|
||
| 1. Create the certificate as a secret in your Kubernetes cluster, if not already | ||
| present: | ||
|
|
||
| ```shell | ||
| kubectl create secret tls postgres-certs -n coder --key="postgres.key" --cert="postgres.crt" | ||
| ``` | ||
|
|
||
| 1. Define the secret volume and volumeMounts in the Helm chart: | ||
|
|
||
| ```yaml | ||
| coder: | ||
| volumes: | ||
| - name: "pg-certs-mount" | ||
| secret: | ||
| secretName: "postgres-certs" | ||
| volumeMounts: | ||
| - name: "pg-certs-mount" | ||
| mountPath: "$HOME/.postgresql" | ||
| readOnly: true | ||
| ``` | ||
|
|
||
| 1. Lastly, your PG connection URL will look like: | ||
|
|
||
| ```shell | ||
| postgres://<user>:<password>@databasehost:<port>/<db-name>?sslmode=require&sslcert="$HOME/.postgresql/postgres.crt&sslkey=$HOME/.postgresql/postgres.key" | ||
| ``` | ||
|
|
||
| ## Server verification (client verifies the server) | ||
|
|
||
| 1. Download the CA certificate chain for your database instance, and create it | ||
| as a secret in your Kubernetes cluster, if not already present: | ||
|
|
||
| ```shell | ||
| kubectl create secret tls postgres-certs -n coder --key="postgres-root.key" --cert="postgres-root.crt" | ||
| ``` | ||
|
|
||
| 1. Define the secret volume and volumeMounts in the Helm chart: | ||
|
|
||
| ```yaml | ||
| coder: | ||
| volumes: | ||
| - name: "pg-certs-mount" | ||
| secret: | ||
| secretName: "postgres-certs" | ||
| volumeMounts: | ||
| - name: "pg-certs-mount" | ||
| mountPath: "$HOME/.postgresql/postgres-root.crt" | ||
| readOnly: true | ||
| ``` | ||
|
|
||
| 1. Lastly, your PG connection URL will look like: | ||
|
|
||
| ```shell | ||
| postgres://<user>:<password>@databasehost:<port>/<db-name>?sslmode=verify-full&sslrootcert="/home/coder/.postgresql/postgres-root.crt" | ||
| ``` | ||
|
|
||
| > More information on connecting to PostgreSQL databases using certificates can | ||
| > be found | ||
| > [here](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-CLIENTCERT). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
@ericpaulsen, as this PG verification step is common to all installation methods, should it be refactored to a new section (advanced install)? It does not fit here in K8s.
Also, We should probably create a generic guide on creating a k8s secret and mounting it as a volume in the k8s pod and then refer to it within docs whenever we discuss mounting any k8s secrets.
cc: @coder/pms
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.
@matifali i agree - i can move this to a guide.