Skip to content

Docs: sync upstream clickhouse-operator docs updates#236

Closed
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/5821cbbd
Closed

Docs: sync upstream clickhouse-operator docs updates#236
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/5821cbbd

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs the Mintlify copy under products/kubernetes-operator/ with the latest docs/ content from ClickHouse/clickhouse-operator (trigger commit 4041e93).

Changes

  • New guides added (referenced from navigation.json):
    • guides/monitoring.mdx — Prometheus metrics and health probes
    • guides/scaling.mdx — replicas, shards, Keeper quorum
    • guides/tls.mdx — end-to-end TLS with cert-manager
  • navigation.json — registers the three new guide pages.
  • overview.mdx — updates "What's next" links to the new guides (monitoring/scaling/tls).
  • guides/configuration.mdx — adds Multi-disk (JBOD) storage section, additionalPorts, clusterDomain, expanded default user password configuration, and other content updates.
  • guides/introduction.mdx — updates teardown commands to use the correct -clickhouse instance labels.
  • install/helm.mdx — fixes operator version override to use manager.image.tag (was using the non-existent manager.container.tag JSON path).
  • install/kubectl.mdx — switches install to server-side apply (required because the combined CRDs exceed the client-side apply size limit) and adds a fallback to the new stripped-CRDs artifact for client-side-only environments.
  • install/olm.mdx — minor trailing whitespace cleanup.
  • reference/api-reference.mdx — adds AdditionalPort and CABundleSelector types, documents additionalVolumeClaimTemplates / additionalPorts fields, and updates serverCertSecret / caBundle descriptions to reflect the new "no caBundle from certificate by default" behavior.

Context

Trigger commit (4041e93ci: fix changelog categories generation, @GrigoryPervakov) itself only touched .github/workflows/release.yaml, but the upstream docs/ tree had drifted ahead of the Mintlify copy from multiple recent PRs (#222 scaling, #223 tls, #228 clusterDomain, #230 docs fixes, #232 stripped CRDs, #136 JBOD, #237 caBundle, #238 default user password). This PR brings the Mintlify copy back in sync with docs/ at 4041e93, byte-for-byte.

Conflicts / issues

  • None — files were copied verbatim from upstream.
  • mint validate was not run to completion (timed out in the sync environment); upstream is the source of truth, so any validation issues should be addressed there first.

cc @GrigoryPervakov @arekborucki for review — you authored the upstream docs changes being synced here.


Note

Low Risk
Documentation-only sync with no runtime or application code changes; risk is limited to possible doc/link inaccuracies rather than production behavior.

Overview
Brings the Mintlify Kubernetes Operator docs in line with upstream clickhouse-operator docs/ at commit 4041e93.

New guidesmonitoring.mdx (operator Prometheus/health), scaling.mdx (replicas/shards/Keeper), and tls.mdx (cert-manager walkthrough). They are wired into navigation.json and the overview “Guides” list (monitoring no longer points at introduction).

Configuration guide — Large additions: JBOD/additionalVolumeClaimTemplates, clusterDomain, externalSecret, additionalPorts, version probe/upgradeChannel, expanded default-user password and server logging; TLS/Keeper trust docs now emphasize optional caBundle (not auto from server cert); default container memory 512Mi; PDB tables reformatted.

Install fixes — Helm version override uses manager.image.tag instead of the wrong manager.container.tag path. kubectl install documents server-side apply for oversized CRDs plus a stripped-CRDs manifest for client-side-only clusters; custom dist/install.yaml apply matches.

Smaller edits — Introduction teardown uses -clickhouse instance labels for pod/PVC cleanup. API reference adds AdditionalPort, CABundleSelector, JBOD templates, and updated TLS/container resource semantics.

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

@mintlify

mintlify Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

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

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

1 participant