{
"description": "define a set of Kubernetes resources (StatefulSet, PVC, Service, ConfigMap) which describe behavior one or more clusters",
"type": "object",
"required": [
"spec"
],
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation\nof an object. Servers should convert recognized schemas to the latest\ninternal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this\nobject represents. Servers may infer this from the endpoint the client\nsubmits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n",
"type": "string"
},
"metadata": {
"type": "object"
},
"status": {
"type": "object",
"description": "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\n",
"properties": {
"chop-version": {
"type": "string",
"description": "Operator version"
},
"chop-commit": {
"type": "string",
"description": "Operator git commit SHA"
},
"chop-date": {
"type": "string",
"description": "Operator build date"
},
"chop-ip": {
"type": "string",
"description": "IP address of the operator's pod which managed this resource"
},
"clusters": {
"type": "integer",
"minimum": 0,
"description": "Clusters count"
},
"shards": {
"type": "integer",
"minimum": 0,
"description": "Shards count"
},
"replicas": {
"type": "integer",
"minimum": 0,
"description": "Replicas count"
},
"hosts": {
"type": "integer",
"minimum": 0,
"description": "Hosts count"
},
"status": {
"type": "string",
"description": "Status"
},
"taskID": {
"type": "string",
"description": "Current task id"
},
"taskIDsStarted": {
"type": "array",
"description": "Started task ids",
"nullable": true,
"items": {
"type": "string"
}
},
"taskIDsCompleted": {
"type": "array",
"description": "Completed task ids",
"nullable": true,
"items": {
"type": "string"
}
},
"action": {
"type": "string",
"description": "Action"
},
"actions": {
"type": "array",
"description": "Actions",
"nullable": true,
"items": {
"type": "string"
}
},
"error": {
"type": "string",
"description": "Last error"
},
"errors": {
"type": "array",
"description": "Errors",
"nullable": true,
"items": {
"type": "string"
}
},
"hostsUnchanged": {
"type": "integer",
"minimum": 0,
"description": "Unchanged Hosts count"
},
"hostsUpdated": {
"type": "integer",
"minimum": 0,
"description": "Updated Hosts count"
},
"hostsAdded": {
"type": "integer",
"minimum": 0,
"description": "Added Hosts count"
},
"hostsCompleted": {
"type": "integer",
"minimum": 0,
"description": "Completed Hosts count"
},
"hostsDeleted": {
"type": "integer",
"minimum": 0,
"description": "Deleted Hosts count"
},
"hostsDelete": {
"type": "integer",
"minimum": 0,
"description": "About to delete Hosts count"
},
"pods": {
"type": "array",
"description": "Pods",
"nullable": true,
"items": {
"type": "string"
}
},
"pod-ips": {
"type": "array",
"description": "Pod IPs",
"nullable": true,
"items": {
"type": "string"
}
},
"fqdns": {
"type": "array",
"description": "Pods FQDNs",
"nullable": true,
"items": {
"type": "string"
}
},
"endpoint": {
"type": "string",
"description": "Endpoint"
},
"endpoints": {
"type": "array",
"description": "All endpoints",
"nullable": true,
"items": {
"type": "string"
}
},
"generation": {
"type": "integer",
"minimum": 0,
"description": "Generation"
},
"normalized": {
"type": "object",
"description": "Normalized resource requested",
"nullable": true,
"x-kubernetes-preserve-unknown-fields": true
},
"normalizedCompleted": {
"type": "object",
"description": "Normalized resource completed",
"nullable": true,
"x-kubernetes-preserve-unknown-fields": true
},
"hostsWithTablesCreated": {
"type": "array",
"description": "List of hosts with tables created by the operator",
"nullable": true,
"items": {
"type": "string"
}
},
"hostsWithReplicaCaughtUp": {
"type": "array",
"description": "List of hosts with replica caught up",
"nullable": true,
"items": {
"type": "string"
}
},
"usedTemplates": {
"type": "array",
"description": "List of templates used to build this CHI",
"nullable": true,
"x-kubernetes-preserve-unknown-fields": true,
"items": {
"type": "object",
"x-kubernetes-preserve-unknown-fields": true
}
}
},
"additionalProperties": false
},
"spec": {
"type": "object",
"description": "Specification of the desired behavior of one or more ClickHouse clusters\nMore info: https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md\n",
"properties": {
"taskID": {
"type": "string",
"description": "Allows to define custom taskID for CHI update and watch status of this update execution.\nDisplayed in all .status.taskID* fields.\nBy default (if not filled) every update of CHI manifest will generate random taskID\n"
},
"stop": {
"type": "string",
"description": "Allows to stop all ClickHouse Keeper clusters defined in a CHK.\nWorks as the following:\n - 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.\n - 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.\n",
"enum": [
"",
"0",
"1",
"False",
"false",
"True",
"true",
"No",
"no",
"Yes",
"yes",
"Off",
"off",
"On",
"on",
"Disable",
"disable",
"Enable",
"enable",
"Disabled",
"disabled",
"Enabled",
"enabled"
]
},
"suspend": {
"type": "string",
"description": "Suspend reconciliation of resources managed by a ClickHouse Keeper.\nWorks as the following:\n - When `suspend` is `true` operator stops reconciling all resources.\n - When `suspend` is `false` or not set, operator reconciles all resources.\n",
"enum": [
"",
"0",
"1",
"False",
"false",
"True",
"true",
"No",
"no",
"Yes",
"yes",
"Off",
"off",
"On",
"on",
"Disable",
"disable",
"Enable",
"enable",
"Disabled",
"disabled",
"Enabled",
"enabled"
]
},
"namespaceDomainPattern": {
"type": "string",
"description": "Custom domain pattern which will be used for DNS names of `Service` or `Pod`.\nTypical use scenario - custom cluster domain in Kubernetes cluster\nExample: %s.svc.my.test\n"
},
"reconciling": {
"type": "object",
"description": "Optional, allows tuning reconciling cycle for ClickhouseInstallation from clickhouse-operator side",
"properties": {
"policy": {
"type": "string",
"description": "DISCUSSED TO BE DEPRECATED\nSyntax sugar\nOverrides all three 'reconcile.host.wait.{exclude, queries, include}' values from the operator's config\nPossible values:\n - wait - should wait to exclude host, complete queries and include host back into the cluster\n - nowait - should NOT wait to exclude host, complete queries and include host back into the cluster\n",
"enum": [
"",
"wait",
"nowait"
]
},
"configMapPropagationTimeout": {
"type": "integer",
"description": "Timeout in seconds for `clickhouse-operator` to wait for modified `ConfigMap` to propagate into the `Pod`\nMore details: https://kubernetes.io/docs/concepts/configuration/configmap/#mounted-configmaps-are-updated-automatically\n",
"minimum": 0,
"maximum": 3600
},
"cleanup": {
"type": "object",
"description": "Optional, defines behavior for cleanup Kubernetes resources during reconcile cycle",
"properties": {
"unknownObjects": {
"type": "object",
"description": "Describes what clickhouse-operator should do with found Kubernetes resources which should be managed by clickhouse-operator,\nbut do not have `ownerReference` to any currently managed `ClickHouseInstallation` resource.\nDefault behavior is `Delete`\"\n",
"properties": {
"statefulSet": {
"type": "string",
"description": "Behavior policy for unknown StatefulSet, `Delete` by default",
"enum": [
"",
"Retain",
"Delete"
]
},
"pvc": {
"type": "string",
"description": "Behavior policy for unknown PVC, `Delete` by default",
"enum": [
"",
"Retain",
"Delete"
]
},
"configMap": {
"type": "string",
"description": "Behavior policy for unknown ConfigMap, `Delete` by default",
"enum": [
"",
"Retain",
"Delete"
]
},
"service": {
"type": "string",
"description": "Behavior policy for unknown Service, `Delete` by default",
"enum": [
"",
"Retain",
"Delete"
]
}
},
"additionalProperties": false
},
"reconcileFailedObjects": {
"type": "object",
"description": "Describes what clickhouse-operator should do with Kubernetes resources which are failed during reconcile.\nDefault behavior is `Retain`\"\n",
"properties": {
"statefulSet": {
"type": "string",
"description": "Behavior policy for failed StatefulSet, `Retain` by default",
"enum": [
"",
"Retain",
"Delete"
]
},
"pvc": {
"type": "string",
"description": "Behavior policy for failed PVC, `Retain` by default",
"enum": [
"",
"Retain",
"Delete"
]
},
"configMap": {
"type": "string",
"description": "Behavior policy for failed ConfigMap, `Retain` by default",
"enum": [
"",
"Retain",
"Delete"
]
},
"service": {
"type": "string",
"description": "Behavior policy for failed Service, `Retain` by default",
"enum": [
"",
"Retain",
"Delete"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"defaults": {
"type": "object",
"description": "define default behavior for whole ClickHouseInstallation, some behavior can be re-define on cluster, shard and replica level\nMore info: https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md#specdefaults\n",
"properties": {
"replicasUseFQDN": {
"type": "string",
"description": "define should replicas be specified by FQDN in ``.\nIn case of \"no\" will use short hostname and clickhouse-server will use kubernetes default suffixes for DNS lookup\n\"no\" by default\n",
"enum": [
"",
"0",
"1",
"False",
"false",
"True",
"true",
"No",
"no",
"Yes",
"yes",
"Off",
"off",
"On",
"on",
"Disable",
"disable",
"Enable",
"enable",
"Disabled",
"disabled",
"Enabled",
"enabled"
]
},
"distributedDDL": {
"type": "object",
"description": "allows change `` settings\nMore info: https://clickhouse.tech/docs/en/operations/server-configuration-parameters/settings/#server-settings-distributed_ddl\n",
"properties": {
"profile": {
"type": "string",
"description": "Settings from this profile will be used to execute DDL queries"
}
},
"additionalProperties": false
},
"storageManagement": {
"type": "object",
"description": "default storage management options",
"properties": {
"provisioner": {
"type": "string",
"description": "defines `PVC` provisioner - be it StatefulSet or the Operator",
"enum": [
"",
"StatefulSet",
"Operator"
]
},
"reclaimPolicy": {
"type": "string",
"description": "defines behavior of `PVC` deletion.\n`Delete` by default, if `Retain` specified then `PVC` will be kept when deleting StatefulSet\n",
"enum": [
"",
"Retain",
"Delete"
]
}
},
"additionalProperties": false
},
"templates": {
"type": "object",
"description": "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",
"properties": {
"hostTemplate": {
"type": "string",
"description": "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`"
},
"podTemplate": {
"type": "string",
"description": "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`"
},
"dataVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"logVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"serviceTemplate": {
"type": "string",
"description": "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": {
"type": "array",
"description": "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",
"nullable": true,
"items": {
"type": "string"
}
},
"clusterServiceTemplate": {
"type": "string",
"description": "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`"
},
"shardServiceTemplate": {
"type": "string",
"description": "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`"
},
"replicaServiceTemplate": {
"type": "string",
"description": "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`"
},
"volumeClaimTemplate": {
"type": "string",
"description": "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`"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"configuration": {
"type": "object",
"description": "allows configure multiple aspects and behavior for `clickhouse-server` instance and also allows describe multiple `clickhouse-server` clusters inside one `chi` resource",
"properties": {
"settings": {
"type": "object",
"description": "allows configure multiple aspects and behavior for `clickhouse-keeper` instance\n",
"x-kubernetes-preserve-unknown-fields": true
},
"files": {
"type": "object",
"description": "allows define content of any setting\n",
"x-kubernetes-preserve-unknown-fields": true
},
"clusters": {
"type": "array",
"description": "describes clusters layout and allows change settings on cluster-level and replica-level\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "cluster name, used to identify set of servers and wide used during generate names of related Kubernetes resources",
"minLength": 1,
"maxLength": 15,
"pattern": "^[a-zA-Z0-9-]{0,15}$"
},
"settings": {
"type": "object",
"description": "optional, allows configure `clickhouse-server` settings inside ... tag in each `Pod` only in one cluster during generate `ConfigMap` which will mount in `/etc/clickhouse-server/config.d/`\noverride top-level `chi.spec.configuration.settings`\nMore details: https://clickhouse.tech/docs/en/operations/settings/settings/\n",
"x-kubernetes-preserve-unknown-fields": true
},
"files": {
"type": "object",
"description": "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/`\noverride top-level `chi.spec.configuration.files`\n",
"x-kubernetes-preserve-unknown-fields": true
},
"templates": {
"type": "object",
"description": "optional, configuration of the templates names which will use for generate Kubernetes resources according to selected cluster\noverride top-level `chi.spec.configuration.templates`\n",
"properties": {
"hostTemplate": {
"type": "string",
"description": "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`"
},
"podTemplate": {
"type": "string",
"description": "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`"
},
"dataVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"logVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"serviceTemplate": {
"type": "string",
"description": "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": {
"type": "array",
"description": "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",
"nullable": true,
"items": {
"type": "string"
}
},
"clusterServiceTemplate": {
"type": "string",
"description": "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`"
},
"shardServiceTemplate": {
"type": "string",
"description": "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`"
},
"replicaServiceTemplate": {
"type": "string",
"description": "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`"
},
"volumeClaimTemplate": {
"type": "string",
"description": "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`"
}
},
"additionalProperties": false
},
"pdbManaged": {
"type": "string",
"description": "Specifies whether the Pod Disruption Budget (PDB) should be managed.\nDuring the next installation, if PDB management is enabled, the operator will\nattempt to retrieve any existing PDB. If none is found, it will create a new one\nand initiate a reconciliation loop. If PDB management is disabled, the existing PDB\nwill remain intact, and the reconciliation loop will not be executed. By default,\nPDB management is enabled.\n",
"enum": [
"",
"0",
"1",
"False",
"false",
"True",
"true",
"No",
"no",
"Yes",
"yes",
"Off",
"off",
"On",
"on",
"Disable",
"disable",
"Enable",
"enable",
"Disabled",
"disabled",
"Enabled",
"enabled"
]
},
"pdbMaxUnavailable": {
"type": "integer",
"description": "Pod eviction is allowed if at most \"pdbMaxUnavailable\" pods are unavailable after the eviction,\ni.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions\nby specifying 0. This is a mutually exclusive setting with \"minAvailable\".\n",
"minimum": 0,
"maximum": 65535
},
"layout": {
"type": "object",
"description": "describe current cluster layout, how much shards in cluster, how much replica in shard\nallows override settings on each shard and replica separatelly\n",
"properties": {
"replicasCount": {
"type": "integer",
"description": "how much replicas in each shards for current cluster will run in Kubernetes,\neach replica is a separate `StatefulSet` which contains only one `Pod` with `clickhouse-server` instance,\nevery shard contains 1 replica by default\"\n"
},
"replicas": {
"type": "array",
"description": "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",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "optional, by default replica name is generated, but you can override it and setup custom name",
"minLength": 1,
"maxLength": 15,
"pattern": "^[a-zA-Z0-9-]{0,15}$"
},
"settings": {
"type": "object",
"description": "optional, allows configure `clickhouse-server` settings inside ... tag in `Pod` only in one replica during generate `ConfigMap` which will mount in `/etc/clickhouse-server/conf.d/`\noverride 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\nMore details: https://clickhouse.tech/docs/en/operations/settings/settings/\n",
"x-kubernetes-preserve-unknown-fields": true
},
"files": {
"type": "object",
"description": "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/`\noverride top-level `chi.spec.configuration.files` and cluster-level `chi.spec.configuration.clusters.files`, will ignore if `chi.spec.configuration.clusters.layout.shards` presents\n",
"x-kubernetes-preserve-unknown-fields": true
},
"templates": {
"type": "object",
"description": "optional, configuration of the templates names which will use for generate Kubernetes resources according to selected replica\noverride top-level `chi.spec.configuration.templates`, cluster-level `chi.spec.configuration.clusters.templates`\n",
"properties": {
"hostTemplate": {
"type": "string",
"description": "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`"
},
"podTemplate": {
"type": "string",
"description": "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`"
},
"dataVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"logVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"serviceTemplate": {
"type": "string",
"description": "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": {
"type": "array",
"description": "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",
"nullable": true,
"items": {
"type": "string"
}
},
"clusterServiceTemplate": {
"type": "string",
"description": "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`"
},
"shardServiceTemplate": {
"type": "string",
"description": "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`"
},
"replicaServiceTemplate": {
"type": "string",
"description": "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`"
},
"volumeClaimTemplate": {
"type": "string",
"description": "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`"
}
},
"additionalProperties": false
},
"shardsCount": {
"type": "integer",
"description": "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
},
"shards": {
"type": "array",
"description": "optional, list of shards related to current replica, will ignore if `chi.spec.configuration.clusters.layout.shards` presents",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "optional, by default shard name is generated, but you can override it and setup custom name",
"minLength": 1,
"maxLength": 15,
"pattern": "^[a-zA-Z0-9-]{0,15}$"
},
"zkPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"raftPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"settings": {
"type": "object",
"description": "optional, allows configure `clickhouse-server` settings inside ... tag in `Pod` only in one shard related to current replica during generate `ConfigMap` which will mount in `/etc/clickhouse-server/conf.d/`\noverride top-level `chi.spec.configuration.settings`, cluster-level `chi.spec.configuration.clusters.settings` and replica-level `chi.spec.configuration.clusters.layout.replicas.settings`\nMore details: https://clickhouse.tech/docs/en/operations/settings/settings/\n",
"x-kubernetes-preserve-unknown-fields": true
},
"files": {
"type": "object",
"description": "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/`\noverride top-level `chi.spec.configuration.files` and cluster-level `chi.spec.configuration.clusters.files`, will ignore if `chi.spec.configuration.clusters.layout.shards` presents\n",
"x-kubernetes-preserve-unknown-fields": true
},
"templates": {
"type": "object",
"description": "optional, configuration of the templates names which will use for generate Kubernetes resources according to selected replica\noverride top-level `chi.spec.configuration.templates`, cluster-level `chi.spec.configuration.clusters.templates`, replica-level `chi.spec.configuration.clusters.layout.replicas.templates`\n",
"properties": {
"hostTemplate": {
"type": "string",
"description": "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`"
},
"podTemplate": {
"type": "string",
"description": "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`"
},
"dataVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"logVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"serviceTemplate": {
"type": "string",
"description": "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": {
"type": "array",
"description": "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",
"nullable": true,
"items": {
"type": "string"
}
},
"clusterServiceTemplate": {
"type": "string",
"description": "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`"
},
"shardServiceTemplate": {
"type": "string",
"description": "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`"
},
"replicaServiceTemplate": {
"type": "string",
"description": "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`"
},
"volumeClaimTemplate": {
"type": "string",
"description": "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`"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"templates": {
"type": "object",
"description": "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",
"properties": {
"hostTemplates": {
"type": "array",
"description": "hostTemplate will use during apply to generate `clickhose-server` config files",
"items": {
"type": "object",
"properties": {
"name": {
"description": "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`",
"type": "string"
},
"portDistribution": {
"type": "array",
"description": "define how will distribute numeric values of named ports in `Pod.spec.containers.ports` and clickhouse-server configs",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "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"
]
}
},
"additionalProperties": false
}
},
"spec": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "by default, hostname will generate, but this allows define custom name for each `clickhouse-server`",
"minLength": 1,
"maxLength": 15,
"pattern": "^[a-zA-Z0-9-]{0,15}$"
},
"zkPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"raftPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"settings": {
"type": "object",
"description": "optional, allows configure `clickhouse-server` settings inside ... tag in each `Pod` where this template will apply during generate `ConfigMap` which will mount in `/etc/clickhouse-server/conf.d/`\nMore details: https://clickhouse.tech/docs/en/operations/settings/settings/\n",
"x-kubernetes-preserve-unknown-fields": true
},
"files": {
"type": "object",
"description": "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/`\n",
"x-kubernetes-preserve-unknown-fields": true
},
"templates": {
"type": "object",
"description": "be careful, this part of CRD allows override template inside template, don't use it if you don't understand what you do",
"properties": {
"hostTemplate": {
"type": "string",
"description": "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`"
},
"podTemplate": {
"type": "string",
"description": "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`"
},
"dataVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"logVolumeClaimTemplate": {
"type": "string",
"description": "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`"
},
"serviceTemplate": {
"type": "string",
"description": "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": {
"type": "array",
"description": "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",
"nullable": true,
"items": {
"type": "string"
}
},
"clusterServiceTemplate": {
"type": "string",
"description": "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`"
},
"shardServiceTemplate": {
"type": "string",
"description": "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`"
},
"replicaServiceTemplate": {
"type": "string",
"description": "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`"
},
"volumeClaimTemplate": {
"type": "string",
"description": "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`"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"podTemplates": {
"type": "array",
"description": "podTemplate will use during render `Pod` inside `StatefulSet.spec` and allows define rendered `Pod.spec`, pod scheduling distribution and pod zone\nMore information: https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md#spectemplatespodtemplates\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "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`"
},
"generateName": {
"type": "string",
"description": "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"
},
"zone": {
"type": "object",
"description": "allows define custom zone name and will separate ClickHouse `Pods` between nodes, shortcut for `chi.spec.templates.podTemplates.spec.affinity.podAntiAffinity`",
"properties": {
"key": {
"type": "string",
"description": "optional, if defined, allows select kubernetes nodes by label with `name` equal `key`"
},
"values": {
"type": "array",
"description": "optional, if defined, allows select kubernetes nodes by label with `value` in `values`",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"distribution": {
"type": "string",
"description": "DEPRECATED, shortcut for `chi.spec.templates.podTemplates.spec.affinity.podAntiAffinity`",
"enum": [
"",
"Unspecified",
"OnePerHost"
]
},
"podDistribution": {
"type": "array",
"description": "define ClickHouse Pod distribution policy between Kubernetes Nodes inside Shard, Replica, Namespace, CHI, another ClickHouse cluster",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "you can define multiple affinity policy types",
"enum": [
"",
"Unspecified",
"ClickHouseAntiAffinity",
"ShardAntiAffinity",
"ReplicaAntiAffinity",
"AnotherNamespaceAntiAffinity",
"AnotherClickHouseInstallationAntiAffinity",
"AnotherClusterAntiAffinity",
"MaxNumberPerNode",
"NamespaceAffinity",
"ClickHouseInstallationAffinity",
"ClusterAffinity",
"ShardAffinity",
"ReplicaAffinity",
"PreviousTailAffinity",
"CircularReplication"
]
},
"scope": {
"type": "string",
"description": "scope for apply each podDistribution",
"enum": [
"",
"Unspecified",
"Shard",
"Replica",
"Cluster",
"ClickHouseInstallation",
"Namespace"
]
},
"number": {
"type": "integer",
"description": "define, how much ClickHouse Pods could be inside selected scope with selected distribution type",
"minimum": 0,
"maximum": 65535
},
"topologyKey": {
"type": "string",
"description": "use for inter-pod affinity look to `pod.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey`,\nmore info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity\"\n"
}
},
"additionalProperties": false
}
},
"metadata": {
"type": "object",
"description": "allows pass standard object's metadata from template to Pod\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n",
"x-kubernetes-preserve-unknown-fields": true
},
"spec": {
"type": "object",
"description": "allows define whole Pod.spec inside StaefulSet.spec, look to https://kubernetes.io/docs/concepts/workloads/pods/#pod-templates for details",
"x-kubernetes-preserve-unknown-fields": true
}
},
"additionalProperties": false
}
},
"volumeClaimTemplates": {
"type": "array",
"description": "allows define template for rendering `PVC` kubernetes resource, which would use inside `Pod` for mount clickhouse `data`, clickhouse `logs` or something else\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name, could use to link inside\ntop-level `chi.spec.defaults.templates.dataVolumeClaimTemplate` or `chi.spec.defaults.templates.logVolumeClaimTemplate`,\ncluster-level `chi.spec.configuration.clusters.templates.dataVolumeClaimTemplate` or `chi.spec.configuration.clusters.templates.logVolumeClaimTemplate`,\nshard-level `chi.spec.configuration.clusters.layout.shards.temlates.dataVolumeClaimTemplate` or `chi.spec.configuration.clusters.layout.shards.temlates.logVolumeClaimTemplate`\nreplica-level `chi.spec.configuration.clusters.layout.replicas.templates.dataVolumeClaimTemplate` or `chi.spec.configuration.clusters.layout.replicas.templates.logVolumeClaimTemplate`\n"
},
"provisioner": {
"type": "string",
"description": "defines `PVC` provisioner - be it StatefulSet or the Operator",
"enum": [
"",
"StatefulSet",
"Operator"
]
},
"reclaimPolicy": {
"type": "string",
"description": "defines behavior of `PVC` deletion.\n`Delete` by default, if `Retain` specified then `PVC` will be kept when deleting StatefulSet\n",
"enum": [
"",
"Retain",
"Delete"
]
},
"metadata": {
"type": "object",
"description": "allows to pass standard object's metadata from template to PVC\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n",
"x-kubernetes-preserve-unknown-fields": true
},
"spec": {
"type": "object",
"description": "allows define all aspects of `PVC` resource\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims\n",
"x-kubernetes-preserve-unknown-fields": true
}
},
"additionalProperties": false
}
},
"serviceTemplates": {
"type": "array",
"description": "allows define template for rendering `Service` which would get endpoint from Pods which scoped chi-wide, cluster-wide, shard-wide, replica-wide level\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name, could use to link inside\nchi-level `chi.spec.defaults.templates.serviceTemplate`\ncluster-level `chi.spec.configuration.clusters.templates.clusterServiceTemplate`\nshard-level `chi.spec.configuration.clusters.layout.shards.temlates.shardServiceTemplate`\nreplica-level `chi.spec.configuration.clusters.layout.replicas.templates.replicaServiceTemplate` or `chi.spec.configuration.clusters.layout.shards.replicas.replicaServiceTemplate`\n"
},
"generateName": {
"type": "string",
"description": "allows define format for generated `Service` name,\nlook to https://github.com/Altinity/clickhouse-operator/blob/master/docs/custom_resource_explained.md#spectemplatesservicetemplates\nfor details about available template variables\"\n"
},
"metadata": {
"type": "object",
"description": "allows pass standard object's metadata from template to Service\nCould be use for define specificly for Cloud Provider metadata which impact to behavior of service\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n",
"x-kubernetes-preserve-unknown-fields": true
},
"spec": {
"type": "object",
"description": "describe behavior of generated Service\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/\n",
"x-kubernetes-preserve-unknown-fields": true
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}