跳转到主要内容
本文档提供 ClickHouse Operator 自定义资源的详细 API 参考。

AdditionalPort

AdditionalPort 声明了一个额外的 TCP 端口,用于在 ClickHouse pod (容器组) 和由 operator 管理的无头 Service 上暴露。 出现于:

CABundleSelector

CABundleSelector 用于从集群命名空间中的某个 Secret 里选择一个保存 CA bundle 的键。 出现在:

ClickHouseCluster

ClickHouseCluster 是 clickhouseclusters API 的 schema。

API 版本和 Kind

出现于:

ClickHouseClusterList

ClickHouseClusterList 包含 ClickHouseCluster 的列表。

API 版本和 Kind

ClickHouseClusterSpec

ClickHouseClusterSpec 定义了 ClickHouseCluster 的期望状态。 出现于:

ClickHouseClusterStatus

ClickHouseClusterStatus 定义了 ClickHouseCluster 的已观测状态。 出现位置:

ClickHouseSettings

ClickHouseSettings 定义 ClickHouse 服务器的设置选项。 出现于:

ClusterTLSSpec

ClusterTLSSpec 定义集群的 TLS 配置。 出现于:

ConfigMapKeySelector

ConfigMapKeySelector 用于选择 ConfigMap 中的某个键。 出现在:

ContainerImage

ContainerImage 定义了一个容器镜像,其中包含 repository、tag 或 hash。 出现在:

ContainerTemplateSpec

ContainerTemplateSpec 描述了集群中各容器的容器配置覆盖项。 出现位置:

DefaultPasswordSelector

DefaultPasswordSelector 用于选择默认用户密码的来源。 出现在:

ExternalSecret

ExternalSecret 是对同一命名空间中某个 Secret 的引用。 出现在:

ExternalSecretPolicy

ExternalSecretPolicy 用于控制 operator 如何处理外部 Secret 的内容。 出现于:

KeeperCluster

KeeperCluster 是 keeperclusters API 的 schema。

API 版本和 Kind

出现于:

KeeperClusterList

KeeperClusterList 包含一个 KeeperCluster 列表。

API 版本和 Kind

KeeperClusterReference

KeeperClusterReference 用于标识 ClickHouseCluster 所使用的 KeeperCluster。 出现于:

KeeperClusterSpec

KeeperClusterSpec 定义了 KeeperCluster 的期望状态。 出现在:

KeeperClusterStatus

KeeperClusterStatus 定义了 KeeperCluster 的已观测状态。 出现于:

KeeperSettings

KeeperSettings 定义 ClickHouse Keeper server 的配置。 出现在:

LoggerConfig

LoggerConfig 定义服务器日志配置。 出现在:

NamedTemplateMeta

NamedTemplateMeta 定义了需要名称的模板对象支持的元数据设置。 出现于:

PDBPolicy

PDBPolicy 用于控制是否创建 PodDisruptionBudget。 出现位置:

PersistentVolumeClaimTemplate

PersistentVolumeClaimTemplate 是一个按副本划分的具名 PersistentVolumeClaim 模板。 出现位置:

PodDisruptionBudgetSpec

PodDisruptionBudgetSpec 用于配置为集群创建的 PDB。 MinAvailableMaxUnavailable 只能设置其中之一。 如果两者都未设置,operator 会根据副本数选择一个安全的默认值。 出现位置:

PodTemplateSpec

PodTemplateSpec 描述了集群中 Pod (容器组) 的配置覆盖项。 出现位置:

SecretKeySelector

SecretKeySelector 用于选择某个 Secret 中的一个键。 出现在:

TemplateMeta

TemplateMeta 定义了模板对象支持的元数据设置。 出现于:

VersionProbeContainer

VersionProbeContainer 定义版本探测的容器级覆盖配置。 字段名和 JSON 标签与 corev1.Container 保持一致,以便 SMP 按名称进行合并。 出现位置:

VersionProbeJobSpec

VersionProbeJobSpec 定义了版本探测的 Job 级别覆盖配置。 出现位置:

VersionProbePodSpec

VersionProbePodSpec 定义了版本探测的 Pod 级覆盖项。 字段名和 JSON 标签与 corev1.PodSpec 保持一致,以兼容策略性合并补丁。 出现于:

VersionProbePodTemplate

VersionProbePodTemplate 用于描述对版本探测 pod (容器组) 的覆盖配置。 出现于:

VersionProbeTemplate

VersionProbeTemplate 定义了版本检测 Job 的覆盖配置。 该结构参照 batchv1.JobTemplateSpec,仅公开受支持的字段。 出现于:
最后修改于 2026年7月2日