terraform-provider-vsphere

README

terraform-provider-vsphere

Terraform Custom Provider for VMware vSphere

Description

This project is a terraform custom provider for VMware vSphere. This is work in progress. This current version only supports creation and deletion of virtual machine with VM template.

Requirement

• hashicorp/terraform
• vmware/govmomi

VM template specification

In this use case, please don't include network adapters in VM template. When deploying a new virtual machine, this provider adds new network adapters to the new virtual machine. Supported network adapter type in the current version is VMXNET 3 only.

Usage

Provider Configuration

vsphere

provider "vsphere" {
    user = "${var.vsphere_user}"
    password = "${var.vsphere_password}"
    vcenter_server = "${var.vsphere_vcenter}"
}

Argument Reference

The following arguments are supported.

• user - (Required) This is the user name to access to vCenter server.
• password - (Required) This is the password to access to vCenter server.
• vcenter_server - (Required) This is a target vCenter server, such as "vcenter.my.domain.com"

Resource Configuration

vsphere_virtual_machine

resource "vsphere_virtual_machine" "default" {
    name = "VM name"
    datacenter = "Datacenter name"
    cluster = "Cluster name"
    vcpu = 2
    memory = 4096
    disk {
        datastore = "Datastore name"
        template = "templates/centos-6.6-x86_64"
    }
    gateway = "Gateway ip address"
    network_interface {
        label = "Network label name"
        ip_address = "IP address"
        subnet_mask = "Subnet mask"
    }
}

Argument Reference

The following arguments are supported.

• name - (Required) Hostname of the virtual machine

• vcpu - (Required) A number of vCPUs

• memory - (Required) Memory size in MB.

• disk - (Required) Hard disk configuration. This can be specified multiple times for multiple disks. Structure is documented below.

• network_interface - (Required) Network configuration. This can be specified multiple times for multiple networks. Structure is documented below.

• datacenter - (Optional) Datacenter name

• cluster - (Optional) Cluster name, a cluster is a group of hosts.

• resource_pool - (Optional) Resource pool name.

• gateway - (Optional) Gateway IP address. If you use the static IP address, it's required.

• time_zone - (Optional) Time zone configuration. By default, it's "Etc/UTC".

• domain - (Optional) Domain configuration. By default, it's "vsphere.local".

• dns_suffix - (Optional) List of DNS suffix. By default, it's ["vsphere.local"].

• dns_server - (Optional) List of DNS server. By default, it's ["8.8.8.8", "8.8.4.4"].

Each network_interface supports the following:

• label - (Required) Network label name.
• ip_address - (Optional) IP address. DHCP configuration in default. If you use the static IP address, it's required.
• subnet_mask - (Optional) Subnet mask. If you use the static IP address, it's required.

The disk block supports the following:

For the first disk,

• template - (Optional) VM template name. If you want to deploy new VM from VM template, it's required. This argument is valid at the first disk. If not specified, empty disk will be created. For example, it's used for booting with iPXE.
• datastore - (Optional) Datastore name.
• size - (Optional) Size of hard disk in gigabytes. If not specified, it will inherit the size of the VM template. If template argument is not specified, it's required.
• iops - (Optional) IOPS number. By default, it's unlimited.

For the second and following disks,

• size - (Required) Size of hard disk in gigabytes.
• iops - (Optional) IOPS number. By default, it's unlimited.

For example

Example 1:

resource "vsphere_virtual_machine" "default" {
    name = "newvm-1"
    vcpu = 2
    memory = 4096
    disk {
        template = "centos-6.6-x86_64"
    }
    network_interface {
        label = "label-1"
    }
}

Example 2:

resource "vsphere_virtual_machine" "default" {
    name = "newvm-1"
    domain = "foo"
    datacenter = "datacenter-1"
    cluster = "cluster-1"
    vcpu = 2
    memory = 4096
    disk {
        datastore = "datastore-1"
        template = "centos-6.6-x86_64"
        iops = 500
    }
    disk {
        size = 20
        iops = 500
    }
    gateway = "192.168.0.254"
    network_interface {
        label = "label-1"
        ip_address = "192.168.0.1"
        subnet_mask = "255.255.255.0"
    }
    network_interface {
        label = "label-2"
    }
}

Example 3:

resource "vsphere_virtual_machine" "default" {
    name = "newvm-1"
    domain = "foo"
    datacenter = "datacenter-1"
    cluster = "cluster-1"
    vcpu = 2
    memory = 4096
    disk {
        datastore = "datastore-1"
        size = 10
        iops = 500
    }
    disk {
        size = 20
        iops = 500
    }
    network_interface {
        label = "label-1"
    }
    network_interface {
        label = "label-2"
    }
    time_zone = "Asia/Tokyo"
}

Contribution

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Licence

Mozilla Public License, version 2.0

Author

tkak