diskimage-builder/doc/source/user_guide/installation.rst
SamYaple 0c32784663 Revert "Zerofree the image if possible"
This reverts commit 5184d02a7c.

The decision was made to go with fstrim because it is faster and more
universal that zerofree. The related-id has the patchset that implements
fstrim.

Related-Id: I269b4416be450369616f9b8e030f84c30e329804
Change-Id: If40cf2fc0ecd8686768cbfeac9ecee90907674e7
2016-03-10 20:38:01 +00:00

1.6 KiB

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/Gentoo.

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. Of particular note is the need for the dev-python/pyyaml package on Gentoo hosts.

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