openstack/diskimage-builder
Code Issues Proposed changes
3eeefefa85
diskimage-builder/doc/source/user_guide/installation.rst
Isaac Beckman 24d1527111 Move speedup section to image building guide 
speedup section explains  the user how to sppedup image build by using
tmpfs. The  correct user guide to have this section, is the user guide
about image building rather than the installation user guide.

Change-Id: I96b90bd79df53db4f926a928ae3c86b888315230
2016-01-18 07:02:00 +00:00

1.5 KiB
Raw Blame History

Installation

Diskimage-builder can either be run directly out of the source repository or installed via pip. If you plan on doing development on diskimage-builder or the elements then we recommend you run the tool out of the source repository as this installation requires minimal extra effort and does not require an extra install step for your changes to take effect.

Once installed, you will be able to build images <building_an_image> using disk-image-create and the elements included in the main diskimage-builder repository.

Requirements

Most image formats require the qemu-img tool which is provided by the qemu-utils package on Ubuntu/Debian or the qemu package on Fedora/RHEL/opensuse.

Some image formats, such as VHD, may require additional tools. Please see the disk-image-create help output for more information.

Individual elements can also have additional dependencies for the build host. It is recommended you check the documentation for each element you are using to determine if there are any additional dependencies.

Source Installation

Clone the diskimage-builder and dib-utils repositories locally:

git clone https://git.openstack.org/openstack/diskimage-builder
git clone https://git.openstack.org/openstack/dib-utils

Add the bin dirs to your path:

export PATH=$PATH:$(pwd)/diskimage-builder/bin:$(pwd)/dib-utils/bin

Pip Installation

Installing via pip is as simple as:

pip install diskimage-builder