ironlib

Ironlib wraps various opensource and various vendor utilities to expose a consistent set of interface methods to,

• Collect inventory
• Update firmware
• Set/Get BIOS configuration
• Set/Get BMC configuration

For the available methods,

• The supported actions interface and method docs can be found here
• The supported utilities and its methods can be found here

Currently supported hardware

• Dell
• Supermicro
• AsrockRack

Requirements

Ironlib expects various vendor utilities to be made available.

TODO: define a list of utility path env vars a user can set.

Invoking ironlib

Ironlib identifies the hardware and executes tooling respective to the hardware/component being queried or updated,

The list of tools that ironlib wraps around, in no particular order,

• dell racadm
• dmidecode
• dell dsu
• lshw
• mlxup
• msecli
• nvmecli
• smartctl
• supermicro SUM
• storecli

For the full list see here

Examples

More examples can be found in the examples directory

package main

import (
	"context"
	"encoding/json"
	"fmt"

	"github.com/metal-toolbox/ironlib"
	"github.com/sirupsen/logrus"
)


func main() {
	logger := logrus.New()
	device, err := ironlib.New(logger)
	if err != nil {
		logger.Fatal(err)
	}

	inv, err := device.GetInventory(context.TODO())
	if err != nil {
		logger.Fatal(err)
	}

	j, err := json.MarshalIndent(inv, "", "  ")
	if err != nil {
		logger.Fatal(err)
	}

	fmt.Println(string(j))
}

Executable path environment variables.

By default ironlib will lookup the executable path, if required the path can be overriden by exporting one or more of these environment variables

IRONLIB_UTIL_ASRR_BIOSCONTROL
IRONLIB_UTIL_RACADM7
IRONLIB_UTIL_DNF
IRONLIB_UTIL_DSU
IRONLIB_UTIL_HDPARM
IRONLIB_UTIL_LSBLK
IRONLIB_UTIL_LSHW
IRONLIB_UTIL_MLXUP
IRONLIB_UTIL_MSECLI
IRONLIB_UTIL_MVCLI
IRONLIB_UTIL_NVME
IRONLIB_UTIL_SMARTCTL
IRONLIB_UTIL_SMC_IPMICFG
IRONLIB_UTIL_SUM
IRONLIB_UTIL_STORECLI

Check out this snippet to determine if all required dependencies are available to ironlib.

ironlib docker image

A github workflow builds and releases a docker image based off the Dockerfile in this repository.

The Dockerfile provides ONBUILD hooks so downstream users can build their own images including any further dependencies required (i.e. proprietary vendor tools). To use the ONBUILD functionality in a downstream docker image, add the extra tools to a dependencies directory and provide a script install-extra-deps.sh to install those within the image.

Downstream Dockerfile can be as simple as:

# Use base ironlib image with ONBUILD instructions to include extra deps
FROM ghcr.io/metal-toolbox/ironlib:latest as stage0

# Keep image lean after all extra deps are installed
FROM scratch
COPY --from=stage0 / /