docs: tls configuration#223
Open
arekborucki wants to merge 4 commits into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Why
Right now, the Configuration guide only lists the TLS fields (spec.settings.tls: enabled, required, serverCertSecret, caBundle). It does not show how to actually turn TLS on from scratch: how to create a certificate, point the cluster at it, and connect a client over the secure ports.
This trips people up. The most common problem is the certificate's dnsNames: they have to match the headless Service the operator creates, or the client fails to connect with certificate verify failed.
This guide fills that gap and fits with the other task-based guides (Introduction, Configuration, Monitoring, Scaling).
What
Adds
docs/guides/tls.mdx- an end-to-end guide for securing a cluster with TLS: issue a certificate with cert-manager (self-signed CA -> server cert), enable TLS on the cluster, and connect a client over the secure ports.It explains what the operator does at each level:
On enabled: true: opens the secure ports 9440 (native TLS) and 8443 (HTTPS) alongside the existing ones, mounts the cert, and generates the openSSL block (verificationMode: relaxed, disableProtocols: sslv2,sslv3, preferServerCiphers: true).
On required: true: additionally drops the insecure ports 9000/8123 and switches the liveness probe to 9440.
It also covers Keeper encryption (secure port 2281, automatic TLS from the ClickHouse side once Keeper has it enabled) and a custom caBundle.