sig_cloud/diskimage-builder
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f33526d20c
diskimage-builder/doc/source/user_guide/installation.rst

50 lines
1.4 KiB
ReStructuredText
Raw Normal View History

Split out README into separate files This makes the docs site a lot more manageable and begins moving us in the direction of separate user and developer docs. Change-Id: I1650ef9d5be1733b8bc118d99090143cb5b06102
2015-02-12 07:07:47 +00:00
Installation
============
Fix typo in installation.rst Trivial fix. Change-Id: I7d4fa9e4007954d5d847e659a17ac602f337e78f
2018-07-31 21:15:26 +00:00
If your distribution does not provide packages, you should install
Move dib-run-parts into diskimage-builder Move dib-run-parts from dib-utils into diskimage-builder directly. For calling outside the chroot, we provide a standard entry-point script. However, as noted in the warning comment, the underlying script is still copied directly into the chroot by the dib-run-parts element. I believe this to be the KISS approach. This removes the dependency on dib-utils. We have discussed this previously and nobody seemed to think retiring dib-utils was going to be an issue. This also updates the documentation to not mention dib-utils, or using disk-image-create via $PATH setup, but rather gives instructions on installing from pip with a virtualenv. Change-Id: Ic1e22ba498d2c368da7d72e2e2b70ff34324feb8
2016-11-03 00:38:39 +00:00
``diskimage-builder`` via ``pip``, mostly likely in a ``virtualenv``
to keep it separate.
Update install docs to be more user friendly Our install docs are out of date and not very user friendly. Lets fix that. Change-Id: Idaff33096bf32865020b85ee776abd6691ac45ad
2015-04-12 16:07:51 +00:00
Move dib-run-parts into diskimage-builder Move dib-run-parts from dib-utils into diskimage-builder directly. For calling outside the chroot, we provide a standard entry-point script. However, as noted in the warning comment, the underlying script is still copied directly into the chroot by the dib-run-parts element. I believe this to be the KISS approach. This removes the dependency on dib-utils. We have discussed this previously and nobody seemed to think retiring dib-utils was going to be an issue. This also updates the documentation to not mention dib-utils, or using disk-image-create via $PATH setup, but rather gives instructions on installing from pip with a virtualenv. Change-Id: Ic1e22ba498d2c368da7d72e2e2b70ff34324feb8
2016-11-03 00:38:39 +00:00
For example, to create a ``virtualenv`` and install from ``pip``
::
virtualenv ~/dib-virtualenv
. ~/dib-virtualenv/bin/activate
pip install diskimage-builder
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`` repository.
Update install docs to be more user friendly Our install docs are out of date and not very user friendly. Lets fix that. Change-Id: Idaff33096bf32865020b85ee776abd6691ac45ad
2015-04-12 16:07:51 +00:00
Split out README into separate files This makes the docs site a lot more manageable and begins moving us in the direction of separate user and developer docs. Change-Id: I1650ef9d5be1733b8bc118d99090143cb5b06102
2015-02-12 07:07:47 +00:00
Requirements
------------
Move dib-run-parts into diskimage-builder Move dib-run-parts from dib-utils into diskimage-builder directly. For calling outside the chroot, we provide a standard entry-point script. However, as noted in the warning comment, the underlying script is still copied directly into the chroot by the dib-run-parts element. I believe this to be the KISS approach. This removes the dependency on dib-utils. We have discussed this previously and nobody seemed to think retiring dib-utils was going to be an issue. This also updates the documentation to not mention dib-utils, or using disk-image-create via $PATH setup, but rather gives instructions on installing from pip with a virtualenv. Change-Id: Ic1e22ba498d2c368da7d72e2e2b70ff34324feb8
2016-11-03 00:38:39 +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
Add Gentoo to the list of supported distributions We also document any additional package needed. Change-Id: I7b9193fa5711138287f587935fc864fee4f95856
2016-02-18 16:57:07 +00:00
Fedora/RHEL/opensuse/Gentoo.
Update install docs to be more user friendly Our install docs are out of date and not very user friendly. Lets fix that. Change-Id: Idaff33096bf32865020b85ee776abd6691ac45ad
2015-04-12 16:07:51 +00:00
Add kpartx as a requirement to build images Testing on a ubuntu cloud image, the build is not possible because it is missing the kpartx dependency. Adding that as a requirement, when producing images with partitions. Change-Id: I0c8f39b5233dd450d8130735ed801bbed6bca0e9
2017-08-11 13:15:08 +00:00
When generating images with partitions, the ``kpartx`` tool is needed,
which is provided by the ``kpartx`` package.
Move dib-run-parts into diskimage-builder Move dib-run-parts from dib-utils into diskimage-builder directly. For calling outside the chroot, we provide a standard entry-point script. However, as noted in the warning comment, the underlying script is still copied directly into the chroot by the dib-run-parts element. I believe this to be the KISS approach. This removes the dependency on dib-utils. We have discussed this previously and nobody seemed to think retiring dib-utils was going to be an issue. This also updates the documentation to not mention dib-utils, or using disk-image-create via $PATH setup, but rather gives instructions on installing from pip with a virtualenv. Change-Id: Ic1e22ba498d2c368da7d72e2e2b70ff34324feb8
2016-11-03 00:38:39 +00:00
Some image formats, such as ``VHD``, may require additional
tools. Please see the ``disk-image-create`` help output for more
information.
Update install docs to be more user friendly Our install docs are out of date and not very user friendly. Lets fix that. Change-Id: Idaff33096bf32865020b85ee776abd6691ac45ad
2015-04-12 16:07:51 +00:00
Individual elements can also have additional dependencies for the build host.
It is recommended you check the documentation for each element you are using
Add Gentoo to the list of supported distributions We also document any additional package needed. Change-Id: I7b9193fa5711138287f587935fc864fee4f95856
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.
Update install docs to be more user friendly Our install docs are out of date and not very user friendly. Lets fix that. Change-Id: Idaff33096bf32865020b85ee776abd6691ac45ad
2015-04-12 16:07:51 +00:00
Document install of diskimage-builder on Gentoo Change-Id: I27bf3499f998dcbdeb5cfebddde306e5200cc0b5
2016-10-12 01:17:49 +00:00
Package Installation
--------------------
On Gentoo you can emerge diskimage-builder directly.
::
emerge app-emulation/diskimage-builder
Reference in New Issue Copy Permalink