Skip to content

docs: clarify CHIT usage #1918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Slach merged 2 commits into from
Feb 7, 2026
Merged

docs: clarify CHIT usage #1918

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7cb3bc
docs: clarify CHIT usage
eyyu Feb 7, 2026
243a480
Merge branch '0.26.0' of github.com:Altinity/clickhouse-operator into…
Slach Feb 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/operator_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,5 +163,31 @@ spec:
...
```

#### Applying Changes from ClickHouseInstallationTemplates

Changes applied to a ClickHouseInstallationTemaplte do not automatically trigger a reconcile of the ClickHouseInstallations using the template. This is by design and intended to preserve user control and prevent undesirable rollouts to ClickHouseInstallations.

To apply the changes to ClickHouseInstallations, update the spec.taskID:

```
apiVersion: "clickhouse.altinity.com/v1"
kind: "ClickHouseInstallation"
...
spec:
taskID: "randomly-generated-string"
...
```

> Note, ClickHouse settings applied to the ClickHouse server through `spec.configuration.settings` in a ClickHouseInstallationTemplate will not trigger a server restart whether or not the setting requires a server restart to be applied. To apply the settings and restart the server, you should also set `spec.restart` to `'RollingUpdate'`. RollingUpdate should be used sparingly. It is typically removed after usage to prevent unecessary restarts:

```
apiVersion: "clickhouse.altinity.com/v1"
kind: "ClickHouseInstallation"
...
spec:
restart: "RollingUpdate"
...
```

[clickhouse-operator-install-bundle.yaml]: ../deploy/operator/clickhouse-operator-install-bundle.yaml
[70-chop-config.yaml]: ./chi-examples/70-chop-config.yaml