Skip to content
/ canu Public
generated from Cray-HPE/metal-template

A network device configuration and firmware utility. Designed for use on Cray-HPE Shasta systems.

License

Notifications You must be signed in to change notification settings

Cray-HPE/canu

Repository files navigation


🛶 CANU (CSM Automatic Network Utility)

will float through a Shasta network and make switch setup and validation a breeze.

CANU can be used to:

  • Check if switches (Aruba, Dell, or Mellanox) on a Shasta network meet the firmware version requirements
  • Check network cabling status using LLDP
  • Validate BGP status
  • Validate that SHCD spreadsheets are configured correctly and pass a number of checks
  • Validate an SHCD against actual network cabling status to check for mis-cabling
  • Generate switch configuration for an entire network
  • Convert SHCD to CCJ (CSM Cabling JSON)
  • Use CCJ / Paddle to validate the network and generate network config
  • Run tests against the mgmt network to check for faults/inconsistencies.
  • Backup switch configs.

Documentation

There are several ways to view the CANU documentation:

  • https://cray-hpe.github.io/canu
  • from a virtualenv in the root of this repo: nox -e docs && mkdocs serve --config mkdocs.yml (local web server via mkdocs)
  • from a virtualenv in the root of this repo: nox -e docs && make docs (local web server via mkdocs)
  • make docs_image && make cdocs (containerized docs image)