feat(metadata-augmentor): include Topograph topology labels by default by resker · Pull Request #1226 · NVIDIA/NVSentinel

resker · 2026-04-23T01:53:20Z

Summary

Include the four node labels written by NVIDIA/topograph in the Metadata Augmentor's default allowedLabels:

network.topology.nvidia.com/accelerator — NVLink domain (clique) ID
network.topology.nvidia.com/leaf, /spine, /core — switch hierarchy levels

When Topograph is deployed, these labels describe the cluster's physical network topology. With them allowed by default, NVSentinel propagates them into health event metadata so downstream consumers (CEL rules, remediation CRs, dashboards, blast-radius analysis) can reason about topological locality without operator-side configuration.

Implements Option 1 (default-on in Metadata Augmentor) from #1205, per @XRFXLP's and @lalitadithya's guidance.

On clusters without Topograph the labels are absent and the Metadata Augmentor simply skips them — no behavior change there.

Type of Change

✨ New feature
📚 Documentation

Component(s) Affected

Core Services (Platform Connectors / Metadata Augmentor)
Documentation/CI (docs/INTEGRATIONS.md)

Testing

helm template against both distros/kubernetes/nvsentinel/values.yaml and values-full.yaml — confirms the four keys render into the platform-connectors ConfigMap's allowedLabels
helm lint distros/kubernetes/nvsentinel — no new findings
go test ./platform-connectors/pkg/transformers/metadata/... passes on Go 1.26.2, including a new topograph topology labels test case that mirrors the existing cloud-specific topology labels case
No breaking changes — the Metadata Augmentor's behavior on clusters without topograph labels is unchanged (absent labels are simply not copied)

Checklist

Self-review completed
Documentation updated — new "Topology Awareness (Topograph)" section in docs/INTEGRATIONS.md; topograph labels also added inline (with comment + link) in both default values files
Ready for review

Closes (addresses Option 1 from): Integration with NVIDIA/topograph's topology node labels #1205
Topograph label reference (authoritative): https://github.com/NVIDIA/topograph/blob/main/docs/reference/node-labels.md
Companion doc-clarification PR on topograph side (tightening the AWS Capacity Block phrasing raised in Integration with NVIDIA/topograph's topology node labels #1205): NVIDIA/topograph#289

Summary by CodeRabbit

New Features
- Extended metadata enrichment to include Topograph-based topology labels for improved fault locality analysis and cluster topology awareness.
Documentation
- Added integration guide detailing topology label support, usage scenarios, and downstream consumer applications.
Tests
- Added test coverage for topology label augmentation and validation.

Append the four topology labels written by NVIDIA/topograph to the Metadata Augmentor's default `allowedLabels`: - network.topology.nvidia.com/accelerator - network.topology.nvidia.com/leaf - network.topology.nvidia.com/spine - network.topology.nvidia.com/core On clusters where Topograph is deployed, these labels describe the physical network topology (NVLink domains, leaf/spine/core switch hierarchy). With them allowed, NVSentinel propagates them into health event metadata so downstream consumers (CEL rules, remediation CRs, dashboards, blast-radius analysis) can reason about topological locality. On clusters without Topograph the labels are absent and the Metadata Augmentor skips them — no operator-side configuration change. Also add a Topograph-labels test case to the transformer suite (mirrors the existing cloud-specific topology labels case) and a short "Topology Awareness (Topograph)" section to docs/INTEGRATIONS.md.

coderabbitai · 2026-04-23T01:53:33Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 901b7d84-18f9-42ee-9a9a-b4ee43e1da61

📥 Commits

Reviewing files that changed from the base of the PR and between 53a3659 and e416a17.

📒 Files selected for processing (4)

distros/kubernetes/nvsentinel/values-full.yaml
distros/kubernetes/nvsentinel/values.yaml
docs/INTEGRATIONS.md
platform-connectors/pkg/transformers/metadata/transformer_test.go

📝 Walkthrough

Walkthrough

NVSentinel's metadata enrichment configuration is extended to recognize four Topograph-emitted network topology labels (network.topology.nvidia.com/accelerator, leaf, spine, core). These labels are now included in health event metadata by default, with documentation and test coverage added to explain their purpose and verify propagation behavior.

Changes

Cohort / File(s)	Summary
Helm Values Configuration `distros/kubernetes/nvsentinel/values-full.yaml`, `distros/kubernetes/nvsentinel/values.yaml`	Extended `platformConnector.transformers.MetadataAugmentor.allowedLabels` list to include four Topograph-specific topology label keys for node-label enrichment in health events.
Integration Documentation `docs/INTEGRATIONS.md`	Added guidance on Topograph-based topology awareness, documenting the four node-label keys Topograph applies and how downstream consumers can leverage propagated topology values for fault locality analysis.
Metadata Transformer Test `platform-connectors/pkg/transformers/metadata/transformer_test.go`	Added new test scenario verifying correct propagation of Topograph NVIDIA topology labels into `pb.HealthEvent.Metadata` and confirming non-allowed labels are filtered out.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Topograph whispers through the nodes,
Speaking lanes where data flows—
Accelerator, leaf, and spine,
Now in metadata they align!
Labels travel, network knows.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: extending the Metadata Augmentor to include Topograph topology labels by default. It is concise, specific, and reflects the primary feature addition across the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.11.4)

level=error msg="[linters_context] typechecking error: pattern ./...: directory prefix . does not contain main module or its selected dependencies"

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

resker · 2026-04-23T01:57:50Z

cc @dmitsh — FYI

github-actions · 2026-04-23T01:58:46Z

🌿 Fern Docs Preview: https://nvidia-preview-pull-request-1226.docs.buildwithfern.com/nvsentinel

NVIDIA#1226)

resker mentioned this pull request Apr 23, 2026

Integration with NVIDIA/topograph's topology node labels #1205

Closed

resker mentioned this pull request Apr 23, 2026

fix(ci): include docs/ in Fern preview artifact NVIDIA/topograph#290

Merged

3 tasks

lalitadithya approved these changes Apr 23, 2026

View reviewed changes

lalitadithya merged commit 00f7a04 into NVIDIA:main Apr 23, 2026
75 checks passed

KaivalyaMDabhadkar pushed a commit to KaivalyaMDabhadkar/NVSentinel that referenced this pull request Apr 24, 2026

feat(metadata-augmentor): include Topograph topology labels by default (

e40e05b

NVIDIA#1226)

This was referenced May 7, 2026

Merge upstream NVIDIA/NVSentinel v1.4.0 #1256

Closed

Merge upstream NVIDIA/NVSentinel v1.4.0 reflectionai/NVSentinel#17

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(metadata-augmentor): include Topograph topology labels by default#1226

feat(metadata-augmentor): include Topograph topology labels by default#1226
lalitadithya merged 1 commit into
NVIDIA:mainfrom
resker:feat/metadata-augmentor-topograph-labels

resker commented Apr 23, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 23, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

resker commented Apr 23, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

resker commented Apr 23, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Type of Change

Component(s) Affected

Testing

Checklist

Related

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

resker commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

resker commented Apr 23, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 23, 2026 •

edited

Loading

resker commented Apr 23, 2026 •

edited

Loading