sig_cloud/diskimage-builder
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update install docs to be more user friendly

Browse Source 
Our install docs are out of date and not very user friendly. Lets fix
that.

Change-Id: Idaff33096bf32865020b85ee776abd6691ac45ad
This commit is contained in:
Gregory Haynes 2015-04-12 16:07:51 +00:00
parent 65ad6377a6
commit d98e6dcff9
1 changed files with 56 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
doc/source/user_guide/installation.rst
View File

@ -1,24 +1,69 @@
Installation Installation
============ ============
Diskimage-builder is run directly out of the source repository. 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 Requirements
------------ ------------
If you have 4GB of available physical RAM (As reported by Most image formats require the qemu-img tool which is provided by the
/proc/meminfo MemTotal), or more, diskimage-builder will create a tmpfs mount qemu-utils package on Ubuntu/Debian or the qemu package on
to build the image in. This will improve image build time by building in RAM. 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
Speedups
--------
If you have 4GB of available physical RAM (As reported by /proc/meminfo
MemTotal), or more, diskimage-builder will create a tmpfs mount to build the
image in. This will improve image build time by building in RAM.
This can be disabled completely by passing --no-tmpfs to disk-image-create. This can be disabled completely by passing --no-tmpfs to disk-image-create.
ramdisk-image-create builds a regular image and then within that does ramdisk ramdisk-image-create builds a regular image and then within that does ramdisk
creation. If tmpfs is not used, you will need enough room in /tmp to store two creation. If tmpfs is not used, you will need enough room in /tmp to store two
uncompressed cloud images. If you do have tmpfs, you will still need /tmp space uncompressed cloud images. If you do have tmpfs, you will still need /tmp space
for one uncompressed cloud image and about 20% of that for working files. for one uncompressed cloud image and about 20% of that for working files.
Installation
------------
* Clone the repository locally, then add bin to your path.
* Make sure you have qemu-img (qemu-utils package on Ubuntu/Debian,
qemu on Fedora/RHEL/openSUSE) and kpartx installed.