diskimage-builder/doc/source/developer/components.rst
Ian Wienand 79ea63f525 Futher bootloader cleanups
GRUB_OPTS has never been documented as externally available, and is
not used.  Assume it's value to simplify the code.

Move the grub version check separately, as we only support grub2

Remove references to buliding i386 images.  I don't image it works in
any way.

Remove ci.md, which is no longer relevant.

Refactor the test for "building BIOS image on EFI system" consiberably
after these changes.

Change-Id: Ia99687815667c3cf5e82cf21d841d3b1008b8fa9
2022-02-10 15:08:56 +11:00

36 lines
1.3 KiB
ReStructuredText

Components
==========
`disk-image-create [-a amd64|armhf|arm64] -o filename {element} [{element} ...]`
Create an image of element {element}, optionally mixing in other elements.
Element dependencies are automatically included. Support for other
architectures depends on your environment being able to run binaries of
that platform and/or packages being available for the architecture. For
instance, to enable armhf on Ubuntu install the qemu-user-static package,
or to enable arm64 on CentOS setup the RDO aarch64 package repositories.
The default output format from disk-image-create is qcow2. To instead
output a tarball pass in "-t tar". This tarball could then be used as an
image for a linux container(see docs/docker.md).
`ramdisk-image-create -o filename {element} [{element} ...]`
Create a kernel+ ramdisk pair for running maintenance on bare metal
machines (deployment, inventory, burnin etc).
To generate kernel+ramdisk pair for use with nova-baremetal, use::
ramdisk-image-create -o deploy.ramdisk deploy-baremetal
Ironic no longer supports images created like this.
`element-info`
Extract information about elements.
`tests/run_functests.sh`
This runs a set of functional tests for diskimage-builder.
elements can be found in the top level elements directory.