Terraform provider for libvirt

This provider is still being actively developed. To see what is left or planned, see the issues list.

This is a terraform provider that lets you provision servers on a libvirt host via Terraform.

Requirements

• libvirt 1.2.14 or newer on the hypervisor

The provider uses virDomainInterfaceAddresses which was added in 1.2.14. If you need a stable server distribution with a recent libvirt version, try openSUSE Leap or Ubuntu (from version 15.10 Wily Werewolf on).

In the future, I may try to support older libvirt versions if I find a way to elegantely conditional compile the code and get the IP addresses with alternative methods.

Installing

Copied from the Terraform documentation:

To install a plugin, put the binary somewhere on your filesystem, then configure Terraform to be able to find it. The configuration where plugins are defined is ~/.terraformrc for Unix-like systems and %APPDATA%/terraform.rc for Windows.

If you are using opensuse/SUSE distro, add the repo and download the package (check the repo according your distro)

DISTRO=openSUSE_Leap_42.1
zypper addrepo http://download.opensuse.org/repositories/Virtualization:containers/$DISTRO/Virtualization:containers.repo
zypper refresh
zypper install terraform-provider-libvirt

Using the provider

Here is an example that will setup the following:

• A virtual server resource

(create this as libvirt.tf and run terraform commands from this directory):

provider "libvirt" {
    uri = "qemu:///system"
}

You can also set the URI in the LIBVIRT_DEFAULT_URI environment variable.

Now, define a libvirt domain:

resource "libvirt_domain" "terraform_test" {
  name = "terraform_test"
}

Now you can see the plan, apply it, and then destroy the infrastructure:

$ terraform plan
$ terraform apply
$ terraform destroy

Building from source

This project uses vndr to vendor all its dependencies.

Run go install to build the binary. You will now find the binary at $GOPATH/bin/terraform-provider-libvirt.

Running

1. create the example file libvirt.tf in your working directory
2. terraform plan
3. terraform apply

Running acceptance tests

You need to define the LIBVIRT_DEFAULT_URI and TF_ACC variables:

export LIBVIRT_DEFAULT_URI=qemu:///system
export TF_ACC=1
go test ./...

Known Problems

• There is a bug in libvirt that seems to be causing problems to unlink volumes. Tracked here.

  If you see something like:

  cannot unlink file '/var/lib/libvirt/images/XXXXXXXXXXXX': Permission denied

  It is probably related and fixed in libvirt 1.3.3 (already available in openSUSE Tumbleweed).

• On Ubuntu distros SELinux is enforced by qemu even if it is disabled globally, this might cause unexpected Could not open '/var/lib/libvirt/images/<FILE_NAME>': Permission denied errors. Double check that security_driver = "none" is uncommented in /etc/libvirt/qemu.conf and issue sudo systemctl restart libvirt-bin to restart the daemon.

Author

• Duncan Mac-Vicar P. [email protected]

The structure and boilerplate is inspired from the Softlayer and Google Terraform provider sources.

License

• Apache 2.0, See LICENSE file