Skip to content

Docs: sync upstream clickhouse-operator docs updates#208

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
sync-clickhouse-operator-docs-f55fbb7
Open

Docs: sync upstream clickhouse-operator docs updates#208
mintlify[bot] wants to merge 1 commit into
mainfrom
sync-clickhouse-operator-docs-f55fbb7

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs /docs updates from clickhouse/clickhouse-operator@f55fbb7 ("docs: update AGENTS.md, do not run tests on pure documentation changes (#231)") into products/kubernetes-operator/.

cc @gerlowskija — original author was @pervakovgrigorii (Pervakov Grigorii <pervakov.grigory@gmail.com>); please review.

Changes

New guides:

  • guides/monitoring.mdx — Prometheus metrics and health probes for the operator
  • guides/scaling.mdx — Scale replicas, shards, and Keeper quorum
  • guides/tls.mdx — End-to-end TLS with cert-manager

Updated:

  • navigation.json — adds monitoring/scaling/tls entries under Guides
  • overview.mdx — links to the three new guides (fixes broken monitoring link)
  • guides/configuration.mdx — adds External Secret section, TLS guide cross-link, bumps default operator memory to 512Mi
  • guides/introduction.mdx — corrects cleanup kubectl selectors to <name>-clickhouse
  • install/helm.mdx — fixes Helm install command (--set manager.image.tag=…)
  • install/kubectl.mdx — fixes kubectl apply to use -f dist/install.yaml
  • install/olm.mdx — trailing newline only
  • reference/api-reference.mdx — adds AdditionalPort type and additionalPorts field on ClickHouseClusterSpec; updates Resources and Keeper PDB descriptions

Context

Files were copied verbatim from upstream. No conflicts. mint validate was attempted but timed out on the full repo; the changed MDX files parse cleanly and follow existing frontmatter/link conventions. Per instructions, any issues should be fixed upstream first.


Note

Low Risk
Documentation-only sync with no runtime or application code changes; risk is limited to doc accuracy and broken links if upstream content diverges.

Overview
Imports upstream documentation into products/kubernetes-operator/, with the largest additions in the configuration guide and three new task guides.

New guides cover operator Prometheus metrics and health probes (monitoring.mdx), scaling replicas/shards and Keeper quorum (scaling.mdx), and end-to-end TLS with cert-manager (tls.mdx). navigation.json and overview.mdx wire them into the sidebar and fix the monitoring link that previously pointed at the introduction page.

guides/configuration.mdx grows substantially: spec.externalSecret (Observe/Manage, required keys, status conditions), spec.additionalPorts (reserved ports/names, MySQL example), version probe and upgradeChannel, spec.settings.logger, updated default container memory (512Mi request/limit), and a cross-link to the TLS guide.

Smaller fixes: introduction.mdx cleanup commands use the -clickhouse instance label; install/helm.mdx uses --set manager.image.tag; install/kubectl.mdx applies dist/install.yaml with -f; api-reference.mdx documents AdditionalPort / additionalPorts and refreshes resources and Keeper PDB wording.

Reviewed by Cursor Bugbot for commit 8e88a4e. 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, 2:42 PM

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 8e88a4e. Configure here.

labels:
severity: critical
annotations:
summary: 'No leader for the ClickHouse operator (HA deployment)'

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leader alert uses absent()

Medium Severity

The suggested ClickHouseOperatorNoLeader rule uses absent(leader_election_master_status{...}), which fires only when the metric series is missing entirely—not when leader election is enabled but no replica reports master status 1. It also tends to fire on deployments without leader election, where the metric never exists, despite the summary claiming “no leader” in HA.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 8e88a4e. Configure here.

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