From df8bd3b85c21bf523d34e147c4e052b29d3039c7 Mon Sep 17 00:00:00 2001 From: Jordan Simonovski Date: Tue, 17 Nov 2026 11:15:46 +1100 Subject: [PATCH 1/4] docs: replace the empty Pages landing page The site at clickhouse.github.io/ClickStack-helm-charts showed the gh-pages README from the initial commit. The page now lives in pages/ on main and the release job copies it onto gh-pages, committing only when it changed. --- .github/workflows/release.yml | 17 +++++++++++++++++ AGENTS.md | 2 +- pages/README.md | 30 ++++++++++++++++++++++++++++++ pages/_config.yml | 2 ++ 4 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 pages/README.md create mode 100644 pages/_config.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f755b77..36281c9 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -79,3 +79,20 @@ jobs: helm push "$pkgs/$tag.tgz" "$OCI_REPO" fi done + - name: Sync Pages landing page + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # The Pages site is the gh-pages branch; its landing page lives in pages/ so it is reviewed on main. + run: | + site=$(mktemp -d) + git fetch --no-tags origin gh-pages + git worktree add --detach "$site" FETCH_HEAD + cp -R pages/. "$site/" + cd "$site" + git add -A + if git diff --cached --quiet; then + echo "Pages landing page is up to date" + exit 0 + fi + git commit -m "docs: sync Pages landing page from ${GITHUB_SHA::7}" + git push "https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" HEAD:gh-pages diff --git a/AGENTS.md b/AGENTS.md index 6a0b421..ad6ab1d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -218,7 +218,7 @@ tests: |----------|------|---------|---------| | Helm Chart Tests | `helm-test.yaml` | push/PR to main | `helm-unittest` job (unit tests + example validation + docs check) and `helmcov` job (template coverage; PR comment with line/branch coverage) | | Integration Test | `chart-test.yml` | push/PR/nightly | Kind-based integration suites | -| Release | `release.yml` | after tests pass on main | Changeset version + chart release | +| Release | `release.yml` | after tests pass on main | Changeset version + chart release; syncs `pages/` to the gh-pages landing page | | Update App Version | `update-app-version.yml` | workflow_dispatch | Bump `appVersion` in Chart.yaml | | Bump ClickHouse Image | `bump-clickhouse-image.yml` | weekly/workflow_dispatch | PR moving the ClickHouse server and keeper tags to the newest patch on their LTS line | diff --git a/pages/README.md b/pages/README.md new file mode 100644 index 0000000..849e2b4 --- /dev/null +++ b/pages/README.md @@ -0,0 +1,30 @@ +# ClickStack Helm charts + +[ClickStack](https://clickhouse.com/docs/use-cases/observability/clickstack) is an open-source observability stack for logs, metrics and traces, built on ClickHouse, OpenTelemetry and HyperDX. This is its Helm chart repository. + +## Install + +```bash +helm repo add clickstack https://clickhouse.github.io/ClickStack-helm-charts +helm repo update + +# Install the operators and their CRDs first +helm install clickstack-operators clickstack/clickstack-operators + +# Then ClickStack, once the operators are ready +helm install my-clickstack clickstack/clickstack +``` + +## Charts + +| Chart | What it installs | +|---|---| +| [clickstack-operators](https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/charts/clickstack-operators/README.md) | The ClickHouse and MongoDB operators and their CRDs. Install it first. | +| [clickstack](https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/charts/clickstack/README.md) | HyperDX, the OpenTelemetry Collector, and the ClickHouse and MongoDB resources the operators manage. | + +## Documentation + +- [Deploying with Helm](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/helm): configuration, cloud providers, ingress and troubleshooting +- [Upgrade guide](https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/docs/UPGRADE.md): what to change when moving between chart versions +- [Releases](https://github.com/ClickHouse/ClickStack-helm-charts/releases): chart packages and release notes +- [Source and issues](https://github.com/ClickHouse/ClickStack-helm-charts) diff --git a/pages/_config.yml b/pages/_config.yml new file mode 100644 index 0000000..4292d6b --- /dev/null +++ b/pages/_config.yml @@ -0,0 +1,2 @@ +title: ClickStack Helm charts +description: Helm charts for ClickStack, the open-source observability stack built on ClickHouse, OpenTelemetry and HyperDX. From 402c67884eba312b41ff7f6a15166cd0af63eeed Mon Sep 17 00:00:00 2001 From: Jordan Simonovski Date: Wed, 18 Nov 2026 19:11:18 +1100 Subject: [PATCH 2/4] Publish artifacthub-repo.yml with the Pages site Links the chart repo to the ClickHouse org on Artifact Hub so both charts get the verified publisher badge. --- pages/artifacthub-repo.yml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 pages/artifacthub-repo.yml diff --git a/pages/artifacthub-repo.yml b/pages/artifacthub-repo.yml new file mode 100644 index 0000000..9356a12 --- /dev/null +++ b/pages/artifacthub-repo.yml @@ -0,0 +1,4 @@ +repositoryID: 64bbac14-0c92-49bb-baf3-e8fdf38ec8fc +owners: + - name: ClickHouse + email: artifacthub-admin@clickhouse.com From 8b2a6c042c50bbf893cf209a47b8a2d1da6b2346 Mon Sep 17 00:00:00 2001 From: Jordan Simonovski Date: Wed, 18 Nov 2026 19:09:51 +1100 Subject: [PATCH 3/4] chore: point chart metadata at ClickHouse/ClickStack-helm-charts for Artifact Hub Adds an icon, keywords and Artifact Hub category to both charts and replaces the old hyperdxio/helm-charts source links. Bumps clickstack-operators to 1.1.1 so the new metadata gets published. --- .changeset/artifacthub-metadata.md | 5 +++++ charts/clickstack-operators/Chart.yaml | 16 +++++++++++++++- charts/clickstack-operators/README.md | 2 +- charts/clickstack/Chart.yaml | 15 +++++++++++++-- charts/clickstack/README.md | 2 +- 5 files changed, 35 insertions(+), 5 deletions(-) create mode 100644 .changeset/artifacthub-metadata.md diff --git a/.changeset/artifacthub-metadata.md b/.changeset/artifacthub-metadata.md new file mode 100644 index 0000000..2e1391d --- /dev/null +++ b/.changeset/artifacthub-metadata.md @@ -0,0 +1,5 @@ +--- +"helm-charts": patch +--- + +chore: chart metadata now points at the ClickHouse/ClickStack-helm-charts repo instead of the old hyperdxio/helm-charts location, and adds an icon, keywords and Artifact Hub category so both charts show up properly on Artifact Hub. diff --git a/charts/clickstack-operators/Chart.yaml b/charts/clickstack-operators/Chart.yaml index 4266308..7aa0ed7 100644 --- a/charts/clickstack-operators/Chart.yaml +++ b/charts/clickstack-operators/Chart.yaml @@ -4,8 +4,22 @@ description: >- Operator dependencies for ClickStack. Install this chart before installing clickstack/clickstack to ensure CRDs are registered. home: https://clickhouse.com/docs/use-cases/observability/clickstack +icon: https://raw.githubusercontent.com/hyperdxio/hyperdx/main/packages/app/public/favicons/clickstack/favicon.svg +sources: + - https://github.com/ClickHouse/ClickStack-helm-charts +keywords: + - clickstack + - operator + - clickhouse + - mongodb +annotations: + artifacthub.io/category: monitoring-logging + artifacthub.io/license: MIT + artifacthub.io/links: | + - name: Chart Source + url: https://github.com/ClickHouse/ClickStack-helm-charts type: application -version: 1.1.0 +version: 1.1.1 appVersion: "1.0.0" dependencies: - name: mongodb-kubernetes diff --git a/charts/clickstack-operators/README.md b/charts/clickstack-operators/README.md index 752cb7f..dc5f328 100644 --- a/charts/clickstack-operators/README.md +++ b/charts/clickstack-operators/README.md @@ -1,6 +1,6 @@ # clickstack-operators -![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat) +![Version: 1.1.1](https://img.shields.io/badge/Version-1.1.1-informational?style=flat) ![Build Status](https://github.com/ClickHouse/ClickStack-helm-charts/actions/workflows/helm-test.yaml/badge.svg) Operator dependencies for ClickStack. Install this chart before installing clickstack/clickstack to ensure CRDs are registered. diff --git a/charts/clickstack/Chart.yaml b/charts/clickstack/Chart.yaml index 6531960..10caa43 100644 --- a/charts/clickstack/Chart.yaml +++ b/charts/clickstack/Chart.yaml @@ -4,16 +4,27 @@ description: >- A Helm chart for ClickStack - Full-stack observability with ClickHouse, OpenTelemetry, and HyperDX home: https://clickhouse.com/docs/use-cases/observability/clickstack +icon: https://raw.githubusercontent.com/hyperdxio/hyperdx/main/packages/app/public/favicons/clickstack/favicon.svg sources: + - https://github.com/ClickHouse/ClickStack-helm-charts - https://github.com/hyperdxio/hyperdx - - https://github.com/hyperdxio/helm-charts +keywords: + - observability + - opentelemetry + - clickhouse + - logs + - traces + - metrics annotations: + artifacthub.io/category: monitoring-logging artifacthub.io/license: MIT artifacthub.io/links: | - name: Chart Source - url: https://github.com/hyperdxio/helm-charts + url: https://github.com/ClickHouse/ClickStack-helm-charts - name: Upstream Project url: https://github.com/hyperdxio/hyperdx + - name: Upgrade Guide + url: https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/docs/UPGRADE.md type: application version: 3.6.0 appVersion: 2.45.0 diff --git a/charts/clickstack/README.md b/charts/clickstack/README.md index 619989c..02a1fbe 100644 --- a/charts/clickstack/README.md +++ b/charts/clickstack/README.md @@ -9,8 +9,8 @@ A Helm chart for ClickStack - Full-stack observability with ClickHouse, OpenTele ## Source Code +* * -* ## Prerequisites From 95edf904e82cded34cac9395a67a0132067df066 Mon Sep 17 00:00:00 2001 From: Jordan Simonovski Date: Wed, 18 Nov 2026 19:19:19 +1100 Subject: [PATCH 4/4] docs: link to Artifact Hub from the READMEs and landing page --- README.md | 3 +++ charts/clickstack-operators/README.md | 1 + charts/clickstack-operators/README.md.gotmpl | 1 + charts/clickstack/README.md | 1 + charts/clickstack/README.md.gotmpl | 1 + pages/README.md | 1 + 6 files changed, 8 insertions(+) diff --git a/README.md b/README.md index 85649d3..9d5a7e9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # ClickStack Helm Charts +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/clickstack)](https://artifacthub.io/packages/search?repo=clickstack) +[![Build Status](https://github.com/ClickHouse/ClickStack-helm-charts/actions/workflows/helm-test.yaml/badge.svg)](https://github.com/ClickHouse/ClickStack-helm-charts/actions/workflows/helm-test.yaml) + **ClickStack** is an open-source observability stack combining ClickHouse, HyperDX, and OpenTelemetry for logs, metrics, and traces. ## Quick Start diff --git a/charts/clickstack-operators/README.md b/charts/clickstack-operators/README.md index dc5f328..0acb907 100644 --- a/charts/clickstack-operators/README.md +++ b/charts/clickstack-operators/README.md @@ -2,6 +2,7 @@ ![Version: 1.1.1](https://img.shields.io/badge/Version-1.1.1-informational?style=flat) ![Build Status](https://github.com/ClickHouse/ClickStack-helm-charts/actions/workflows/helm-test.yaml/badge.svg) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/clickstack)](https://artifacthub.io/packages/helm/clickstack/clickstack-operators) Operator dependencies for ClickStack. Install this chart before installing clickstack/clickstack to ensure CRDs are registered. diff --git a/charts/clickstack-operators/README.md.gotmpl b/charts/clickstack-operators/README.md.gotmpl index c1138a0..b4303f3 100644 --- a/charts/clickstack-operators/README.md.gotmpl +++ b/charts/clickstack-operators/README.md.gotmpl @@ -2,6 +2,7 @@ {{ template "chart.versionBadge" . }} ![Build Status](https://github.com/ClickHouse/ClickStack-helm-charts/actions/workflows/helm-test.yaml/badge.svg) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/clickstack)](https://artifacthub.io/packages/helm/clickstack/clickstack-operators) {{ template "chart.description" . }} diff --git a/charts/clickstack/README.md b/charts/clickstack/README.md index 02a1fbe..a6866df 100644 --- a/charts/clickstack/README.md +++ b/charts/clickstack/README.md @@ -2,6 +2,7 @@ ![Version: 3.6.0](https://img.shields.io/badge/Version-3.6.0-informational?style=flat) ![Build Status](https://github.com/ClickHouse/ClickStack-helm-charts/actions/workflows/helm-test.yaml/badge.svg) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/clickstack)](https://artifacthub.io/packages/helm/clickstack/clickstack) A Helm chart for ClickStack - Full-stack observability with ClickHouse, OpenTelemetry, and HyperDX diff --git a/charts/clickstack/README.md.gotmpl b/charts/clickstack/README.md.gotmpl index 2878dd9..24e2a7b 100644 --- a/charts/clickstack/README.md.gotmpl +++ b/charts/clickstack/README.md.gotmpl @@ -2,6 +2,7 @@ {{ template "chart.versionBadge" . }} ![Build Status](https://github.com/ClickHouse/ClickStack-helm-charts/actions/workflows/helm-test.yaml/badge.svg) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/clickstack)](https://artifacthub.io/packages/helm/clickstack/clickstack) {{ template "chart.description" . }} diff --git a/pages/README.md b/pages/README.md index 849e2b4..04bb581 100644 --- a/pages/README.md +++ b/pages/README.md @@ -26,5 +26,6 @@ helm install my-clickstack clickstack/clickstack - [Deploying with Helm](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/helm): configuration, cloud providers, ingress and troubleshooting - [Upgrade guide](https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/docs/UPGRADE.md): what to change when moving between chart versions +- [Artifact Hub](https://artifacthub.io/packages/search?repo=clickstack): both charts with their versions, default values and security reports - [Releases](https://github.com/ClickHouse/ClickStack-helm-charts/releases): chart packages and release notes - [Source and issues](https://github.com/ClickHouse/ClickStack-helm-charts)