Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/artifacthub-metadata.md
Original file line number Diff line number Diff line change
@@ -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.
17 changes: 17 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ tests:
|----------|------|---------|---------|
| Helm Chart Tests | `helm-test.yaml` | push/PR to main | `helm-unittest` job (unit tests + example validation + docs check), `helmcov` job (template coverage; PR comment with line/branch coverage), and `version-script-smoke` job (changeset version and release-notes scripts) |
| Helm Chart Integration Test | `chart-test.yml` | push/PR/nightly | Kind-based integration suites |
| Release Helm Charts | `release.yml` | after either test workflow succeeds on a push to main | Changeset version + chart release |
| Release Helm Charts | `release.yml` | after either test workflow succeeds on a push to main | Changeset version + chart release; syncs `pages/` to the gh-pages landing page |
| Upgrade Notes | `upgrade-notes.yml` | PR to main | Requires a `docs/UPGRADE.md` note for `major` changesets; warns on `minor` |
| Lint Workflows | `lint-workflows.yml` | push/PR to main touching workflows | `actionlint` and `zizmor` |
| Deep Code Review | `deep-review.yml` | non-draft PR opened/updated, workflow_dispatch | Multi-agent Claude review posted as a sticky PR comment |
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
16 changes: 15 additions & 1 deletion charts/clickstack-operators/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion charts/clickstack-operators/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# 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)
[![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.

Expand Down
1 change: 1 addition & 0 deletions charts/clickstack-operators/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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" . }}

Expand Down
15 changes: 13 additions & 2 deletions charts/clickstack/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion charts/clickstack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@

![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

**Homepage:** <https://clickhouse.com/docs/use-cases/observability/clickstack>

## Source Code

* <https://github.com/ClickHouse/ClickStack-helm-charts>
* <https://github.com/hyperdxio/hyperdx>
* <https://github.com/hyperdxio/helm-charts>

## Prerequisites

Expand Down
1 change: 1 addition & 0 deletions charts/clickstack/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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" . }}

Expand Down
31 changes: 31 additions & 0 deletions pages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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
- [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)
2 changes: 2 additions & 0 deletions pages/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
title: ClickStack Helm charts
description: Helm charts for ClickStack, the open-source observability stack built on ClickHouse, OpenTelemetry and HyperDX.
4 changes: 4 additions & 0 deletions pages/artifacthub-repo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
repositoryID: 64bbac14-0c92-49bb-baf3-e8fdf38ec8fc
owners:
- name: ClickHouse
email: artifacthub-admin@clickhouse.com
Loading