Quick Start

Start Here

View as Markdown

NVIDIA Config Manager is a Helm-deployed platform for rendering, deploying, and operating NVIDIA network configuration at scale. It combines APIs, workers, Nautobot, data stores, eventing, and device-facing services behind one deployment.

Use Config Manager when you need to:

  • Bootstrap new switch fabrics from modeled intent.
  • Keep rendered intended configuration tied to Nautobot data.
  • Review and approve Day-2 configuration changes before they reach devices.
  • Run operational workflows such as backup, deploy, cable validation, password rotation, OS upgrades, and reprovisioning.

The project’s GitHub repository is https://github.com/nvidia/nv-config-manager.

Primary Personas

PersonaPrimary work
Network Infrastructure AdministratorStands up and maintains the platform. This includes the Helm release, Nautobot integration, identity provider integration, secrets, registries, observability, ZTP exposure, and workflow defaults.
Network Infrastructure OperatorUses a running platform to drive network outcomes. This includes launching workflows, approving changes, browsing rendered or backed-up configs, provisioning devices through ZTP/DHCP, and watching dashboards or logs.

Feature Areas

Feature areaAdministrator focusOperator focus
Getting Started with Config ManagerDeploy the Helm release on Kind or a target Kubernetes cluster, choose sizing, hostnames, services, and TLS.Confirm the running UIs and APIs are reachable after install.
Airgapped DeploymentBuild, transfer, and install the offline bundle through an internal registry.Use the installed platform the same way as a connected deployment.
Nautobot IntegrationConfigure bundled or external Nautobot, bootstrap jobs, tokens, and source-of-truth data loading.Treat Nautobot as the source of truth for device, interface, cabling, IPAM, VLAN, and config context data.
Device authenticationSeed per-site network secrets in Vault/OpenBao through ESO, or Kubernetes secrets for local development.Run and review device or site password rotation workflows.
Render ServiceEnable template plugin paths, storage, and event plumbing.Review intended config output and trigger safe render checks through Nautobot changes.
Config StoreProvision storage, API, and UI exposure.Browse intended and backup configs, inspect diffs, and confirm rendered output exists.
Temporal WorkflowsConfigure Temporal, worker pools, and workflow RBAC.Launch, approve, retry, reject, or terminate workflow runs.
ZTP ProvisioningConfigure OS image storage, boot URLs, DHCP/ZTP exposure, and Nautobot readiness.Watch device boot and callback progress during bring-up.
DHCP ServiceEnable Kea-backed DHCP and model reservations/options in Nautobot.Inspect reservations, leases, and generated DHCP config when provisioning stalls.
Config Manager UISet global.baseHostname, SSO callbacks, and gateway/TLS access.Use workflow and config views for day-0 and day-2 operations.
Observability and troubleshootingEnable monitoring resources and the local observability stack when appropriate.Use Troubleshooting, pod logs, and workflow status to investigate failed operations.
DSX Air Simulation User GuideBring up a public NVIDIA DSX Air demo with Config Manager installed inside the simulation.Exercise Ethernet/Cumulus workflows against simulated switches before using a physical lab.
  1. Administrators should start with Config Manager Concepts, then follow Getting Started with Config Manager or Airgapped Deployment.
  2. Before pointing Config Manager at real devices, confirm network secrets, DHCP/ZTP exposure, device authentication prerequisites, and maintenance controls.
  3. Operators should start with Which Interface Should I Use?, then review Temporal Workflows, Workflow Lifecycle, and Config Store.
  4. To preview Config Manager locally without a real lab, use Local Development Quick Start.
  5. To validate device-facing workflows without a physical lab, use DSX Air Simulation User Guide.
  6. After installation, follow First Run Tour to verify the deployment and choose the first workflows to run.

The local development quick start is not a deployment path and is not a workflow validation environment. Use the DSX Air Simulation User Guide when you need simulated Cumulus switches for workflow validation without touching real devices.