docs(observability): document GPU monitoring templates and NVSentinel#2472
Open
flomedja wants to merge 8 commits into
Conversation
✅ Deploy Preview for vcluster-docs-site ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Add two pages to the fleet observability section for ENGPLAT-834:
- GPU monitoring templates: summary of the bundled Argo CD templates
(cert-manager, GPU Operator, Fleet Intelligence Agent, NVSentinel),
deployment order, the two DCGM metric families with the double-count
warning, per-pod GPU attribution, and stack teardown
- NVSentinel GPU monitoring: deploy guide with UI and YAML flows, what
dry-run does and does not do, full parameter reference including
Janitor providers, and cleanup of the retained MongoDB PVCs
Link both pages from the section overview and the Argo CD templates
page, and shift later pages down in the sidebar.
flomedja
force-pushed
the
ENGPLAT-834-docs-gpu-template-and-nv-apps-document-by-design-behaviors-teardown
branch
from
July 20, 2026 19:37
af7219c to
08d5373
Compare
…pendency Add GPU/DCGM/NVSentinel to the Google.Headings vocab and scope off Google.WordList for the NVSentinel page, where "terminate" and "service account name" are accurate cloud/API terminology rather than false positives. Also clarify that enableNodeDrainer's Fault Quarantine dependency, unlike the MongoDB store and Janitor dependencies, is not auto-resolved by the ArgoCD template, per upstream NVSentinel docs and the loft-enterprise template source.
Switch do not/does not/cannot to don't/doesn't/can't across both new GPU/NVSentinel pages, keeping the "Does/Doesn't" dry-run bullet list parallel. Fixes the internal anchor link broken by the "does not do" -> "doesn't do" heading rename.
seanschneeweiss
left a comment
seanschneeweiss
left a comment
Contributor
There was a problem hiding this comment.
Would be good to add a small section that the Cluster Collector is preconfigured to scrape metrics from gpu-operator, nvsentinel (only if destionationNamespace kept at default value).
Mention cert-manager in the GPU stack overview so the bundled-templates table doesn't introduce a fourth item the intro never named. In the NVSentinel prerequisites, defer the cert-manager conditional-requirement detail to a new section placed after the component table, so the prerequisites checklist stops naming components (Fault Quarantine, Node Drainer, Janitor, etc.) before they're defined. Also cross-link to the deployment order guidance so readers landing directly on the NVSentinel page know to deploy GPU Operator first.
…wording Reorder the sidebar so Argo CD templates precedes Install gateway, matching the explicit "Get started" step order on the overview page (deploy backend/Grafana, then create the connector) instead of contradicting it. Replace "control plane cluster" with "local cluster" everywhere the metrics backend, Grafana, and gateway are described, per engineering manager feedback questioning whether that wording was deliberately vague. Confirmed against loft-enterprise source that these components are hardcoded to Platform's own local cluster (loft-cluster), not an arbitrary registered control plane cluster, so the prior "replace with your control plane cluster name" framing was inaccurate. Also clarify "Deploy collectors to each cluster": the opening sentence implied tenant-cluster-only, while a control-plane-cluster option was only revealed at the end of the section. State both cluster types up front instead.
deploy-with-argocd.mdx bundled two non-adjacent workflow steps (backend/Grafana before the gateway, collectors after it), so the sidebar order didn't match the order a reader actually needed to follow it. Dissolve that page and move each Argo CD template's instructions onto the step's own page, alongside the manual path. Add a quickstart page with a single linear walkthrough of the default path for readers who want to deploy end to end without cross-referencing every option on the reference pages. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…template-and-nv-apps-document-by-design-behaviors-teardown # Conflicts: # platform/maintenance/observability/deploy-with-argocd.mdx
…ollectors Add --context to the GPU stack teardown commands so they can't run against the wrong cluster's cert-manager or namespaces, per Sean's review comment. Document that the cluster-collector template already scrapes the GPU stack (Fleet Intelligence Agent, dcgm-exporter, GPU Health Monitor) as long as those components stay at their default namespaces, verified against the template source in loft-enterprise. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Collaborator
|
Addressed the review feedback:
All commits pushed to this branch. |
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
3 participants
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.
Content Description
Preview Link
Note: Every page in the observability nav section has some updates. The above pages are the main ones.
Internal Reference
Closes ENGPLAT-834
AI review: mention
@claudein a comment to request a review or changes. See CONTRIBUTING.md for available commands.@netlify /docs