Docs: sync upstream clickhouse-operator docs updates#235
Closed
mintlify[bot] wants to merge 1 commit into
Closed
Conversation
1 task
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 latest
/docscontent fromclickhouse/clickhouse-operatorintoproducts/kubernetes-operator/in this Mintlify site.Changes
guides/monitoring.mdx— Prometheus metrics and health probesguides/scaling.mdx— scale replicas, shards, and Keeper quorumguides/tls.mdx— end-to-end TLS with cert-manageroverview.mdx— new links to monitoring, scaling, TLS guidesinstall/kubectl.mdx— switches to--server-side --force-conflictsapply; adds stripped-CRDs variant for client-side applyinstall/helm.mdx— Helm value renamed frommanager.container.tagtomanager.image.taginstall/olm.mdx— trailing newline tweakguides/introduction.mdx— correctskubectl wait/kubectl delete pvcselectors to use the-clickhousesuffixguides/configuration.mdx— adds Multi-disk (JBOD) storage section documentingadditionalVolumeClaimTemplatesreference/api-reference.mdx— addsAdditionalPort,CABundleSelectortypes andadditionalVolumeClaimTemplatesfieldnavigation.json— adds the three new guide pages (monitoring,scaling,tls) under the Guides group, mirroring upstreamdocs/navigation.json.Context
Triggered by merge of ClickHouse/clickhouse-operator@15cdb35 (CI-only change), which carried with it the accumulated docs work from recent upstream PRs (#222 scaling, #223 tls, #228 clusterDomain, #230 mintlify fetch, #136 JBOD, #237 caBundle, #238 default user password). Files are copied verbatim from upstream — any required fixes should land upstream first.
Known issues / conflicts
MDX syntax error in
reference/api-reference.mdx(upstream). The newadditionalVolumeClaimTemplatesrow in theClickHouseClusterSpectable embeds the literal<name>in a markdown table cell, which MDX parses as an unclosed JSX tag and breaksmint broken-links/mint validate:Per the sync policy, the file is copied as-is and should be fixed upstream (e.g. escape as
<name>or wrap in backticks) before this PR is merged, otherwise the page will fail to render.cc @arekborucki @GrigoryPervakov for review — primary authors of the upstream docs changes being synced.
Note
Medium Risk
Documentation-only, but the unescaped
<name>inapi-reference.mdxcan fail Mintlify build/validation and block publishing until fixed upstream or patched here.Overview
This PR imports the latest upstream
clickhouse-operatordocumentation intoproducts/kubernetes-operator/(verbatim sync), expanding what the Mintlify site covers for install, configuration, and day‑2 operations.New guides add dedicated pages for operator monitoring (Prometheus/health probes), scaling (replicas, shards, Keeper quorum), and TLS (cert-manager walkthrough).
The configuration guide grows substantially with new sections on JBOD /
additionalVolumeClaimTemplates,clusterDomain,externalSecret,additionalPorts, version probe /upgradeChannel, expanded default user password and server logging, plus refreshed TLS and default container memory values. Introduction fixes kubectl label selectors for pod/PVC cleanup (-clickhousesuffix).Install docs document
kubectl apply --server-side --force-conflicts(and a stripped-CRDs fallback) and rename the Helm pin tomanager.image.tag. Overview andnavigation.jsonlink the new guides.api-reference.mdxaddsAdditionalPort,CABundleSelector, JBOD templates, and related field/description updates.Merge blocker: upstream
api-reference.mdxstill embeds literal<name>in a table cell (JBOD mount path), which breaks MDX parsing until escaped upstream.Reviewed by Cursor Bugbot for commit af67e0c. Bugbot is set up for automated code reviews on this repo. Configure here.