Skip to content

Docs: sync upstream clickhouse-operator docs updates#173

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

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

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Sync /docs updates from ClickHouse/clickhouse-operator@2e19eb5 (#202) into products/kubernetes-operator/.

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

Changes

  • New file: guides/monitoring.mdx — Prometheus metrics guide.
  • guides/configuration.mdx — restored External Secret section, restored inline # H1, reverted title to 'Configuration', tweaked sample memory requests/limits.
  • guides/introduction.mdx — reverted title to 'Introduction', restored inline # H1, links to Replicated database engine reverted from /reference/... to /core/reference/....
  • install/olm.mdx — re-added trailing newline.
  • navigation.json — added guides/monitoring to the Guides group.
  • overview.mdx — added Monitoring bullet under Guides (links to /products/kubernetes-operator/guides/introduction upstream — see Conflicts).
  • reference/api-reference.mdx — added AdditionalPort type section, added additionalPorts field on ClickHouseClusterSpec, updated resources description to mention SMP deep-merge.

Conflicts / known issues (need upstream fix)

Per instructions, files were copied as-is and the following issues should be fixed upstream before/after merge:

  1. Broken links to /core/... paths — the docs site routes use /reference/... and /concepts/..., not /core/.... These were previously fixed in this repo and are now reintroduced by the sync:
    • guides/introduction.mdx: two links to /core/reference/engines/database-engines/replicated
    • guides/configuration.mdx:
      • /core/concepts/features/configuration/server-config/configuration-files#example-1
      • /core/reference/settings/server-settings/settings
      • /core/concepts/features/configuration/settings/settings-users
  2. guides/monitoring.mdx — broken link /operations/server-configuration-parameters/settings#prometheus (no such page on docs site).
  3. overview.mdx — the new Monitoring bullet links to /products/kubernetes-operator/guides/introduction instead of /products/kubernetes-operator/guides/monitoring. Likely a typo in the upstream PR.
  4. Frontmatter title regression — upstream files use short titles (e.g. 'Configuration', 'Introduction') plus an inline # H1. The previous in-repo copy used descriptive titles (e.g. ClickHouse Operator configuration guide) without an inline H1, matching Mintlify conventions. The sync reverts both files to the upstream style.

Context

Triggered by merge of upstream PR #202 ("test: add openshift e2e smoke test") into clickhouse-operator:main, which also bundled the docs additions above.


Note

Low Risk
Documentation-only changes with no runtime impact; risk is broken /core/... and other cross-links until follow-up fixes.

Overview
Syncs upstream clickhouse-operator documentation into products/kubernetes-operator/, mainly expanding the configuration guide and adding operator monitoring docs.

New: guides/monitoring.mdx — Prometheus scraping, Helm ServiceMonitor, secured /metrics, health probes, metric catalog, PromQL, and sample alerts for the controller manager.

Configuration guide — Large additions: External Secret (spec.externalSecret, Observe/Manage, status troubleshooting), additional ports (K8s vs ClickHouse extraConfig, reserved ports), version probe / upgrade channel (upgradeChannel, status conditions, versionProbeTemplate, operator flags), and server logging (spec.settings.logger). Sample default container memory is now 512Mi for both requests and limits. Frontmatter titles shorten to 'Configuration' / 'Introduction' with inline # H1 headings; several internal links switch to /core/... paths (may not match this docs site).

API reference — Documents AdditionalPort and additionalPorts on ClickHouseClusterSpec; resources merge behavior text updated (whole apply vs SMP deep-merge).

Navnavigation.json lists the monitoring guide; overview.mdx still omits a Monitoring bullet in the synced file (upstream had a wrong link to introduction).

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

@mintlify

mintlify Bot commented Jun 10, 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 10, 2026, 10:13 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