From b358b73431dc79fdefdcd5ba92f6a66cc950ba55 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 27 May 2026 18:02:32 +0000 Subject: [PATCH] docs: sync upstream clickhouse-operator AdditionalPort API reference --- .../reference/api-reference.mdx | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/products/kubernetes-operator/reference/api-reference.mdx b/products/kubernetes-operator/reference/api-reference.mdx index 43e59de8..2872ead1 100644 --- a/products/kubernetes-operator/reference/api-reference.mdx +++ b/products/kubernetes-operator/reference/api-reference.mdx @@ -8,9 +8,20 @@ doc_type: 'reference' sidebarTitle: 'API reference' --- - This document provides detailed API reference for the ClickHouse Operator custom resources. +## AdditionalPort {#additionalport} + +AdditionalPort declares one extra TCP port to expose on the ClickHouse Pod and the operator-managed headless Service. + +| Field | Type | Description | Required | Default | +|-------|------|-------------|----------|---------| +| `name` | string | Name uniquely identifies the port within the list. Used as both the container port name and the Service port name.
This must be a DNS_LABEL. | true | | +| `port` | integer | Port is the TCP port number to expose. | true | | + +Appears in: +- [ClickHouseClusterSpec](#clickhouseclusterspec) + ## ClickHouseCluster {#clickhousecluster} ClickHouseCluster is the Schema for the `clickhouseclusters` API. @@ -65,6 +76,7 @@ ClickHouseClusterSpec defines the desired state of ClickHouseCluster. | `upgradeChannel` | string | UpgradeChannel specifies the release channel for major version upgrade checks.
When empty, only minor updates will be proposed. Allowed values are: stable, lts or specific major.minor version (e.g. 25.8). | false | | | `versionProbeTemplate` | [VersionProbeTemplate](#versionprobetemplate) | VersionProbeTemplate overrides for the version detection Job. | false | | | `externalSecret` | [ExternalSecret](#externalsecret) | ExternalSecret is an optional reference to an externally-managed Secret containing cluster secrets.
The secret must reside in the same namespace as the cluster. | false | | +| `additionalPorts` | [AdditionalPort](#additionalport) array | AdditionalPorts declares extra TCP ports to expose on the ClickHouse Pod and the operator-managed headless Service.
The operator only adds the ports to the Kubernetes resources, it does not configure the ClickHouse server to listen on them. | false | | Appears in: - [ClickHouseCluster](#clickhousecluster)