Docs: sync upstream clickhouse-operator docs updates#210
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-operator(commit27b92d4) intoproducts/kubernetes-operator/exactly as upstream.Changes
guides/configuration.mdx,guides/introduction.mdx,install/helm.mdx,install/kubectl.mdx,install/olm.mdx,reference/api-reference.mdx,overview.mdx.guides/monitoring.mdx,guides/scaling.mdx,guides/tls.mdx.navigation.jsonto include the three new guides.Context
The trigger commit (#229) did not itself modify
/docs, but upstream/docswas already ahead of the mirror in this repo — this PR closes that gap by syncing the current upstream state verbatim.Notes / conflicts
mint validatepasses.mint broken-linkstimed out locally (repo-size related, not introduced by this change) and was skipped.cc @GrigoryPervakov for review (author of the upstream commit).
Note
Low Risk
Documentation-only changes with no application or infrastructure code; risk is limited to doc accuracy and broken links.
Overview
Mirrors upstream
clickhouse-operatordocs intoproducts/kubernetes-operator/, expanding operator coverage rather than changing runtime behavior.New guides add dedicated pages for operator Prometheus scraping (
monitoring.mdx), replica/shard/Keeper scaling (scaling.mdx), and cert-manager TLS (tls.mdx). Navigation and overview now link to those guides instead of a placeholder monitoring pointer.The configuration guide grows with
spec.externalSecret(Observe/Manage, required keys,ExternalSecretValid),additionalPorts(reserved ports/names, MySQL example), version probe /upgradeChannelstatus conditions,spec.settings.logger, updated default container memory examples, and a TLS cross-link to the new TLS guide.Install docs fix Helm (
manager.image.tagvs--set-json) and kubectl custom install (kubectl apply -f dist/install.yaml). Introduction corrects pod/PVC label selectors for teardown. API reference documentsAdditionalPort,additionalPorts/externalSecret, and clarifies container resource merge and Keeper PDB /updateRevisionwording.Reviewed by Cursor Bugbot for commit fb7cb74. Bugbot is set up for automated code reviews on this repo. Configure here.