Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

libvirt

manages libvirtd in a SIMP-compatible environment
Project URLRSS FeedReport issues

13,462 downloads

179 latest version

4.7 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 5.9.1 (latest)
  • 5.8.0
  • 5.6.0
  • 5.5.0
  • 5.4.0
  • 5.3.1
  • 5.3.0
  • 5.2.2
  • 5.2.1
  • 5.2.0
  • 5.1.0
  • 5.0.4
  • 5.0.3
  • 5.0.2
  • 4.1.2
  • 4.1.1
released Jan 17th 2024
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'simp-libvirt', '5.9.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add simp-libvirt
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install simp-libvirt --version 5.9.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: kvm, libvirt, simp, virsh

Documentation

simp/libvirt — version 5.9.1 Jan 17th 2024

License CII Best Practices Puppet Forge Puppet Forge Downloads Build Status

Table of Contents

Overview

This module manages the installation of libvirt as well as providing a rudimentary ability to create virtual machines on your system.

This is a SIMP module

This module is a component of the System Integrity Management Platform, a compliance-management framework built on Puppet.

If you find any issues, they can be submitted to our JIRA.

This module is optimally designed for use within a larger SIMP ecosystem, but it can be used independently:

  • When included within the SIMP ecosystem, security compliance settings will be managed from the Puppet server.
  • If used independently, all SIMP-managed security subsystems will be disabled by default and must be explicitly opted into by administrators. Please review simp_options for details.

Module Description

You can use this module to install and manage basic aspects of libvirt, KSM, KVM, and the polkit rules that surround usage of libvirt capabilities.

You can also use the libvirt::vm defined type to spin up local virtual machines on your nodes.

See REFERENCE.md for API details.

Usage

Basic Usage

Simply include the libvirt class to add support to your system.

include libvirt

If you want KSM support, then you should set the follwing in Hiera:

---
libvirt::ksm: true

Advanced Usage

This example uses the simp-network module to create a bridge and then spins up a single VM on the resulting system. It also allows users in the virshusers group to execute libvirt commands via polkit.

include libvirt
include network

# Set up a local bridge on the network
network::eth { "em1":
  bridge => 'br0',
  hwaddr => $facts['macaddress_em1']
}

network::eth { "br0":
  net_type => 'Bridge',
  hwaddr   => $facts['macaddress_em1'],
  require  => Network::Eth['em1']
}

# Create polkit policy to allow users in virsh users group to use libvirt
class { 'libvirt::polkit':
  ensure => present,
  group  => 'virshusers',
  local  => true,
  active => true
}

# Create group and add users.
group{ 'virshusers':
  members => ['user1','user2']
}

# Kickstart a VM on the system and bind it to the local bridge
libvirt::vm { 'test_system':
  mac_addr  => 'AA:BB:CC:DD:EE:FF',
  size      => 20,
  networks  => { 'type' => 'bridge', 'target' => 'br0' },
  pxe       => true,
  disk_opts => { 'bus' => 'virtio' },
  require   => Network::Eth['br0']
}

Development

Please read our Contribution Guide

Acceptance tests

This module includes Beaker acceptance tests using the SIMP Beaker Helpers. By default the tests use Vagrant with VirtualBox as a back-end; Vagrant and VirtualBox must both be installed to run these tests without modification. To execute the tests run the following:

bundle exec rake beaker:suites

Some environment variables may be useful:

BEAKER_debug=true
BEAKER_provision=no
BEAKER_destroy=no
BEAKER_use_fixtures_dir_for_modules=yes
BEAKER_fips=yes
  • BEAKER_debug: show the commands being run on the STU and their output.
  • BEAKER_destroy=no: prevent the machine destruction after the tests finish so you can inspect the state.
  • BEAKER_provision=no: prevent the machine from being recreated. This can save a lot of time while you're writing the tests.
  • BEAKER_use_fixtures_dir_for_modules=yes: cause all module dependencies to be loaded from the spec/fixtures/modules directory, based on the contents of .fixtures.yml. The contents of this directory are usually populated by bundle exec rake spec_prep. This can be used to run acceptance tests to run on isolated networks.
  • BEAKER_fips=yes: enable FIPS-mode on the virtual instances. This can take a very long time, because it must enable FIPS in the kernel command-line, rebuild the initramfs, then reboot.

Please refer to the SIMP Beaker Helpers documentation for more information.