For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GitHub
DocumentationREST API Reference
DocumentationREST API Reference
    • Home
  • Overview
    • What is NICo?
    • Key Capabilities
    • Operational Principles
    • Day 0 / Day 1 / Day 2 Lifecycle
    • Scope and Boundaries
  • Getting Started
    • Building NICo Containers
    • Quick Start Guide
  • Architecture
    • Overview and Components
    • Reliable State Handling
    • Networking Integrations
    • Key Group Synchronization
  • Provisioning (Day 0)
    • Ingesting Hosts
    • Ingesting Hosts (REST API)
    • Machine Validation
    • SKU Validation
    • Measured Boot Attestation
  • Configuration (Day 1)
    • Network Isolation
    • Tenant Management
    • Organization & Permissions
  • Operations (Day 2)
    • Tenant Lifecycle Cleanup
    • Network Isolation
    • Network Security Groups
    • InfiniBand Partitioning
    • NVLink Partitioning
    • Rack-Level Administration (RLA)
    • IP Resource Pools
    • BGP Peering
    • nicocli Reference
  • Reference
    • Hardware Compatibility List
    • Release Notes
    • FAQs
      • Codebase Overview
      • Bootable Artifacts
      • Local Development
      • Running a PXE Client in a VM
      • TLS and SPIFFE Certificates
      • SPIFFE and casbin policies with admin-cli
      • Re-creating Issuer/CA in Local Dev
      • Visual Studio Code Remote Development
      • Adding Support for New Hardware
      • Build Guide
    • Glossary
GitHub
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
ReferenceDevelopment

Codebase overview

||View as Markdown|

The repository is organized as a Rust workspace plus deployment, documentation, and development support directories.

bluefield/ - dpu-agent and other tools running on the DPU.

crates/ - source code for the Rust crates that make up NICo. Important crates include:

  • admin-cli/ - nico-admin-cli, a command line client for the nico API server.
  • api/ - the nico-api binary and NICo primary entrypoint for gRPC/API calls. It wires together and starts the core background modules and state controllers.
  • site-explorer/ - Site Explorer implementation. This code is compiled into and run by the nico-api binary.
  • preingestion-manager/ - Preingestion Manager implementation. This code is compiled into and run by the nico-api binary.
  • nvlink-manager/ - NVLink Manager / NvlPartitionMonitor implementation. This code is compiled into and run by the nico-api binary.
  • scout/ - nico-scout, a binary that runs on NICo managed hosts and DPUs and executes workflows on behalf of the site controller.
  • dhcp/ - Kea DHCP integration. It intercepts DHCPDISCOVERs from DHCP relays and forwards the information to nico-api.
  • dhcp-server/ - DHCP server written in Rust. This server runs on the DPU and serves host DHCP requests.
  • dns/ - DNS resolution for assets in the NICo database.
  • log-parser/ - service which parses SSH console logs and generates health alerts based on them.
  • pxe/ - nico-pxe, a web service which provides iPXE and cloud-init data to machines.
  • rpc/ - protobuf definitions and a Rust library for marshalling data between gRPC and native Rust types.

dev/ - support files that are not product code, such as Dockerfiles, Kubernetes YAML, and local development helpers.

docs/ - product documentation used by the documentation site.

include/ - additional makefiles used by cargo make, as specified in Makefile.toml.

Previous

FAQs

Next

Bootable Artifacts