IO Module RESTful API driver

This driver provides an HTTP RESTful API and is written in Rust using Rocket.
It uses the IO Module driver and makes all IO Module functions available.

The API is stable and should be used for remote as well as local applications.
The entire documentation can be found here.
The driver currently does not support authentication/session handling. The authentication is done via proxy settings.

Building

To build this project for the target platform the "aarch64-unknown-linux-gnu" target must be installed via rustup.
The "aarch64-linux-gnu-gcc" linker must also be configured (check the Dockerfile).

cargo build --target=aarch64-unknown-linux-gnu

The project can be build directly on the Nexus if Rust is installed, but it will take some time:

cargo build

Docker

There is a Dockerfile in the project which allows you to build the project for armv8/arm64:

docker buildx build --platform linux/arm64 -t rust-cross-build .
docker run --platform linux/arm64 -t --rm -w "$PWD" -v "$PWD:$PWD":rw,z rust-cross-build cargo build --target=aarch64-unknown-linux-gnu --release
docker run --platform linux/arm64 -t --rm -w "$PWD" -v "$PWD:$PWD":rw,z rust-cross-build ./makedeb_github.sh

Executing

The application must be executed on the Nexus and the nexus-drv-io service must be running.
Please ensure the nexus-rest-io service is stopped.

RUST_APP_LOG="info" ROCKET_PROFILE=production PORT=8003 ./nexus-rest-bmc

Packaging

We do not build Debian packages on Github because the aarch64 architecture is not supported.
Please check the packaging guide for details.

Testing

The testsuite is currently not published because it relies on hardware, physical test tools and a specific wiring.

License

This driver is licensed under GPLv3.