Skip to content

Docs: sync upstream clickhouse-operator docs updates#217

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/5fbbaa64
Open

Docs: sync upstream clickhouse-operator docs updates#217
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/5fbbaa64

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs /docs content from ClickHouse/clickhouse-operator@6e96f8e ("feat: support distroless images in ch version probe, remove keeper version probe job (#195)") into products/kubernetes-operator/.

Changes

  • Updated existing pages: overview.mdx, guides/introduction.mdx, guides/configuration.mdx, install/helm.mdx, install/kubectl.mdx, install/olm.mdx, reference/api-reference.mdx, navigation.json
  • Added new guides: guides/monitoring.mdx, guides/scaling.mdx, guides/tls.mdx
  • navigation.json updated to register the three new guide pages (Monitoring, Scaling, TLS)

Upstream-only files (not part of the deployed docs site) were skipped: docs/README.md, docs/development.md, docs/styles/, docs/templates/.

Localized copies under es/, ja/, ko/, pt-BR/, ru/, zh/ were not touched — they are regenerated by the translation pipeline.

Context

Upstream PR: ClickHouse/clickhouse-operator#195 by @ashishch432

Notes / Issues

  • mint validate timed out locally on this large repo and could not be run to completion. Files were copied verbatim per instructions; any content issues should be fixed upstream first.

cc @ashishch432 for review


Note

Low Risk
Changes are limited to MDX documentation and navigation; no application code, auth, or runtime behavior is modified.

Overview
Syncs ClickHouse Kubernetes Operator docs from upstream into products/kubernetes-operator/, expanding configuration coverage and adding dedicated guides.

The configuration guide gains major new sections: multi-disk (JBOD) via additionalVolumeClaimTemplates, clusterDomain, externalSecret (Observe/Manage policies and status conditions), additionalPorts (with reserved ports and MySQL example), version probe / upgradeChannel, and spec.settings.logger. Smaller edits include updated default container memory in examples and reformatted PDB tables.

New guides document operator Prometheus metrics (Helm ServiceMonitor, secure scraping, PromQL/alerts), scaling replicas/shards/Keeper quorum and related status conditions, and a cert-manager TLS walkthrough for ClickHouse and Keeper.

Install docs now recommend server-side apply for large manifests (plus a stripped-CRD fallback) and fix the Helm pin to manager.image.tag. Introduction corrects kubectl label selectors for pod/PVC cleanup. API reference and navigation/overview are updated for new CRD fields (AdditionalPort, PersistentVolumeClaimTemplate, deprecated Keeper version-probe Job) and the three new guide pages.

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

@mintlify

mintlify Bot commented Jun 17, 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 17, 2026, 5:03 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