Docs: sync upstream clickhouse-operator docs updates#236
Closed
mintlify[bot] wants to merge 1 commit into
Closed
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 Mintlify copy under
products/kubernetes-operator/with the latestdocs/content fromClickHouse/clickhouse-operator(trigger commit4041e93).Changes
navigation.json):guides/monitoring.mdx— Prometheus metrics and health probesguides/scaling.mdx— replicas, shards, Keeper quorumguides/tls.mdx— end-to-end TLS with cert-managernavigation.json— registers the three new guide pages.overview.mdx— updates "What's next" links to the new guides (monitoring/scaling/tls).guides/configuration.mdx— adds Multi-disk (JBOD) storage section,additionalPorts,clusterDomain, expanded default user password configuration, and other content updates.guides/introduction.mdx— updates teardown commands to use the correct-clickhouseinstance labels.install/helm.mdx— fixes operator version override to usemanager.image.tag(was using the non-existentmanager.container.tagJSON path).install/kubectl.mdx— switches install to server-side apply (required because the combined CRDs exceed the client-side apply size limit) and adds a fallback to the new stripped-CRDs artifact for client-side-only environments.install/olm.mdx— minor trailing whitespace cleanup.reference/api-reference.mdx— addsAdditionalPortandCABundleSelectortypes, documentsadditionalVolumeClaimTemplates/additionalPortsfields, and updatesserverCertSecret/caBundledescriptions to reflect the new "no caBundle from certificate by default" behavior.Context
Trigger commit (
4041e93— ci: fix changelog categories generation, @GrigoryPervakov) itself only touched.github/workflows/release.yaml, but the upstreamdocs/tree had drifted ahead of the Mintlify copy from multiple recent PRs (#222 scaling, #223 tls, #228 clusterDomain, #230 docs fixes, #232 stripped CRDs, #136 JBOD, #237 caBundle, #238 default user password). This PR brings the Mintlify copy back in sync withdocs/at4041e93, byte-for-byte.Conflicts / issues
mint validatewas not run to completion (timed out in the sync environment); upstream is the source of truth, so any validation issues should be addressed there first.cc @GrigoryPervakov @arekborucki for review — you authored the upstream docs changes being synced here.
Note
Low Risk
Documentation-only sync with no runtime or application code changes; risk is limited to possible doc/link inaccuracies rather than production behavior.
Overview
Brings the Mintlify Kubernetes Operator docs in line with upstream
clickhouse-operatordocs/at commit4041e93.New guides —
monitoring.mdx(operator Prometheus/health),scaling.mdx(replicas/shards/Keeper), andtls.mdx(cert-manager walkthrough). They are wired intonavigation.jsonand the overview “Guides” list (monitoring no longer points at introduction).Configuration guide — Large additions: JBOD/
additionalVolumeClaimTemplates,clusterDomain,externalSecret,additionalPorts, version probe/upgradeChannel, expanded default-user password and server logging; TLS/Keeper trust docs now emphasize optionalcaBundle(not auto from server cert); default container memory 512Mi; PDB tables reformatted.Install fixes — Helm version override uses
manager.image.taginstead of the wrongmanager.container.tagpath. kubectl install documents server-side apply for oversized CRDs plus a stripped-CRDs manifest for client-side-only clusters; customdist/install.yamlapply matches.Smaller edits — Introduction teardown uses
-clickhouseinstance labels for pod/PVC cleanup. API reference addsAdditionalPort,CABundleSelector, JBOD templates, and updated TLS/container resource semantics.Reviewed by Cursor Bugbot for commit 115a73d. Bugbot is set up for automated code reviews on this repo. Configure here.