Docs: sync upstream clickhouse-operator docs updates#79
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
1 participant
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 new
AdditionalPortAPI reference documentation from upstreamclickhouse/clickhouse-operator(PR #197, commit7e82242) intoproducts/kubernetes-operator/reference/api-reference.mdx.Changes
products/kubernetes-operator/reference/api-reference.mdx:AdditionalPorttype section documenting thenameandportfields.additionalPortsrow to theClickHouseClusterSpectable.Context
Upstream PR clickhouse/clickhouse-operator#197 introduces a new
additionalPortsspec field that lets users expose extra TCP ports (e.g. MySQL/Postgres/gRPC protocols) on the operator-managed Pod and headless Service. This PR copies the upstreamapi-reference.mdxchanges verbatim.Conflicts / issues to note
While diffing
clickhouse/clickhouse-operator/docs/*againstproducts/kubernetes-operator/*, the following pre-existing drift between upstream and downstream was observed but not changed in this PR (these are not part of the new upstream update — they predate it and look like intentional downstream link adjustments). Flagging here so they can be reconciled upstream if desired:guides/configuration.mdx— downstream uses/core/concepts/...and/core/reference/...link prefixes; upstream uses/concepts/...and/reference/...(lines 353–354, 386).guides/introduction.mdx— same/core/reference/engines/database-engines/replicatedvs/reference/engines/database-engines/replicateddivergence (lines 104, 117).install/olm.mdx— upstream has one extra trailing blank line.If these should be fixed, the canonical path is to update upstream first per the sync policy.
Author
Original author of the upstream change: @GrigoryPervakov — please review.
Note
Low Risk
Documentation-only sync with no runtime, auth, or infrastructure behavior changes.
Overview
Syncs upstream ClickHouse Operator API reference into
products/kubernetes-operator/reference/api-reference.mdxfor the newadditionalPortscapability.The doc adds an
AdditionalPortsection (name,port) and documentsClickHouseClusterSpec.additionalPorts, explaining that the operator exposes extra TCP ports on the ClickHouse Pod and headless Service only—ClickHouse must still be configured to listen on those ports separately.Reviewed by Cursor Bugbot for commit b358b73. Bugbot is set up for automated code reviews on this repo. Configure here.