Skip to content

Latest commit

 

History

History
141 lines (86 loc) · 4.01 KB

README.md

File metadata and controls

141 lines (86 loc) · 4.01 KB
Raw

simple_libvirt

Creates a bunch of virtual machines via libvirt. It makes use of https://registry.terraform.io/providers/dmacvicar/libvirt/latest/docs.

Example Usage

module "simple_libvirt" {

  # Path to the module.
  source = "git::https://github.com/scmschmidt/simple_deployment.git//modules/simple_libvirt"
  
  # URI to libvirtd and used subnet.
  location = qemu:///system"
  subnet   = "172.31.0.0/16"
  
  # The name prefix for our resources.
  name = "sschmidt-spielwiese"

  # Map of the machines to create. Each machine has a unique id with a tuple of 'size' and 'image'.
  machines = {
    1    = ["micro", "sles_15"],
    2    = ["micro", "sles_15.1"],
    "3a" = ["micro", "sles_15.1"],
    "3b" = ["micro", "sles_15.2"],
    4    = ["micro", "sles_15.3"]
  }

  # We need a German keyboard.
  keymap = "de-latin1-nodeadkeys"

  # Our logon user with SSH public key.
  admin_user = "enter"
  admin_user_key = "ssh-rsa ..." 

  # Server and key to register the SLES.
  subscription_registration_key = "INTERNAL-USE-ONLY-46a45tcd5654f54"
  registration_server = "https://scc.suse.com"

  # We also want to logon as root.
  enable_root_login = true
}

Argument Reference

The following arguments are supported:

  • source (mandatory)

    Points to the module directory either local (relative to the project folder or remote (GitHub). See https://www.terraform.io/language/modules/sources for details.

  • location (optional)

    URI to access libvirt. Default: qemu:///system

  • subnet (optional)

    Network for libvirt network.

    Default: 172.31.0.0/16

  • name (mandatory)

    Name of the environment. It is used throughout the installation as prefix for the resources.

  • machines (mandatory)

    Map with unique id as key and tuples with the size and image data for the instance: [size, image] as data.

    Id is used as an identifier for various resources. The machine name is a catenation of name and id. Take care, that the key is unique! Terraform will always take silently the last hit. "Renaming" of machines can lead to strange effects and might brake your environment!

    Size is an identifier to select the sizing for the virtual machine. The identifiers must be provided by the file sizing_libvirt.yaml in the project root directory, which must contain the identifiers you want to use, which contains sizing for vcpu, memory and disk.

    An example can be found in the modules directory.

    Image is an identifier to select the correct qcow image for the virtual machine. The identifiers and the images must be provided by the file images_libvirt.yaml, which must contain the identifiers you want to use, which point to the qcow image.

    An example can be found in the modules directory.

    Having a mapping allows the usage of the same identifier with all three modules. The mapping resolves them into the correct names for AWS, Azure and libvirt.

  • keymap (optional)

    The keymap used on the machines.

    Default: de-latin1-nodeadkeys

  • admin_user (optional)

    The unprivileged user to logon to the deployed machine.

    Default: enter

  • admin_user_key (mandatory)

    The SSH public key for the admin user to logon to the machine.

  • subscription_registration_key (optional)

    Subscription registration code to register SLES.

    Default: "-"

  • registration_server (optional)

    URL to the registration server. A "-" as value skips the registration.

    Default: https://scc.suse.com

  • enable_root_login (optional)

    Enable or disable the SSH root login (with admin user key).

Output

The module outputs the following variables:

  • machines (list)

    The libvirt_domain data for each domain.

  • machine_info (object)

    Aggregated information for each virtual machine. The machine names get used as keys and the value is an object with:

    • id - The instance id.
    • size - The sizing identifier used in the plan.
    • image - The image identifier used in the plan.
    • ip_address - The (first) IP (of the first interface) for the machine.