Skip to content

Docs: sync upstream clickhouse-operator docs updates#161

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

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

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs docs/ from clickhouse/clickhouse-operator into products/kubernetes-operator/ to match the upstream snapshot at commit 30368f9.

cc @GrigoryPervakov for review (author of the most recent upstream commit on the operator repo).

Changes

  • guides/monitoring.mdx — new page added upstream; copied over and registered in navigation.json under the Guides group.
  • navigation.json — added products/kubernetes-operator/guides/monitoring entry.
  • overview.mdx — removed the stray bullet - **[Monitoring](/products/kubernetes-operator/guides/introduction)** - Monitor clickhouse-operator using Prometheus metrics (this line is not present in upstream).
  • guides/introduction.mdx — internal links for the Replicated database engine changed from /reference/engines/database-engines/replicated to /core/reference/engines/database-engines/replicated (see conflict note below).
  • guides/configuration.mdx — new External Secret section (~290 lines) and resource-request example values updated (memory: 256Mi512Mi, 1Gi512Mi).
  • install/olm.mdx — trailing newline added.
  • reference/api-reference.mdx — new AdditionalPort type documented, new additionalPorts field added to ClickHouseClusterSpec, and the resources field description rewritten to reflect new SMP deep-merge behavior.

Conflicts / issues

All copied exactly as upstream, per the sync policy. The following pre-existing broken links surfaced from mint broken-links and should be fixed upstream in clickhouse/clickhouse-operator before they can be resolved here:

  • products/kubernetes-operator/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
  • products/kubernetes-operator/guides/introduction.mdx
    • /core/reference/engines/database-engines/replicated (×2) — upstream changed the prefix from /reference/... to /core/reference/..., but neither path resolves in this docs site. The previous /reference/engines/... form (still present pre-sync) also did not resolve.
  • products/kubernetes-operator/guides/monitoring.mdx
    • /operations/server-configuration-parameters/settings#prometheus

mint validate passes.


Note

Low Risk
Documentation-only sync with no application code changes; main follow-up risk is broken internal /core/... and monitoring cross-links until paths are fixed upstream or locally.

Overview
Syncs Kubernetes Operator product docs with upstream clickhouse-operator, mainly by expanding guides and API reference rather than changing runtime code.

Configuration guide grows substantially: documents spec.externalSecret (Observe/Manage, required keys, ExternalSecretValid troubleshooting), spec.additionalPorts (reserved ports/names, pairing with extraConfig.protocols), version probe and upgradeChannel status conditions, and spec.settings.logger. Example default container memory in the snippet is updated to 512Mi for both requests and limits.

Adds a new Monitoring guide covering operator /metrics and /healthz//readyz, Helm prometheus.enable, secured scraping (RBAC, ServiceMonitor), PromQL, and sample alerts; it is wired into navigation.json. Overview drops the incorrect monitoring link that pointed at the introduction guide.

API reference documents AdditionalPort and ClickHouseClusterSpec.additionalPorts, and revises containerTemplate.resources to “applied as a whole” instead of SMP deep-merge. Introduction and configuration cross-links switch several paths to a /core/... prefix (may still be broken on this site per PR notes).

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

@mintlify

mintlify Bot commented Jun 9, 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 9, 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