Skip to content

Commit c50e6c3

Browse files
committed
add TLS config keys to the README
1 parent 0a6663c commit c50e6c3

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

charts/clickhouse/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,30 @@ EOSQL
205205
| clickhouse.settings | object | `{}` | |
206206
| clickhouse.shardsCount | int | `1` | number of shards. |
207207
| clickhouse.users | list | `[]` | Configure additional ClickHouse users and per-user settings. |
208+
| clickhouse.tls | object | | TLS certificate configuration for HTTPS/TLS connections. See [examples/values-tls.yaml](examples/values-tls.yaml) for a concrete example. |
209+
| clickhouse.tls.enabled | bool | `false` | Enable TLS. When true, adds `https_port` and `tcp_port_secure` to ClickHouse settings and exposes secure ports on Service resources. Requires `clickhouse.extraPorts` to declare the corresponding container ports on the pod template. |
210+
| clickhouse.tls.httpsPort | int | `8443` | HTTPS port for secure HTTP connections. |
211+
| clickhouse.tls.secureTcpPort | int | `9440` | Secure native TCP port for encrypted client connections. |
212+
| clickhouse.tls.certificateFile | object | | Server X509 certificate file. Requires `configFileName` and exactly one of `inlineFileContent` or `secretReference`. |
213+
| clickhouse.tls.certificateFile.configFileName | string | | Part of the destination filepath within the ClickHouse pod. Inline content is placed under `config.d/`; secret reference is placed under `secrets.d/`. See [here](https://github.com/Altinity/clickhouse-operator/blob/release-0.25.6/docs/security_hardening.md?plain=1#L428-L429) for the exact filepath format. |
214+
| clickhouse.tls.certificateFile.inlineFileContent | string | | Certificate content embedded directly in the CHI spec. Mutually exclusive with `secretReference`. |
215+
| clickhouse.tls.certificateFile.secretReference | object | | Reference to a Kubernetes secret containing the certificate. Mutually exclusive with `inlineFileContent`. |
216+
| clickhouse.tls.certificateFile.secretReference.name | string | | Name of the Kubernetes secret. |
217+
| clickhouse.tls.certificateFile.secretReference.key | string | | Key within the secret that holds the certificate data. |
218+
| clickhouse.tls.privateKeyFile | object | | Private key file. Same structure as `certificateFile`. |
219+
| clickhouse.tls.privateKeyFile.configFileName | string | | See `certificateFile.configFileName`. |
220+
| clickhouse.tls.privateKeyFile.inlineFileContent | string | | See `certificateFile.inlineFileContent`. |
221+
| clickhouse.tls.privateKeyFile.secretReference | object | | See `certificateFile.secretReference`. |
222+
| clickhouse.tls.privateKeyFile.secretReference.name | string | | See `certificateFile.secretReference.name`. |
223+
| clickhouse.tls.privateKeyFile.secretReference.key | string | | See `certificateFile.secretReference.key`. |
224+
| clickhouse.tls.dhParamsFile | object | | Diffie-Hellman parameters file. Same structure as `certificateFile`. |
225+
| clickhouse.tls.dhParamsFile.configFileName | string | | See `certificateFile.configFileName`. |
226+
| clickhouse.tls.dhParamsFile.inlineFileContent | string | | See `certificateFile.inlineFileContent`. |
227+
| clickhouse.tls.dhParamsFile.secretReference | object | | See `certificateFile.secretReference`. |
228+
| clickhouse.tls.dhParamsFile.secretReference.name | string | | See `certificateFile.secretReference.name`. |
229+
| clickhouse.tls.dhParamsFile.secretReference.key | string | | See `certificateFile.secretReference.key`. |
230+
| clickhouse.tls.opensslConfig | string | | OpenSSL configuration XML rendered as `openssl.xml` in the ClickHouse pod. Must include the full `<clickhouse><openSSL><server>` structure with file paths matching your certificate, key, and DH params locations. See [here](https://docs.altinity.com/operationsguide/security/#generate-files) for another sample of the full structure. |
231+
| clickhouse.users | list | `[]` | Configure additional ClickHouse users. |
208232
| clickhouse.zones | list | `[]` | |
209233
| keeper.enabled | bool | `false` | Whether to enable Keeper. Required for replicated tables. |
210234
| keeper.image | string | `"altinity/clickhouse-keeper"` | |

0 commit comments

Comments
 (0)