ClickHouseOperatorConfiguration

clickhouse.altinity.com / v1

apiVersion: clickhouse.altinity.com/v1 kind: ClickHouseOperatorConfiguration metadata: name: example

spec object

Allows to define settings of the clickhouse-operator. More info: https://github.com/Altinity/clickhouse-operator/blob/master/config/config.yaml Check into etc-clickhouse-operator* ConfigMaps if you need more control

annotation object

defines which metadata.annotations items will include or exclude during render StatefulSet, Pod, PVC resources

exclude []string

When propagating labels from the chi's `metadata.annotations` section to child objects' `metadata.annotations`, exclude annotations with names from the following list

include []string

When propagating labels from the chi's `metadata.annotations` section to child objects' `metadata.annotations`, include annotations with names from the following list

clickhouse object

Clickhouse related parameters used by clickhouse-operator

access object

parameters which use for connect to clickhouse from clickhouse-operator deployment

password string

ClickHouse password to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName

port integer

Port to be used by operator to connect to ClickHouse instances

minimum: 1

maximum: 65535

rootCA string

Root certificate authority that clients use when verifying server certificates. Used for https connection to ClickHouse

scheme string

The scheme to user for connecting to ClickHouse. Possible values: http, https, auto

secret object

name string

Name of k8s Secret with username and password to be used by operator to connect to ClickHouse instances

namespace string

Location of k8s Secret with username and password to be used by operator to connect to ClickHouse instances

timeouts object

Timeouts used to limit connection and queries from the operator to ClickHouse instances, In seconds

connect integer

Timout to setup connection from the operator to ClickHouse instances. In seconds.

minimum: 1

maximum: 10

query integer

Timout to perform SQL query from the operator to ClickHouse instances. In seconds.

minimum: 1

maximum: 600

username string

ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName

addons object

Configuration addons specifies additional settings

rules []object

Array of set of rules per specified ClickHouse versions

spec object

spec

configuration object

allows configure multiple aspects and behavior for `clickhouse-server` instance and also allows describe multiple `clickhouse-server` clusters inside one `chi` resource

files object

see same section from CR spec

profiles object

see same section from CR spec

quotas object

see same section from CR spec

settings object

see same section from CR spec

users object

see same section from CR spec

version string

ClickHouse version expression

configuration object

file object

path object

Each 'path' can be either absolute or relative. In case path is absolute - it is used as is. In case path is relative - it is relative to the folder where configuration file you are reading right now is located.

common string

Path to the folder where ClickHouse configuration files common for all instances within a CHI are located. Default value - config.d

host string

Path to the folder where ClickHouse configuration files unique for each instance (host) within a CHI are located. Default value - conf.d

user string

Path to the folder where ClickHouse configuration files with users settings are located. Files are common for all instances within a CHI. Default value - users.d

network object

Default network parameters for any user which will create

hostRegexpTemplate string

ClickHouse server configuration `<host_regexp>...</host_regexp>` for any <user>

user object

Default parameters for any user which will create

default object

networksIP []string

ClickHouse server configuration `<networks><ip>...</ip></networks>` for any <user>

password string

ClickHouse server configuration `<password>...</password>` for any <user>

profile string

ClickHouse server configuration `<profile>...</profile>` for any <user>

quota string

ClickHouse server configuration `<quota>...</quota>` for any <user>

configurationRestartPolicy object

Configuration restart policy describes what configuration changes require ClickHouse restart

rules []object

Array of set of rules per specified ClickHouse versions

rules []object

Set of configuration rules for specified ClickHouse version

version string

ClickHouse version expression

metrics object

parameters which use for connect to fetch metrics from clickhouse by clickhouse-operator

excludeRegexp []string

List of regexps to match ClickHouse metrics to exclude from export. Regexps match internal metric names before Prometheus normalization and prefixing.

tablesRegexp string

Regexp to match tables in system database to fetch metrics from. Multiple tables can be matched using regexp. Matched tables are merged using merge() table function. Default is "^(metrics|custom_metrics)$".

timeouts object

Timeouts used to limit connection and queries from the metrics exporter to ClickHouse instances Specified in seconds.

collect integer

Timeout used to limit metrics collection request. In seconds. Upon reaching this timeout metrics collection is aborted and no more metrics are collected in this cycle. All collected metrics are returned.

minimum: 1

maximum: 600

label object

defines which metadata.labels will include or exclude during render StatefulSet, Pod, PVC resources

appendScope object

Whether to append *Scope* labels to StatefulSet and Pod - "LabelShardScopeIndex" - "LabelReplicaScopeIndex" - "LabelCHIScopeIndex" - "LabelCHIScopeCycleSize" - "LabelCHIScopeCycleIndex" - "LabelCHIScopeCycleOffset" - "LabelClusterScopeIndex" - "LabelClusterScopeCycleSize" - "LabelClusterScopeCycleIndex" - "LabelClusterScopeCycleOffset"

exclude []string

When propagating labels from the chi's `metadata.labels` section to child objects' `metadata.labels`, exclude labels from the following list

include []string

When propagating labels from the chi's `metadata.labels` section to child objects' `metadata.labels`, include labels from the following list

logger object

allow setup clickhouse-operator logger behavior

alsologtostderr string

boolean allows logs to stderr and files both

log_backtrace_at string

It can be set to a file and line number with a logging line. Ex.: file.go:123 Each time when this line is being executed, a stack trace will be written to the Info log.

logtostderr string

boolean, allows logs to stderr

stderrthreshold string

v string

verbosity level of clickhouse-operator log, default - 1 max - 9

vmodule string

Comma-separated list of filename=N, where filename (can be a pattern) must have no .go ext, and N is a V level. Ex.: file*=2 sets the 'V' to 2 in all files with names like file*.

metrics object

defines metrics exporter options

labels object

defines metric labels options

exclude []string

When adding labels to a metric exclude labels with names from the following list

pod object

define pod specific parameters

terminationGracePeriod integer

Optional duration in seconds the pod needs to terminate gracefully. Look details in `pod.spec.terminationGracePeriodSeconds`

reconcile object

allow tuning reconciling process

coordination object

Coordination with external systems during reconcile

keeper object

Keeper-related coordination settings

onKeeperResourceUpdate string

Reaction when a referenced CHK resource changes. none (default) — do nothing reconcile — trigger CHI reconcile

enum: , None, none, Reconcile, reconcile

readyTimeout integer

How long the operator waits for a referenced ClickHouseKeeper to become ready before aborting CHI reconcile. In seconds. Default is 120.

minimum: 1

host object

Whether the operator during reconcile procedure should wait for a ClickHouse host: - to be excluded from a ClickHouse cluster - to complete all running queries - to be included into a ClickHouse cluster respectfully before moving forward

drop object

replicas object

Whether the operator during reconcile procedure should drop replicas when replica is deleted or recreated

active object

Whether the operator during reconcile procedure should drop active replicas when replica is deleted or recreated

onDelete object

Whether the operator during reconcile procedure should drop replicas when replica is deleted

onLostVolume object

Whether the operator during reconcile procedure should drop replicas when replica volume is lost

hooks object

default host-level hooks to execute before and after host reconcile

post []object

actions to execute after host reconcile

http object

method string

url string

shell object

command []string

container string

sql object

queries []string

target string

where to execute hook: FirstHost (default), AllHosts, AllShards

enum: , FirstHost, firsthost, AllHosts, allhosts, AllShards, allshards

pre []object

actions to execute before host reconcile

http object

method string

url string

shell object

command []string

container string

sql object

queries []string

target string

where to execute hook: FirstHost (default), AllHosts, AllShards

enum: , FirstHost, firsthost, AllHosts, allhosts, AllShards, allshards

wait object

exclude object

Whether the operator during reconcile procedure should wait for a ClickHouse host to be excluded from a ClickHouse cluster

include object

Whether the operator during reconcile procedure should wait for a ClickHouse host to be included into a ClickHouse cluster

probes object

What probes the operator should wait during host launch procedure

readiness object

Whether the operator during host launch procedure should wait for readiness probe to succeed. In case probe is unspecified wait is assumed to be completed successfully. Default option value is to wait.

startup object

Whether the operator during host launch procedure should wait for startup probe to succeed. In case probe is unspecified wait is assumed to be completed successfully. Default option value is to do not wait.

queries object

Whether the operator during reconcile procedure should wait for a ClickHouse host to complete all running queries

replicas object

Whether the operator during reconcile procedure should wait for replicas to catch-up

all object

Whether the operator during reconcile procedure should wait for all replicas to catch-up

delay integer

replication max absolute delay to consider replica is not delayed

new object

Whether the operator during reconcile procedure should wait for new replicas to catch-up

recovery object

Auto-recovery from reconcile failures, scoped by CHI state

from object

Recovery scopes keyed by CHI state being recovered from

aborted object

Recovery from Status=Aborted

onPodReady string

Reaction when a pod belonging to an Aborted CHI transitions to Ready. retry (default) — re-enqueue the CHI for reconcile none — do nothing, CHI stays Aborted

enum: , None, none, Retry, retry

runtime object

runtime parameters for clickhouse-operator process which are used during reconcile cycle

reconcileCHIsThreadsNumber integer

How many goroutines will be used to reconcile CHIs in parallel, 10 by default

minimum: 1

maximum: 65535

reconcileShardsMaxConcurrencyPercent integer

The maximum percentage of cluster shards that may be reconciled in parallel, 50 percent by default.

minimum: 0

maximum: 100

reconcileShardsThreadsNumber integer

How many goroutines will be used to reconcile shards of a cluster in parallel, 1 by default

minimum: 1

maximum: 65535

statefulSet object

Allow change default behavior for reconciling StatefulSet which generated by clickhouse-operator

create object

Behavior during create StatefulSet

onFailure string

What to do in case created StatefulSet is not in Ready after `statefulSetUpdateTimeout` seconds Possible options: 1. abort - do nothing, just break the process and wait for admin. 2. delete - delete newly created problematic StatefulSet. 3. ignore (default) - ignore error, pretend nothing happened and move on to the next StatefulSet.

recreate object

Behavior during recreate StatefulSet

onDataLoss string

What to do in case operator needs to recreate StatefulSet due to PVC data loss or missing volumes. Possible options: 1. abort - abort the process, do nothing with the problematic StatefulSet. 2. recreate (default) - proceed and recreate StatefulSet.

onUpdateFailure string

What to do in case operator needs to recreate StatefulSet due to update failure or StatefulSet not ready. Possible options: 1. abort - abort the process, do nothing with the problematic StatefulSet. 2. recreate (default) - proceed and recreate StatefulSet.

update object

Behavior during update StatefulSet

onFailure string

What to do in case updated StatefulSet is not in Ready after `statefulSetUpdateTimeout` seconds Possible options: 1. abort - do nothing, just break the process and wait for admin. 2. rollback (default) - delete Pod and rollback StatefulSet to previous Generation. Pod would be recreated by StatefulSet based on rollback-ed configuration. 3. ignore - ignore error, pretend nothing happened and move on to the next StatefulSet.

pollInterval integer

How many seconds to wait between checks for created/updated StatefulSet status

timeout integer

How many seconds to wait for created/updated StatefulSet to be Ready

security object

Per-component security toggles for outbound connections the operator establishes: ClickHouse-client TLS (clickhouse.tls.verify, clickhouse.tls.minVersion, clickhouse.tls.serverName, clickhouse.tls.rootCA, clickhouse.tls.rootCASecretRef), ZooKeeper/Keeper-client TLS (zookeeper.tls.verify, zookeeper.tls.minVersion), Kubernetes-client startup gate (kubernetes.tls.verify=Strict refuses an insecure kubeconfig; kubernetes.tls.minVersion is declared for shape uniformity but not yet enforced on the K8s API transport), operator↔metrics-exporter IPC channel hardening (ipc.mode, ipc.bindHost, ipc.tokenPath). Operator-wide master switch (security.policy): Permissive (default) preserves 0.27.0 behavior; Enforced coerces all per-component knobs above to their Strict positions at startup (clickhouse.tls.verify=Strict, clickhouse.tls.minVersion=1.3, zookeeper.tls.verify=Strict, zookeeper.tls.minVersion=1.3, kubernetes.tls.verify=Strict, kubernetes.tls.minVersion=1.3, ipc.mode=Secure) and rejects CHIs that cannot be served in a FIPS-compatible posture (e.g. CHIs referencing plain-text external ZooKeeper). Independent of the Go runtime FIPS toolchain — when this operator binary is built with GOFIPS140=v1.0.0 (the Go FIPS module currently in CMVP review, not yet a completed validation) the startup gate ORs runtime detection with this knob. FIPS image policy (security.images.policy): orthogonal to security.policy. Permissive (default) accepts any image; Required refuses CRs whose CH/Keeper images lack the "fips" tag substring (admission) AND aborts running CRs whose `SELECT version()` lacks "fips" (post-Ready confirmation). All fields default to nil — current behavior preserved on upgrade. See docs/security_hardening.md for details.

statefulSet object

define StatefulSet-specific parameters

revisionHistoryLimit integer

revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. Look details in `statefulset.spec.revisionHistoryLimit`

status object

defines status options

fields object

defines status fields options

action object

Whether the operator should fill status field 'action'

actions object

Whether the operator should fill status field 'actions'

error object

Whether the operator should fill status field 'error'

errors object

Whether the operator should fill status field 'errors'

template object

Parameters which are used if you want to generate ClickHouseInstallationTemplate custom resources from files which are stored inside clickhouse-operator deployment

chi object

path string

Path to folder where ClickHouseInstallationTemplate .yaml manifests are located.

policy string

CHI template updates handling policy Possible policy values: - ReadOnStart. Accept CHIT updates on the operators start only. - ApplyOnNextReconcile. Accept CHIT updates at all time. Apply news CHITs on next regular reconcile of the CHI

enum: , ReadOnStart, ApplyOnNextReconcile

watch object

Parameters for watch kubernetes resources which used by clickhouse-operator deployment

configuration object

Behavior when ClickHouseOperatorConfiguration resources change

onChange string

none/ignore — do nothing; restart — exit process so the operator pod restarts

enum: none, None, ignore, Ignore, restart, Restart

namespaces object

List of namespaces where clickhouse-operator watches for events.

status object

No matches. Try .spec.annotation for an exact path