Skip to content
Merged
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/clickstack-values-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"helm-charts": minor
---

feat: rename the top-level `hyperdx` values key to `clickstack`. Values files that still use `hyperdx` keep working and get a deprecation warning in the install notes; where both keys set the same value, `hyperdx` wins.
2 changes: 1 addition & 1 deletion .changeset/dashboards-include-release-namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
"helm-charts": minor
---

feat: add `hyperdx.dashboards.includeReleaseNamespace` (default `true`, unchanged behaviour). Set it to `false` with `hyperdx.dashboards.namespaces: [<ns>]` to confine the dashboard watcher, and its ConfigMap read access, to the listed namespaces: the chart then renders a namespaced Role and RoleBinding in each listed namespace, no ClusterRole, and nothing in the release namespace. Those objects are named `<fullname>-<release namespace>-dashboard-provisioner-scoped`, distinct from the RoleBindings the cross-namespace mode renders, so the flag can be flipped either way on an existing install: no upgrade has to change an existing RoleBinding's `roleRef`. The render fails if it is `false` with no namespaces listed, or with inline `configMaps` while the release namespace is not watched.
feat: add `clickstack.dashboards.includeReleaseNamespace` (default `true`, unchanged behaviour). Set it to `false` with `clickstack.dashboards.namespaces: [<ns>]` to confine the dashboard watcher, and its ConfigMap read access, to the listed namespaces: the chart then renders a namespaced Role and RoleBinding in each listed namespace, no ClusterRole, and nothing in the release namespace. Those objects are named `<fullname>-<release namespace>-dashboard-provisioner-scoped`, distinct from the RoleBindings the cross-namespace mode renders, so the flag can be flipped either way on an existing install: no upgrade has to change an existing RoleBinding's `roleRef`. The render fails if it is `false` with no namespaces listed, or with inline `configMaps` while the release namespace is not watched.
9 changes: 5 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,18 +164,19 @@ for Playwright.

### Template Files
- Organized by component: `templates/hyperdx/`, `templates/clickhouse/`, `templates/mongodb/`, `templates/otel-collector/`
- Start every template with `{{- include "clickstack.normalizeValues" . -}}` so the deprecated `hyperdx` key is merged into `clickstack` before anything reads it
- Use `nindent` for indentation in template pipelines: `{{- include "clickstack.labels" . | nindent 4 }}`
- Quote string values with `| quote`; use `toYaml` for complex values
- Guard optional sections with `{{- if .Values.x.y }}` blocks
- Use `tpl` for values that may contain template expressions (see `clickstack.hyperdx.configmap` in `_helpers.tpl`)

### Values Structure (`values.yaml`)
- Top-level keys: `global`, `hyperdx`, `mongodb`, `clickhouse`, `additionalManifests`, `otel-collector`
- Top-level keys: `global`, `clickstack` (formerly `hyperdx`, still accepted with a deprecation warning), `mongodb`, `clickhouse`, `additionalManifests`, `otel-collector`
- Document user-facing values with `# --` comments directly above each key (helm-docs format)
- `make docs` omits undocumented keys (`--ignore-non-descriptions`); prefer commenting parent keys for operator/subchart passthrough specs
- `hyperdx.config` — non-sensitive env vars (ConfigMap), supports `tpl` expressions
- `hyperdx.secrets` — sensitive env vars (Secret); set to `null` to skip creation
- `hyperdx.deployment` — Deployment spec (image, replicas, resources, probes, etc.)
- `clickstack.config` — non-sensitive env vars (ConfigMap), supports `tpl` expressions
- `clickstack.secrets` — sensitive env vars (Secret); set to `null` to skip creation
- `clickstack.deployment` — Deployment spec (image, replicas, resources, probes, etc.)

### Labels
- Always include common labels via `{{- include "clickstack.labels" . | nindent 4 }}`
Expand Down
2 changes: 1 addition & 1 deletion charts/clickstack-operators/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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
icon: https://raw.githubusercontent.com/ClickHouse/ClickStack/main/packages/app/public/favicons/clickstack/favicon.svg
sources:
- https://github.com/ClickHouse/ClickStack-helm-charts
keywords:
Expand Down
6 changes: 3 additions & 3 deletions charts/clickstack/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ 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
icon: https://raw.githubusercontent.com/ClickHouse/ClickStack/main/packages/app/public/favicons/clickstack/favicon.svg
sources:
- https://github.com/ClickHouse/ClickStack-helm-charts
- https://github.com/hyperdxio/hyperdx
- https://github.com/ClickHouse/ClickStack
keywords:
- observability
- opentelemetry
Expand All @@ -22,7 +22,7 @@ annotations:
- name: Chart Source
url: https://github.com/ClickHouse/ClickStack-helm-charts
- name: Upstream Project
url: https://github.com/hyperdxio/hyperdx
url: https://github.com/ClickHouse/ClickStack
- name: Upgrade Guide
url: https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/docs/UPGRADE.md
type: application
Expand Down
Loading
Loading