Docs: sync upstream clickhouse-operator docs updates#216
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
Sync
docs/updates fromclickhouse/clickhouse-operator(commit10a6f02) intoproducts/kubernetes-operator/.cc @pervakov-grigory for review (original author).
Changes
guides/monitoring.mdx,guides/scaling.mdx,guides/tls.mdx.guides/configuration.mdx— added Multi-disk (JBOD) storage, Cluster domain, and Server logging sections; updated default memory examples.guides/introduction.mdx— correctedkubectl wait/kubectl delete pvclabel selectors to usemy-cluster-clickhouse.install/helm.mdx— switched flag to--set manager.image.tag=<operator version>.install/kubectl.mdx— switched tokubectl apply --server-side --force-conflicts; documented stripped-CRD variant for client-side apply.install/olm.mdx— minor trailing-newline change.overview.mdx— Monitoring link now points to the newguides/monitoring; added Scaling and TLS entries.navigation.json— addedmonitoring,scaling,tlsentries under guides.reference/api-reference.mdx— addedAdditionalPort,NamedTemplateMeta,PersistentVolumeClaimTemplatetypes; addedadditionalVolumeClaimTemplatesandadditionalPortsfields; rewordedresources,podDisruptionBudget,updateRevisiondescriptions.Context
Triggered by upstream merge
10a6f02(test: use latest supported ClickHouse versions in tests (#234)), which carries the docs delta authored by Pervakov Grigorii.Known issues (sync-as-is)
products/kubernetes-operator/reference/api-reference.mdxline 71 contains a literal<name>inside a Markdown table cell, which MDX parses as an unclosed JSX tag.mint broken-linksreports:mint validatedid not complete within the sandbox timeout (>5 min); onlybroken-linkswas run.Note
Low Risk
Documentation-only changes with no runtime or security logic; the known MDX
<name>parse issue may fail doc validation until fixed upstream or locally.Overview
Syncs upstream ClickHouse Kubernetes Operator documentation into
products/kubernetes-operator/, expanding configuration coverage and adding task-oriented guides.New guides:
monitoring.mdx(Prometheus/health endpoints, HelmServiceMonitor, RBAC, sample alerts),scaling.mdx(replica/shard/Keeper scaling and status conditions), andtls.mdx(cert-manager walkthrough for ClickHouse and Keeper).guides/configuration.mdxgains major sections on JBOD/additionalVolumeClaimTemplates,clusterDomain, externally managed credentials (externalSecret),additionalPorts, version probe/upgradeChannel, andsettings.logger; default container memory examples are updated to 512Mi request/limit.Install docs: Helm uses
--set manager.image.tag; kubectl/custom installs document server-side apply and the stripped-CRD manifest for client-side apply.Navigation/overview: Guides list Monitoring, Scaling, and TLS;
reference/api-reference.mdxaddsAdditionalPort, JBOD PVC types, and new spec fields with revised field descriptions.Fixes: Introduction storage cleanup uses label
my-cluster-clickhouseinstead of mismatched selectors.Note:
api-reference.mdxstill has a literal<name>in a table cell (upstream MDX issue) that can breakmint broken-linksuntil escaped.Reviewed by Cursor Bugbot for commit 254d6ec. Bugbot is set up for automated code reviews on this repo. Configure here.