libvirt puppet module

Build Status Puppet Forge Puppet Forge Puppet Forge Puppet Forge

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Usage - Configuration options and additional functionality
  4. Reference
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module


Puppet module to install libvirt and create virtual domain configuration. This module has very minimal external dependencies and tries to not make any assumptions about how you want to setup your virtual machines.

The module contains helper scripts to manage VMs on a 2 node cluster with disk replication over DRBD. But this is completely optional.

Remark: For puppet 3 support use versions 2.x.x !


This module tries to adhere to the Unix philosophy of doing one thing but doing it right. It installs and configures libvirt and virtual domains, but does not do the basic setup of your networking bridge or configure the disks used by the virtual domains. This is left to other puppet modules.

For a basic setup you have to include the libvirt class, define a libvirt::network and a libvirt::domain.

As an optional add-on this module contains a libvirt hook and a Python management script to create a 2 node cluster with disks replicated over DRBD. This setup allows live migration of VMs from one node to the other.

A complete working solution can be achived by integrating the following modules in addition to this module:


Install libvirt:

class {'libvirt': }

Install including the DRBD hook:

class {'libvirt':
  qemu_hook => 'drbd',

Define a network (basic linux bridge example):

libvirt::network { 'net-simple':
    forward_mode   => 'bridge',
    bridge         => 'br-simple',

Define a network (advanced openvswitch example):

libvirt::network { 'net-ovs':
  forward_mode     => 'bridge',
  bridge           => 'br-ovs',
  virtualport_type => 'openvswitch',
  autostart        => true,
  portgroups       => [
                       {'name'     => 'intern',
                        'trunk'    => false,
                        'vlan_tag' => '2',
                       {'name'     => 'trunk',
                        'trunk'    => true,
                        'vlan_tag' => ['100', '101', '102', ],

Define a domain (VM):

libvirt::domain { 'my-domain':
  max_memory     => '2000',
  cpus           => 2,
  boot           => 'hd',
  disks          => [{'type' => 'block',
                      'device' => 'disk',
                      'source' => {'dev' => '/dev/vm-pool/my-domain.img'},
                     {'type'   => 'file',
                      'device' => 'disk',
                      'source' => {'dev' => '/var/lib/libvirt/images/my-disk.qcow2'},
                      'bus'    => 'virtio',
                      'driver' => {'name'  => 'qemu',
                                   'type'  => 'qcow2',
                                   'cache' => 'none',
  interfaces     => [{'network' => 'net-simple'},],
  autostart      => true,

Define a storage pool:

libvirt_pool { 'default' :
    ensure     => present,
    type       => 'logical',
    autostart  => true,
    sourcedev  => '/dev/sda5',
    sourcename => 'vm',
    target     => '/dev/vm',

Complete documentation is included in puppet doc format in the manifest files.




Returns a MAC address in the QEMU/KVM MAC OID (52:54:00:...)


Generates MAC addresses for all interfaces in the array which do not yet have an address specified. The MAC addresses are based on the domain name, network and portgroup.



Manages libvirt pools

Example : libvirt_pool { 'default' : ensure => absent }

libvirt_pool { 'mydirpool' : ensure => present, active => true, autostart => true, type => 'dir', target => '/tmp/mypool', }

libvirt_pool { 'mydirpool2' : ensure => present, active => true, autostart => true, type => 'dir', target => '/tmp/mypool2', target_owner => 107, target_group => 107, target_mode => '0755', }

libvirt_pool { 'vm_storage': ensure => 'present', active => 'true', type => 'logical', sourcedev => ['/dev/sdb', '/dev/sdc'], target => '/dev/vg0' }


The following properties are available in the libvirt_pool type.


Valid values: present, absent

Manages the creation or the removal of a pool present means that the pool will be defined and created absent means that the pool will be purged from the system

Default value: present


Valid values: true, false

Whether the pool should be started.

Default value: true


Valid values: true, false

Whether the pool should be autostarted.

Default value: false


The following parameters are available in the libvirt_pool type.


Valid values: /^\S+$/


The pool name.


Valid values: dir, netfs, fs, logical, disk, iscsi, mpath, rbd, sheepdog

The pool type.


Valid values: /^\S+$/

The source host.


Valid values: /(\/)?(\w)/

The source path.


Valid values: /(\/)?(\w)/

The source device.


Valid values: /^\S+$/

The source name.


Valid values: auto, nfs, glusterfs, cifs

The source format.


Valid values: /(\/)?(\w)/

The target.


Valid values: /^\S+$/

The owner of the target dir or filesystem


Valid values: /^\S+$/

The group of the target dir or filesystem


Valid values: /^[0-7]4$/

The mode of the target dir or filesystem


Things currently not supported:

  • Operating Systems other than Debian, Ubuntu or RedHat. Adding support for other systems is a matter of defining the relevant parameters in params.pp. So this is really easy for someone with access to such a system.
  • Network interfaces not attached to a libvirt network

Patches to support any of these (or other) missing features are welcome.


Please report bugs and feature request using GitHub issue tracker.

For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint and the available spec tests in order to follow the recommended Puppet style guidelines from the Puppet Labs style guide.