Skip to content

Docs: sync upstream clickhouse-operator docs updates#212

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/84a509c1
Open

Docs: sync upstream clickhouse-operator docs updates#212
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/84a509c1

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Sync /docs content from clickhouse/clickhouse-operator (trigger commit a5ec30b) into products/kubernetes-operator/.

cc @GrigoryPervakov for review.

Changes

  • New pages added under products/kubernetes-operator/guides/:
    • monitoring.mdx — Prometheus metrics and health probes
    • scaling.mdx — scaling replicas, shards, and Keeper quorum
    • tls.mdx — end-to-end TLS with cert-manager
  • Updated pages:
    • overview.mdx — link out to the new monitoring, scaling, and TLS guides
    • navigation.json — register the three new guides
    • guides/configuration.mdx — new "Cluster domain" section, resource-default updates, TLS cross-link
    • guides/introduction.mdx — cleanup uses the correct app.kubernetes.io/instance=my-cluster-clickhouse label
    • install/helm.mdx — fix --set manager.image.tag flag (was an invalid --set-json form)
    • install/kubectl.mdx — switch to kubectl apply --server-side --force-conflicts and document the clickhouse-operator-stripped-crds.yaml fallback
    • install/olm.mdx — trailing-newline normalization
    • reference/api-reference.mdx — add AdditionalPort type and additionalPorts field; refine resource-merge and PDB descriptions; fix updateRevision description

Context

Trigger commit a5ec30b ("test: fix flaky operator-upgrade keeper writes", PR #233) does not itself touch /docs, but the upstream /docs tree had drifted ahead of the Mintlify copy. This PR brings the mirror back in sync. Files were copied verbatim from upstream — no rewrites, so any upstream issues should be fixed upstream first.

Conflicts / issues

None — all changes applied cleanly as straight copies.


Note

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

Overview
Brings the Mintlify products/kubernetes-operator/ tree in line with upstream clickhouse-operator docs.

New guides: Monitoring (Prometheus/health for the controller), Scaling (replicas, shards, Keeper quorum), and TLS (cert-manager walkthrough). navigation.json and overview.mdx link to them.

guides/configuration.mdx gains substantial reference material: clusterDomain, externalSecret (keys, Observe/Manage, status conditions), additionalPorts (reserved ports, MySQL example), version probe / upgradeChannel, spec.settings.logger, updated default container memory in examples, and a cross-link to the TLS guide.

Install docs: Helm uses --set manager.image.tag; kubectl install documents kubectl apply --server-side --force-conflicts and the clickhouse-operator-stripped-crds.yaml fallback for client-side-only environments.

Smaller fixes: Introduction cleanup commands use app.kubernetes.io/instance=my-cluster-clickhouse; API reference adds AdditionalPort / additionalPorts and clarifies container resource merge and Keeper PDB / updateRevision wording.

Reviewed by Cursor Bugbot for commit 4ffc17d. 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, 4: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.

0 participants