Docs: sync upstream clickhouse-operator docs updates#213
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
/docsfromclickhouse/clickhouse-operatorintoproducts/kubernetes-operator/in this repo.cc @GrigoryPervakov for review (author of the triggering upstream commit
124b588— "feat: add crds as a separate release artifact, build stripped crds to fit client-side apply", PR #232).Changes
install/kubectl.mdx— switch the manifest install tokubectl apply --server-side --force-conflicts, document the newclickhouse-operator-stripped-crds.yamlartifact for client-side-apply environments, and fix themake build-installerstep to usekubectl apply -f(was-k).navigation.json+overview.mdx— add new guides: Monitoring, Scaling, Securing with TLS.guides/monitoring.mdx,guides/scaling.mdx,guides/tls.mdx— new pages from upstream.guides/configuration.mdx— addsCluster domainsection, bumps example Keeper memory limits to512Mi, adds end-to-end TLS cross-reference.guides/introduction.mdx— corrects post-deletekubectl wait/kubectl delete pvclabel selectors tomy-cluster-clickhouse.install/helm.mdx— fixes the operator-version Helm flag to--set manager.image.tag=....install/olm.mdx— minor whitespace.reference/api-reference.mdx— addsAdditionalPorttype, addsadditionalPortsfield onClickHouseClusterSpec, refreshesresourcesandpodDisruptionBudgetdescriptions, and correctsupdateRevisionnaming inKeeperClusterStatus.Context
The triggering commit only touched
install/kubectl.mdx, but the local copy of/docshad drifted from upstream across several other files (likely un-synced prior upstream PRs). Per the sync instructions, all upstream/docscontent was copied over exactly as-is — any issues should be fixed upstream first. No conflicts encountered.mint validate/mint broken-linkstimed out on this large repo and could not be completed; please re-run in CI if needed.Note
Low Risk
Documentation-only sync with corrected install examples and new guide pages; no runtime or application code changes.
Overview
Brings the Kubernetes Operator docs in this repo in line with upstream
clickhouse/clickhouse-operator/docs, with no product-code changes—only MDX, navigation, and reference updates.New guides — Adds Monitoring (Prometheus/health endpoints, Helm
ServiceMonitor, RBAC, sample alerts), Scaling (replicas/shards, schema sync, Keeper quorum and status conditions), and Securing with TLS (cert-manager walkthrough, Keeper encryption).navigation.jsonandoverview.mdxlink these pages; the overview no longer points monitoring at the introduction guide.Configuration guide — Documents
spec.clusterDomain,spec.externalSecret(keys, Observe/Manage,ExternalSecretValid),spec.additionalPorts(reserved ports, MySQL example), version probe /upgradeChannel, andspec.settings.logger. Example default container memory is 512Mi (request and limit); TLS section cross-links the new TLS guide.Install fixes — kubectl install uses server-side apply and documents
clickhouse-operator-stripped-crds.yamlfor client-side-only clusters; custom builds usekubectl apply -f dist/install.yaml. Helm version pin is--set manager.image.tag=(replacing the brokenmanager.container.tag/--set-jsonexample).Smaller edits — Introduction cleanup uses label
my-cluster-clickhousefor wait/delete PVC. API reference addsAdditionalPort/additionalPorts, updates containerresourcesmerge behavior and Keeper PDB wording, and fixesupdateRevisiondescription onKeeperClusterStatus.Reviewed by Cursor Bugbot for commit 0564a30. Bugbot is set up for automated code reviews on this repo. Configure here.