Skip to content

docs: document installing the charts from GHCR - #322

Merged
jordan-simonovski merged 1 commit into
mainfrom
jordansimonovski/ghcr-install-docs
Nov 17, 2026
Merged

jordan-simonovski merged 1 commit into
mainfrom
jordansimonovski/ghcr-install-docs

Conversation

@jordan-simonovski

Copy link
Copy Markdown
Contributor

The GHCR packages for both charts are now public, so the READMEs show the OCI install (oci://ghcr.io/clickhouse/charts/<chart>) next to the existing helm repo add one. Until now the only place the GHCR location appeared was release.yml.

  • The root README and both chart READMEs carry the full OCI commands.
  • The example READMEs and the two-phase install section of docs/UPGRADE.md keep their Helm repo commands and gain a one-line note on swapping in the OCI reference.
  • Both charts pull from GHCR with an anonymous token, checked against clickstack 3.6.0 and clickstack-operators 1.1.0.

Docs only: no template or values changes. The patch changeset is there because the chart READMEs ship in the packages.

@jordan-simonovski
jordan-simonovski requested a review from a team as a code owner November 17, 2026 23:39
@changeset-bot

changeset-bot Bot commented Nov 17, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3b38386

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
helm-charts Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

Helm template coverage

Metric Value
Line coverage 99.85%
Branch coverage 91.00%
Line threshold 99% (met)
Branch threshold 90% (met)
Uncovered details

charts/clickstack/templates/NOTES.txt

Uncovered lines: none

Uncovered branches: 37:default:fallback

charts/clickstack/templates/_helpers.tpl

Uncovered lines: 17

Uncovered branches: 130:range:empty, 132:range:empty, 133:ternary:false, 16:if:true, 194:or(1):true, 211:range:empty, 242:default:fallback, 243:or(1):true, 259:if:false, 327:range:empty, 348:range:empty

charts/clickstack/templates/additional-manifests.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/clickhouse/cluster.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/clickhouse/keeper.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/configmap.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/cronjob-check-alerts.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/dashboard-configmap.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/dashboard-provisioner-rbac.yaml

Uncovered lines: none

Uncovered branches: 40:range:empty

charts/clickstack/templates/hyperdx/deployment.yaml

Uncovered lines: none

Uncovered branches: 121:default:fallback, 131:default:fallback, 196:default:fallback, 201:with:empty, 20:with:empty, 26:default:fallback, 41:if:false, 42:with:empty

charts/clickstack/templates/hyperdx/hpa.yaml

Uncovered lines: none

Uncovered branches: 16:with:empty

charts/clickstack/templates/hyperdx/ingress.yaml

Uncovered lines: none

Uncovered branches: 35:if:false, 40:range:empty, 45:range:empty, 48:with:empty, 54:range:empty, 58:range:empty, 59:or(2):true, 59:or(3):true

charts/clickstack/templates/hyperdx/networkpolicy.yaml

Uncovered lines: none

Uncovered branches: 11:with:empty

charts/clickstack/templates/hyperdx/pdb.yaml

Uncovered lines: none

Uncovered branches: 10:with:empty

charts/clickstack/templates/hyperdx/secret.yaml

Uncovered lines: none

Uncovered branches: 1:or(2):true, 1:or(3):true

charts/clickstack/templates/hyperdx/service.yaml

Uncovered lines: none

Uncovered branches: 14:default:fallback, 9:with:empty

charts/clickstack/templates/hyperdx/serviceaccount.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/mongodb/community.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/mongodb/password-secret.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/otel-collector/custom-config.yaml

Uncovered lines: none

Uncovered branches: none

@github-actions

Copy link
Copy Markdown
Contributor

Deep Review

✅ No critical issues found. This is a documentation-only change that adds GHCR/OCI install instructions alongside the existing helm repo add flow. Every verifiable claim in the diff checks out against the repository.

Verification performed:

  • OCI paths are correct. oci://ghcr.io/clickhouse/charts/clickstack and .../clickstack-operators match where .github/workflows/release.yml actually pushes (OCI_REPO=oci://ghcr.io/clickhouse/charts with helm push appending the chart name), and the chart names in charts/*/Chart.yaml (clickstack, clickstack-operators) line up.
  • Anchor links resolve. The new [Quick Start](...#quick-start) references in docs/UPGRADE.md (../README.md) and the three examples/*/README.md files (../../README.md) all point at the real ## Quick Start heading at README.md:5.
  • helm-docs stays consistent. The static OCI block added to each charts/*/README.md is byte-identical to the block added to its README.md.gotmpl and sits in the hand-written (non-{{ template }}) region, so make docs-check will not flag the generated READMEs as stale.
  • Install flow is sound. The root README's OCI block preserves the two-phase ordering (operators before clickstack), and public/anonymous-pull OCI charts need no helm registry login, so no step is missing.
  • Changeset is well-formed. "helm-charts": patch matches package.json, and a docs-only patch bump is the correct classification.

Reviewers (3): correctness, maintainability, project-standards.

Testing gaps: Two items could not be mechanically verified from the checkout and rest on the author's stated validation: (1) helm-docs is not installed here, so make docs-check could not be run to confirm generated-README parity — consistency was confirmed by byte-comparing the added blocks; (2) the OCI instructions assume the GHCR packages are configured for public/anonymous pull — if any package is private, helm install oci://... would require a login step the docs intentionally omit.

@jordan-simonovski
jordan-simonovski merged commit b37d395 into main Nov 17, 2026
12 checks passed
@jordan-simonovski
jordan-simonovski deleted the jordansimonovski/ghcr-install-docs branch November 17, 2026 23:46
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