ClickHouseKeeperInstallation

clickhouse-keeper.altinity.com / v1

apiVersion: clickhouse-keeper.altinity.com/v1 kind: ClickHouseKeeperInstallation metadata: name: example

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

Specification of the desired behavior of one or more ClickHouse clusters More info: https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md

configuration object

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

clusters []object

describes clusters layout and allows change settings on cluster-level and replica-level

files object

optional, allows define content of any setting file inside each `Pod` on current cluster during generate `ConfigMap` which will mount in `/etc/clickhouse-server/config.d/` or `/etc/clickhouse-server/conf.d/` or `/etc/clickhouse-server/users.d/` override top-level `chi.spec.configuration.files`

insecure object

optional, controls exposure of the plaintext Keeper client port (zk:2181). Defaults to "yes" (legacy behavior, byte-stable). Set to "no" to: - suppress zk:2181 from the per-cluster Service and from per-host StatefulSet container ports; - emit <tcp_port remove="1"/> in the per-host overlay so the Keeper process binds no plaintext listener at all (the liveness probe automatically falls back to `pgrep clickhouse-keeper` because 4LW does not work over TLS upstream). Must be paired with `secure: yes` — the normalizer aborts reconcile with reason NoKeeperListener when `insecure: no` is set without `secure: yes` (no client port would be emitted).

layout object

describe current cluster layout, how much shards in cluster, how much replica in shard allows override settings on each shard and replica separatelly

replicas []object

optional, allows override top-level `chi.spec.configuration` and cluster-level `chi.spec.configuration.clusters` configuration for each replica and each shard relates to selected replica, use it only if you fully understand what you do

files object

optional, allows define content of any setting file inside each `Pod` only in one replica during generate `ConfigMap` which will mount in `/etc/clickhouse-server/config.d/` or `/etc/clickhouse-server/conf.d/` or `/etc/clickhouse-server/users.d/` override top-level `chi.spec.configuration.files` and cluster-level `chi.spec.configuration.clusters.files`, will ignore if `chi.spec.configuration.clusters.layout.shards` presents

name string

optional, by default replica name is generated, but you can override it and setup custom name

pattern: ^[a-zA-Z0-9-]{0,15}$

minLength: 1

maxLength: 15

settings object

optional, allows configure `clickhouse-server` settings inside <yandex>...</yandex> tag in `Pod` only in one replica during generate `ConfigMap` which will mount in `/etc/clickhouse-server/conf.d/` override top-level `chi.spec.configuration.settings`, cluster-level `chi.spec.configuration.clusters.settings` and will ignore if shard-level `chi.spec.configuration.clusters.layout.shards` present More details: https://clickhouse.tech/docs/en/operations/settings/settings/

shards []object

optional, list of shards related to current replica, will ignore if `chi.spec.configuration.clusters.layout.shards` presents

files object

optional, allows define content of any setting file inside each `Pod` only in one shard related to current replica during generate `ConfigMap` which will mount in `/etc/clickhouse-server/config.d/` or `/etc/clickhouse-server/conf.d/` or `/etc/clickhouse-server/users.d/` override top-level `chi.spec.configuration.files` and cluster-level `chi.spec.configuration.clusters.files`, will ignore if `chi.spec.configuration.clusters.layout.shards` presents

name string

optional, by default shard name is generated, but you can override it and setup custom name

pattern: ^[a-zA-Z0-9-]{0,15}$

minLength: 1

maxLength: 15

raftPort integer

minimum: 1

maximum: 65535

settings object

optional, allows configure `clickhouse-server` settings inside <yandex>...</yandex> tag in `Pod` only in one shard related to current replica during generate `ConfigMap` which will mount in `/etc/clickhouse-server/conf.d/` override top-level `chi.spec.configuration.settings`, cluster-level `chi.spec.configuration.clusters.settings` and replica-level `chi.spec.configuration.clusters.layout.replicas.settings` More details: https://clickhouse.tech/docs/en/operations/settings/settings/

templates object

optional, configuration of the templates names which will use for generate Kubernetes resources according to selected replica override top-level `chi.spec.configuration.templates`, cluster-level `chi.spec.configuration.clusters.templates`, replica-level `chi.spec.configuration.clusters.layout.replicas.templates`

clusterServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each clickhouse cluster described in `chi.spec.configuration.clusters`

dataVolumeClaimTemplate string

optional, template name from chi.spec.templates.volumeClaimTemplates, allows customization each `PVC` which will mount for clickhouse data directory in each `Pod` during render and reconcile every StatefulSet.spec resource described in `chi.spec.configuration.clusters`

hostTemplate string

optional, template name from chi.spec.templates.hostTemplates, which will apply to configure every `clickhouse-server` instance during render ConfigMap resources which will mount into `Pod`

logVolumeClaimTemplate string

optional, template name from chi.spec.templates.volumeClaimTemplates, allows customization each `PVC` which will mount for clickhouse log directory in each `Pod` during render and reconcile every StatefulSet.spec resource described in `chi.spec.configuration.clusters`

podTemplate string

optional, template name from chi.spec.templates.podTemplates, allows customization each `Pod` resource during render and reconcile each StatefulSet.spec resource described in `chi.spec.configuration.clusters`

replicaServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each replica inside each shard inside each clickhouse cluster described in `chi.spec.configuration.clusters`

serviceTemplate string

optional, template name from chi.spec.templates.serviceTemplates. used for customization of the `Service` resource, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

serviceTemplates []string

optional, template names from chi.spec.templates.serviceTemplates. used for customization of the `Service` resources, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

shardServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each shard inside clickhouse cluster described in `chi.spec.configuration.clusters`

volumeClaimTemplate string

optional, alias for dataVolumeClaimTemplate, template name from chi.spec.templates.volumeClaimTemplates, allows customization each `PVC` which will mount for clickhouse data directory in each `Pod` during render and reconcile every StatefulSet.spec resource described in `chi.spec.configuration.clusters`

zkPort integer

minimum: 1

maximum: 65535

zkPortSecure integer

optional, secure (TLS) Keeper client port; emitted alongside zkPort when the cluster opts into secure mode

minimum: 1

maximum: 65535

shardsCount integer

optional, count of shards related to current replica, you can override each shard behavior on low-level `chi.spec.configuration.clusters.layout.replicas.shards`

minimum: 1

templates object

clusterServiceTemplate string

dataVolumeClaimTemplate string

hostTemplate string

optional, template name from chi.spec.templates.hostTemplates, which will apply to configure every `clickhouse-server` instance during render ConfigMap resources which will mount into `Pod`

logVolumeClaimTemplate string

podTemplate string

replicaServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each replica inside each shard inside each clickhouse cluster described in `chi.spec.configuration.clusters`

serviceTemplate string

optional, template name from chi.spec.templates.serviceTemplates. used for customization of the `Service` resource, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

serviceTemplates []string

optional, template names from chi.spec.templates.serviceTemplates. used for customization of the `Service` resources, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

shardServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each shard inside clickhouse cluster described in `chi.spec.configuration.clusters`

volumeClaimTemplate string

replicasCount integer

how much replicas in each shards for current cluster will run in Kubernetes, each replica is a separate `StatefulSet` which contains only one `Pod` with `clickhouse-server` instance, every shard contains 1 replica by default"

name string

cluster name, used to identify set of servers and wide used during generate names of related Kubernetes resources

pattern: ^[a-zA-Z0-9-]{0,15}$

minLength: 1

maxLength: 15

pdbManaged object

Specifies whether the Pod Disruption Budget (PDB) should be managed. During the next installation, if PDB management is enabled, the operator will attempt to retrieve any existing PDB. If none is found, it will create a new one and initiate a reconciliation loop. If PDB management is disabled, the existing PDB will remain intact, and the reconciliation loop will not be executed. By default, PDB management is enabled.

pdbMaxUnavailable integer

Pod eviction is allowed if at most "pdbMaxUnavailable" pods are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".

minimum: 0

maximum: 65535

secure object

optional, open secure (TLS) Keeper client ports for this cluster. Translates into <secure>1</secure> in Raft server entries so peer Keeper instances dial each other over TLS. Mirrors the cluster.secure flag on CHI.

security object

Per-cluster security toggles. Nil fields fall through to CHK spec security and then to operator-wide defaults in ClickHouseOperatorConfiguration. Symmetric with chi.spec.configuration.clusters[].security. See docs/security_hardening.md.

settings object

optional, allows configure `clickhouse-server` settings inside <yandex>...</yandex> tag in each `Pod` only in one cluster during generate `ConfigMap` which will mount in `/etc/clickhouse-server/config.d/` override top-level `chi.spec.configuration.settings` More details: https://clickhouse.tech/docs/en/operations/settings/settings/

templates object

optional, configuration of the templates names which will use for generate Kubernetes resources according to selected cluster override top-level `chi.spec.configuration.templates`

clusterServiceTemplate string

dataVolumeClaimTemplate string

hostTemplate string

optional, template name from chi.spec.templates.hostTemplates, which will apply to configure every `clickhouse-server` instance during render ConfigMap resources which will mount into `Pod`

logVolumeClaimTemplate string

podTemplate string

replicaServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each replica inside each shard inside each clickhouse cluster described in `chi.spec.configuration.clusters`

serviceTemplate string

optional, template name from chi.spec.templates.serviceTemplates. used for customization of the `Service` resource, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

serviceTemplates []string

optional, template names from chi.spec.templates.serviceTemplates. used for customization of the `Service` resources, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

shardServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each shard inside clickhouse cluster described in `chi.spec.configuration.clusters`

volumeClaimTemplate string

files object

allows define content of any setting

settings object

allows configure multiple aspects and behavior for `clickhouse-keeper` instance

defaults object

define default behavior for whole ClickHouseInstallation, some behavior can be re-define on cluster, shard and replica level More info: https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md#specdefaults

distributedDDL object

allows change `<yandex><distributed_ddl></distributed_ddl></yandex>` settings More info: https://clickhouse.tech/docs/en/operations/server-configuration-parameters/settings/#server-settings-distributed_ddl

profile string

Settings from this profile will be used to execute DDL queries

replicasUseFQDN object

define should replicas be specified by FQDN in `<host></host>`. In case of "no" will use short hostname and clickhouse-server will use kubernetes default suffixes for DNS lookup "no" by default

storageManagement object

default storage management options

provisioner string

defines `PVC` provisioner - be it StatefulSet or the Operator

enum: , StatefulSet, Operator

reclaimPolicy string

defines behavior of `PVC` deletion. `Delete` by default, if `Retain` specified then `PVC` will be kept when deleting StatefulSet

enum: , Retain, Delete

templates object

optional, configuration of the templates names which will use for generate Kubernetes resources according to one or more ClickHouse clusters described in current ClickHouseInstallation (chi) resource

clusterServiceTemplate string

dataVolumeClaimTemplate string

hostTemplate string

optional, template name from chi.spec.templates.hostTemplates, which will apply to configure every `clickhouse-server` instance during render ConfigMap resources which will mount into `Pod`

logVolumeClaimTemplate string

podTemplate string

replicaServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each replica inside each shard inside each clickhouse cluster described in `chi.spec.configuration.clusters`

serviceTemplate string

optional, template name from chi.spec.templates.serviceTemplates. used for customization of the `Service` resource, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

serviceTemplates []string

optional, template names from chi.spec.templates.serviceTemplates. used for customization of the `Service` resources, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

shardServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each shard inside clickhouse cluster described in `chi.spec.configuration.clusters`

volumeClaimTemplate string

namespaceDomainPattern string

Custom domain pattern which will be used for DNS names of `Service` or `Pod`. Typical use scenario - custom cluster domain in Kubernetes cluster Example: %s.svc.my.test

reconciling object

Optional, allows tuning reconciling cycle for ClickhouseInstallation from clickhouse-operator side

cleanup object

Optional, defines behavior for cleanup Kubernetes resources during reconcile cycle

reconcileFailedObjects object

Describes what clickhouse-operator should do with Kubernetes resources which are failed during reconcile. Default behavior is `Retain`"

configMap string

Behavior policy for failed ConfigMap, `Retain` by default

enum: , Retain, Delete

pvc string

Behavior policy for failed PVC, `Retain` by default

enum: , Retain, Delete

service string

Behavior policy for failed Service, `Retain` by default

enum: , Retain, Delete

statefulSet string

Behavior policy for failed StatefulSet, `Retain` by default

enum: , Retain, Delete

unknownObjects object

Describes what clickhouse-operator should do with found Kubernetes resources which should be managed by clickhouse-operator, but do not have `ownerReference` to any currently managed `ClickHouseInstallation` resource. Default behavior is `Delete`"

configMap string

Behavior policy for unknown ConfigMap, `Delete` by default

enum: , Retain, Delete

pvc string

Behavior policy for unknown PVC, `Delete` by default

enum: , Retain, Delete

service string

Behavior policy for unknown Service, `Delete` by default

enum: , Retain, Delete

statefulSet string

Behavior policy for unknown StatefulSet, `Delete` by default

enum: , Retain, Delete

configMapPropagationTimeout integer

Timeout in seconds for `clickhouse-operator` to wait for modified `ConfigMap` to propagate into the `Pod` More details: https://kubernetes.io/docs/concepts/configuration/configmap/#mounted-configmaps-are-updated-automatically

minimum: 0

maximum: 3600

policy string

DISCUSSED TO BE DEPRECATED Syntax sugar Overrides all three 'reconcile.host.wait.{exclude, queries, include}' values from the operator's config Possible values: - wait - should wait to exclude host, complete queries and include host back into the cluster - nowait - should NOT wait to exclude host, complete queries and include host back into the cluster

enum: , wait, nowait

security object

CHK-level security defaults, applied to every cluster that does not override them. Symmetric with chi.spec.security. See docs/security_hardening.md.

stop object

Allows to stop all ClickHouse Keeper clusters defined in a CHK. Works as the following: - When `stop` is `1` operator sets `Replicas: 0` in each StatefulSet. Thie leads to having all `Pods` and `Service` deleted. All PVCs are kept intact. - When `stop` is `0` operator sets `Replicas: 1` and `Pod`s and `Service`s will created again and all retained PVCs will be attached to `Pod`s.

suspend object

Suspend reconciliation of resources managed by a ClickHouse Keeper. Works as the following: - When `suspend` is `true` operator stops reconciling all resources. - When `suspend` is `false` or not set, operator reconciles all resources.

taskID string

Allows to define custom taskID for CHI update and watch status of this update execution. Displayed in all .status.taskID* fields. By default (if not filled) every update of CHI manifest will generate random taskID

templates object

allows define templates which will use for render Kubernetes resources like StatefulSet, ConfigMap, Service, PVC, by default, clickhouse-operator have own templates, but you can override it

hostTemplates []object

hostTemplate will use during apply to generate `clickhose-server` config files

name string

template name, could use to link inside top-level `chi.spec.defaults.templates.hostTemplate`, cluster-level `chi.spec.configuration.clusters.templates.hostTemplate`, shard-level `chi.spec.configuration.clusters.layout.shards.temlates.hostTemplate`, replica-level `chi.spec.configuration.clusters.layout.replicas.templates.hostTemplate`

portDistribution []object

define how will distribute numeric values of named ports in `Pod.spec.containers.ports` and clickhouse-server configs

type string

type of distribution, when `Unspecified` (default value) then all listen ports on clickhouse-server configuration in all Pods will have the same value, when `ClusterScopeIndex` then ports will increment to offset from base value depends on shard and replica index inside cluster with combination of `chi.spec.templates.podTemlates.spec.HostNetwork` it allows setup ClickHouse cluster inside Kubernetes and provide access via external network bypass Kubernetes internal network

enum: , Unspecified, ClusterScopeIndex

spec object

files object

optional, allows define content of any setting file inside each `Pod` where this template will apply during generate `ConfigMap` which will mount in `/etc/clickhouse-server/config.d/` or `/etc/clickhouse-server/conf.d/` or `/etc/clickhouse-server/users.d/`

name string

by default, hostname will generate, but this allows define custom name for each `clickhouse-server`

pattern: ^[a-zA-Z0-9-]{0,15}$

minLength: 1

maxLength: 15

raftPort integer

minimum: 1

maximum: 65535

settings object

optional, allows configure `clickhouse-server` settings inside <yandex>...</yandex> tag in each `Pod` where this template will apply during generate `ConfigMap` which will mount in `/etc/clickhouse-server/conf.d/` More details: https://clickhouse.tech/docs/en/operations/settings/settings/

templates object

be careful, this part of CRD allows override template inside template, don't use it if you don't understand what you do

clusterServiceTemplate string

dataVolumeClaimTemplate string

hostTemplate string

optional, template name from chi.spec.templates.hostTemplates, which will apply to configure every `clickhouse-server` instance during render ConfigMap resources which will mount into `Pod`

logVolumeClaimTemplate string

podTemplate string

replicaServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each replica inside each shard inside each clickhouse cluster described in `chi.spec.configuration.clusters`

serviceTemplate string

optional, template name from chi.spec.templates.serviceTemplates. used for customization of the `Service` resource, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

serviceTemplates []string

optional, template names from chi.spec.templates.serviceTemplates. used for customization of the `Service` resources, created by `clickhouse-operator` to cover all clusters in whole `chi` resource

shardServiceTemplate string

optional, template name from chi.spec.templates.serviceTemplates, allows customization for each `Service` resource which will created by `clickhouse-operator` which cover each shard inside clickhouse cluster described in `chi.spec.configuration.clusters`

volumeClaimTemplate string

zkPort integer

minimum: 1

maximum: 65535

zkPortSecure integer

optional, secure (TLS) Keeper client port; emitted alongside zkPort when the cluster opts into secure mode

minimum: 1

maximum: 65535

podTemplates []object

podTemplate will use during render `Pod` inside `StatefulSet.spec` and allows define rendered `Pod.spec`, pod scheduling distribution and pod zone More information: https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md#spectemplatespodtemplates

distribution string

DEPRECATED, shortcut for `chi.spec.templates.podTemplates.spec.affinity.podAntiAffinity`

enum: , Unspecified, OnePerHost

generateName string

allows define format for generated `Pod` name, look to https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md#spectemplatesservicetemplates for details about available template variables

metadata object

allows pass standard object's metadata from template to Pod More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

name string

template name, could use to link inside top-level `chi.spec.defaults.templates.podTemplate`, cluster-level `chi.spec.configuration.clusters.templates.podTemplate`, shard-level `chi.spec.configuration.clusters.layout.shards.temlates.podTemplate`, replica-level `chi.spec.configuration.clusters.layout.replicas.templates.podTemplate`

podDistribution []object

define ClickHouse Pod distribution policy between Kubernetes Nodes inside Shard, Replica, Namespace, CHI, another ClickHouse cluster

number integer

define, how much ClickHouse Pods could be inside selected scope with selected distribution type

minimum: 0

maximum: 65535

scope string

scope for apply each podDistribution

enum: , Unspecified, Shard, Replica, Cluster, ClickHouseInstallation, Namespace

topologyKey string

use for inter-pod affinity look to `pod.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey`, more info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity"

type string

you can define multiple affinity policy types

enum:

, Unspecified, ClickHouseAntiAffinity, ShardAntiAffinity, ReplicaAntiAffinity, AnotherNamespaceAntiAffinity, AnotherClic...

, Unspecified, ClickHouseAntiAffinity, ShardAntiAffinity, ReplicaAntiAffinity, AnotherNamespaceAntiAffinity, AnotherClickHouseInstallationAntiAffinity, AnotherClusterAntiAffinity, MaxNumberPerNode, NamespaceAffinity, ClickHouseInstallationAffinity, ClusterAffinity, ShardAffinity, ReplicaAffinity, PreviousTailAffinity, CircularReplication

spec object

allows define whole Pod.spec inside StaefulSet.spec, look to https://kubernetes.io/docs/concepts/workloads/pods/#pod-templates for details

zone object

allows define custom zone name and will separate ClickHouse `Pods` between nodes, shortcut for `chi.spec.templates.podTemplates.spec.affinity.podAntiAffinity`

key string

optional, if defined, allows select kubernetes nodes by label with `name` equal `key`

values []string

optional, if defined, allows select kubernetes nodes by label with `value` in `values`

serviceTemplates []object

allows define template for rendering `Service` which would get endpoint from Pods which scoped chi-wide, cluster-wide, shard-wide, replica-wide level

generateName string

allows define format for generated `Service` name, look to https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md#spectemplatesservicetemplates for details about available template variables"

metadata object

allows pass standard object's metadata from template to Service Could be use for define specificly for Cloud Provider metadata which impact to behavior of service More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

name string

template name, could use to link inside chi-level `chi.spec.defaults.templates.serviceTemplate` cluster-level `chi.spec.configuration.clusters.templates.clusterServiceTemplate` shard-level `chi.spec.configuration.clusters.layout.shards.temlates.shardServiceTemplate` replica-level `chi.spec.configuration.clusters.layout.replicas.templates.replicaServiceTemplate` or `chi.spec.configuration.clusters.layout.shards.replicas.replicaServiceTemplate`

spec object

describe behavior of generated Service More info: https://kubernetes.io/docs/concepts/services-networking/service/

volumeClaimTemplates []object

allows define template for rendering `PVC` kubernetes resource, which would use inside `Pod` for mount clickhouse `data`, clickhouse `logs` or something else

metadata object

allows to pass standard object's metadata from template to PVC More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

name string

template name, could use to link inside top-level `chi.spec.defaults.templates.dataVolumeClaimTemplate` or `chi.spec.defaults.templates.logVolumeClaimTemplate`, cluster-level `chi.spec.configuration.clusters.templates.dataVolumeClaimTemplate` or `chi.spec.configuration.clusters.templates.logVolumeClaimTemplate`, shard-level `chi.spec.configuration.clusters.layout.shards.temlates.dataVolumeClaimTemplate` or `chi.spec.configuration.clusters.layout.shards.temlates.logVolumeClaimTemplate` replica-level `chi.spec.configuration.clusters.layout.replicas.templates.dataVolumeClaimTemplate` or `chi.spec.configuration.clusters.layout.replicas.templates.logVolumeClaimTemplate`

provisioner string

defines `PVC` provisioner - be it StatefulSet or the Operator

enum: , StatefulSet, Operator

reclaimPolicy string

defines behavior of `PVC` deletion. `Delete` by default, if `Retain` specified then `PVC` will be kept when deleting StatefulSet

enum: , Retain, Delete

spec object

allows define all aspects of `PVC` resource More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

status object

Status contains many fields like a normalized configuration, clickhouse-operator version, current action and all applied action list, current taskID and all applied taskIDs and other

action string

Action

actions []string

Actions

chop-commit string

Operator git commit SHA

chop-date string

Operator build date

chop-ip string

IP address of the operator's pod which managed this resource

chop-version string

Operator version

clusters integer

Clusters count

minimum: 0

endpoint string

Endpoint

endpoints []string

All endpoints

error string

Last error

errors []string

Errors

fqdns []string

Pods FQDNs

generation integer

Generation

minimum: 0

hosts integer

Hosts count

minimum: 0

hostsAdded integer

Added Hosts count

minimum: 0

hostsCompleted integer

Completed Hosts count

minimum: 0

hostsDelete integer

About to delete Hosts count

minimum: 0

hostsDeleted integer

Deleted Hosts count

minimum: 0

hostsUnchanged integer

Unchanged Hosts count

minimum: 0

hostsUpdated integer

Updated Hosts count

minimum: 0

hostsWithReplicaCaughtUp []string

List of hosts with replica caught up

hostsWithTablesCreated []string

List of hosts with tables created by the operator

normalized object

Normalized resource requested

normalizedCompleted object

Normalized resource completed

pod-ips []string

Pod IPs

pods []string

Pods

replicas integer

Replicas count

minimum: 0

shards integer

Shards count

minimum: 0

status string

Status

taskID string

Current task id

taskIDsCompleted []string

Completed task ids

taskIDsStarted []string

Started task ids

usedTemplates []object

List of templates used to build this CHI

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