Docs: sync upstream clickhouse-operator docs updates#212
Open
mintlify[bot] wants to merge 1 commit into
Open
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
Sync
/docscontent fromclickhouse/clickhouse-operator(trigger commita5ec30b) intoproducts/kubernetes-operator/.cc @GrigoryPervakov for review.
Changes
products/kubernetes-operator/guides/:monitoring.mdx— Prometheus metrics and health probesscaling.mdx— scaling replicas, shards, and Keeper quorumtls.mdx— end-to-end TLS with cert-manageroverview.mdx— link out to the new monitoring, scaling, and TLS guidesnavigation.json— register the three new guidesguides/configuration.mdx— new "Cluster domain" section, resource-default updates, TLS cross-linkguides/introduction.mdx— cleanup uses the correctapp.kubernetes.io/instance=my-cluster-clickhouselabelinstall/helm.mdx— fix--set manager.image.tagflag (was an invalid--set-jsonform)install/kubectl.mdx— switch tokubectl apply --server-side --force-conflictsand document theclickhouse-operator-stripped-crds.yamlfallbackinstall/olm.mdx— trailing-newline normalizationreference/api-reference.mdx— addAdditionalPorttype andadditionalPortsfield; refine resource-merge and PDB descriptions; fixupdateRevisiondescriptionContext
Trigger commit
a5ec30b("test: fix flaky operator-upgrade keeper writes", PR #233) does not itself touch/docs, but the upstream/docstree had drifted ahead of the Mintlify copy. This PR brings the mirror back in sync. Files were copied verbatim from upstream — no rewrites, so any upstream issues should be fixed upstream first.Conflicts / issues
None — all changes applied cleanly as straight copies.
Note
Low Risk
Documentation-only changes under
products/kubernetes-operator/with no runtime or application code modified.Overview
Brings the Mintlify
products/kubernetes-operator/tree in line with upstreamclickhouse-operatordocs.New guides: Monitoring (Prometheus/health for the controller), Scaling (replicas, shards, Keeper quorum), and TLS (cert-manager walkthrough).
navigation.jsonandoverview.mdxlink to them.guides/configuration.mdxgains substantial reference material:clusterDomain,externalSecret(keys, Observe/Manage, status conditions),additionalPorts(reserved ports, MySQL example), version probe /upgradeChannel,spec.settings.logger, updated default container memory in examples, and a cross-link to the TLS guide.Install docs: Helm uses
--set manager.image.tag; kubectl install documentskubectl apply --server-side --force-conflictsand theclickhouse-operator-stripped-crds.yamlfallback for client-side-only environments.Smaller fixes: Introduction cleanup commands use
app.kubernetes.io/instance=my-cluster-clickhouse; API reference addsAdditionalPort/additionalPortsand clarifies container resource merge and Keeper PDB /updateRevisionwording.Reviewed by Cursor Bugbot for commit 4ffc17d. Bugbot is set up for automated code reviews on this repo. Configure here.