diff --git a/doc/source/components.rst b/doc/source/components.rst index 4c5c8967..43151f97 100644 --- a/doc/source/components.rst +++ b/doc/source/components.rst @@ -1,29 +1,38 @@ -Componenets -=========== +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). +`disk-image-create [-a i386|amd64|armhf] -o filename {element} [{element} ...]` -* ramdisk-image-create -o filename {element} [{element} ...] : Create a kernel+ - ramdisk pair for running maintenance on bare metal machines (deployment, - inventory, burnin etc). + 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). - To generate kernel+ramdisk pair for use with nova-baremetal, use - ramdisk-image-create -o deploy.ramdisk deploy-baremetal +`ramdisk-image-create -o filename {element} [{element} ...]` - To generate kernel+ramdisk pair for use with ironic, use - ramdisk-image-create -o deploy.ramdisk deploy-ironic + Create a kernel+ ramdisk pair for running maintenance on bare metal + machines (deployment, inventory, burnin etc). -* 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 `baremetal` element, rather than this tool. + To generate kernel+ramdisk pair for use with nova-baremetal, use:: -* 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.