Docs: sync upstream clickhouse-operator docs updates#173
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
/docsupdates from ClickHouse/clickhouse-operator@2e19eb5 (#202) intoproducts/kubernetes-operator/.cc @GrigoryPervakov for review (original author of the upstream docs changes).
Changes
guides/monitoring.mdx— Prometheus metrics guide.guides/configuration.mdx— restoredExternal Secretsection, restored inline# H1, revertedtitleto'Configuration', tweaked sample memoryrequests/limits.guides/introduction.mdx— revertedtitleto'Introduction', restored inline# H1, links toReplicateddatabase engine reverted from/reference/...to/core/reference/....install/olm.mdx— re-added trailing newline.navigation.json— addedguides/monitoringto the Guides group.overview.mdx— addedMonitoringbullet under Guides (links to/products/kubernetes-operator/guides/introductionupstream — see Conflicts).reference/api-reference.mdx— addedAdditionalPorttype section, addedadditionalPortsfield onClickHouseClusterSpec, updatedresourcesdescription to mention SMP deep-merge.Conflicts / known issues (need upstream fix)
Per instructions, files were copied as-is and the following issues should be fixed upstream before/after merge:
/core/...paths — the docs site routes use/reference/...and/concepts/..., not/core/.... These were previously fixed in this repo and are now reintroduced by the sync:guides/introduction.mdx: two links to/core/reference/engines/database-engines/replicatedguides/configuration.mdx:/core/concepts/features/configuration/server-config/configuration-files#example-1/core/reference/settings/server-settings/settings/core/concepts/features/configuration/settings/settings-usersguides/monitoring.mdx— broken link/operations/server-configuration-parameters/settings#prometheus(no such page on docs site).overview.mdx— the newMonitoringbullet links to/products/kubernetes-operator/guides/introductioninstead of/products/kubernetes-operator/guides/monitoring. Likely a typo in the upstream PR.titleregression — upstream files use short titles (e.g.'Configuration','Introduction') plus an inline# H1. The previous in-repo copy used descriptive titles (e.g.ClickHouse Operator configuration guide) without an inline H1, matching Mintlify conventions. The sync reverts both files to the upstream style.Context
Triggered by merge of upstream PR #202 ("test: add openshift e2e smoke test") into
clickhouse-operator:main, which also bundled the docs additions above.Note
Low Risk
Documentation-only changes with no runtime impact; risk is broken
/core/...and other cross-links until follow-up fixes.Overview
Syncs upstream clickhouse-operator documentation into
products/kubernetes-operator/, mainly expanding the configuration guide and adding operator monitoring docs.New:
guides/monitoring.mdx— Prometheus scraping, HelmServiceMonitor, secured/metrics, health probes, metric catalog, PromQL, and sample alerts for the controller manager.Configuration guide — Large additions: External Secret (
spec.externalSecret, Observe/Manage, status troubleshooting), additional ports (K8s vs ClickHouseextraConfig, reserved ports), version probe / upgrade channel (upgradeChannel, status conditions,versionProbeTemplate, operator flags), and server logging (spec.settings.logger). Sample default container memory is now 512Mi for both requests and limits. Frontmatter titles shorten to'Configuration'/'Introduction'with inline# H1headings; several internal links switch to/core/...paths (may not match this docs site).API reference — Documents
AdditionalPortandadditionalPortsonClickHouseClusterSpec;resourcesmerge behavior text updated (whole apply vs SMP deep-merge).Nav —
navigation.jsonlists the monitoring guide;overview.mdxstill omits a Monitoring bullet in the synced file (upstream had a wrong link to introduction).Reviewed by Cursor Bugbot for commit b0e6721. Bugbot is set up for automated code reviews on this repo. Configure here.