feat: add clickhouse-cluster helm chart#183
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new “clickhouse-cluster-helm” Helm chart intended to deploy a ClickHouseCluster + KeeperCluster CR pair (with generated values.yaml derived from CRD schemas), alongside CI/release automation updates and an e2e deployment test that installs the new chart.
Changes:
- Introduce a new cluster Helm chart under
dist/chart-cluster/that renders ClickHouseCluster and KeeperCluster CRs. - Add a Go-based generator (
tools/gen-cluster-chart) to produce the cluster chart’svalues.yamlfrom CRD schemas and wire it intomake+ CI. - Extend helm-based deployment tests to install and validate the new cluster chart.
Reviewed changes
Copilot reviewed 7 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/gen-cluster-chart/templates/values.yaml.tmpl | Template used by the generator to render values.yaml field blocks from CRD-derived schema data. |
| tools/gen-cluster-chart/main.go | New generator binary that reads CRDs and renders the chart values.yaml. |
| test/deploy/deploy_test.go | Adds a helm-install-based validation path for the new cluster chart. |
| README.md | Documents installing a sample cluster via the new clickhouse-cluster-helm chart. |
| Makefile | Adds targets to build/run the generator and package/push/lint the new cluster chart. |
| dist/chart-cluster/values.yaml | Generated default values for the new cluster chart. |
| dist/chart-cluster/templates/NOTES.txt | Post-install notes for the cluster chart. |
| dist/chart-cluster/templates/keeper-cluster.yaml | Template for rendering a KeeperCluster CR from values. |
| dist/chart-cluster/templates/clickhouse-cluster.yaml | Template for rendering a ClickHouseCluster CR (including optional keeperClusterRef wiring). |
| dist/chart-cluster/templates/_helpers.tpl | Naming helpers for the cluster chart. |
| dist/chart-cluster/Chart.yaml | New chart metadata for clickhouse-cluster-helm. |
| dist/chart-cluster/.helmignore | Ignore rules for packaging the new chart. |
| .github/workflows/release.yaml | Packages and publishes the cluster chart artifact and OCI push during releases. |
| .github/workflows/ci.yaml | Ensures cluster chart generation is checked and cluster chart linting runs in CI. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
11b9f18 to
2592417
Compare
2592417 to
b37b270
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
For the projects with Helm-based deployment, it's convenient to use a Helm chart to deploy a CRs to create a cluster
What
Introduced a new Helm chart for keeper+clickhouse deployment.
values.yaml are generated from the CRD to represent the chart structure