Skip to content

Docs: sync upstream clickhouse-operator docs updates#144

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

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

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs documentation changes from clickhouse/clickhouse-operator commit a718cc9 ("fix: track users reload separately of server config" #218) into the Mintlify mirror under products/kubernetes-operator/.

cc @grigorypv for review (original author of the upstream docs changes).

Changes

  • overview.mdx — Added "Monitoring" entry to the list of guides.
  • guides/introduction.mdx — Two Replicated engine links re-prefixed to /core/reference/engines/database-engines/replicated.
  • guides/configuration.mdx — Memory request bumped to 512Mi (was 256Mi); memory limit reduced to 512Mi (was 1Gi); new "External Secret" section (#external-secret) covering spec.externalSecret, required keys, and Observe vs Manage policy.
  • guides/monitoring.mdx — New page (added to nav and to overview).
  • install/olm.mdx — Trailing newline added.
  • reference/api-reference.mdx — New AdditionalPort type section and corresponding additionalPorts field on ClickHouseClusterSpec; updated description for resources to mention SMP deep-merge behavior; added intro sentence under the page heading.
  • navigation.json — Added products/kubernetes-operator/guides/monitoring under the Guides group.

Conflicts / issues

Files were copied verbatim from upstream as instructed. The following pre-existing upstream link issues now exist in the Mintlify mirror and surface in mint broken-links. They should be fixed upstream first, then re-synced:

  • guides/introduction.mdx — Links to /core/reference/engines/database-engines/replicated (×2). The Mintlify path is /reference/engines/database-engines/replicated (no /core prefix).
  • guides/configuration.mdx — Links to /core/concepts/features/configuration/server-config/configuration-files#example-1, /core/reference/settings/server-settings/settings, and /core/concepts/features/configuration/settings/settings-users — same /core prefix issue.
  • guides/monitoring.mdx — Links to /operations/server-configuration-parameters/settings#prometheus, which does not resolve in the Mintlify site.
  • overview.mdx — The new "Monitoring" bullet links to /products/kubernetes-operator/guides/introduction (likely meant to be /products/kubernetes-operator/guides/monitoring).

mint validate passes.


Note

Low Risk
Documentation-only sync with no runtime changes; risk is limited to broken internal links from verbatim /core/ paths until corrected.

Overview
Syncs upstream clickhouse-operator documentation into the Mintlify products/kubernetes-operator/ mirror.

guides/configuration.mdx updates documented default ClickHouse container memory to 512Mi for both requests and limits (limit down from 1Gi). It adds large new guide sections for spec.externalSecret (required keys, Observe vs Manage, status troubleshooting), spec.additionalPorts (reserved ports/names, MySQL protocol example), and version probe / upgradeChannel (status conditions, versionProbeTemplate, operator flags). Several cross-doc links are re-pointed to /core/... paths.

guides/monitoring.mdx is a new guide for scraping and securing the operator controller metrics (/metrics, Helm ServiceMonitor, RBAC, PromQL, sample alerts). navigation.json registers it under Guides.

reference/api-reference.mdx documents AdditionalPort and additionalPorts on ClickHouseClusterSpec, and revises containerTemplate.resources to describe whole-object application instead of SMP deep-merge.

guides/introduction.mdx updates Replicated engine links to /core/reference/.... overview.mdx drops the incorrect Monitoring guide bullet that linked to Introduction. Minor whitespace in install/olm.mdx.

Note: Mirrored /core/... and some monitoring cross-links may still fail Mintlify broken-links until paths are fixed upstream or in a follow-up.

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

@mintlify

mintlify Bot commented Jun 8, 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 8, 2026, 7:14 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