docs: add unified Kubernetes monitoring entry point under install-pmm#5406
Open
michaelcoburn wants to merge 1 commit into
Open
docs: add unified Kubernetes monitoring entry point under install-pmm#5406michaelcoburn wants to merge 1 commit into
michaelcoburn wants to merge 1 commit into
Conversation
Adds a discoverable PMM-side page documenting Kubernetes cluster monitoring with PMM Server as the destination for the Victoria Metrics Kubernetes monitoring stack (cAdvisor / kubelet / CoreDNS / kube-state-metrics / node-exporter / apiserver / control-plane). The integration already works — the Helm walkthroughs live in each of the four operator docs repos (`monitor-kubernetes.md` in `k8sps-docs`, `k8spxc-docs`, `k8spsmdb-docs`, `k8spg-docs`). PMM's own docs only mention K8s monitoring in passing on a dashboard reference page (`reference/dashboards/kubernetes_monitor_operators.md`) which is unlikely to be reached by users searching for "how do I monitor Kubernetes with PMM." This change: - adds `install-pmm/install-pmm-client/connect-database/kubernetes.md` — a short use-case framing + what-gets-captured table + cross-links to the four operator monitor-kubernetes pages for the Helm walkthroughs (avoids duplicating ~250 lines of procedure across five places that would drift apart over time) - adds the new page to the connect-database overview list - adds a "Kubernetes monitoring" nav section under "Configure monitoring" in `mkdocs-base.yml` - marks the feature Technical Preview to match the existing framing on the dashboard reference page No content from the operator repos is duplicated; the new page is purely a navigation / discoverability improvement. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
PMM-XXXXX (JIRA ticket to be filed by Percona-Lab/pmm-workshop-pl2026 maintainer; this PR is the deliverable a JIRA ticket will reference)
Link to the Feature Build: SUBMODULES-0
Why
PMM Server can act as the centralized observability backend for both your databases and the Kubernetes clusters they run on — the integration with the Victoria Metrics Kubernetes monitoring stack already works and is documented in all four Percona operator docs repos:
docs.percona.com/percona-operator-for-mysql/ps/monitor-kubernetes.htmldocs.percona.com/percona-operator-for-mysql/pxc/monitor-kubernetes.htmldocs.percona.com/percona-operator-for-mongodb/monitor-kubernetes.htmldocs.percona.com/percona-operator-for-postgresql/2.0/monitor-kubernetes.htmlBut PMM's own docs only mention this feature in passing on a dashboard reference page (
reference/dashboards/kubernetes_monitor_operators.md), which is unlikely to be reached by a user searching for "how do I monitor Kubernetes with PMM."This is a discoverability gap. A user reading PMM docs to plan their monitoring strategy has no entry point that says "yes, PMM can be your K8s observability backend too — here's how to plug it in."
What
Adds a single new page under
install-pmm/install-pmm-client/connect-database/that:monitor-kubernetespages for the actual Helm walkthrough, rather than duplicating ~250 lines of procedure that would drift across five separate locations.Also:
connect-database/index.md).mkdocs-base.yml, alongside the existing Database / Cloud / System / Proxy / External-services subsections.What this PR does NOT do
reference/dashboards/kubernetes_monitor_operators.mdpage — that page is left in place as the dashboard-reference entry point.Test plan
mkdocs build -f documentation/mkdocs.ymlpasses (couldn't validate locally — no mkdocs installed; relying on CI)api/authentication.md,reference/glossary.md,reference/third-party/victoria.md,reference/dashboards/kubernetes_monitor_operators.md,install-pmm-server/deployment-options/helm/index.md)docs.percona.com/percona-operator-for-*/monitor-kubernetes.html)Context
This PR was generated as the deliverable for a docs audit performed for the upcoming Percona Live 2026 PMM 3 hands-on tutorial workshop. The audit confirmed that 7 out of 8 originally-suspected PMM 3 doc gaps had already been resolved by the docs team's PMM 3 refactor — this is the remaining one.