Altinity / Altinity/clickhouse-operator
Feature Request: Use underscores (`_`) in cluster names
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2.6k
- Forks
- 574
- Avg merge
- 8d 6h
- Merged PRs (30d)
- 6
Description
Cluster names currently seem to be restricted to [A-Za-z0-9-]. Unfortunately, our cluster names use _ as a separator, which I think is also idiomatic in ClickHouse cluster naming.
I guess this is due to using the cluster name as part of the Kubernetes resource names, which can't use _. But even if I try providing my own service/pod templates that use {clusterID} instead, it still refuses to create the resources.
Assuming I'm not missing or misunderstanding anything - Would it be possible to introduce a new configuration field e.g. systemClusterName to configure specifically the cluster's name within ClickHouse's config, separate from the Kubernetes resource name, which defaults to the regular name when unset?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing where cluster names are validated and where the name is used for Kubernetes resources versus the ClickHouse configuration. Compare the behavior with custom service and pod templates, then define how a separate system cluster name should be configured and verify that both naming paths work without violating Kubernetes resource-name rules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- infrastructure
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100