Terraform Provider for Proxmox

A Terraform Provider which adds support for Proxmox solutions.

Requirements

• Terraform 0.11+
• Go 1.12 (to build the provider plugin)

Building the Provider

Clone repository to: $GOPATH/src/github.com/danitso/terraform-provider-proxmox

$ mkdir -p $GOPATH/src/github.com/danitso; cd $GOPATH/src/github.com/danitso
$ git clone git@github.com:danitso/terraform-provider-proxmox

Enter the provider directory, initialize and build the provider

$ cd $GOPATH/src/github.com/danitso/terraform-provider-proxmox
$ make init
$ make build

Using the Provider

If you're building the provider, follow the instructions to install it as a plugin. After placing it into your plugins directory, run terraform init to initialize it.

Configuration

Arguments

• virtual_environment - (Optional) This is the configuration block for the Proxmox Virtual Environment.
  • endpoint - (Required) The endpoint for the Proxmox Virtual Environment API.
  • insecure - (Optional) Whether to skip the TLS verification step. Defaults to false.
  • password - (Required) The password for the Proxmox Virtual Environment API.
  • username - (Required) The username for the Proxmox Virtual Environment API.

Data Sources

Virtual Environment

Access Group (proxmox_virtual_environment_access_group)

Arguments

• id - (Required) The group id.

Attributes

• comment - The group comment.
• members - The group members as a list with username@realm entries.

Access Groups (proxmox_virtual_environment_access_groups)

Arguments

This data source doesn't accept arguments.

Attributes

• comments - The group comments.
• ids - The group ids.

Version (proxmox_virtual_environment_version)

Arguments

This data source doesn't accept arguments.

Attributes

• keyboard - The keyboard layout.
• release - The release number.
• repository_id - The repository id.
• version - The version string.

Resources

Virtual Environment

Access Group (proxmox_virtual_environment_access_group)

Arguments

• comment - (Optional) The group comment.
• group_id - (Required) The group id.

Attributes

• members - The group members as a list with username@realm entries.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.12+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make build
...
$ $GOPATH/bin/terraform-provider-proxmox
...

If you wish to contribute to the provider, the following requirements must be met,

• All tests must pass using make test
• The Go code must be formatted using Gofmt
• Dependencies are installed by make init

Testing the Provider

In order to test the provider, you can simply run make test.

$ make test

Tests are limited to regression tests, ensuring backwards compability.