Cnuas Guides
Task-oriented documentation for Cnuas. The design documents and datasheets
describe what Cnuas is. These guides describe how to use it and how to change
it.
For users
Start with the system requirements. Cnuas can be installed in a host-only form
that needs no virtualisation, no root and no guest kernel, and knowing which
form is wanted saves most of the installation work.
For developers
The developer guide covers the build system, the C and Python interfaces, the
REST and Redfish surfaces, coding standards and continuous integration. The
extending guide walks through adding a device on the ORV3 RS-485 segment and
adding one reached over Ethernet and IP.
Where each subject is covered
| Subject |
Guide |
| Host sizing, GPU device memory, what is not required |
System Requirements |
| Host-only install, QEMU install, ORV3 shelf, datacentre simulation |
Installation |
| Environment configuration, CLI, REST, Redfish, power shelf, facility twin |
User Guide |
| Custom site, halls, racks, cooling, power, grid, OpenUSD and Isaac Sim |
Custom Data Center Simulation |
| Bazel and Make, C API, Python API, standards, testing, CI |
Developer Guide |
| RS-485 components, Modbus register maps, network components, PCI devices |
Extending Cnuas |
| Remote direct memory access, queue pairs, subnet managers, RoCEv2 |
RDMA, InfiniBand and RoCE |
Beyond the guides
| Area |
Where |
| What each component is and does |
Datasheets |
| Why each component is built as it is |
The design documents in the navigation |
| Evidence for every claim |
Validation Matrix |
| Planned work |
Roadmap |