Skip to content

docs(nvpair-node-info): add normative service specification - #131

Merged
Noah-Tervalon-Nvidia merged 2 commits into
developfrom
docs/spec-nvpair-node-info-gh
Oct 14, 2026
Merged

Noah-Tervalon-Nvidia merged 2 commits into
developfrom
docs/spec-nvpair-node-info-gh

Conversation

@Noah-Tervalon-Nvidia

Copy link
Copy Markdown
Collaborator

Description

Adds services/nvpair-node-info/spec.md, the normative specification for the per-node hardware reporter, derived from the Go source and its tests and following the structure of the existing specs.

It covers the two responsibilities the service now carries beyond the inventory route: telemetryValid and msSince, which describe the GPU utilization sample the scheduler turns into pressure and keep a stale sample distinguishable from a fresh one; and the peer-observed address report, which the broker relays to the scanner for address ranking. Open items record that the inventory is plaintext on the LAN, that a stopped GPU collector keeps serving its last numbers with only a growing msSince to show it, and that the --tls-port default collides with nvpair-errors.

Release intent

Changelog title

n/a

Changelog body

n/a

Bumps

  • services: none
  • nvpair-cluster-manager: none
  • nvpair-engine-manager: none
  • nvpair-errors: none
  • nvpair-job-scheduler: none
  • nvpair-manual-nodes: none
  • nvpair-node-info: none
  • nvpair-node-scanner: none
  • nvpair-node-settings: none
  • nvpair-proxy: none
  • nvpair-tui: none
  • nvpair-ui-broker: none
  • nvpair-workload-manager: none

Scope

Documentation only: one new file. No Go, desktop, installer, or version changes. The open items above are recorded, not fixed.

Validation

  • node scripts/spdx-headers.mjs passes.
  • Every behavioral statement was checked against the source on develop.

Risk

None at runtime. spec.md is normative, so please flag any statement that does not match the code.

Checklist

  • I have read the Contributing Guidelines.
  • Every commit is signed off (git commit -s), certifying the Developer Certificate of Origin.
  • New or existing tests cover the change. (Not applicable: documentation only.)
  • Relevant documentation is updated.
  • I checked the diff, changed filenames, and commit messages for credentials, private data, internal URLs, internal issue identifiers, and generated artifacts.
  • I recorded the validation commands and results above.
  • I declared version bumps in the release-intent block above. services/versions.json is written by automation — do not edit it by hand.

Add services/nvpair-node-info/spec.md, derived from the Go source and
its tests rather than the README, following the structure of the
existing specs: sections 1-15, a 7.0 method and notification table, and
a closing section on the process model, CLI, and build wiring.

It covers the two responsibilities the service now carries beyond the
inventory route: telemetryValid and msSince, which describe the GPU
utilization sample the scheduler turns into pressure and keep a stale
sample distinguishable from a fresh one; and the peer-observed address
report, which the broker relays to the scanner for address ranking.

Documentation only. No Go file is touched and no version changes.

Signed-off-by: Terve <ntervalon@nvidia.com>
@Noah-Tervalon-Nvidia
Noah-Tervalon-Nvidia requested review from kjlubick and nvrithik and removed request for kjlubick September 29, 2026 15:28
The terminal interface rebuilt in #117 polls /v1/node-info directly from
its node detail screen, for the one node that is open, at the desktop's
2000 ms cadence with a 1500 ms timeout. List it beside the scanner,
manual-nodes, and the desktop wherever the spec enumerates consumers,
describe its poll in the use cases, and record that it discards an
answer from the wrong machine and tries the next address. It never polls
over TLS; a hand-added TLS node shows its manual-nodes probe instead.

The desktop's direct poll is now the desktop's exception rather than the
product's only one. The build is now 13 steps.

Signed-off-by: Terve <ntervalon@nvidia.com>
@Noah-Tervalon-Nvidia
Noah-Tervalon-Nvidia merged commit 835b35d into develop Oct 14, 2026
13 checks passed
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