r8s
Data & Analytics

clickhouse

ClickHouse Operator for Kubernetes by Altinity

@r8s/crds/clickhouse

clickhouse

Declared Operator

⚙

clickhouse-operator

version 0.25.0

Components (1)

01

ClickHouseInstallation

Render a ClickHouseInstallation (clickhouse.altinity.com/v1) exactly as defined by its CRD.


import { ClickHouseInstallationComponent } from '@r8s/crds/clickhouse'

<ClickHouseInstallationComponent
  metadata={{ name: 'clickhouse', namespace: 'default' }}
  spec={{
    configuration: {
      clusters: [{ name: 'default', layout: { shardsCount: 1, replicasCount: 1 } }],
    },
  }}
/>
"taskID"stringOptional—

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

"stop"RecordOptional—

Allows to stop all ClickHouse clusters defined in a CHI. 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 Pods and Services will created again and all retained PVCs will be attached to Pods.

"restart""" | "RollingUpdate" | "rollingupdate"Optional—

In case 'RollingUpdate' specified, the operator will always restart ClickHouse pods during reconcile. This options is used in rare cases when force restart is required and is typically removed after the use in order to avoid unneeded restarts.

"suspend"RecordOptional—

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

"troubleshoot"RecordOptional—

Allows to troubleshoot Pods during CrashLoopBack state. This may happen when wrong configuration applied, in this case clickhouse-server wouldn't start. Command within ClickHouse container is modified with sleep in order to avoid quick restarts and give time to troubleshoot via CLI. Liveness and Readiness probes are disabled as well.

"namespaceDomainPattern"stringOptional—

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

"templating"TemplatingOptional—

Optional, applicable inside ClickHouseInstallationTemplate only. Defines current ClickHouseInstallationTemplate application options to target ClickHouseInstallation(s)."

"reconciling"ReconcilingOptional—

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

"reconcile"ReconcileOptional—

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

"defaults"DefaultsOptional—

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

"configuration"ConfigurationOptional—

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

"templates"Templates2Optional—

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

"security"RecordOptional—

CHI-level security defaults, applied to every cluster that does not override them. Each cluster can shadow these via spec.configuration.clusters[].security. See docs/security_hardening.md for details.

"useTemplates"UseTemplatesItem[]Optional—

list of ClickHouseInstallationTemplate (chit) resource names which will merge with current CHI manifest during render Kubernetes resources to create related ClickHouse clusters"

←All packages