Update

Author: MonolithProjects

README.md

@@ -3,14 +3,16 @@
 [![GitHub Actions](https://github.com/MonolithProjects/terraform-libvirt-vm/workflows/Lint/badge.svg)](https://github.com/MonolithProjects/terraform-libvirt-vm/actions)
 [![License](https://img.shields.io/github/license/MonolithProjects/terraform-libvirt-vm)](https://github.com/MonolithProjects/terraform-libvirt-vm/blob/master/LICENSE)
 
-Terraform module for KVM/Libvirt Virtual Machine. This module will create a libvirt domain, storage pool, system volume and configure the VM using cloud_init. This module is using [dmacvicar/libvirt](https://github.com/dmacvicar/terraform-provider-libvirt) Terraform provider.
+Terraform module for KVM/Libvirt Virtual Machine. This module will create a KVM Virtual Machine(s), configure it using Cloud Init and test the ssh connection. This module is using [dmacvicar/libvirt](https://github.com/dmacvicar/terraform-provider-libvirt) Terraform provider.
 
 ## What the module provides
 
-- create one or more libvirt domains
-- create a storage pool
-- create a system volume from the pool
-- use cloud_init to configure VMs
+- create one or more VMs at once
+- libvirt domain(s) with one NIC connected to the network using the **bridge interface**
+- user can set number of vCPUs, RAM, system volume size
+- setup network interface using DHCP or static
+- cloud_init VM(s) configuration
+- test the ssh connection
 
 ## Parameters
 
@@ -22,22 +24,68 @@ Terraform module for KVM/Libvirt Virtual Machine. This module will create a libv
 |vm_hostname_prefix|VM hostname prefix|vm
 |memory|RAM in MB|512
 |vcpu|Number of vCPUs|1
+|pool|Storage pool name|default
 |system_volume|System Volume size (GB)|10
 |dhcp|Use DHCP or Static IP settings|false
-|ip_address|"List of IP addresses|[ "192.168.123.1" ]
-|ip_nameserver|IP addresses of a nameserver|192.168.123.1
-|ip_gateway|IP addresses of a gateway|192.168.123.1
+|ip_address|"List of static IP addresses|[ "192.168.123.1" ]
+|ip_nameserver|Static IP addresses of a nameserver|192.168.123.1
+|ip_gateway|Static IP addresses of a gateway|192.168.123.1
 |ssh_admin|Admin user with ssh access|ssh-admin
 |ssh_keys|List of public ssh keys| []
 |local_admin|Admin user without ssh access|local-admin
 |local_admin_passwd|Local admin user password|password_example
 |time_zone|Time Zone|UTC
-|ssh_private_key|Private key for SSH connection test|~/.ssh/deployer_keys/id_ed25519
-
-**Cloud_init** configuration can be found in `modules/virt-machine/templates`.
+|ssh_private_key|Private key for SSH connection test|~/.ssh/id_ed25519
 
 ## Example
 
+DHCP IP settings:
+
+```hcl
+terraform {
+  required_version = ">= 0.13"
+    required_providers {
+      libvirt = {
+        source  = "dmacvicar/libvirt"
+        version = "0.6.3"
+      }
+    }
+}
+
+provider "libvirt" {
+  uri = "qemu+ssh://[email protected]/system"
+}
+
+module "nodes" {
+  source      = "./modules/virt-machine"
+
+  vm_hostname_prefix = "server"
+  vm_count    = 3
+  memory      = "2048"
+  vcpu        = 1
+  pool        = terra_pool
+  system_volume = 20
+
+  dhcp        = true
+
+  local_admin = "local-admin"
+  ssh_admin   = "ci-user"
+  ssh_private_key = "~/.ssh/id_ed25519"
+  local_admin_passwd = "$6$rounds=4096$xxxxxxxxHASHEDxxxPASSWORD"
+  ssh_keys    = [ 
+    "ssh-ed25519 AAAAxxxxxxxxxxxxSSHxxxKEY example", 
+    ]
+  time_zone   = "CET"
+  os_img_url  = "file:///home/myuser/ubuntu-20.04-server-cloudimg-amd64.img"
+}
+
+output "ip_addresses" {
+  value = module.k3s_nodes
+}
+```
+
+Static IP settings:
+
 ```hcl
 terraform {
   required_version = ">= 0.13"
@@ -55,11 +103,14 @@ provider "libvirt" {
 
 module "nodes" {
   source      = "./modules/virt-machine"
+
   vm_hostname_prefix = "server"
   vm_count    = 3
   memory      = "2048"
   vcpu        = 1
+  pool        = terra_pool
   system_volume = 20
+
   dhcp        = false
   ip_address  = [ 
                   "192.168.165.151",
@@ -68,6 +119,7 @@ module "nodes" {
                 ]
   ip_gateway  = "192.168.165.254"
   ip_nameserver = "192.168.165.104"
+
   local_admin = "local-admin"
   ssh_admin   = "ci-user"
   ssh_private_key = "~/.ssh/id_ed25519"
@@ -79,6 +131,9 @@ module "nodes" {
   os_img_url  = "file:///home/myuser/ubuntu-20.04-server-cloudimg-amd64.img"
 }
 
+output "ip_addresses" {
+  value = module.k3s_nodes
+}
 ```
 
 ## License

modules/virt-machine/main.tf

@@ -9,18 +9,19 @@ terraform {
     }
 }
 
-
 resource "libvirt_domain" "virt-machine" {
   count  = var.vm_count
   name   = format("${var.vm_hostname_prefix}%02d", count.index + 1)
   memory = var.memory
   vcpu   = var.vcpu
+  autostart  = true
+  qemu_agent = true
 
   cloudinit = element(libvirt_cloudinit_disk.commoninit.*.id, count.index)
 
   network_interface {
-    bridge         = "br0"
-    wait_for_lease = false
+    bridge         = var.bridge
+    wait_for_lease = true
     hostname       = format("${var.vm_hostname_prefix}%02d", count.index + 1)
   }
 
@@ -48,15 +49,14 @@ resource "libvirt_domain" "virt-machine" {
 
   provisioner "remote-exec" {
     inline = [
-      "echo \"Virtual Machine is UP!\"",
-      "uptime",
+      "echo \"Virtual Machine \"$(hostname)\" is UP!\"",
       "date"
     ]
 
     connection {
       type                = "ssh"
       user                = var.ssh_admin
-      host                = var.ip_address[0]
+      host                = self.network_interface.0.addresses.0
       private_key         = file(var.ssh_private_key)
       timeout             = "2m"
     }

modules/virt-machine/output.tf

@@ -0,0 +1,3 @@
+output "ip_address" {
+  value = libvirt_domain.virt-machine.*.network_interface.0.addresses.0
+}

modules/virt-machine/storage.tf

@@ -1,20 +1,14 @@
-resource "libvirt_pool" "terra" {
-  name = "terratest"
-  type = "dir"
-  path = var.libvirt_disk_path
-}
-
 resource "libvirt_volume" "base-volume-qcow2" {
   name   = format("${var.vm_hostname_prefix}-base.qcow2")
-  pool   = libvirt_pool.terra.name
+  pool   = var.pool
   source = var.os_img_url
   format = "qcow2"
 }
 
 resource "libvirt_volume" "volume-qcow2" {
   count  = var.vm_count
   name   = format("${var.vm_hostname_prefix}%02d.qcow2", count.index + 1)
-  pool   = libvirt_pool.terra.name
+  pool   = var.pool
   size   = 1024*1024*1024*var.system_volume
   base_volume_id = libvirt_volume.base-volume-qcow2.id
   format = "qcow2"
@@ -25,5 +19,5 @@ resource "libvirt_cloudinit_disk" "commoninit" {
   name           = format("${var.vm_hostname_prefix}_init%2d.iso", count.index + 1)
   user_data      = data.template_cloudinit_config.init_config[count.index].rendered
   network_config = data.template_file.network_config[count.index].rendered
-  pool           = libvirt_pool.terra.name
+  pool           = var.pool
 }

modules/virt-machine/templates/cloud_init.tpl

@@ -3,8 +3,14 @@
 package_upgrade: false
 
 packages:
-  - python3
   - iotop
+  - python3
+  - qemu-guest-agent
+
+runcmd:
+  - [ systemctl, daemon-reload ]
+  - [ systemctl, enable, qemu-guest-agent ]
+  - [ systemctl, start, qemu-guest-agent ]
 
 fqdn: ${hostname}
 

modules/virt-machine/templates/network_config_dhcp.tpl

@@ -1,4 +1,4 @@
 version: 2
 ethernets:
   ens3:
-    dhcp4: dhcp
+    dhcp4: true

modules/virt-machine/variables.tf

@@ -35,6 +35,11 @@ variable "vcpu" {
   default = 1
 }
 
+variable "pool" {
+  description = "Storage pool name"
+  default = "default"
+}
+
 variable "system_volume" {
   description = "System Volume size (GB)"
   default = 10
@@ -46,6 +51,11 @@ variable "dhcp" {
   default     = false
 }
 
+variable "bridge" {
+  description = "Bridge interface"
+  default     = "br0"
+}
+
 variable "ip_address" {
   description = "List of IP addresses"
   type        = list(string)