Terraform provider plugin for proxmox
Branch: master
Clone or download
ggongaware Merge pull request #36 from jereksel/either_clone_or_iso
Show message when neither clone nor iso is set
Latest commit 17bf67c Jan 14, 2019

README.md

Proxmox 4 Terraform

Terraform provider plugin for proxmox

Working prototype

Go Install

go install github.com/Telmate/terraform-provider-proxmox/cmd/terraform-provider-proxmox
go install github.com/Telmate/terraform-provider-proxmox/cmd/terraform-provisioner-proxmox

Note: this plugin is both a provider and provisioner in one, which is why it needs two install commands.

Build local source

Requires https://github.com/Telmate/proxmox-api-go

go get github.com/Telmate/proxmox-api-go
make

make install

Recommended ISO builder https://github.com/Telmate/terraform-ubuntu-proxmox-iso

Run

terraform apply

Sample file

main.tf:

provider "proxmox" {
	pm_tls_insecure = true
}

/* Uses cloud-init options from Proxmox 5.2 */
resource "proxmox_vm_qemu" "cloudinit-test" {
	name = "tftest1.xyz.com"
	desc = "tf description"
	target_node = "proxmox1-xx"

	clone = "ci-ubuntu-template"
	storage = "local"
	cores = 3
	sockets = 1
	memory = 2560
	disk_gb = 4
	nic = "virtio"
	bridge = "vmbr0"

	ssh_user = "root"
	ssh_private_key = <<EOF
-----BEGIN RSA PRIVATE KEY-----
private ssh key root
-----END RSA PRIVATE KEY-----
EOF

	os_type = "cloud-init"
	ipconfig0 = "ip=10.0.2.99, gw=10.0.2.2"

	sshkeys = <<EOF
ssh-rsa AAAAB3NzaC1kj...key1
ssh-rsa AAAAB3NzaC1kj...key2
EOF

	provisioner "remote-exec" {
		inline = [
			"ip a"
		]
	}
}

/* Uses custom eth1 user-net SSH portforward */
resource "proxmox_vm_qemu" "prepprovision-test" {
	name = "tftest1.xyz.com"
	desc = "tf description"
	target_node = "proxmox1-xx"

	clone = "terraform-ubuntu1404-template"
	cores = 3
	sockets = 1
	memory = 2560
	network {
		id = 0
		model = "virtio"
	}
	network {
		id = 1
		model = "virtio"
		bridge = "vmbr1"
	}
	disk {
		id = 0
		type = virtio
		storage = local-lvm
		storage_type = lvm
		size = 4G
		backup = true
	}
	preprovision = true
	ssh_forward_ip = "10.0.0.1"
	ssh_user = "terraform"
	ssh_private_key = <<EOF
-----BEGIN RSA PRIVATE KEY-----
private ssh key terraform
-----END RSA PRIVATE KEY-----
EOF

	os_type = "ubuntu"
	os_network_config = <<EOF
auto eth0
iface eth0 inet dhcp
EOF

	provisioner "remote-exec" {
		inline = [
			"ip a"
		]
	}

	provisioner "proxmox" {
		action = "sshbackward"
	}
}

Provider usage

You can start from either an ISO or clone an existing VM.

Optimally, you could create a VM resource you will use a clone base with an ISO, and make the rest of the VM resources depend on that base "template" and clone it.

Interesting parameters: preprovision - to enable or disable internal pre-provisioning (e.g. if you already have another way to provision VMs). Conflicts with: ssh_forward_ip, ssh_user, ssh_private_key, os_type, os_network_config. os_type -

ssh_forward_ip - should be the IP or hostname of the target node or bridge IP. This is where proxmox will create a port forward to your VM with via a user_net. (for pre-cloud-init provisioning)

Cloud-Init

Cloud-init VMs must be cloned from a cloud-init ready template. See: https://pve.proxmox.com/wiki/Cloud-Init_Support

  • ciuser - User name to change ssh keys and password for instead of the image’s configured default user.
  • cipassword - Password to assign the user.
  • searchdomain - Sets DNS search domains for a container.
  • nameserver - Sets DNS server IP address for a container.
  • sshkeys - public ssh keys, one per line
  • ipconfig0 - [gw=] [,gw6=] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]
  • ipconfig1 - optional, same as ipconfig0 format

Preprovision (internal alternative to Cloud-Init)

There is a pre-provision phase which is used to set a hostname, intialize eth0, and resize the VM disk to available space. This is done over SSH with the ssh_forward_ip, ssh_user and ssh_private_key.

Disk resize is done if the file /etc/auto_resize_vda.sh exists. Source: https://github.com/Telmate/terraform-ubuntu-proxmox-iso/blob/master/auto_resize_vda.sh

Provisioner usage

Remove the temporary net1 adapter. Inside the VM this usually triggers the routes back to the provisioning machine on net0.

	provisioner "proxmox" {
		action = "sshbackward"
	}

Replace the temporary net1 adapter with a new persistent net1.

	provisioner "proxmox" {
		action = "reconnect"
		net1 = "virtio,bridge=vmbr0,tag=99"
	}

If net1 needs a config other than DHCP you should prior to this use provisioner "remote-exec" to modify the network config.