Update docs to include PostgreSQL SSL certificate #43313
Merged
+254
−424
Conversation
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
Closes keycloak#43311 Signed-off-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
|
@ahus1 @ryanemerson, when you get a chance, please review. Thank you. |
Signed-off-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
ryanemerson
reviewed
Oct 9, 2025
| <3> Specify the URL to your custom {project_name} image. If your image is optimized, set the `startOptimized` flag to `true`. | ||
| <4> Enable additional features for multi-cluster support like the loadbalancer probe `/lb-check`. | ||
| <5> To be able to analyze the system under load, enable the metrics endpoint. | ||
| <6> Specify the `ConfigMap` name with the Amazon Aurora PostgreSQL database certificate bundle. |
| include::../examples/generated/keycloak.yaml[tag=keycloak] | ||
| ---- | ||
| <1> The database connection pool initial, max and min size should be identical to allow statement caching for the database. | ||
| <1> Secure database connection with `sslmode=verify-full` and `sslrootcert`. |
There was a problem hiding this comment.
"Secure the database connection with the sslmode=verify-full and sslrootcert properties."
docs/guides/server/db.adoc
Outdated
| Secure the connection by adding the following properties to your connection URL: | ||
| * `sslmode=verify-full`: Forces TLS and verifies the server's identity against the trusted certificate. | ||
| * `sslrootcert=/path/to/certificate`: The path to the server's public certificate file on the client machine. |
There was a problem hiding this comment.
Nitpick, but should the explanation come after the example source? Same applies to the Aurora section.
ahus1
requested changes
Oct 9, 2025
docs/guides/server/db.adoc
Outdated
| [TIP] | ||
| .Secure Your PostgreSQL Connection | ||
| ==== | ||
| To achieve the highest level of security, you must configure your PostgreSQL server to use TLS and perform full server certificate verification from the client. |
There was a problem hiding this comment.
There might be other options that some people might consider more secure, like for example mTLS. So I suggest a rephrase:
Suggested change
| To achieve the highest level of security, you must configure your PostgreSQL server to use TLS and perform full server certificate verification from the client. | |
| To secure your database connection, configure your PostgreSQL server to use TLS and perform full server certificate verification on the client side. |
docs/guides/server/db.adoc
Outdated
| [TIP] | ||
| .Secure Your Aurora PostgreSQL Connection | ||
| ==== | ||
| Amazon Aurora PostgreSQL **17.0+** enables TLS by default. |
There was a problem hiding this comment.
Suggested change
| Amazon Aurora PostgreSQL **17.0+** enables TLS by default. | |
| Amazon Aurora PostgreSQL 17.0 or later requires TLS connections by default. |
docs/guides/server/db.adoc
Outdated
| ==== | ||
| Amazon Aurora PostgreSQL **17.0+** enables TLS by default. | ||
| While this secures the connection, for the **highest level of security**, you must perform full server certificate verification. To do this: |
There was a problem hiding this comment.
Suggested change
| While this secures the connection, for the **highest level of security**, you must perform full server certificate verification. To do this: | |
| While this encrypts the connection, you must still perform a full server certificate verification. To do this, perform the following steps: |
|
@ahus1 @ryanemerson updated. Thank you |
ahus1
approved these changes
Oct 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #43311
The examples were regenerated from the Keycloak Benchmark repository.