NVIDIA / NVIDIA/nvcf

Add a diagnostics utility to validate NVCF deployment prerequisites and collect environment details

Open
#1,966 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs-triage
Dominant language
Go
Stars
218
Forks
72
Avg merge
1d 12h
Merged PRs (30d)
427

Description

Is this related to a problem? Please describe.

When an NVCF self-hosted deployment misbehaves, operators have no quick way to tell whether the cause sits in NVCF or in the surrounding environment (Kubernetes, storage, networking, host configuration). Narrowing that down currently means manually collecting versions, component status, and cluster configuration from several places, with no consistent view of what NVCF expects

Describe the solution you'd like

Proposal

A diagnostics utility that validates the deployment against documented NVCF prerequisites, collects relevant environment information, and produces a portable artifact.
The bundle answers:

  • Does this deployment meet documented prerequisites?
  • Which NVCF components are deployed, at what versions, in what state?
  • Which layer do the failing or misconfigured components sit in?
  • Does the configuration fall outside documented prerequisites?

Requirements

  • Operators can generate the full bundle in one step, without manually gathering inputs first.
  • Collects deployment metadata: NVCF version, Kubernetes distribution and version, deployed platform components and their status.
  • Checks the deployment against documented prerequisites and reports pass/fail per check.
  • Reports detected configuration that falls outside documented prerequisites.
  • Produces a summary that groups findings by layer (NVCF platform components vs. Kubernetes, storage, networking, host configuration) so the operator can narrow where to investigate.
  • Packages the complete set of collected findings like checks, metadata, component state, logs into a single self-contained archive that the operator can share with the NVIDIA NVCF team when requesting support, so no back-and-forth is needed to gather basic deployment context.
  • Redacts credentials, API keys, and tenant identifiers before the archive is written; documents exactly what is and isn't collected so operators can review before sharing.

By submitting this issue, you agree to follow our code of conduct and our contributing guidelines.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points; first locate the documented NVCF prerequisites and the existing deployment metadata and component-status collection paths. Define the utility's scope around prerequisite checks, layered findings, portable packaging, and redaction, with completion demonstrated by a one-step self-contained archive and documented collection boundaries.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes
Domain
cloud, devops, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.