ClickHouse Operator API 참조

이 문서는 ClickHouse Operator의 사용자 정의 리소스에 대한 자세한 API 참조를 제공합니다.

이 문서는 ClickHouse Operator의 사용자 정의 리소스에 대한 자세한 API 참조를 제공합니다.

​

AdditionalPort

AdditionalPort는 ClickHouse 파드와 공개 헤드리스 Service에 노출할 추가 TCP 포트 하나를 선언합니다.

필드	유형	설명	필수	기본값
name	string	목록 내에서 포트를 고유하게 식별하는 이름입니다. 컨테이너 포트 이름과 Service 포트 이름으로 모두 사용됩니다. 반드시 DNS_LABEL이어야 합니다.	true
port	integer	노출할 TCP 포트 번호입니다.	true

다음에 표시됩니다:

• ClickHouseClusterSpec

​

CABundleSelector

CABundleSelector는 클러스터 네임스페이스의 시크릿에서 CA 번들을 담고 있는 키를 선택하는 데 사용됩니다.

필드	유형	설명	필수	기본값
name	string	선택할 시크릿이 있는 클러스터 네임스페이스의 이름입니다.	true
key	string	선택할 시크릿의 키입니다. 유효한 시크릿 키여야 합니다.	false	ca.crt

다음 항목에 사용됩니다:

• ClusterTLSSpec

​

ClickHouseCluster

ClickHouseCluster는 clickhouseclusters API의 스키마입니다.

​

API 버전 및 Kind

apiVersion: clickhouse.com/v1alpha1
kind: ClickHouseCluster

필드	유형	설명	필수	기본값
spec	ClickHouseClusterSpec		true
status	ClickHouseClusterStatus		true

다음 항목에 표시됩니다:

• ClickHouseClusterList

​

ClickHouseClusterList

ClickHouseClusterList에는 ClickHouseCluster 목록이 포함됩니다.

​

API 버전 및 Kind

apiVersion: clickhouse.com/v1alpha1
kind: ClickHouseClusterList

필드	유형	설명	필수	기본값
items	ClickHouseCluster 배열		true

​

ClickHouseClusterSpec

ClickHouseClusterSpec는 ClickHouseCluster의 원하는 상태를 정의합니다.

Field	Type	Description	Required	Default
replicas	integer	단일 세그먼트의 레플리카 수입니다.	false	3
shards	integer	클러스터의 세그먼트 수입니다.	false	1
keeperClusterRef	KeeperClusterReference	ClickHouse 코디네이션에 사용되는 KeeperCluster에 대한 참조입니다. 네임스페이스를 생략하면 ClickHouseCluster의 네임스페이스가 사용됩니다.	true
podTemplate	PodTemplateSpec	ClickHouse 파드 사양에 전달되는 매개변수입니다.	false
containerTemplate	ContainerTemplateSpec	ClickHouse 컨테이너 사양에 전달되는 매개변수입니다.	false
dataVolumeClaimSpec	PersistentVolumeClaimSpec	ClickHouse 데이터용 영구 스토리지 사양입니다.	false
additionalVolumeClaimTemplates	PersistentVolumeClaimTemplate 배열	JBOD / 멀티 디스크 스토리지를 위한 파드별 추가 PVC 템플릿입니다. 각 항목은 StatefulSet volumeClaimTemplate에 전파되고, /var/lib/clickhouse/disks/<name>에 마운트되며 생성된 JBOD 스토리지 정책에 추가됩니다. 디스크 세트는 생성 시 고정됩니다.	false
labels	object (keys:string, values:string)	리소스에 추가할 레이블입니다.	false
annotations	object (keys:string, values:string)	리소스에 추가할 어노테이션입니다.	false
podDisruptionBudget	PodDisruptionBudgetSpec	PodDisruptionBudget는 각 세그먼트에 대해 생성되는 PDB를 구성합니다. 설정하지 않으면 연산자는 단일 레플리카 세그먼트에는 기본적으로 maxUnavailable=1을, 다중 레플리카 세그먼트에는 minAvailable=1을 사용합니다.	false
networkPolicy	ClickHouseNetworkPolicySpec	NetworkPolicy는 클러스터에 대해 관리되는 NetworkPolicy를 구성합니다.	false
settings	ClickHouseSettings	ClickHouse 서버의 구성 매개변수입니다.	false	{ }
clusterDomain	string	ClusterDomain은 DNS 해석에 사용되는 Kubernetes 클러스터 도메인 접미사입니다.	false	cluster.local
upgradeChannel	string	UpgradeChannel은 메이저 버전 업그레이드 확인에 사용할 릴리스 채널을 지정합니다. 비어 있으면 마이너 업데이트만 제안됩니다. 허용되는 값은 stable, lts 또는 특정 major.minor 버전(예: 25.8)입니다.	false
versionProbeTemplate	VersionProbeTemplate	버전 감지 Job에 대한 VersionProbeTemplate 재정의입니다.	false
externalSecret	ExternalSecret	ExternalSecret은 클러스터 시크릿이 포함된 외부 관리형 시크릿에 대한 선택적 참조입니다. 해당 시크릿은 클러스터와 동일한 네임스페이스에 있어야 합니다.	false
additionalPorts	AdditionalPort 배열	AdditionalPorts는 ClickHouse 파드와 공개 헤드리스 Service에 노출할 추가 TCP 포트를 선언합니다. 연산자는 Kubernetes 리소스에 포트만 추가하며, ClickHouse 서버가 해당 포트에서 수신 대기하도록 구성하지는 않습니다.	false

다음 항목에 나타납니다:

• ClickHouseCluster

​

ClickHouseClusterStatus

ClickHouseClusterStatus는 ClickHouseCluster의 현재 관찰된 상태를 정의합니다.

필드	유형	설명	필수	기본값
conditions	Condition 배열		false
readyReplicas	integer	ReadyReplicas는 요청을 처리할 준비가 된 레플리카의 총개수를 나타냅니다.	false
configurationRevision	string	ConfigurationRevision은 모든 레플리카의 대상 구성 리비전을 나타냅니다.	true
statefulSetRevision	string	StatefulSetRevision은 모든 레플리카의 대상 StatefulSet 리비전을 나타냅니다.	true
currentRevision	string	CurrentRevision은 가장 최근에 적용된 ClickHouseCluster spec 리비전을 나타냅니다.	true
updateRevision	string	UpdateRevision은 가장 최근에 요청된 ClickHouseCluster spec 리비전을 나타냅니다.	true
observedGeneration	integer	ObservedGeneration은 컨트롤러가 관찰한 최신 generation을 나타냅니다.	true
version	string	Version은 컨테이너 이미지가 보고한 버전을 나타냅니다.	false
versionProbeRevision	string	VersionProbeRevision은 마지막으로 성공한 버전 프로브의 이미지 해시입니다. 이 값이 현재 이미지 해시와 일치하면 캐시된 Version이 바로 사용됩니다.	false

다음 항목에 표시됩니다:

• ClickHouseCluster

​

ClickHouseNetworkPolicySpec

ClickHouseNetworkPolicySpec는 ClickHouse 클러스터에 대해 관리되는 NetworkPolicy를 구성합니다. 관리형 정책은 클러스터 내부 트래픽을 포괄합니다.

• 레플리카 간 연결
• 연산자에서 클러스터로의 액세스 클라이언트 연결 및 메트릭 스크래핑을 포함한 그 외 모든 인그레스에는 사용자가 정의한 NetworkPolicy가 필요합니다.

필드	유형	설명	필수	기본값
policy	NetworkPolicyPolicy	이 정책은 연산자가 클러스터 파드로의 인그레스를 제한하는 NetworkPolicy를 관리할지 여부를 제어합니다. 설정하지 않으면 기본값은 “Disabled”입니다.	false	Disabled

다음에 포함됩니다.

• ClickHouseClusterSpec

​

ClickHouseSettings

ClickHouseSettings는 ClickHouse 서버 설정 옵션을 정의합니다.

필드	유형	설명	필수 여부	기본값
defaultUserPassword	DefaultPasswordSelector	default ClickHouse 사용자의 비밀번호 소스 및 유형을 지정합니다.	false
logger	LoggerConfig	ClickHouse 서버 로깅 구성입니다.	false
tls	ClusterTLSSpec	TLS 설정으로, ClickHouse 서버의 보안 엔드포인트 및 인증서 검증을 구성할 수 있습니다.	false
encryption	EncryptionSettings	암호화 설정입니다. 설정하면 전용 스토리지 정책을 통해 테이블 데이터 저장 시 암호화를 활성화합니다. 테이블별로 SETTINGS storage_policy = '<policyName>'를 사용하여 선택적으로 적용할 수 있습니다.	false
enableDatabaseSync	boolean	새로 생성된 레플리카로의 ClickHouse 데이터베이스 동기화 및 스케일 다운 후 오래된 레플리카 정리를 활성화합니다. 스케일 다운 후. Replicated 및 통합(integration) 데이터베이스만 지원합니다.	false	true
extraConfig	RawExtension	기본 구성에 머지될 추가 ClickHouse 구성입니다.	false
extraUsersConfig	RawExtension	기본 구성에 머지될 추가 ClickHouse 사용자 구성입니다.	false

다음에서 사용됩니다:

• ClickHouseClusterSpec

​

ClusterTLSSpec

ClusterTLSSpec는 클러스터의 TLS 구성을 정의합니다.

필드	유형	설명	필수	기본값
enabled	boolean	Enabled는 TLS 사용 여부를 나타내며, 보안 포트를 열지 여부를 결정합니다.	false	false
required	boolean	Required는 모든 연결에 TLS를 강제할지 지정합니다. 비보안 포트는 비활성화됩니다.	false	false
serverCertSecret	LocalObjectReference	ServerCertSecret은 서버 인증서가 포함된 TLS 시크릿에 대한 참조입니다. 이 시크릿은 cert-manager가 생성한 인증서와 동일한 구조를 가져야 하며, 인증서와 private key는 각각 “tls.crt” 및 “tls.key” 키에 저장되어 있어야 합니다.	false
caBundle	CABundleSelector	CABundle은 피어 인증서를 검증하는 데 사용되는 CA 번들을 보관하는 시크릿 키에 대한 참조입니다. 비어 있으면 시스템에서 신뢰하는 CA 번들을 사용합니다. 키를 지정하지 않으면 기본값은 “ca.crt”입니다.	false

다음 항목에 표시됩니다:

• ClickHouseSettings
• KeeperSettings

​

ConfigMapKeySelector

ConfigMapKeySelector는 ConfigMap의 키를 선택합니다.

필드	유형	설명	필수	기본값
name	string	선택할 클러스터의 네임스페이스에 있는 ConfigMap의 이름입니다.	true
key	string	선택할 ConfigMap의 키입니다. 유효한 키여야 합니다.	true

다음 항목에서 사용됩니다:

• DefaultPasswordSelector

​

ContainerImage

ContainerImage는 리포지토리, 태그 또는 해시를 포함하는 컨테이너 이미지를 정의합니다.

필드	유형	설명	필수	기본값
repository	string	컨테이너 이미지 레지스트리 이름 예시: docker.io/clickhouse/clickhouse	false
tag	string	컨테이너 이미지 태그입니다. hash와는 함께 사용할 수 없습니다. 예시: 25.3	false
hash	string	컨테이너 이미지 해시입니다. tag와는 함께 사용할 수 없습니다.	false

다음 항목에서 사용됩니다:

• ContainerTemplateSpec

​

ContainerTemplateSpec

ContainerTemplateSpec는 클러스터의 컨테이너에 대한 구성 재정의 항목을 설명합니다.

Field	Type	Description	Required	Default
image	ContainerImage	Image는 배포할 컨테이너 이미지입니다.	true
imagePullPolicy	PullPolicy	이미지의 ImagePullPolicy이며, 기본값은 IfNotPresent입니다.	false
resources	ResourceRequirements	Resources는 서버 컨테이너의 리소스 요구 사항입니다. 전체에 적용됩니다. 모든 리소스 필드가 비어 있을 때만 연산자 기본값이 사용됩니다.	false
volumeMounts	VolumeMount array	VolumeMounts는 컨테이너의 볼륨 마운트 목록입니다. 연산자가 생성한 마운트와 결합됩니다. 연산자 마운트와 mountPath를 공유하는 항목은 projected volume으로 머지됩니다.	false
env	EnvVar array	Env는 컨테이너에 설정할 환경 변수 목록입니다. 이름을 기준으로 연산자 기본값과 머지됩니다.	false
securityContext	SecurityContext	SecurityContext는 컨테이너 실행 시 적용할 보안 옵션을 정의합니다. nil이 아닌 SecurityContext는 연산자 기본값을 완전히 대체하며, 사용자가 전체 구조체를 책임집니다. nil이면 연산자 기본값이 유지됩니다. 자세한 정보: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
livenessProbe	Probe	LivenessProbe는 연산자의 기본 liveness probe를 재정의합니다.	false
readinessProbe	Probe	ReadinessProbe는 연산자의 기본 준비 상태 프로브를 재정의합니다.	false

다음에 나타납니다:

• ClickHouseClusterSpec
• KeeperClusterSpec

​

DefaultPasswordSelector

DefaultPasswordSelector는 기본 사용자 비밀번호의 소스를 선택합니다.

필드	유형	설명	필수	기본값
passwordType	string	제공된 비밀번호의 유형입니다. 가능한 값은 https://clickhouse.com/docs/operations/settings/settings-users#user-namepassword 문서를 참조하십시오.	true	password
secret	SecretKeySelector	시크릿의 키에서 비밀번호 값을 선택합니다.	false
configMap	ConfigMapKeySelector	ConfigMap의 키에서 비밀번호 값을 선택합니다.	false

다음 항목에 표시됩니다:

• ClickHouseSettings

​

EncryptionSettings

EncryptionSettings는 테이블 데이터의 저장 데이터 암호화(저장 시 암호화)를 활성화합니다. 이 설정이 있으면 연산자가 각 데이터 디스크를 감싸는 암호화된 ClickHouse 스토리지 정책을 생성하며, 테이블은 SETTINGS storage_policy를 통해 이 정책을 사용하도록 설정합니다. 암호화는 한 번 활성화하면 비활성화할 수 없습니다.

필드	유형	설명	필수	기본값
policyName	string	PolicyName은 생성된 암호화 스토리지 정책의 이름입니다.	false	encrypted

다음에 포함됩니다:

• ClickHouseSettings

​

ExternalSecret

ExternalSecret는 동일한 네임스페이스에 있는 시크릿을 가리키는 참조입니다.

필드	유형	설명	필수 여부	기본값
name	string	시크릿의 이름입니다.	true
policy	ExternalSecretPolicy	정책은 연산자가 시크릿의 내용을 처리하는 방식을 제어합니다. Observe (기본값): 필수 키가 하나라도 없으면 리컨실리에이션을 차단합니다. Manage: 기존 시크릿에 누락된 필수 키를 생성합니다.	false	Observe

다음 항목에 나타납니다:

• ClickHouseClusterSpec

​

ExternalSecretPolicy

ExternalSecretPolicy는 연산자가 외부 시크릿의 내용을 어떻게 다룰지 제어합니다.

Field	Description
Observe	ExternalSecretPolicyObserve는 기본 정책입니다. 연산자는 시크릿을 읽고 유효성을 검사합니다. 필수 키가 하나라도 없으면 리컨실리에이션이 차단됩니다. 누락된 필수 키와 예상 포맷은 런타임에 ExternalSecretValid status condition을 통해 보고됩니다.
Manage	ExternalSecretPolicyManage는 연산자가 누락된 필수 키에 대해 값을 생성하여 채워 넣는 정책입니다. 시크릿은 업데이트되지만 연산자가 이를 소유하거나 삭제하지는 않습니다.

다음 항목에 나타납니다:

• ExternalSecret

​

KeeperCluster

KeeperCluster는 keeperclusters API의 스키마입니다.

​

API 버전 및 Kind

apiVersion: clickhouse.com/v1alpha1
kind: KeeperCluster

필드	유형	설명	필수	기본값
spec	KeeperClusterSpec		true
status	KeeperClusterStatus		true

다음에 포함됩니다:

• KeeperClusterList

​

KeeperClusterList

KeeperClusterList에는 KeeperCluster 목록이 포함되어 있습니다.

​

API 버전 및 Kind

apiVersion: clickhouse.com/v1alpha1
kind: KeeperClusterList

필드	유형	설명	필수	기본값
items	KeeperCluster 배열		true

​

KeeperClusterReference

KeeperClusterReference는 ClickHouseCluster에서 사용하는 KeeperCluster를 식별합니다.

필드	유형	설명	필수	기본값
name	string	KeeperCluster 리소스의 이름입니다.	true
namespace	string	KeeperCluster 리소스의 네임스페이스입니다. 생략하면 ClickHouseCluster의 네임스페이스를 사용합니다.	false

다음 항목에 표시됩니다:

• ClickHouseClusterSpec

​

KeeperClusterSpec

KeeperClusterSpec는 KeeperCluster의 원하는 상태를 정의합니다.

Field	Type	Description	Required	Default
replicas	integer	클러스터의 레플리카 수입니다.	false	3
podTemplate	PodTemplateSpec	Keeper 파드 사양에 전달되는 매개변수입니다.	false
containerTemplate	ContainerTemplateSpec	Keeper 컨테이너 사양에 전달되는 매개변수입니다.	false
dataVolumeClaimSpec	PersistentVolumeClaimSpec	ClickHouse Keeper 데이터용 영구 스토리지 사양입니다.	false
labels	object (keys:string, values:string)	리소스에 추가할 추가 레이블입니다.	false
annotations	object (keys:string, values:string)	리소스에 추가할 추가 어노테이션입니다.	false
podDisruptionBudget	PodDisruptionBudgetSpec	PodDisruptionBudget는 Keeper 클러스터용으로 생성되는 PDB를 구성합니다. 설정하지 않으면 연산자는 기본적으로 maxUnavailable=replicas/2를 사용합니다. (2F+1 클러스터의 quorum 유지); 단일 레플리카 클러스터는 maxUnavailable=1을 사용합니다.	false
networkPolicy	KeeperNetworkPolicySpec	NetworkPolicy는 Keeper 클러스터용으로 관리되는 NetworkPolicy를 구성합니다.	false
settings	KeeperSettings	ClickHouse Keeper 서버의 구성 매개변수입니다.	false
clusterDomain	string	ClusterDomain은 DNS 해석에 사용되는 Kubernetes 클러스터 도메인 접미사입니다.	false	cluster.local
upgradeChannel	string	UpgradeChannel은 메이저 버전 업그레이드 확인에 사용할 릴리스 채널을 지정합니다. 비어 있으면 마이너 업데이트만 제안됩니다. 허용되는 값은 stable, lts 또는 특정 major.minor 버전(예: 25.8)입니다.	false
versionProbeTemplate	VersionProbeTemplate	버전 감지 job에 대한 VersionProbeTemplate 재정의입니다. Deprecated: Keeper 버전 프로브 job은 사용되지 않습니다. 이 필드는 이전 버전과의 호환성을 위해 유지됩니다.	false

다음에 표시됩니다:

• KeeperCluster

​

KeeperClusterStatus

KeeperClusterStatus는 KeeperCluster의 관찰된 상태를 정의합니다.

필드	유형	설명	필수	기본값
conditions	Condition 배열		false
readyReplicas	integer	ReadyReplicas는 요청을 처리할 준비가 된 레플리카의 총 개수입니다.	false
configurationRevision	string	ConfigurationRevision은 각 레플리카의 대상 구성 리비전을 나타냅니다.	true
statefulSetRevision	string	StatefulSetRevision은 각 레플리카의 대상 StatefulSet 리비전을 나타냅니다.	true
currentRevision	string	CurrentRevision은 가장 최근에 적용된 KeeperCluster spec 리비전을 나타냅니다.	true
updateRevision	string	UpdateRevision은 가장 최근에 요청된 KeeperCluster spec 리비전을 나타냅니다.	true
observedGeneration	integer	ObservedGeneration은 컨트롤러가 관찰한 최신 generation을 나타냅니다.	true
version	string	Version은 Keeper server가 보고한 버전을 나타냅니다.	false
versionProbeRevision	string	VersionProbeRevision은 마지막으로 성공한 버전 프로브의 image hash입니다. Deprecated: Keeper 버전 프로브 Jobs는 사용되지 않으며, 이 필드는 이전 버전과의 호환성을 위해 유지됩니다.	false

다음 항목에 나타납니다:

• KeeperCluster

​

KeeperNetworkPolicySpec

KeeperNetworkPolicySpec는 Keeper 클러스터에 적용되는 관리형 NetworkPolicy를 구성합니다. 관리형 정책은 클러스터 내부 트래픽에 적용됩니다.

• 레플리카 간 연결
• 연산자에서 클러스터로의 액세스
• 이 Keeper 클러스터를 참조하는 ClickHouse 클러스터의 액세스 메트릭 스크래핑을 비롯한 그 밖의 모든 인그레스에는 사용자가 정의한 NetworkPolicy가 필요합니다.

필드	유형	설명	필수	기본값
policy	NetworkPolicyPolicy	이 정책은 연산자가 Keeper 파드로의 인그레스를 제한하는 NetworkPolicy를 관리할지 여부를 제어합니다. 설정하지 않으면 기본값은 “Disabled”입니다.	false	Disabled

다음에서 사용됩니다.

• KeeperClusterSpec

​

KeeperSettings

KeeperSettings는 ClickHouse Keeper 서버 구성을 정의합니다.

필드	유형	설명	필수	기본값
logger	LoggerConfig	ClickHouse Keeper 서버의 로깅 구성입니다.	false
tls	ClusterTLSSpec	TLS 설정으로, ClickHouse Keeper 서버의 보안 endpoint 및 인증서 검증을 구성할 수 있습니다.	false
extraConfig	RawExtension	기본 구성과 머지되는 추가 ClickHouse Keeper 구성입니다.	false

다음에 표시됩니다:

• KeeperClusterSpec

​

LoggerConfig

LoggerConfig는 server 로깅 구성을 정의합니다.

필드	유형	설명	필수	기본값
logToFile	boolean	false이면 파일 로깅을 모두 비활성화합니다.	false	true
jsonLogs	boolean	true이면 JSON 포맷으로 로깅합니다.	false	false
level	string	server 로거의 상세 수준입니다.	false	trace
size	string	로그 파일의 최대 크기입니다.	false	1000M
count	integer	유지할 로그 파일의 최대 개수입니다.	false	50

다음에 사용됩니다:

• ClickHouseSettings
• KeeperSettings

​

NamedTemplateMeta

NamedTemplateMeta는 이름이 필요한 템플릿 객체에서 지원되는 메타데이터 설정을 정의합니다.

필드	유형	설명	필수 여부	기본값
name	string	이름은 리소스 식별자입니다.	true
labels	객체 (keys:string, values:string)	템플릿 객체에 적용되는 레이블입니다.	false
annotations	객체 (keys:string, values:string)	템플릿 객체에 적용되는 어노테이션입니다.	false

다음 항목에 나타납니다:

• PersistentVolumeClaimTemplate

​

NetworkPolicyPolicy

NetworkPolicyPolicy는 연산자가 클러스터의 NetworkPolicy를 관리할지 결정합니다.

필드	설명
Enabled	NetworkPolicyEnabled는 연산자가 클러스터 파드로의 인그레스를 제한하는 NetworkPolicy를 관리하도록 합니다.
Disabled	NetworkPolicyDisabled는 관리형 NetworkPolicy를 비활성화하며, 존재하는 경우 연산자가 이를 삭제합니다.

다음 위치에 나타납니다:

• ClickHouseNetworkPolicySpec
• KeeperNetworkPolicySpec

​

PDBPolicy

PDBPolicy는 PodDisruptionBudget를 생성할지 여부를 제어합니다.

Field	Description
Enabled	PDBPolicyEnabled는 연산자가 PodDisruptionBudget를 생성하도록 합니다.
Disabled	PDBPolicyDisabled는 PodDisruptionBudget를 비활성화하며, 연산자는 일치하는 레이블이 있는 리소스를 삭제합니다.
Ignored	PDBPolicyIgnored는 PodDisruptionBudget를 무시합니다. 연산자는 어떤 PDB도 생성하거나 삭제하지 않으며, 기존 PDB는 변경되지 않습니다.

다음 항목에 나타납니다:

• PodDisruptionBudgetSpec

​

PersistentVolumeClaimTemplate

PersistentVolumeClaimTemplate는 레플리카별 PersistentVolumeClaim에 사용하는 이름 있는 템플릿입니다.

필드	유형	설명	필수	기본값
metadata	NamedTemplateMeta	metadata 필드는 Kubernetes API 문서를 참조하십시오.	true
spec	PersistentVolumeClaimSpec	Spec은 파드 작성자가 요청하는 볼륨의 원하는 특성을 정의합니다. 자세한 내용은 다음을 참조하십시오: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true

다음에 사용됩니다:

• ClickHouseClusterSpec

​

PodDisruptionBudgetSpec

PodDisruptionBudgetSpec는 클러스터에 대해 생성되는 PDB를 구성합니다. MinAvailable 또는 MaxUnavailable 중 하나만 설정할 수 있습니다. 둘 다 설정하지 않으면 연산자가 레플리카 수를 기준으로 안전한 기본값을 선택합니다.

필드	유형	설명	필수 여부	기본값
policy	PDBPolicy	Policy는 연산자가 PodDisruptionBudget를 생성할지 여부를 제어합니다. 설정하지 않으면 기본값은 “Enabled”입니다. PDB를 생성하지 않으려면(예: 개발 환경) “Disabled”로 설정하십시오.	false	Enabled
minAvailable	IntOrString	MinAvailable은 중단이 발생하는 동안 계속 사용 가능해야 하는 최소 파드 수입니다.	false
maxUnavailable	IntOrString	MaxUnavailable은 중단이 발생하는 동안 사용 불가 상태가 될 수 있는 최대 파드 수입니다.	false
unhealthyPodEvictionPolicy	UnhealthyPodEvictionPolicyType	UnhealthyPodEvictionPolicy는 비정상 파드를 언제 퇴거 대상으로 간주할지에 대한 기준을 정의합니다. 유효한 값은 “IfReady” 및 “AlwaysAllow”입니다.	false

다음 항목에서 사용됩니다:

• ClickHouseClusterSpec
• KeeperClusterSpec

​

PodTemplateSpec

PodTemplateSpec는 클러스터의 파드에 적용되는 파드 구성 재정의 항목을 설명합니다.

필드	유형	설명	필수	기본값
terminationGracePeriodSeconds	integer	파드가 정상적으로 종료되는 데 필요한 선택적 시간(초)입니다. 삭제 요청 시 더 짧게 설정될 수 있습니다. 값은 0 이상의 정수여야 합니다. 값이 0이면 kill 시그널을 통해 즉시 중지됨을 의미합니다 (종료할 기회가 없음). 이 값이 nil이면 대신 기본 유예 기간이 사용됩니다. 유예 기간은 파드에서 실행 중인 프로세스에 종료 시그널이 전송된 시점부터 kill 시그널로 프로세스가 강제로 중지되는 시점까지의 시간(초)입니다. 이 값은 프로세스의 예상 정리 시간보다 길게 설정하십시오. 기본값은 30초입니다.	false
topologySpreadConstraints	TopologySpreadConstraint 배열	TopologySpreadConstraints는 파드 그룹이 토폴로지 도메인 전반에 어떻게 분산되어야 하는지 설명합니다. 스케줄러는 이러한 제약 조건을 준수하도록 파드를 스케줄링합니다. 모든 topologySpreadConstraints는 AND 조건으로 함께 적용됩니다. topologyKey를 기준으로 operator 기본값과 병합됩니다.	false
imagePullSecrets	LocalObjectReference 배열	ImagePullSecrets는 이 PodSpec에서 사용하는 이미지들을 가져올 때 사용할, 동일한 네임스페이스 내 시크릿 참조의 선택적 목록입니다. 지정하면 이러한 시크릿이 각 puller 구현체에 전달되어 사용됩니다. 자세한 내용: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod 이름을 기준으로 operator 기본값과 머지됩니다.	false
nodeSelector	객체 (keys:string, values:string)	NodeSelector는 파드가 노드에 배치되기 위해 충족되어야 하는 선택자입니다. 파드가 해당 노드에 스케줄되려면 노드의 레이블과 일치해야 하는 선택자입니다. 자세한 정보: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/	false
affinity	친화성	지정하면 파드의 스케줄링 제약 조건이 설정됩니다. Operator 기본값에 추가되며, 스케줄링 조건 목록은 이어 붙여집니다.	false
tolerations	Toleration 배열	지정하면 파드의 톨러레이션이 설정됩니다.	false
schedulerName	string	지정하면 해당 파드는 지정된 스케줄러에 의해 스케줄링됩니다. 지정하지 않으면 해당 파드는 기본 스케줄러에 의해 스케줄링됩니다.	false
serviceAccountName	string	ServiceAccountName은 이 파드를 실행할 때 사용할 ServiceAccount의 이름입니다. 자세한 내용: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/	false
priorityClassName	string	PriorityClassName은 파드에서 사용할 PriorityClass의 이름입니다.	false
runtimeClassName	String	RuntimeClassName은 파드에서 사용할 RuntimeClass의 이름입니다.	false
volumes	Volume 배열	Volumes는 파드에 속한 컨테이너가 마운트할 수 있는 볼륨 목록을 정의합니다. 자세한 내용: https://kubernetes.io/docs/concepts/storage/volumes 이름을 기준으로 operator 기본값과 머지되며, 사용자 볼륨은 동일한 이름의 operator 볼륨을 대체합니다.	false
securityContext	PodSecurityContext	SecurityContext는 파드 수준의 보안 속성과 공통 컨테이너 설정을 포함합니다. nil이 아닌 SecurityContext는 operator 기본값을 완전히 대체하며, 사용자가 전체 구조체를 직접 관리합니다. nil인 경우 operator 기본값이 유지됩니다.	false
topologyZoneKey	String	TopologyZoneKey는 노드 레이블의 키입니다. 이 키를 가진 레이블이 있고 그 값이 동일한 노드는 동일한 토폴로지 도메인에 있는 것으로 간주됩니다. 예를 들어 “topology.kubernetes.io/zone”의 경우 동일한 가용 영역, “kubernetes.io/hostname”의 경우 동일한 노드입니다. 동일한 데이터를 보유한 파드(ClickHouse에서는 하나의 세그먼트에 대한 레플리카, Keeper에서는 모든 레플리카)가 도메인 전반에 걸쳐 균형 있게 분산되도록 이 값을 설정하십시오. 즉, 필수 TopologySpreadConstraint(maxSkew 1, DoNotSchedule)와 선호되는 PodAntiAffinity 규칙이 함께 적용됩니다. 서로 다른 세그먼트의 파드는 동일한 도메인을 공유할 수 있으므로 도메인당 여러 파드가 허용됩니다. 도메인 수가 레플리카 수보다 적으면 여러 레플리카가 하나의 도메인을 공유하게 되지만, 여전히 균등하게 분산됩니다. ClickHouse 파드는 추가로 자신이 사용하는 Keeper 파드가 배치된 도메인을 선호합니다. ”topology.kubernetes.io/zone”으로 설정하는 것을 권장합니다.	false
topologyMinDomains	integer	TopologyMinDomains는 TopologyZoneKey에 의해 생성되는 TopologySpreadConstraint의 minDomains 필드를 설정합니다. Kubernetes 스케줄러는 이미 배치 가능한 노드가 존재하는 영역만 토폴로지 도메인으로 계산합니다. 따라서 수요 기반 자동 스케일러(예: Karpenter, Cluster Autoscaler)를 사용하는 경우, 스케줄링 시점에 노드가 두 개의 AZ에만 존재한다면 maxSkew:1/DoNotSchedule 제약 조건이 2/1 분배로도 충족되어 자동 스케일러가 세 번째 AZ에 노드를 프로비저닝하지 않습니다. TopologyMinDomains를 예상되는 영역 수(일반적으로 3)로 설정하면, 스케줄러는 모든 영역에 노드가 존재하는지와 무관하게 해당 수만큼의 영역을 도메인으로 취급하므로 자동 스케일러가 누락된 영역에 노드를 프로비저닝하도록 강제됩니다. 이를 위해서는 TopologyZoneKey가 설정되어 있어야 합니다. 배치 가능한 노드가 이미 존재하는 영역만 계산하는 스케줄러의 기본 동작을 유지하려면 생략(nil)하십시오.	false
nodeHostnameKey	string	NodeHostnameKey는 노드 레이블의 키입니다. 이 키를 가진 레이블이 있고 그 값이 동일한 노드는 같은 노드에 있는 것으로 간주됩니다. 클러스터의 모든 파드에 대해 필수 PodAntiAffinity 규칙을 적용하여 노드의 배타적 점유를 강제하려면 이 값을 설정하십시오. 세그먼트와 관계없이 노드당 최대 하나의 파드만 배치됩니다. 이를 위해서는 최소한 파드 수만큼의 노드가 필요합니다; 노드 수가 더 적으면 초과하는 파드는 Pending 상태로 유지됩니다. 노드당 여러 파드를 배치하면서 동일한 세그먼트의 레플리카를 여러 노드에 분산하려면 대신 TopologyZoneKey를 “kubernetes.io/hostname”으로 설정하십시오. ”kubernetes.io/hostname”로 설정하는 것을 권장합니다.	false
initContainers	Container 배열	InitContainers는 메인 server 컨테이너가 시작되기 전에 실행할 init 컨테이너 목록입니다. 이름을 기준으로 연산자의 기본값과 머지됩니다. 이름이 동일한 경우.	false

다음 항목에서 사용됩니다:

• ClickHouseClusterSpec
• KeeperClusterSpec

​

SecretKeySelector

SecretKeySelector는 시크릿의 키를 선택하는 데 사용됩니다.

필드	유형	설명	필수	기본값
name	string	선택할 시크릿이 있는 클러스터 네임스페이스의 이름입니다.	true
key	string	선택할 시크릿의 키입니다. 유효한 시크릿 키여야 합니다.	true

다음 항목에 사용됩니다:

• DefaultPasswordSelector

​

TemplateMeta

TemplateMeta는 템플릿 객체에 지원되는 메타데이터 설정을 정의합니다.

필드	유형	설명	필수 여부	기본값
labels	객체 (keys:string, values:string)	템플릿 객체에 적용되는 레이블입니다.	false
annotations	객체 (keys:string, values:string)	템플릿 객체에 적용되는 어노테이션입니다.	false

다음 항목에 나타납니다:

• VersionProbePodTemplate
• VersionProbeTemplate

​

VersionProbeContainer

VersionProbeContainer는 버전 프로브의 컨테이너 수준 재정의를 정의합니다. 필드 이름과 JSON 태그는 corev1.Container와 일치하므로 SMP가 이름 기준으로 머지됩니다.

필드	유형	설명	필수	기본값
name	string	컨테이너 이름입니다. 비어 있으면 연산자가 이를 버전 프로브 컨테이너 이름으로 설정합니다.	true	version-probe
resources	ResourceRequirements	버전 프로브 컨테이너의 컴퓨트 리소스 요구 사항입니다. SMP를 통해 연산자 기본값과 딥 머지됩니다.	false
securityContext	SecurityContext	버전 프로브 컨테이너의 보안 옵션을 정의하는 SecurityContext입니다. SMP를 통해 연산자 기본값과 딥 머지됩니다.	false

다음 항목에 나타납니다:

• VersionProbePodSpec

​

VersionProbeJobSpec

VersionProbeJobSpec는 버전 프로브에 대한 Job 수준의 재정의 설정을 정의합니다.

Field	Type	Description	Required	Default
ttlSecondsAfterFinished	integer	TTLSecondsAfterFinished는 완료된 Job의 수명을 제한합니다.	false
template	VersionProbePodTemplate	템플릿은 버전 프로브 Job용으로 생성될 파드를 설명합니다.	false

다음 항목에 포함됩니다:

• VersionProbeTemplate

​

VersionProbePodSpec

VersionProbePodSpec는 버전 프로브의 파드 수준 재정의를 정의합니다. 필드 이름과 JSON 태그는 전략적 머지 패치 호환성을 위해 corev1.PodSpec과 일치합니다.

Field	Type	Description	Required	Default
nodeSelector	object (keys:string, values:string)	NodeSelector는 버전 프로브 파드를 레이블이 일치하는 노드로 제한합니다.	false
tolerations	Toleration array	버전 프로브 파드의 Toleration입니다.	false
securityContext	PodSecurityContext	SecurityContext는 버전 프로브 파드의 파드 수준 보안 속성을 포함합니다.	false
containers	VersionProbeContainer array	버전 프로브 파드의 컨테이너 재정의입니다. name 필드는 선택 사항이며, 연산자가 기본 컨테이너 값으로 채웁니다. 이름이 다른 추가 컨테이너를 지정할 수 있습니다.	false

다음 항목에 나타납니다:

• VersionProbePodTemplate

​

VersionProbePodTemplate

VersionProbePodTemplate는 버전 프로브 파드에 적용할 재정의 항목을 설명합니다.

Field	Type	Description	Required	Default
metadata	TemplateMeta	metadata 필드는 Kubernetes API 문서를 참조하십시오.	false
spec	VersionProbePodSpec	버전 프로브 파드의 원하는 동작에 대한 사양입니다.	false

다음에서 사용됩니다:

• VersionProbeJobSpec

​

VersionProbeTemplate

VersionProbeTemplate은 버전 감지 Job의 재정의 항목을 정의합니다. 이 구조는 batchv1.JobTemplateSpec과 동일한 구조를 따르며, 지원되는 필드만 노출합니다.

Field	Type	Description	Required	Default
metadata	TemplateMeta	metadata 필드는 Kubernetes API 문서를 참조하십시오.	false
spec	VersionProbeJobSpec	버전 프로브 Job의 원하는 동작을 지정하는 사양입니다.	false

다음 항목에 나타납니다:

• ClickHouseClusterSpec
• KeeperClusterSpec