Docs: sync upstream clickhouse-operator docs updates#161
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
docs/from clickhouse/clickhouse-operator intoproducts/kubernetes-operator/to match the upstream snapshot at commit30368f9.cc @GrigoryPervakov for review (author of the most recent upstream commit on the operator repo).
Changes
guides/monitoring.mdx— new page added upstream; copied over and registered innavigation.jsonunder the Guides group.navigation.json— addedproducts/kubernetes-operator/guides/monitoringentry.overview.mdx— removed the stray bullet- **[Monitoring](/products/kubernetes-operator/guides/introduction)** - Monitor clickhouse-operator using Prometheus metrics(this line is not present in upstream).guides/introduction.mdx— internal links for the Replicated database engine changed from/reference/engines/database-engines/replicatedto/core/reference/engines/database-engines/replicated(see conflict note below).guides/configuration.mdx— new External Secret section (~290 lines) and resource-request example values updated (memory: 256Mi→512Mi,1Gi→512Mi).install/olm.mdx— trailing newline added.reference/api-reference.mdx— newAdditionalPorttype documented, newadditionalPortsfield added toClickHouseClusterSpec, and theresourcesfield description rewritten to reflect new SMP deep-merge behavior.Conflicts / issues
All copied exactly as upstream, per the sync policy. The following pre-existing broken links surfaced from
mint broken-linksand should be fixed upstream inclickhouse/clickhouse-operatorbefore they can be resolved here:products/kubernetes-operator/guides/configuration.mdx/core/concepts/features/configuration/server-config/configuration-files#example-1/core/reference/settings/server-settings/settings/core/concepts/features/configuration/settings/settings-usersproducts/kubernetes-operator/guides/introduction.mdx/core/reference/engines/database-engines/replicated(×2) — upstream changed the prefix from/reference/...to/core/reference/..., but neither path resolves in this docs site. The previous/reference/engines/...form (still present pre-sync) also did not resolve.products/kubernetes-operator/guides/monitoring.mdx/operations/server-configuration-parameters/settings#prometheusmint validatepasses.Note
Low Risk
Documentation-only sync with no application code changes; main follow-up risk is broken internal
/core/...and monitoring cross-links until paths are fixed upstream or locally.Overview
Syncs Kubernetes Operator product docs with upstream clickhouse-operator, mainly by expanding guides and API reference rather than changing runtime code.
Configuration guide grows substantially: documents
spec.externalSecret(Observe/Manage, required keys,ExternalSecretValidtroubleshooting),spec.additionalPorts(reserved ports/names, pairing withextraConfig.protocols), version probe andupgradeChannelstatus conditions, andspec.settings.logger. Example default container memory in the snippet is updated to 512Mi for both requests and limits.Adds a new Monitoring guide covering operator
/metricsand/healthz//readyz, Helmprometheus.enable, secured scraping (RBAC, ServiceMonitor), PromQL, and sample alerts; it is wired intonavigation.json. Overview drops the incorrect monitoring link that pointed at the introduction guide.API reference documents
AdditionalPortandClickHouseClusterSpec.additionalPorts, and revisescontainerTemplate.resourcesto “applied as a whole” instead of SMP deep-merge. Introduction and configuration cross-links switch several paths to a/core/...prefix (may still be broken on this site per PR notes).Reviewed by Cursor Bugbot for commit 0fe7531. Bugbot is set up for automated code reviews on this repo. Configure here.