Skip to content

docs: Helm as primary install method on ClickStack OTel collector page#126

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/60b0b80f
Open

docs: Helm as primary install method on ClickStack OTel collector page#126
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/60b0b80f

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Jun 4, 2026

Summary

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

Changes

  • products/clickstack/ingesting-data/collector.mdx:
    • Deploying the collector: For both Managed ClickStack and Open Source ClickStack outer tabs, added intro paragraphs explaining that the official ClickStack Helm chart embeds the upstream opentelemetry-collector chart as a subchart, and added nested Helm (default) / Docker tabs. Helm tabs show helm repo add, a focused values.yaml (image docker.clickhouse.com/clickhouse/clickstack-otel-collector:2.19.0, OTLP ports, extraEnvs for CLICKHOUSE_*, plus OPAMP_SERVER_URL and HYPERDX_API_KEY for OSS), and helm install. Shared environment-variable guidance moved outside the nested tabs.
    • Modifying configuration (both subsections): split into nested Helm / Docker tabs (extraEnvs + helm upgrade vs export + docker run).
    • Securing the collector → Managed ClickStack: split into nested Helm / Docker tabs, with OTLP_AUTH_TOKEN added via extraEnvs on the Helm side.
    • All existing anchors preserved (#configuring-the-collector, #modifying-otel-collector-configuration[-managed], #configuring-managed-clickstack, #configuring-clickhouse-instance, #docker-compose-otel[-managed], #securing-the-collector, #creating-an-ingestion-user[-oss]).

Context

Docusaurus → Mintlify port of ClickHouse/clickhouse-docs#6337. Slug /use-cases/observability/clickstack/ingesting-data/otel-collector is preserved. Transforms applied: <Tabs groupId>/<TabItem value label default><Tabs>/<Tab title>, :::note<Info>, image imports → <Image img="..."/>, /use-cases/observability/clickstack/.../products/clickstack/... for in-repo links. Docker Compose blocks, OSS Securing (OpAMP) prose, and the _extending_config snippet are unchanged, matching the upstream PR.

Notes / ambiguities

  • The Managed ClickStack "see connection details" link was already mapped to /products/cloud/guides/sql-console/connection-details in the Mintlify file (upstream uses /cloud/guides/sql-console/gather-connection-details); preserved the existing Mintlify mapping.
  • i18n files were intentionally not updated per the task scope.

Note

Low Risk
Documentation-only changes to collector deployment guidance; no application, auth, or ingestion code is modified.

Overview
The ClickStack OTel collector doc (collector.mdx) is reorganized so Helm is the primary install path for Kubernetes, with Docker kept in secondary tabs.

For both Managed and Open Source flows, Deploying the collector now opens with Helm chart context (ClickStack chart vs upstream opentelemetry-collector with the ClickStack image), then nested Helm / Docker tabs: helm repo add, sample values.yaml (clickstack-otel-collector image, OTLP ports, extraEnvs for CLICKHOUSE_*; OSS adds OPAMP_SERVER_URL and HYPERDX_API_KEY), helm install, and guidance to use secrets via extraEnvsFrom. Shared env-var notes sit outside the nested tabs.

Modifying configuration and Securing the collector (Managed) are split the same way: Helm shows extraEnvs + helm upgrade; Docker keeps export + docker run (including OTLP_AUTH_TOKEN on the secure path). Existing section anchors and unchanged blocks (Docker Compose, OSS OpAMP securing, _extending_config) are preserved.

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

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 4, 2026

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

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview Jun 4, 2026, 5:49 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