Forge Home

ovirt_guest_agent

Puppet module for managing ovirt-guest-agent

21,490 downloads

17,601 latest version

4.6 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

  • 0.5.0 (latest)
  • 0.4.1
  • 0.4.0
  • 0.3.0
  • 0.2.0
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Mar 20th 2017
This version is compatible with:
  • , , , Debian, Ubuntu

Start using this module

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

Add this module to your Puppetfile:

mod 'scrat14-ovirt_guest_agent', '0.5.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add scrat14-ovirt_guest_agent
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install scrat14-ovirt_guest_agent --version 0.5.0

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

Documentation

scrat14/ovirt_guest_agent — version 0.5.0 Mar 20th 2017

ovirt_guest_agent

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with ovirt_guest_agent
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

This module installs and configure ovirt-guest-agent.

Module Description

ovirt-guest-agent is a daemon that resides within guest virtual machines and is required to supply information to the Virtualization Manager (such as oVirt-engine or Red Hat Enterprise Virtualization Manager) that is required to properly manage the virtual machines.

This module installs ovirt-guest-agent-common (or rhevm-guest-agent-common), enables and starts the ovirt-guest-agent daemon.

Setup

What ovirt_guest_agent affects

  • Packages
    • ovirt-guest-agent-common
    • qemu-guest-agent
  • Files
    • /etc/ovirt-guest-agent.conf
  • Services
    • ovirt-guest-agent daemon

Setup Requirements

This module doesn't enable (possibly) repositories due to the following reasons:

  • Required repository may be already enabled (e.g. EPEL)
  • Repositories aren't handled by yum directly (e.g. when using Red Hat Satellite, Spacewalk, Katello,...)
  • There are plenty of modules available for enabling repositories

The following repositories are required (also see Limitations section below):

Beginning with ovirt_guest_agent

For mninimal usage try:

    include '::ovirt_guest_agent'

which will install the guest agent and enable it.

To pass additional parameters try something like this:

    class {'::ovirt_guest_agent':
        report_disk_usage => 1,
    }

Usage

Install ovirt-guest-agent with default configuration file:

    class {'::ovirt_guest_agent': }

Install rhevm-guest-agent instead of ovirt-guest-agent with default configuration file:

    class {'::ovirt_guest_agent':
      service_name => 'rhevm-guest-agent'
      package_name => 'rhevm-guest-agent-common'
    }

Reference

Classes

  • ovirt_guest_agent: This is the main class which includes all other classes.
  • ovirt_guest_agent::service: Starts/stops and enables/disables ovirt-guest-agent daemon.
  • ovirt_guest_agent::package: Installs/uninstalls ovirt-guest-agent package.

Paramaters

The following parameters are available in ::ovirt_guest_agent class:

service_name

Name of the ovirt-guest-agent service. Override this value if you want to install rhevm-guest-agent. Default value: ovirt-guest-agent

service_enabled

Boolen value for enabling or disabling ovirt-guest-agent service. Default value: true

service_ensure

Handles status of ovirt-guest-agent service. Can be running or stopped. Default value: running

package_name

Name of the ovirt-guest-agent package. Override this value if you want to install rhevm-guest-agent. The name differs on RedHat based systems and Debian based system. Class ::ovirt_guest_agent::params takes care of the right default values. Default value (RedHat): ovirt-guest-agent-common Default value (Debian): ovirt-guest-agent

package_ensure

Handles status of ovirt-guest-agent package. Can be installed or absent. Default value: installed

Limitations

See operatingsystem_support for list of supported operating systems.

If you're using Debian 8, please note that there are 2 bugs in the ovirt-guest-agent package provided by jessie repository:

These bugs are fixed ini package of sid repository.

If you're using Debian 7, please follow the instructions on how to add the required repository: https://software.opensuse.org/download.html?project=home%3Aevilissimo%3Adeb&package=ovirt-guest-agent or

https://www.ovirt.org/documentation/how-to/guest-agent/install-the-guest-agent-in-debian/

If you're using Ubuntu, please follow the instructions on how to add the required repository: https://www.ovirt.org/documentation/how-to/guest-agent/install-the-guest-agent-in-ubuntu/

Development

Fork this module on Github and send a pull request.