Skip to content

docs(npd): add minimal dmesg-only NPD example - #657

Merged
spraveenio merged 4 commits into
ROCm:mainfrom
spraveenio:user/spraveenio/npd-dmesg-example-doc
Sep 25, 2026
Merged

spraveenio merged 4 commits into
ROCm:mainfrom
spraveenio:user/spraveenio/npd-dmesg-example-doc

Conversation

@spraveenio

@spraveenio spraveenio commented Sep 24, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Adds docs/npd/npd-dmesg-example.md: a self-contained, three-manifest walkthrough for detecting AMD GPU kernel crashes via NPD's built-in system-log-monitor (no AMD Device Metrics Exporter / amdgpuhealth required).
  • Covers: minimal RBAC, kernel-monitor.json ConfigMap with amdgpu.* regex rules (page fault, hang, reset, RAS error), stripped DaemonSet mounting only /dev/kmsg, and verify steps.

Test plan

  • Markdown renders without errors (markdownlint)
  • YAML blocks in the doc are valid YAML
  • Links to node-problem-detector.md and ../autoremediation/auto-remediation.md resolve

🤖 Generated with Claude Code

spraveenio and others added 3 commits September 24, 2026 11:53
Add docs/npd/npd-dmesg-example.md with a self-contained walkthrough
for watching /dev/kmsg for AMD GPU kernel crashes using only NPD's
built-in system-log monitor. No AMD Device Metrics Exporter or
amdgpuhealth required.

Covers RBAC, kernel-monitor.json ConfigMap with amdgpu.* regex rules
(page fault, hang, reset, RAS error), a stripped DaemonSet with only
/dev/kmsg mounted, and verify steps.

Co-Authored-By: Claude <noreply@anthropic.com>
…remediation

Update npd-dmesg-example.md to use the operator-integrated NPD pattern:
- dmesg system-log-monitor runs alongside amdgpuhealth custom plugin monitor
- AMDGPUKernelCrash permanent condition wires into remediation ConfigMap
- DaemonSet includes amd-gpu-unhealthy:NoSchedule toleration required by auto-remediation
- Added remediation ConfigMap snippet showing nodeCondition alignment

Add npd-dmesg-example to _toc.yml under Node Problem Detector section.

Add new spellcheck wordlist entries for GPU condition/config terms used in the doc.

Co-Authored-By: Claude <noreply@anthropic.com>
Add 'text' language tag to the ASCII flow diagram and kubectl output
blocks to satisfy markdownlint MD040 (fenced code blocks must have
a language specified).

Co-Authored-By: Claude <noreply@anthropic.com>
@spraveenio
spraveenio force-pushed the user/spraveenio/npd-dmesg-example-doc branch from c404cc4 to 7e9a1c9 Compare September 24, 2026 18:54
Pad table separator rows and cell content to align all pipes,
satisfying markdownlint MD060 (table-column-style aligned).

Co-Authored-By: Claude <noreply@anthropic.com>

@biluriuday biluriuday left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. thanks @spraveenio

@spraveenio
spraveenio merged commit 95b05b6 into ROCm:main Sep 25, 2026
13 checks passed
@spraveenio
spraveenio deleted the user/spraveenio/npd-dmesg-example-doc branch September 25, 2026 04:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants