title_wip

#### Example[​](#clustertlsspec-example "Direct link to Example")

```
tls:
  enabled: true
  required: true
  serverCertSecret:
    name: clickhouse-cert
  caBundle:
    secretKeyRef:
      name: ca-cert-secret
      key: ca.crt
```

### LoggerConfig[​](#loggerconfig "Direct link to LoggerConfig")

Logger configuration for ClickHouse and Keeper.

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Field Type Required Default Description|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | `logToFile` `bool` No `true` Write logs to file.|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | `level` `string` No `"trace"` Log level: trace, debug, information, warning, error.|  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | `size` `string` No `"1000M"` Maximum log file size.|  |  |  |  |  | | --- | --- | --- | --- | --- | | `count` `int` No `50` Number of log files to keep. | | | | | | | | | | | | | | | | | | | | | | | | |

#### Example[​](#loggerconfig-example "Direct link to Example")

```
logger:
  logToFile: true
  level: "information"
  size: "1000M"
  count: 50
```

### DefaultPasswordSelector[​](#defaultpasswordselector "Direct link to DefaultPasswordSelector")

Reference to a Secret or ConfigMap key containing a password.

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Field Type Required Default Description|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | `passwordType` `string` No `plaintext` Type of password encoding. Possible values: `plaintext`, `sha256_password`, `sha256_hash`, `double_sha1_password`, `double_sha1_hash`. See [ClickHouse documentation](/docs/operations/settings/settings-users#user-namepassword) for details.| `secret` `*SecretKeySelector` No - Select password from a Secret key. Mutually exclusive with `configMap`.| `configMap` `*ConfigMapKeySelector` No - Select password from a ConfigMap key. Mutually exclusive with `secret`. | | | | | | | | | | | | | | | | | | | |

Note

You must specify either `secret` OR `configMap`, not both.

#### Example with Secret (Recommended)[​](#defaultpasswordselector-example-secret "Direct link to Example with Secret (Recommended)")

```
defaultUserPassword:
  passwordType: plaintext  # Optional, default
  secret:
    name: clickhouse-password
    key: password
```

#### Example with SHA256[​](#defaultpasswordselector-example-sha256 "Direct link to Example with SHA256")

```
defaultUserPassword:
  passwordType: sha256_password
  secret:
    name: clickhouse-password
    key: password_hash
```

#### Example with ConfigMap[​](#defaultpasswordselector-example-configmap "Direct link to Example with ConfigMap")

```
defaultUserPassword:
  passwordType: plaintext
  configMap:
    name: clickhouse-config
    key: default_password
```

## Default Values[​](#default-values "Direct link to Default Values")

### ClickHouse Defaults[​](#clickhouse-defaults "Direct link to ClickHouse Defaults")

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Setting Default Value|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Replicas `3`| Shards `1`| Image Repository `clickhouse/clickhouse-server`| Image Tag `latest`| Image Pull Policy `IfNotPresent`| CPU Request `2`| CPU Limit `4`| Memory Request `4Gi`| Memory Limit `8Gi`| Logger Level `trace`| Logger Log to File `true`| Logger Size `1000M`| Logger Count `50`| Enable Database Sync `true` | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |

### Keeper Defaults[​](#keeper-defaults "Direct link to Keeper Defaults")

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Setting Default Value|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Replicas `3`| Image Repository `clickhouse/clickhouse-keeper`| Image Tag `latest`| Image Pull Policy `IfNotPresent`| CPU Request `500m`| CPU Limit `1`| Memory Request `512Mi`| Memory Limit `1Gi`| Logger Level `trace`| Logger Log to File `true`| Logger Size `1000M`| Logger Count `50` | | | | | | | | | | | | | | | | | | | | | | | | | |

## Conditions[​](#conditions "Direct link to Conditions")

### ClickHouseCluster conditions[​](#clickhousecluster-conditions "Direct link to ClickHouseCluster conditions")

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Type Description|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | `SpecValid` Whether ClickHouseCluster CustomResource passes validation. Useful in deployments without webhooks|  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | `ReconcileSucceeded` The success of the last reconciliation cycle|  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | `ReplicaStartupSucceeded` Whether all replicas of the ClickHouseCluster are able to start.|  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | `Healthy` Readiness of all requested replicas.|  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | | `ClusterSizeAligned` Cluster have the same amount of replicas/shards as requested.|  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | | `ConfigurationInSync` Represents Configuration deployment state|  |  |  |  | | --- | --- | --- | --- | | `Ready` ClickHouseCluster is ready to serve client requests. At least one replica in every shard is Ready|  |  | | --- | --- | | `SchemaInSync` All replicas have the same database schema after scaling operations. | | | | | | | | | | | | | | | | | |

### KeeperCluster conditions[​](#keepercluster-conditions "Direct link to KeeperCluster conditions")