openstack/diskimage-builder
Code Issues Proposed changes

Cleanup/restify components.rst

Browse Source 
Rework the list as a definition list.

Mark literal code snippets as literal code snippets.

Fix heading typo.

Change-Id: Ie3d393a49914779f12f3075ff2ac2df5ecf78321
This commit is contained in:
James Polley 2015-02-12 17:09:04 +01:00
parent dd5a917571
commit 27d03777dd
1 changed files with 31 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
doc/source/components.rst
View File

@ -1,29 +1,38 @@
Componenets Components
=========== ==========
* disk-image-create [-a i386|amd64|armhf] -o filename {element} [{element} ...] `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+ Create an image of element {element}, optionally mixing in other elements.
ramdisk pair for running maintenance on bare metal machines (deployment, Element dependencies are automatically included. Support for other
inventory, burnin etc). 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).
To generate kernel+ramdisk pair for use with nova-baremetal, use `ramdisk-image-create -o filename {element} [{element} ...]`
ramdisk-image-create -o deploy.ramdisk deploy-baremetal
To generate kernel+ramdisk pair for use with ironic, use Create a kernel+ ramdisk pair for running maintenance on bare metal
ramdisk-image-create -o deploy.ramdisk deploy-ironic machines (deployment, inventory, burnin etc).
* disk-image-get-kernel filename : **DEPRECATED** Extract the appropriate To generate kernel+ramdisk pair for use with nova-baremetal, use::
kernel and ramdisk to use when doing PXE boot using filename as the image
for a machine. Consider using the `baremetal` element, rather than this tool.
* elements can be found in the top level elements directory. ramdisk-image-create -o deploy.ramdisk deploy-baremetal
* element-info : Extract information about elements. 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.