Skip to content

Docs: sync upstream clickhouse-operator docs updates#207

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/5557f552
Open

Docs: sync upstream clickhouse-operator docs updates#207
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/5557f552

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs documentation changes from clickhouse/clickhouse-operator#230 (commit f20f9d8) into products/kubernetes-operator/.

cc @GrigoryPervakov for review.

Changes

  • Updated existing pages: overview.mdx, guides/introduction.mdx, guides/configuration.mdx, install/{kubectl,helm,olm}.mdx, reference/api-reference.mdx
  • Added new guides: guides/monitoring.mdx, guides/scaling.mdx, guides/tls.mdx
  • Updated navigation.json to include the three new guides under the Guides group

Context

Upstream PR description: docs link fixes, CI for docs linting, refresh of comments and doc entries, and resync with mintlify changes that had been committed directly. Files were copied verbatim from clickhouse-operator/docs/ per sync policy — any upstream issues should be addressed upstream first.

Conflicts / issues

  • None encountered. All existing files were overwritten cleanly; navigation reorganization (new guides) applied as-is.
  • mint validate and mint broken-links timed out locally in this environment, so they could not be run as a final gate. Files are byte-for-byte copies of upstream, so any validation issues match upstream state.

Note

Low Risk
Documentation-only changes under products/kubernetes-operator/ with no application code or runtime behavior modified.

Overview
Syncs clickhouse-operator documentation into products/kubernetes-operator/, adding three guides and substantially expanding the configuration reference.

New guides: Monitoring (operator /metrics, Helm ServiceMonitor, RBAC, PromQL/alerts), Scaling (replicas/shards, schema sync, Keeper quorum), and TLS (cert-manager walkthrough, Keeper encryption).

Configuration guide now documents externalSecret, additionalPorts, version probe / upgradeChannel, and spec.settings.logger; default example memory is 512Mi request/limit; TLS points to the dedicated TLS guide.

Install fixes: Helm pin uses manager.image.tag; custom kubectl install applies dist/install.yaml with -f instead of kustomize -k. Introduction fixes pod/PVC cleanup label selectors to *-clickhouse.

API reference adds AdditionalPort / additionalPorts, clarifies container resources merge behavior and Keeper PDB defaults, and corrects updateRevision wording. Navigation and overview link the new guides.

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

@mintlify

mintlify Bot commented Jun 16, 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 16, 2026, 1:12 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