diskimage-builder/doc/source/components.rst
James Polley 27d03777dd Cleanup/restify components.rst
Rework the list as a definition list.

Mark literal code snippets as literal code snippets.

Fix heading typo.

Change-Id: Ie3d393a49914779f12f3075ff2ac2df5ecf78321
2015-03-18 02:12:32 +00:00

38 lines
1.4 KiB
ReStructuredText

Components
==========
`disk-image-create [-a i386|amd64|armhf] -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. For instance, to enable armhf on Ubuntu install the
qemu-user-static package. 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
To generate kernel+ramdisk pair for use with ironic, use::
ramdisk-image-create -o deploy.ramdisk deploy-ironic
`disk-image-get-kernel filename`
**DEPRECATED** Extract the appropriate kernel and ramdisk to use when doing
PXE boot using filename as the image for a machine. Consider using the
:ref:`baremetal` element, rather than this tool.
`element-info`
Extract information about elements.
elements can be found in the top level elements directory.