Skip to content

Latest commit

 

History

History
240 lines (173 loc) · 5.87 KB

INSTALL.md

File metadata and controls

240 lines (173 loc) · 5.87 KB
Raw

Installation

Requirements

This plugin requires QEMU 1.1+.

It also requires libvirt development files to complete installation with dependent ruby-libvirt gems.

Debian/Ubuntu requirements

This plugin requires

Either A) All in one:

apt-get install qemu qemu-kvm libvirt-bin redir dnsmasq-base bridge-utils \
                build-essential ruby2.0-dev libvirt-dev libxslt1-dev \
                libxml2-dev

Or B) Select what you need:

For KVM:

You need: qemu 1.1 and newer, libvirt 1.0 and newer

apt-get install qemu qemu-kvm libvirt-bin
For NFS:
apt-get install nfs-kernel-server nfs-common portmap
For Networking:
apt-get install redir dnsmasq-base bridge-utils
For ruby-libvirt gems installation dependency:
apt-get install build-essential ruby2.0-dev libvirt-dev libxslt1-dev \
                libxml2-dev

Some kernel version has a bug that causes a permission error on image. You are strongly recommended to upgrade a linux-image up-to-date. If you have some reason not to update, you should install apparmor-profiles and apparmor-utils and consult the Known Issues section in README.md. https://github.com/adrahon/vagrant-kvm/blob/master/README.md#known-issues

You can use a backported KVM/QEMU 1.4 with Private Package Archive(PPA) for Ubuntu 12.04(LTS) at launchpad-ppa

Debian/Ubuntu preparation

Before starting plugin installation, you need to configure your user id. Access to the management layer of libvirt is controlled through membership to the libvirtd unix group.

To enable libvirt management access for a user, add them to this group:

$ sudo usermod -G libvirtd  -a ~~username~~

Fedora/CentOS/RedHat/openSUSE requirements

For KVM:

yum install qemu-kvm libvirt libvirt-daemon-kvm.x86_64

For NFS:

yum install nfs-utils

For Networking:

yum install redir

For ruby-libvirt gems installation dependency:

yum install gcc make rubygem-rake ruby-devel libvirt-devel libxslt-devel libxml2-devel

Fedora preparation

Home directory permission is too conservative for Vagrant with kvm. Please relax your home directory permissions.

$ chmod o+x $HOME

To start libvirt:

$ sudo systemctl enable libvirtd
$ sudo systemctl start libvirtd
$ sudo systemctl enable libvirt-guests
$ sudo systemctl start libvirt-guests

Additional information

You may need to add SELinux label to vagrant standard storage-pool directory and box directory.

$ sudo yum install policycoreutils-python
$ semanage fcontext -a -t virt_image_t "~/.vagrant.d/tmp/storage-pool(/.*)?"
$ restorecon -R ~/.vagrant.d/tmp/storage-pool
$ semanage fcontext -a -t virt_context_t "~/.vagrant.d/boxes(/.*)?"
$ restorecon -R ~/.vagrant.d/boxes

Verify that this worked with

$ ls -Z ~/.vagrant.d/tmp/
$ ls -Z ~/.vagrant.d/

Fedora uses PolicyKit to manage access to libvirt, an additional polkit rules file may be required. Following sample configure that user who is in virt group can access libvirt in user privilege.

/etc/polkit-1/rules.d/10.virt.rules

polkit.addRule(function(action, subject) {
  polkit.log("action=" + action);
  polkit.log("subject=" + subject);
  var now = new Date();
  polkit.log("now=" + now)
  if ((action.id == "org.libvirt.unix.manage" || action.id == "org.libvirt.unix.monitor") && subject.isInGroup("virt")) {
    return polkit.Result.YES;
  }
  return null;
});

And Polkit user configuration

$ sudo groupadd virt
$ sudo usermod -a -G virt ~~username~~

Then restart polkit service

$ systemctl restart polkit.service

Alternatively, you can use polkit local authority compatibility configuration

$ sudo yum install -y polkit-pkla-compat

/etc/polkit-1/localauthority/50-vagrant-libvirt-access.pkla:

[libvirt Management Access]
Identity=unix-group:virt
Action=org.libvirt.unix.manage;org.libvirt.unix.monitor
ResultAny=yes
ResultInactive=yes
ResultActive=yes

And Polkit user configuration

$ sudo groupadd virt
$ sudo usermod -a -G virt ~~username~~

Then restart polkit service

$ systemctl restart polkit.service

Consult the polkit section of libvirt document for details. Here is also a good reference blog post

###CentOS6/RedHat6 preparation

You may need to add SELinux label to vagrant standard storage-pool directory and box directory.

$ sudo yum install policycoreutils-python
$ semanage fcontext -a -t virt_image_t "~/.vagrant.d/tmp/storage-pool(/.*)?"
$ restorecon -R ~/.vagrant.d/tmp/storage-pool
$ semanage fcontext -a -t virt_image_t "~/.vagrant.d/boxes(/.*)?"
$ restorecon -R ~/.vagrant.d/boxes

Add polkit configuration file to allow non-root user to access libvirt.

/etc/polkit-1/localauthority/50-local.d/50-libvirt-remote-access.pkla:

[libvirt Management Access]
Identity=unix-user:username
Action=org.libvirt.unix.manage
ResultAny=yes
ResultInactive=yes
ResultActive=yes

Restart libvirtd

$ sudo /etc/init.d/libvirtd restart

ArchLinux requirements

This plugin requires

  • For KVM:
  • qemu-kvm,libvirt

  • For NFS:

    • nfs-utils

  • For Networking:

  • redir bridge-utils dnsmasq
  • For ruby-libvirt gems installation dependency:
  • libvirt-dev

Home directory permission is too conservative for Vagrant with kvm. Please relax your home directory permission.

$ setfacl -m g:qemu:x /home/~~username~~

To use with Vagrant, you may need to configure libvirt for non-root user to run KVM. Consult ArchLinux Wiki for details.

Install procedure

As usual, you can install vagrant-kvm using vagrant plugin install command.

$ vagrant plugin install vagrant-kvm