Make Helm the primary install method on ClickStack OTel collector page#6337
Merged
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
|
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
approved these changes
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Reorganized the
Deploying the collectorandSecuring the collectorsections of/use-cases/observability/clickstack/ingesting-data/otel-collectorso 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-collectorchart). The page previously had Docker-only instructions, which forced Kubernetes users to translatedocker runflags into Helm values themselves.What the new content looks like
helm repo add+ a focusedvalues.yamlshowing the ClickStack image (docker.clickhouse.com/clickhouse/clickstack-otel-collector:2.19.0), OTLP ports, andextraEnvsforCLICKHOUSE_*(plusOPAMP_SERVER_URLandHYPERDX_API_KEYfor the Open Source ClickStack flow) +helm install.docker runblock and associated notes, unchanged.Modifying configurationsubsection and to the Managed ClickStack tab ofSecuring the collector(Helm equivalent ofOTLP_AUTH_TOKENviaextraEnvs).Image tag and env var conventions (
CLICKHOUSE_USER=otelcollector,OPAMP_SERVER_URL,HYPERDX_API_KEY) match the canonicalcharts/clickstack/values.yamlso the docs stay in sync with the chart.Out of scope
Securing the collectoris unchanged — OpAMP-managed credentials work transparently for both install methods, and the existing prose is install-method-agnostic._extending_config.mdsnippet is unchanged (works for both install methods).Compatibility
All existing anchor IDs preserved:
#configuring-the-collector#modifying-otel-collector-configurationand#modifying-otel-collector-configuration-managed#configuring-managed-clickstackand#configuring-clickhouse-instance#docker-compose-oteland#docker-compose-otel-managed#securing-the-collector#creating-an-ingestion-userand#creating-an-ingestion-user-ossInbound links from
production.md,vector.md,hyperdx-only.md,docker-compose.md,all-in-one.md, andmigrating-agents.mdcontinue to resolve.Verification
<Tabs>blocks, all opened and closed in order).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, avalues.yamlwith the ClickStack collector image andextraEnvs(CLICKHOUSE_*; OSS also documentsOPAMP_SERVER_URLandHYPERDX_API_KEY), andhelm 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(includingOTLP_AUTH_TOKENfor secured ingestion); Docker keeps the prior export/docker runexamples. 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.