openstack
/
diskimage-builder
Code Issues Proposed changes

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
This commit is contained in:
Isaac Beckman 2016-01-17 13:38:59 +02:00
parent cd9fdf05e9
commit 24d1527111
2 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/user_guide/building_an_image.rst
View File

@ -70,4 +70,19 @@ this::
disk-image-create --mkfs-options '-i 16384' <distro> vm
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 it in RAM.
By default, the tmpfs file system uses 50% of the available RAM.
Therefore, the RAM should be at least the double of the minimum tmpfs
size required.
For larger images, when no sufficient amount of RAM is available, tmpfs
can be disabled completely by passing --no-tmpfs to disk-image-create.
ramdisk-image-create builds a regular image and then within that image
creates ramdisk.
If tmpfs is not used, you will need enough room in /tmp to store two
uncompressed cloud images. If tmpfs is used, you would still need /tmp space
for one uncompressed cloud image and about 20% of that image for working files.

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

@ -54,16 +54,3 @@ 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.
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
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.