Skip to main content
This document provides detailed API reference for the ClickHouse Operator custom resources.

AdditionalPort

AdditionalPort declares one extra TCP port to expose on the ClickHouse Pod and the operator-managed headless Service. Appears in:

CABundleSelector

CABundleSelector selects a key holding a CA bundle from a Secret in the cluster’s namespace. Appears in:

ClickHouseCluster

ClickHouseCluster is the Schema for the clickhouseclusters API.

API Version and Kind

Appears in:

ClickHouseClusterList

ClickHouseClusterList contains a list of ClickHouseCluster.

API Version and Kind

ClickHouseClusterSpec

ClickHouseClusterSpec defines the desired state of ClickHouseCluster. Appears in:

ClickHouseClusterStatus

ClickHouseClusterStatus defines the observed state of ClickHouseCluster. Appears in:

ClickHouseSettings

ClickHouseSettings defines ClickHouse server settings options. Appears in:

ClusterTLSSpec

ClusterTLSSpec defines cluster TLS configuration. Appears in:

ConfigMapKeySelector

ConfigMapKeySelector selects a key of a ConfigMap. Appears in:

ContainerImage

ContainerImage defines a container image with repository, tag or hash. Appears in:

ContainerTemplateSpec

ContainerTemplateSpec describes the container configuration overrides for the cluster’s containers. Appears in:

DefaultPasswordSelector

DefaultPasswordSelector selects the source for the default user’s password. Appears in:

ExternalSecret

ExternalSecret is a reference to a Secret in the same namespace. Appears in:

ExternalSecretPolicy

ExternalSecretPolicy controls how the operator treats the external secret’s content. Appears in:

KeeperCluster

KeeperCluster is the Schema for the keeperclusters API.

API Version and Kind

Appears in:

KeeperClusterList

KeeperClusterList contains a list of KeeperCluster.

API Version and Kind

KeeperClusterReference

KeeperClusterReference identifies the KeeperCluster used by a ClickHouseCluster. Appears in:

KeeperClusterSpec

KeeperClusterSpec defines the desired state of KeeperCluster. Appears in:

KeeperClusterStatus

KeeperClusterStatus defines the observed state of KeeperCluster. Appears in:

KeeperSettings

KeeperSettings defines ClickHouse Keeper server configuration. Appears in:

LoggerConfig

LoggerConfig defines server logging configuration. Appears in:

NamedTemplateMeta

NamedTemplateMeta defines supported metadata settings for template objects that require a name. Appears in:

PDBPolicy

PDBPolicy controls whether PodDisruptionBudgets are created. Appears in:

PersistentVolumeClaimTemplate

PersistentVolumeClaimTemplate is a named template for a per-replica PersistentVolumeClaim. Appears in:

PodDisruptionBudgetSpec

PodDisruptionBudgetSpec configures the PDB created for the cluster. Exactly one of MinAvailable or MaxUnavailable may be set. When neither is set, the operator picks a safe default based on replica count. Appears in:

PodTemplateSpec

PodTemplateSpec describes the pod configuration overrides for the cluster’s pods. Appears in:

SecretKeySelector

SecretKeySelector selects a key of a Secret. Appears in:

TemplateMeta

TemplateMeta defines supported metadata settings for template objects. Appears in:

VersionProbeContainer

VersionProbeContainer defines container-level overrides for the version probe. Field names and JSON tags match corev1.Container so that SMP merges by name. Appears in:

VersionProbeJobSpec

VersionProbeJobSpec defines Job-level overrides for the version probe. Appears in:

VersionProbePodSpec

VersionProbePodSpec defines Pod-level overrides for the version probe. Field names and JSON tags match corev1.PodSpec for strategic merge patch compatibility. Appears in:

VersionProbePodTemplate

VersionProbePodTemplate describes overrides for the version probe Pod. Appears in:

VersionProbeTemplate

VersionProbeTemplate defines overrides for the version detection Job. The structure mirrors batchv1.JobTemplateSpec, exposing only supported fields. Appears in:
Last modified on July 2, 2026