bootstrap-vz/bootstrapvz/providers/kvm/README.rst

KVM
===

The `KVM <http://www.linux-kvm.org/page/Main_Page>`__ provider creates
virtual images for Linux Kernel-based Virtual Machines. It supports the
installation of `virtio kernel
modules <http://www.linux-kvm.org/page/Virtio>`__ (paravirtualized
drivers for IO operations).
It also supports creating an image with LVM and qcow2 as a disk backend.

Manifest settings
-----------------

Provider
~~~~~~~~

-  ``virtio``: Specifies which virtio kernel modules to install.
   ``optional``
-  ``console``: Specifies which console should be used for stdout and stderr of init process
   to show startup messages and act as a console in single-user mode. Regardless of
   this setting output of kernel messages generated by ``printk()`` and seen by ``dmesg``
   goes to both virtual and serial console. Valid options: ```virtual``` or ```serial``` (default).
   ``optional``
-  ``logicalvolume``: Specifies the logical volume where the disk image will be built.
-  ``volumegroup``: Specifies the volume group where the logical volume will be stored.
   These options should only be used if ``lvm`` was given as a disk backend.


Example:

.. code-block:: yaml

    ---
    provider:
      name: kvm
      virtio:
        - virtio_blk
        - virtio_net
      console: virtual
    volume:
      backing: lvm
      logicalvolume: lvtest
      volumegroup: vgtest
Combine documentation from github wiki with sphinx This is the first step in the effort of combining all documentation about bootstrap-vz into sphinx while still being able to access it from github (github can parse rst as well) 2015-04-11 16:15:49 +02:00			`KVM`
fix document toctree 2016-03-15 11:13:05 +09:00			`===`
Combine documentation from github wiki with sphinx This is the first step in the effort of combining all documentation about bootstrap-vz into sphinx while still being able to access it from github (github can parse rst as well) 2015-04-11 16:15:49 +02:00
			The `KVM <http://www.linux-kvm.org/page/Main_Page>`__ provider creates
			`virtual images for Linux Kernel-based Virtual Machines. It supports the`
			installation of `virtio kernel
			modules <http://www.linux-kvm.org/page/Virtio>`__ (paravirtualized
			`drivers for IO operations).`
Add qcow2 as a disk backend for KVM This allows to build an image with qcow2 as a disk backend. The update implements a new class that inherits from QEMUVolume and just needs the extention and file format. 2017-06-14 18:09:27 +02:00			`It also supports creating an image with LVM and qcow2 as a disk backend.`
Improve providers docs and add loads of manifest examples 2015-12-13 15:24:27 +01:00
			`Manifest settings`
			`-----------------`

			`Provider`
			`~~~~~~~~`

			- ``virtio``: Specifies which virtio kernel modules to install.
			``optional``
Add to the KVM provider option to set output of the init process to a virtual or serial console 2018-01-18 16:39:19 +01:00			- ``console``: Specifies which console should be used for stdout and stderr of init process
			`to show startup messages and act as a console in single-user mode. Regardless of`
			this setting output of kernel messages generated by ``printk()`` and seen by ``dmesg``
			goes to both virtual and serial console. Valid options: ```virtual``` or ```serial``` (default).
			``optional``
Add LVM as a disk backend Enables the use of Logical Volumes as disk backends. It uses an existing volume group and has no support for creating a new one. It will not override an existing logical volume and fail gracefully. The lv is created, activated and then mounted as a loop device. The boostraping process is then launched on the loop device. Once the process is completed, the lv is unmounted and desactivated. The created lv will be deleted should the boostraping process fail. The lv must be activated before use. A manifest has been included for testing purposes. 2017-05-14 21:09:19 +02:00			- ``logicalvolume``: Specifies the logical volume where the disk image will be built.
Add to the KVM provider option to set output of the init process to a virtual or serial console 2018-01-18 16:39:19 +01:00			- ``volumegroup``: Specifies the volume group where the logical volume will be stored.
Add LVM as a disk backend Enables the use of Logical Volumes as disk backends. It uses an existing volume group and has no support for creating a new one. It will not override an existing logical volume and fail gracefully. The lv is created, activated and then mounted as a loop device. The boostraping process is then launched on the loop device. Once the process is completed, the lv is unmounted and desactivated. The created lv will be deleted should the boostraping process fail. The lv must be activated before use. A manifest has been included for testing purposes. 2017-05-14 21:09:19 +02:00			These options should only be used if ``lvm`` was given as a disk backend.
Improve providers docs and add loads of manifest examples 2015-12-13 15:24:27 +01:00
Add to the KVM provider option to set output of the init process to a virtual or serial console 2018-01-18 16:39:19 +01:00
Improve providers docs and add loads of manifest examples 2015-12-13 15:24:27 +01:00			`Example:`

Compat with new sphinx Changed a lot of code:: to code-block:: Also added sphinx_rtd_theme to deps in tox 2016-03-04 01:19:29 +01:00			`.. code-block:: yaml`
Improve providers docs and add loads of manifest examples 2015-12-13 15:24:27 +01:00
			`---`
			`provider:`
			`name: kvm`
			`virtio:`
			`- virtio_blk`
			`- virtio_net`
Add to the KVM provider option to set output of the init process to a virtual or serial console 2018-01-18 16:39:19 +01:00			`console: virtual`
Add LVM as a disk backend Enables the use of Logical Volumes as disk backends. It uses an existing volume group and has no support for creating a new one. It will not override an existing logical volume and fail gracefully. The lv is created, activated and then mounted as a loop device. The boostraping process is then launched on the loop device. Once the process is completed, the lv is unmounted and desactivated. The created lv will be deleted should the boostraping process fail. The lv must be activated before use. A manifest has been included for testing purposes. 2017-05-14 21:09:19 +02:00			`volume:`
			`backing: lvm`
			`logicalvolume: lvtest`
			`volumegroup: vgtest`