Skip to content

docs: make Helm the primary install method on ClickStack OTel collector page#115

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
clickstack-collector-install-helm
Open

docs: make Helm the primary install method on ClickStack OTel collector page#115
mintlify[bot] wants to merge 1 commit into
mainfrom
clickstack-collector-install-helm

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Jun 3, 2026

Summary

Ports ClickHouse/clickhouse-docs#6337 — reorganises the ClickStack OTel collector page so Helm is the primary install path, with Docker preserved in secondary tabs.

Changes

  • Added Helm (default) / Docker tabs to the Deploying the collector section for both Managed and Open Source ClickStack flows, with a values.yaml example pinned to docker.clickhouse.com/clickhouse/clickstack-otel-collector:2.19.0.
  • Mirrored the same Helm / Docker split into the Modifying configuration subsections (#configuring-managed-clickstack, #configuring-clickhouse-instance).
  • Added Helm equivalent of OTLP_AUTH_TOKEN (via extraEnvs) under Securing the collector for the Managed ClickStack tab.
  • Linked the ClickStack Helm deployment guide via root-relative /products/clickstack/deployment/helm.
  • All anchor IDs preserved.

Context

Helm is the recommended install method for Kubernetes and matches how the ClickStack Helm chart ships the collector (as a subchart of the upstream opentelemetry-collector chart).

Notes on the Docusaurus → Mintlify port

  • Converted Docusaurus <Tabs groupId="install-method"> / <TabItem value="…" label="…" default> to Mintlify <Tabs> / <Tab title="…">. Mintlify Tab has no default prop — the first Tab (Helm) is shown first, matching intent. Mintlify also has no groupId, so the install-method tabs are no longer linked across sections; this is the expected mapping.
  • Open Source ClickStack tab of Securing the collector intentionally unchanged, per source PR.
  • i18n directories not touched.

Note

Low Risk
Documentation-only changes to deployment instructions; no application code, auth logic, or data paths are modified.

Overview
The ClickStack OTel collector doc (collector.mdx) is reorganized so Helm is the primary install path for Kubernetes, with Docker kept in a second tab in the same sections.

For both Managed and Open Source flows, Deploying the collector now opens with Helm vs Docker nested tabs: Helm adds the upstream opentelemetry-collector chart repo, a values.yaml using docker.clickhouse.com/clickhouse/clickstack-otel-collector:2.19.0, OTLP ports, and extraEnvs (Managed: Cloud endpoint/credentials; OSS: ClickHouse, OPAMP_SERVER_URL, HYPERDX_API_KEY), plus guidance to use secrets via extraEnvsFrom. Docker content is unchanged but moved under the Docker tab; shared env-var notes sit below the tabs.

Modifying configuration for Managed and OSS is split the same way: Helm shows extraEnvs overrides and helm upgrade; Docker keeps export/docker run examples.

Under Securing the collector (Managed only), OTLP_AUTH_TOKEN via Helm extraEnvs is documented alongside the existing Docker flow. The Open Source securing section is untouched.

Intro copy links the ClickStack Helm chart, upstream OTel Helm chart, and /products/clickstack/deployment/helm. Existing anchor IDs are preserved; Mintlify has no cross-section tab groupId, so install-method tabs are independent per section.

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

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview Jun 3, 2026, 4:50 PM

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.

0 participants