Image Builder Client (ibc)

This is a command line client for the RedHat Hybrid Cloud Console Image Builder. It allows for easy integration of Image Builder into automation and CI pipelines to build images of RHEL or CentOS with the customizations you need and to export them to a public cloud of your choosing or as a downloadable image file.

To use ibc you need to have a valid Red Hat API Token stored in the environment variable REDHAT_API_TOKEN. This environment variable needs to contain your offline token.

For a more complete userguide you can read the Image Builder Client Manual.

ibc

ibc or the Image Builder Client is feature-compatible with the web interface provided in the RedHat Hybrid Cloud Console Image Builder, any customizations and selections that can be made there are available in the client. It is organised in subcommands related to the tasks Image Builder can perform.

The ibc command itself takes a few options that influence all of its subcommands:

USAGE:
    ibc [OPTIONS] <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -q, --quiet      Quiet operation (less output)
    -v, --verbose    Verbose operation (more output)
    -V, --version    Print version information

SUBCOMMANDS:
    help     Print this message or the help of the given subcommand(s)
    image    Build an image.

image

The main thing to do with ibc is to and play with images of your favorite operating systems, you can do this through the ibc image subcommand.

create

There are two required arguments: <distribution> and <architecture>.

This command enqueues the build to the API, tells you its identifier and then exits. You can then lookup the build by its identifier with ibc image list or with ibc image info. If you instead wish to wait for the entire build to complete you can pass the -w/--wait option which will prevent an early exit and only exit when the status of the image is changed to completed or failed.

USAGE:
    ibc image create <distribution> <architecture>

ARGS:
    <distribution>    Distribution to build. [possible values: rhel-8, rhel-9, centos-stream-8,
                      centos-stream-9]
    <architecture>    Architecture to build. [possible values: x86_64, arm64]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information
    -w, --wait       Do not exit after queueing the build but block until done.

Also aliased as: i.

list

Shows a list of completed, failed, and pending image builds.

Also aliased as: l, ls.

create

Start a new image build. This command has a huge amount of options.

Also aliased as: c.

delete

Delete an image build.

Also aliased as: d, rm.