Merge pull request #21 from MonolithProjects/feat/templating

Feat/templating

Author: MonolithProjects

.gitignore

@@ -1 +1,2 @@
 tests
+.terraform*

README.md

@@ -6,7 +6,7 @@
 
 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 this module provides
+## What it provides
 
 - creates one or more VMs
 - one NIC per domain, connected to the network using the **bridge interface**
@@ -17,15 +17,16 @@ Terraform module for KVM/Libvirt Virtual Machine. This module will create a KVM
 
 ## Tested on
 
-- Ubuntu 20.04 TLS
+- Ubuntu 20.04 TLS Cloud Image
+- Ubuntu 22.04 TLS Cloud Image
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
-| <a name="requirement_libvirt"></a> [libvirt](#requirement\_libvirt) | >=0.6.9 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_libvirt"></a> [libvirt](#requirement\_libvirt) | >= 0.7.0 |
 
 ## Modules
 
@@ -39,40 +40,38 @@ No modules.
 | [libvirt_domain.virt-machine](https://registry.terraform.io/providers/dmacvicar/libvirt/latest/docs/resources/domain) | resource |
 | [libvirt_volume.base-volume-qcow2](https://registry.terraform.io/providers/dmacvicar/libvirt/latest/docs/resources/volume) | resource |
 | [libvirt_volume.volume-qcow2](https://registry.terraform.io/providers/dmacvicar/libvirt/latest/docs/resources/volume) | resource |
-| [cloudinit_config.init_config](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/cloudinit_config) | data source |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_additional_disk_ids"></a> [additional\_disk\_ids](#input\_additional\_disk\_ids) | List of volume ids | `list` | `[]` | no |
+| <a name="input_additional_disk_ids"></a> [additional\_disk\_ids](#input\_additional\_disk\_ids) | List of volume ids | `list(string)` | `[]` | no |
 | <a name="input_autostart"></a> [autostart](#input\_autostart) | Autostart the domain | `bool` | `true` | no |
-| <a name="input_base_pool_name"></a> [base\_pool\_name](#input\_base\_pool\_name) | Name of base OS image | `any` | `null` | no |
-| <a name="input_base_volume_name"></a> [base\_volume\_name](#input\_base\_volume\_name) | Name of base OS image | `any` | `null` | no |
+| <a name="input_base_pool_name"></a> [base\_pool\_name](#input\_base\_pool\_name) | Name of base OS image | `string` | `null` | no |
+| <a name="input_base_volume_name"></a> [base\_volume\_name](#input\_base\_volume\_name) | Name of base OS image | `string` | `null` | no |
 | <a name="input_bridge"></a> [bridge](#input\_bridge) | Bridge interface | `string` | `"virbr0"` | no |
 | <a name="input_cpu_mode"></a> [cpu\_mode](#input\_cpu\_mode) | CPU mode | `string` | `"host-passthrough"` | no |
 | <a name="input_dhcp"></a> [dhcp](#input\_dhcp) | Use DHCP or Static IP settings | `bool` | `false` | no |
-| <a name="input_hostname"></a> [hostname](#input\_hostname) | VM hostname or FQDN | `string` | `"server"` | no |
 | <a name="input_index_start"></a> [index\_start](#input\_index\_start) | From where the indexig start | `number` | `1` | no |
 | <a name="input_ip_address"></a> [ip\_address](#input\_ip\_address) | List of IP addresses | `list(string)` | <pre>[<br>  "192.168.123.101"<br>]</pre> | no |
 | <a name="input_ip_gateway"></a> [ip\_gateway](#input\_ip\_gateway) | IP addresses of a gateway | `string` | `"192.168.123.1"` | no |
 | <a name="input_ip_nameserver"></a> [ip\_nameserver](#input\_ip\_nameserver) | IP addresses of a nameserver | `string` | `"192.168.123.1"` | no |
 | <a name="input_local_admin"></a> [local\_admin](#input\_local\_admin) | Admin user without ssh access | `string` | `""` | no |
 | <a name="input_local_admin_passwd"></a> [local\_admin\_passwd](#input\_local\_admin\_passwd) | Local admin user password | `string` | `"password_example"` | no |
 | <a name="input_memory"></a> [memory](#input\_memory) | RAM in MB | `string` | `"1024"` | no |
-| <a name="input_os_img_url"></a> [os\_img\_url](#input\_os\_img\_url) | URL to the OS image | `string` | `"https://cloud-images.ubuntu.com/focal/current/focal-server-cloudimg-amd64.img"` | no |
+| <a name="input_os_img_url"></a> [os\_img\_url](#input\_os\_img\_url) | URL to the OS image | `string` | `"https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64.img"` | no |
 | <a name="input_pool"></a> [pool](#input\_pool) | Storage pool name | `string` | `"default"` | no |
 | <a name="input_runcmd"></a> [runcmd](#input\_runcmd) | Extra commands to be run with cloud init | `list(string)` | <pre>[<br>  "[ systemctl, daemon-reload ]",<br>  "[ systemctl, enable, qemu-guest-agent ]",<br>  "[ systemctl, start, qemu-guest-agent ]",<br>  "[ systemctl, restart, systemd-networkd ]"<br>]</pre> | no |
 | <a name="input_share_filesystem"></a> [share\_filesystem](#input\_share\_filesystem) | n/a | <pre>object({<br>    source   = string<br>    target   = string<br>    readonly = bool<br>    mode     = string<br>  })</pre> | <pre>{<br>  "mode": null,<br>  "readonly": false,<br>  "source": null,<br>  "target": null<br>}</pre> | no |
 | <a name="input_ssh_admin"></a> [ssh\_admin](#input\_ssh\_admin) | Admin user with ssh access | `string` | `"ssh-admin"` | no |
 | <a name="input_ssh_keys"></a> [ssh\_keys](#input\_ssh\_keys) | List of public ssh keys | `list(string)` | `[]` | no |
-| <a name="input_ssh_private_key"></a> [ssh\_private\_key](#input\_ssh\_private\_key) | Private key for SSH connection test | `any` | `null` | no |
+| <a name="input_ssh_private_key"></a> [ssh\_private\_key](#input\_ssh\_private\_key) | Private key for SSH connection test | `string` | `null` | no |
 | <a name="input_system_volume"></a> [system\_volume](#input\_system\_volume) | System Volume size (GB) | `number` | `10` | no |
 | <a name="input_time_zone"></a> [time\_zone](#input\_time\_zone) | Time Zone | `string` | `"UTC"` | no |
 | <a name="input_vcpu"></a> [vcpu](#input\_vcpu) | Number of vCPUs | `number` | `1` | no |
 | <a name="input_vm_count"></a> [vm\_count](#input\_vm\_count) | Number of VMs | `number` | `1` | no |
 | <a name="input_vm_hostname_prefix"></a> [vm\_hostname\_prefix](#input\_vm\_hostname\_prefix) | VM hostname prefix | `string` | `"vm"` | no |
-| <a name="input_xml_override"></a> [xml\_override](#input\_xml\_override) | With these variables you can: Enable hugepages; Set USB controllers; Attach USB devices | `any` | <pre>{<br>  "hugepages": false,<br>  "usb_controllers": [<br>    {<br>      "model": "piix3-uhci"<br>    }<br>  ],<br>  "usb_devices": []<br>}</pre> | no |
+| <a name="input_xml_override"></a> [xml\_override](#input\_xml\_override) | With these variables you can: Enable hugepages; Set USB controllers; Attach USB devices | <pre>object({<br>    hugepages = bool<br>    usb_controllers = list(object({<br>      model = string<br>    }))<br>    usb_devices = list(object({<br>      vendor  = string<br>      product = string<br>    }))<br>  })</pre> | <pre>{<br>  "hugepages": false,<br>  "usb_controllers": [<br>    {<br>      "model": "piix3-uhci"<br>    }<br>  ],<br>  "usb_devices": []<br>}</pre> | no |
 
 ## Outputs
 

cloud_init.tf

@@ -0,0 +1,25 @@
+provider "libvirt" {
+  uri = "qemu:///system"
+}
+
+module "test_nodes" {
+  source             = "../../"
+  vm_hostname_prefix = "test"
+  autostart          = false
+  vm_count           = 2
+  index_start        = 1
+  memory             = "512"
+  vcpu               = 1
+  system_volume      = 20
+  ssh_admin          = "admin"
+  ssh_private_key    = "~/.ssh/your_key_id_ed25519"
+  ssh_keys = [
+    "ssh-ed25519 somethingSOMETHING your_key",
+  ]
+  local_admin        = "localadmin"
+  local_admin_passwd = "<yout password hash (mkpasswd --method=SHA-512 --rounds=4096)>"
+}
+
+output "output_data" {
+  value = module.test_nodes
+}

examples/basic/main.tf

@@ -0,0 +1,9 @@
+terraform {
+  required_version = ">= 1.0"
+  required_providers {
+    libvirt = {
+      source  = "dmacvicar/libvirt"
+      version = ">= 0.7.0"
+    }
+  }
+}

examples/basic/versions.tf

@@ -0,0 +1,14 @@
+locals {
+  all_keys = <<EOT
+[
+%{~for keys in var.ssh_keys~}
+"${keys}",
+%{~endfor~}
+]
+EOT
+  runcmd   = <<EOT
+%{for cmd in var.runcmd~}
+  - ${cmd}
+%{endfor~}
+EOT
+}

locals.tf

@@ -1,9 +1,9 @@
 terraform {
-  required_version = ">= 0.13"
+  required_version = ">= 1.0"
   required_providers {
     libvirt = {
       source  = "dmacvicar/libvirt"
-      version = ">=0.6.9"
+      version = ">= 0.7.0"
     }
   }
 }
@@ -19,7 +19,7 @@ resource "libvirt_domain" "virt-machine" {
   autostart  = var.autostart
   qemu_agent = true
 
-  cloudinit = element(libvirt_cloudinit_disk.commoninit.*.id, count.index)
+  cloudinit = element(libvirt_cloudinit_disk.commoninit[*].id, count.index)
 
   network_interface {
     bridge         = var.bridge
@@ -44,7 +44,7 @@ resource "libvirt_domain" "virt-machine" {
   }
 
   disk {
-    volume_id = element(libvirt_volume.volume-qcow2.*.id, count.index)
+    volume_id = element(libvirt_volume.volume-qcow2[*].id, count.index)
   }
 
   dynamic "disk" {
@@ -78,7 +78,7 @@ resource "libvirt_domain" "virt-machine" {
     connection {
       type        = "ssh"
       user        = var.ssh_admin
-      host        = self.network_interface.0.addresses.0
+      host        = self.network_interface[0].addresses[0]
       private_key = var.ssh_private_key != null ? file(var.ssh_private_key) : null
       timeout     = "2m"
     }

main.tf

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

output.tf

@@ -19,9 +19,9 @@ resource "libvirt_volume" "volume-qcow2" {
 }
 
 resource "libvirt_cloudinit_disk" "commoninit" {
-  count          = var.vm_count
-  name           = format("${var.vm_hostname_prefix}_init%02d.iso", count.index + 1)
-  user_data      = templatefile(
+  count = var.vm_count
+  name  = format("${var.vm_hostname_prefix}_init%02d.iso", count.index + 1)
+  user_data = templatefile(
     "${path.module}/templates/cloud_init.tpl",
     {
       ssh_admin          = var.ssh_admin
@@ -43,5 +43,5 @@ resource "libvirt_cloudinit_disk" "commoninit" {
       # WA: If the shared filesystem is used, Libvirt connects Unclassified device to the 3rd position of PCI bus
     }
   )
-  pool           = var.pool
+  pool = var.pool
 }

storage.tf

@@ -32,36 +32,36 @@ users:
 write_files:
   - path: /etc/ssh/sshd_config
     content: |
-         Port 22
-         Protocol 2
-         HostKey /etc/ssh/ssh_host_rsa_key
-         HostKey /etc/ssh/ssh_host_dsa_key
-         HostKey /etc/ssh/ssh_host_ecdsa_key
-         HostKey /etc/ssh/ssh_host_ed25519_key
-         UsePrivilegeSeparation yes
-         KeyRegenerationInterval 3600
-         ServerKeyBits 1024
-         SyslogFacility AUTH
-         LogLevel INFO
-         LoginGraceTime 120
-         PermitRootLogin no
-         StrictModes yes
-         RSAAuthentication yes
-         PubkeyAuthentication yes
-         IgnoreRhosts yes
-         RhostsRSAAuthentication no
-         HostbasedAuthentication no
-         PermitEmptyPasswords no
-         ChallengeResponseAuthentication no
-         X11Forwarding yes
-         X11DisplayOffset 10
-         PrintMotd no
-         PrintLastLog yes
-         TCPKeepAlive yes
-         AcceptEnv LANG LC_*
-         Subsystem sftp /usr/lib/openssh/sftp-server
-         UsePAM yes
-         AllowUsers ${ssh_admin}
+        Port 22
+        Protocol 2
+        HostKey /etc/ssh/ssh_host_rsa_key
+        HostKey /etc/ssh/ssh_host_dsa_key
+        HostKey /etc/ssh/ssh_host_ecdsa_key
+        HostKey /etc/ssh/ssh_host_ed25519_key
+        UsePrivilegeSeparation yes
+        KeyRegenerationInterval 3600
+        ServerKeyBits 1024
+        SyslogFacility AUTH
+        LogLevel INFO
+        LoginGraceTime 120
+        PermitRootLogin no
+        StrictModes yes
+        RSAAuthentication yes
+        PubkeyAuthentication yes
+        IgnoreRhosts yes
+        RhostsRSAAuthentication no
+        HostbasedAuthentication no
+        PermitEmptyPasswords no
+        ChallengeResponseAuthentication no
+        X11Forwarding yes
+        X11DisplayOffset 10
+        PrintMotd no
+        PrintLastLog yes
+        TCPKeepAlive yes
+        AcceptEnv LANG LC_*
+        Subsystem sftp /usr/lib/openssh/sftp-server
+        UsePAM yes
+        AllowUsers ${ssh_admin}
 
 growpart:
     mode: auto

templates/cloud_init.tpl

@@ -8,3 +8,4 @@ ethernets:
        addresses:
         - ${ip_nameserver}
         - 8.8.8.8
+        - 1.1.1.1