Docs: sync upstream clickhouse-operator docs updates#179
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
arekborucki
approved these changes
Jun 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Syncs documentation updates from the upstream
clickhouse/clickhouse-operatorrepo (commitf5d7604— "docs: scaling guide (#222)") intoproducts/kubernetes-operator/.cc @arekborucki for review.
Changes
New pages:
guides/monitoring.mdx— Prometheus metrics monitoring guideguides/scaling.mdx— Scaling guideUpdated pages (copied verbatim from upstream):
overview.mdx— adds Monitoring link to the guides listguides/introduction.mdx— title/H1 normalization; link target changesguides/configuration.mdx— title/H1 normalization; resource defaults updated (256Mi→512Mi requests, 1Gi→512Mi limits); large new "External Secret" section removedinstall/olm.mdx— trivial whitespacereference/api-reference.mdx— addsAdditionalPorttype/section,additionalPortsfield, and updatesresourcesfield description (SMP deep-merge wording removed)navigation.json— addsguides/monitoringandguides/scalingentriesConflicts / issues to note
/core/reference/...prefix.guides/introduction.mdxnow contains two links to/core/reference/engines/database-engines/replicated(previously/reference/engines/...in the deployed copy). These were copied verbatim from upstream per the sync instructions but likely need to be fixed upstream — there is no/core/route in this docs site, so they will resolve as broken links.mint validatetimed out in the sandbox and could not be run to completion; no other validation was performed locally.Note
Medium Risk
Large verbatim doc import may ship broken
/core/...internal links and outdated overview guide list; content is documentation-only with no runtime impact.Overview
Syncs upstream ClickHouse Operator docs into
products/kubernetes-operator/, with the largest updates in the configuration guide and two new guides wired into navigation.The configuration guide is retitled (sidebar title vs on-page H1), updates documented default container memory (512Mi requests and limits), and adds long sections on
spec.externalSecret(Observe/Manage, required keys, status troubleshooting),spec.additionalPorts(reserved ports/names, MySQL example), version probe /upgradeChannel, andspec.settings.logger. Several cross-links now use a/core/...path prefix, which may not match this docs site’s routes.New:
guides/monitoring.mdx(Prometheus scrape, HelmServiceMonitor, RBAC, PromQL/alerts) andguides/scaling.mdx(replica/shard/Keeper scaling and status conditions).navigation.jsonlists both under Guides.API reference adds
AdditionalPort/spec.additionalPortsand revisescontainerTemplate.resourcesto “applied as a whole” instead of deep-merge wording. Introduction gets the same title/H1 pattern and/core/...Replicated engine links.Reviewed by Cursor Bugbot for commit b06fde0. Bugbot is set up for automated code reviews on this repo. Configure here.