Skip to content

Make Helm the primary install method on ClickStack OTel collector page#6337

Merged
gingerwizard merged 1 commit into
mainfrom
clickstack-collector-install-helm
Jun 4, 2026
Merged

Make Helm the primary install method on ClickStack OTel collector page#6337
gingerwizard merged 1 commit into
mainfrom
clickstack-collector-install-helm

Conversation

@dhable
Copy link
Copy Markdown
Contributor

@dhable dhable commented Jun 3, 2026

What changed

Reorganized the Deploying the collector and Securing the collector sections of /use-cases/observability/clickstack/ingesting-data/otel-collector so Helm is the primary install path, with the existing Docker commands preserved in secondary tabs that aren't displayed by default.

Single file changed: docs/use-cases/observability/clickstack/ingesting-data/collector.md (+217 / −10).

Why

Helm is the recommended install method for Kubernetes deployments and matches how the ClickStack Helm chart actually ships the collector (as a subchart of the upstream opentelemetry-collector chart). The page previously had Docker-only instructions, which forced Kubernetes users to translate docker run flags into Helm values themselves.

What the new content looks like

  • Helm tab (default): helm repo add + a focused values.yaml showing the ClickStack image (docker.clickhouse.com/clickhouse/clickstack-otel-collector:2.19.0), OTLP ports, and extraEnvs for CLICKHOUSE_* (plus OPAMP_SERVER_URL and HYPERDX_API_KEY for the Open Source ClickStack flow) + helm install.
  • Docker tab (not default): the original docker run block and associated notes, unchanged.
  • The intro paragraph in each outer tab notes that the official ClickStack Helm chart embeds the upstream collector chart as a subchart, with an inline link to the main ClickStack Helm deployment guide.
  • Same nested-tab split applied to the Modifying configuration subsection and to the Managed ClickStack tab of Securing the collector (Helm equivalent of OTLP_AUTH_TOKEN via extraEnvs).

Image tag and env var conventions (CLICKHOUSE_USER=otelcollector, OPAMP_SERVER_URL, HYPERDX_API_KEY) match the canonical charts/clickstack/values.yaml so the docs stay in sync with the chart.

Out of scope

  • The Open Source ClickStack tab of Securing the collector is unchanged — OpAMP-managed credentials work transparently for both install methods, and the existing prose is install-method-agnostic.
  • Docker Compose YAML blocks are unchanged.
  • The _extending_config.md snippet is unchanged (works for both install methods).
  • i18n files (jp/ko/ru/zh) are unchanged — translations regenerated separately.

Compatibility

All existing anchor IDs preserved:

  • #configuring-the-collector
  • #modifying-otel-collector-configuration and #modifying-otel-collector-configuration-managed
  • #configuring-managed-clickstack and #configuring-clickhouse-instance
  • #docker-compose-otel and #docker-compose-otel-managed
  • #securing-the-collector
  • #creating-an-ingestion-user and #creating-an-ingestion-user-oss

Inbound links from production.md, vector.md, hyperdx-only.md, docker-compose.md, all-in-one.md, and migrating-agents.md continue to resolve.

Verification

  • Tabs/TabItem nesting balanced programmatically (5 nested <Tabs> blocks, all opened and closed in order).
  • 48 code fences total (even).
  • YAML snippets parse cleanly through js-yaml.

Note

Low Risk
Documentation-only restructuring; no runtime, auth, or ingestion behavior changes.

Overview
The ClickStack OTel collector guide now treats Helm as the default install path on Kubernetes, with existing Docker steps moved into secondary tabs.

For both Managed and Open Source flows, Deploying the collector adds intro text on the ClickStack vs upstream OpenTelemetry Helm charts, then nested Helm / Docker tabs: Helm covers helm repo add, a values.yaml with the ClickStack collector image and extraEnvs (CLICKHOUSE_*; OSS also documents OPAMP_SERVER_URL and HYPERDX_API_KEY), and helm install. Shared env-var guidance sits outside the tabs so it applies to either method.

Modifying configuration and Managed ClickStack → Securing the collector follow the same pattern—Helm shows extraEnvs / helm upgrade (including OTLP_AUTH_TOKEN for secured ingestion); Docker keeps the prior export/docker run examples. Docker Compose, OSS securing (OpAMP), anchors, and i18n are unchanged in this diff.

Reviewed by Cursor Bugbot for commit 251c1ef. Bugbot is set up for automated code reviews on this repo. Configure here.

Reorganize the Deploying and Securing sections so Helm appears as the
default install path, with Docker commands preserved in secondary tabs.
The Helm instructions use the upstream open-telemetry/opentelemetry-collector
chart with the ClickStack image, and note that the official ClickStack Helm
chart embeds the same chart as a subchart.

- Add nested Helm/Docker tabs (Helm default) in both the Managed ClickStack
  and Open Source ClickStack outer tabs of "Deploying the collector"
- Add the same nested split to the "Modifying configuration" subsections
- Add Helm guidance to the Managed ClickStack tab of "Securing the collector"
  (OTLP_AUTH_TOKEN via extraEnvs)
- Preserve all existing anchor IDs so inbound links from production.md,
  vector.md, hyperdx-only.md, docker-compose.md, all-in-one.md, and
  migrating-agents.md continue to resolve

Image tag and env var conventions (CLICKHOUSE_USER=otelcollector,
OPAMP_SERVER_URL, HYPERDX_API_KEY) match the ClickStack-helm-charts
values.yaml.
@dhable dhable requested a review from a team as a code owner June 3, 2026 16:27
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment Jun 3, 2026 4:39pm
clickhouse-docs-jp Building Building Preview, Comment Jun 3, 2026 4:39pm
3 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-ko Ignored Ignored Preview Jun 3, 2026 4:39pm
clickhouse-docs-ru Ignored Ignored Preview Jun 3, 2026 4:39pm
clickhouse-docs-zh Ignored Ignored Preview Jun 3, 2026 4:39pm

Request Review

@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 3, 2026

Docs PR opened: ClickHouse/mintlify-docs-dev#115

Helm is now the primary install method on the ClickStack OTel collector page, with Docker moved to secondary tabs.

Once this PR is merged, we'll do a second pass to capture any additional changes and update the docs PR.

@gingerwizard gingerwizard merged commit 6c222c1 into main Jun 4, 2026
19 checks passed
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 4, 2026

Docs PR opened: ClickHouse/mintlify-docs-dev#126

Ported upstream restructure making Helm the primary install path on the ClickStack OTel collector page, with Docker in secondary tabs.

@dhable dhable deleted the clickstack-collector-install-helm branch June 4, 2026 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants