2015-02-12 07:07:47 +00:00
|
|
|
Installation
|
|
|
|
|
============
|
|
|
|
|
|
2015-04-12 16:07:51 +00:00
|
|
|
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.
|
|
|
|
|
|
2015-07-24 23:47:30 +00:00
|
|
|
Once installed, you will be able to :doc:`build images <building_an_image>`
|
|
|
|
|
using disk-image-create and the elements included in the main diskimage-builder
|
2015-04-12 16:07:51 +00:00
|
|
|
repository.
|
|
|
|
|
|
2015-02-12 07:07:47 +00:00
|
|
|
|
|
|
|
|
Requirements
|
|
|
|
|
------------
|
|
|
|
|
|
2015-04-12 16:07:51 +00:00
|
|
|
Most image formats require the qemu-img tool which is provided by the
|
|
|
|
|
qemu-utils package on Ubuntu/Debian or the qemu package on
|
2016-02-18 16:57:07 +00:00
|
|
|
Fedora/RHEL/opensuse/Gentoo.
|
2015-04-12 16:07:51 +00:00
|
|
|
|
|
|
|
|
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
|
2016-02-18 16:57:07 +00:00
|
|
|
to determine if there are any additional dependencies. Of particular note is
|
|
|
|
|
the need for the `dev-python/pyyaml` package on Gentoo hosts.
|
2015-04-12 16:07:51 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
