Summary and Scope

This PR changes canu and its pipeline so that it only builds once and uses git-tags for defining stable. Currently canu builds twice in the pipeline (once before the RPM to make the binary, and again for the Docker image).

Full list of changes:

• Removes .version and canu/.version, instead versioning is done via git-tags
• Stable RPMs are only built on a git-tag
• Migrates from the old-style requirements files, using setup.py entirely
• Ceases using the cdrx/pyinstaller-linux:python3 image for building the binary, the binary is now built in the .spec file using the running build environment (csm-docker-sle-python:3.10)
• Various tweaks to the README.md as well as the pull_request_template.md
• Speeds up GitHub actions, the 10minute workflow was broken up into 3 parallelized workflows that run in a lot less time (2-3minutes)
• Speeds up the Docker image build, instead of rebuilding canu the image build now installs the canu RPM (thus skipping a second build of the canu source)
• The RPM now creates a canu user, this provides the canu user in the Docker image (it will also live on a system whether or not it is used but it is harmless)
• Updated the README.md with information about the various versions that report (e.g. stable, unstable, and working directory); .dev1 means canu is running from a dirty directory (with uncommitted files), .postX means canu is not stable

PR checklist (you may replace this section):

• I have run nox locally and all tests, linting, and code coverage pass.
• I have added new tests to cover the new code
• My code follows the style guidelines of this project
• If adding a new file, I have updated pyinstaller.py
• I have updated the appropriate Changelog entries in README.md
• I have incremented the version in the README.md

Now feature/develop RPMs, Docker images, canu --version, and the generated switch config headers will look like this:

canu-1.6.20~1~g6b38cd2-1.x86_64.rpm
cray-canu:1.6.20_1_g6b38cd2
canu, version 1.6.20.post1.dev1

###############################################################################
# CSM version:  1.3
# CANU version: 1.6.20.post1.dev1
###############################################################################

After taking a new git-tag, that git-tag's build will produce an RPM, Docker image, canu --version, and the generated switch config headers will look like this:

canu-1.6.21.x86_64.rpm
cray-canu:1.6.21
canu, version 1.6.21

###############################################################################
# CSM version:  1.3
# CANU version: 1.6.21
###############################################################################

I tested my changes with the following commands on redbull, which produced a working ccj.json and generated switch configs:

canu validate shcd -a v1 --shcd ./Shasta\ River\ Redbull\ CCD_RevA9.xlsx --tabs 40G_10G,NMN,HMN --corners I12,S39,I9,S20,I20,S31 --json --out ccj.json

canu generate network config --ccj ccj.json --csm 1.3 --sls-file redbull/sls_input_file.json --folder generated
Architecture Dell and Mellanox Architecture is deprecated
sw-spine-001 Config Generated
sw-spine-002 Config Generated
sw-leaf-bmc-001 Config Generated

Warning

The following devices typically exist, but were not found in the current configuration.
If the network is supposed to have these devices, check the SHCD to ensure all tabs were included.
If the network does not contain these devices, disregard this warning.
------------------------------------------------------------
leaf
edge
cdu
cec
uan
cmm

NOTE The return from the following commands was large so I did not attach it.

canu validate switch config --ip 10.254.0.2 --generated ./generated/sw-spine-001.cfg

canu validate switch config --ip 10.254.0.2 --generated ./generated/sw-spine-001.cfg --remediation

Issues and Related PRs

• Resolves rpm creation enhancements #44

Testing

Tested on:

• List of virtual system tested.
• List of physical systems tested.