Docs: sync upstream clickhouse-operator docs updates#202
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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 the
docs/content fromclickhouse/clickhouse-operatorintoproducts/kubernetes-operator/following the merge of upstream PR #226 (commit6346a75).cc @GrigoryPervakov for review — original author of the upstream docs changes.
Changes
guides/configuration.mdx— frontmatter title changed toConfiguration, H1 re-added in body, added new External Secret section (~290 lines), and updated defaultresourcesexample values (256Mi/1Gi → 512Mi/512Mi).guides/introduction.mdx— frontmatter title changed toIntroduction, H1 re-added, internal links to the Replicated database engine page updated to/core/reference/engines/database-engines/replicated.guides/monitoring.mdx— new file covering controller-manager Prometheus metrics, TLS, ServiceMonitor, alerting rules and Grafana.guides/scaling.mdx— new file covering shard, replica, and Keeper scaling.install/olm.mdx— adds a trailing newline only.overview.mdx— drops the "Monitoring" bullet from the Guides section (kept matching upstream — note: upstream removed it but the new monitoring guide is reachable via the side navigation).reference/api-reference.mdx— addsAdditionalPorttype and correspondingadditionalPortsfield onClickHouseClusterSpec, and updates theresourcesfield description to reflect the new SMP deep-merge semantics.navigation.json— adds the two new guides (monitoring,scaling) to the Guides group.Context
Upstream PR #226 itself only modified
internal/controller/keeper/templates.go, but the upstreamdocs/tree had accumulated unmerged drift relative to this repo. Per the sync rules, all updated files underdocs/have been copied verbatim — any content issues should be fixed upstream first.Known issues / conflicts to flag
guides/monitoring.mdxlinks to/operations/server-configuration-parameters/settings#prometheus, which does not exist in this docs site. The equivalent page lives under a different path here. Fix upstream before this is resolved cleanly.overview.mdxdropped the "Monitoring" bullet from the Guides list while a newguides/monitoring.mdxpage was added. The page is still reachable via the navigation, but the overview no longer references it — likely an upstream oversight worth a follow-up upstream PR.mint validatestep timed out in CI sandbox; broken-links was not run. Reviewers should rely on Mintlify's preview build for link validation.Note
Low Risk
Docs-only sync with a known broken cross-link in the new monitoring guide (
/operations/...#prometheus); no runtime or security impact.Overview
Documentation sync from upstream
clickhouse-operatorintoproducts/kubernetes-operator/, with no operator code changes.The configuration guide gets frontmatter title tweaks (H1 moved into the body), updated default container memory in the example (
512Mirequest/limit), new sections onspec.externalSecret,additionalPorts, version probe /upgradeChannel, andspec.settings.logger, plus internal links retargeted to/core/...paths.New guides:
monitoring.mdx(controller-manager Prometheus metrics, HelmServiceMonitor, TLS/RBAC, PromQL and alerts) andscaling.mdx(replica/shard scaling, schema sync conditions, Keeper quorum scaling).Navigation adds both guides under Guides; overview drops the Monitoring bullet (page remains in the sidebar). API reference documents
AdditionalPort/additionalPortsand revisescontainerTemplate.resourcesto “applied as a whole” instead of SMP deep-merge. Introduction Replicated-engine links use/core/reference/....Reviewed by Cursor Bugbot for commit ba60abd. Bugbot is set up for automated code reviews on this repo. Configure here.