Hardware Information API (hwapi)

The repo contains the API server and client for retrieving hardware information.

Prerequisites for Deploying Locally

• Install docker and setup permissions for server deployment
• Install rust and cargo for client deployment (https://www.rust-lang.org/tools/install)

Running API Server With Docker

Go to the server/ directory in the project. The following command builds the hwapi server:

$ docker build -t hwapi .

Then, stand up the hwapi server:

$ docker run -p 8080:8080 hwapi

If you want to reload the application automatically when you change the source code, you can mount the current directory on the host to the app directory inside the container:

$ docker run -p 8080:8080 -v $(pwd)/hwapi:/home/app/hwapi hwapi

Then you can access the server via this URL: http://127.0.0.1:8080

For information regarding accessing the API schema, read server README

Accessing API schema

You can retrieve API schema in HTML, YAML, and JSON formats:

• To access the HTML view for the API schema, just run the server and follow the /#docs endpoint.
• A self-contained HTML representation of the schema is also included in the repository: openapi.html.
• Retrieve the schema in YAML from the running service by following the /openapi.yaml endpoint
• A copy of the openapi.yaml is included in the repo, and it is enforced by a CI automation to be up to date.
• For getting its JSON version, follow the /openapi.json endpoint.

Build the library (hwlib)

For now, the library contains the function to return a sample certification status. It depends on the environment variable CERTIFICATION_STATUS and accepts the following values:

• 0: The system has not been seen (default behaviour even if the env variable is not defined).
• 1: The system is partially certified (we haven't seen this specific system, but some of its hardware components have been tested on other systems).
• 2: This system has been certified (but probably for other Ubuntu release).

$ cd client/hwlib
$ cargo build

Build and Run the Reference CLI Tool (hwctl)

$ export CERTIFICATION_STATUS=2
$ cd client/hwctl
$ cargo run

This is the output you should get running the commands above:

    Finished dev [unoptimized + debuginfo] target(s) in 2.00s
Certified(
    CertifiedResponse {
        status: "Certified",
        os: OS {
            distributor: "Ubuntu",
            description: "Ubuntu 20.04.1 LTS",
            version: "20.04",
            codename: "focal",
            kernel: KernelPackage {
                name: "Linux",
                version: "5.4.0-42-generic",
                signature: "Sample Signature",
            },
            loaded_modules: [
                "module1",
                "module2",
            ],
        },
        bios: Bios {
            firmware_revision: "1.0",
            release_date: "2020-01-01",
            revision: "rev1",
            vendor: "BIOSVendor",
            version: "v1.0",
        },
    },
)