mirrors/terraform-provider-proxmox
0
0
Fork 0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-07-04 21:14:05 +00:00
Code
08e389dac8
terraform-provider-proxmox/README.md
Dan Petersen 08e389dac8 Continued work on VM resource
2019-12-27 19:13:40 +01:00

395 lines
15 KiB
Markdown
Raw Blame History

[![Build Status](https://api.travis-ci.com/danitso/terraform-provider-proxmox.svg?branch=master)](https://travis-ci.com/danitso/terraform-provider-proxmox)
# Terraform Provider for Proxmox
A Terraform Provider which adds support for Proxmox solutions.
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) 0.11+
- [Go](https://golang.org/doc/install) 1.13 (to build the provider plugin)
## Table of contents
- [Building the Provider](#building-the-provider)
- [Using the Provider](#using-the-provider)
- [Configuration](#configuration)
- [Arguments](#arguments)
- [Environment variables](#environment-variables)
- [Data Sources](#data-sources)
- [Datastores](#datastores-proxmox_virtual_environment_datastores)
- [Group](#group-proxmox_virtual_environment_group)
- [Groups](#groups-proxmox_virtual_environment_groups)
- [Nodes](#nodes-proxmox_virtual_environment_nodes)
- [Pool](#pool-proxmox_virtual_environment_pool)
- [Pools](#pools-proxmox_virtual_environment_pools)
- [Role](#role-proxmox_virtual_environment_role)
- [Roles](#roles-proxmox_virtual_environment_roles)
- [User](#user-proxmox_virtual_environment_user)
- [Users](#users-proxmox_virtual_environment_users)
- [Version](#version-proxmox_virtual_environment_version)
- [Resources](#resources)
- [File](#file-proxmox_virtual_environment_file)
- [Group](#group-proxmox_virtual_environment_group-1)
- [Pool](#pool-proxmox_virtual_environment_pool-1)
- [Role](#role-proxmox_virtual_environment_role-1)
- [User](#user-proxmox_virtual_environment_user-1)
- [VM](#vm-proxmox_virtual_environment_vm)
- [Developing the Provider](#developing-the-provider)
- [Testing the Provider](#testing-the-provider)
## Building the Provider
Clone repository to: `$GOPATH/src/github.com/danitso/terraform-provider-proxmox`
```sh
$ 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
```sh
$ 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.](https://www.terraform.io/docs/plugins/basics.html#installing-plugins) 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
#### Environment variables
You can set up the provider by passing environment variables instead of specifying arguments.
* `PROXMOX_VE_ENDPOINT` or `PM_VE_ENDPOINT` - The endpoint for the Proxmox Virtual Environment API
* `PROXMOX_VE_INSECURE` or `PM_VE_INSECURE` - Whether to skip the TLS verification step
* `PROXMOX_VE_PASSWORD` or `PM_VE_PASSWORD` - The password for the Proxmox Virtual Environment API
* `PROXMOX_VE_USERNAME` or `PM_VE_USERNAME` - The username for the Proxmox Virtual Environment API
```hcl
provider "proxmox" {
virtual_environment {}
}
```
##### Usage
```sh
$ export PROXMOX_VE_ENDPOINT="https://hostname:8006"
$ export PROXMOX_VE_INSECURE="true"
$ export PROXMOX_VE_PASSWORD="a-strong-password"
$ export PROXMOX_VE_USERNAME="username@realm"
$ terraform plan
```
You can omit `PROXMOX_VE_INSECURE`, if the Proxmox Virtual Environment API is exposing a certificate trusted by your operating system.
### Data Sources
#### Virtual Environment
##### Datastores (proxmox_virtual_environment_datastores)
###### Arguments
* `node_name` - (Required) A node name
###### Attributes
* `active` - Whether the datastore is active
* `content_types` - The allowed content types
* `datastore_ids` - The datastore ids
* `enabled` - Whether the datastore is enabled
* `shared` - Whether the datastore is shared
* `space_available` - The available space in bytes
* `space_total` - The total space in bytes
* `space_used` - The used space in bytes
* `types` - The storage types
##### Group (proxmox_virtual_environment_group)
###### Arguments
* `group_id` - (Required) The group id
###### Attributes
* `acl` - The access control list
* `path` - The path
* `propagate` - Whether to propagate to child paths
* `role_id` - The role id
* `comment` - The group comment
* `members` - The group members as a list with `username@realm` entries
##### Groups (proxmox_virtual_environment_groups)
###### Arguments
This data source doesn't accept arguments.
###### Attributes
* `comments` - The group comments
* `group_ids` - The group ids
##### Nodes (proxmox_virtual_environment_nodes)
###### Arguments
This data source doesn't accept arguments.
###### Attributes
* `cpu_count` - The CPU count for each node
* `cpu_utilization` - The CPU utilization on each node
* `memory_available` - The memory available on each node
* `memory_used` - The memory used on each node
* `names` - The node names
* `online` - Whether a node is online
* `ssl_fingerprints` - The SSL fingerprint for each node
* `support_levels` - The support level for each node
* `uptime` - The uptime in seconds for each node
##### Pool (proxmox_virtual_environment_pool)
###### Arguments
* `pool_id` - (Required) The pool id
###### Attributes
* `comment` - The pool comment
* `members` - The pool members
* `datastore_id` - The datastore id
* `id` - The member id
* `node_name` - The node name
* `type` - The member type
* `vm_id` - The virtual machine id
##### Pools (proxmox_virtual_environment_pools)
###### Arguments
This data source doesn't accept arguments.
###### Attributes
* `pool_ids` - The pool ids
##### Role (proxmox_virtual_environment_role)
###### Arguments
* `role_id` - (Required) The role id
###### Attributes
* `privileges` - The role privileges
##### Roles (proxmox_virtual_environment_roles)
###### Arguments
This data source doesn't accept arguments.
###### Attributes
* `privileges` - The role privileges
* `role_ids` - The role ids
* `special` - Whether the role is special (built-in)
##### User (proxmox_virtual_environment_user)
###### Arguments
* `user_id` - (Required) The user id.
###### Attributes
* `acl` - The access control list
* `path` - The path
* `propagate` - Whether to propagate to child paths
* `role_id` - The role id
* `comment` - The user comment
* `email` - The user's email address
* `enabled` - Whether the user account is enabled
* `expiration_date` - The user account's expiration date (RFC 3339)
* `first_name` - The user's first name
* `groups` - The user's groups
* `keys` - The user's keys
* `last_name` - The user's last name
##### Users (proxmox_virtual_environment_users)
###### Arguments
This data source doesn't accept arguments.
###### Attributes
* `comments` - The user comments
* `emails` - The users' email addresses
* `enabled` - Whether a user account is enabled
* `expiration_dates` - The user accounts' expiration dates (RFC 3339)
* `first_names` - The users' first names
* `groups` - The users' groups
* `keys` - The users' keys
* `last_names` - The users' last names
* `user_ids` - The user ids
##### Version (proxmox_virtual_environment_version)
###### Arguments
This data source doesn't accept arguments.
###### Attributes
* `keyboard_layout` - The keyboard layout
* `release` - The release number
* `repository_id` - The repository id
* `version` - The version string
### Resources
#### Virtual Environment
##### File (proxmox_virtual_environment_file)
###### Arguments
* `content_type` - (Optional) The content type (`backup`, `images`, `iso` or `vztmpl`)
* `datastore_id` - (Required) The datastore id
* `node_name` - (Required) The node name
* `override_file_name` - (Optional) The file name to use instead of the source file name
* `source` - (Required) A path to a local file or a URL
* `source_checksum` - (Optional) The SHA256 checksum of the source file
* `source_insecure` - (Optional) Whether to skip the TLS verification step for HTTPS sources (defaults to `false`)
###### Attributes
* `file_modification_date` - The file modification date (RFC 3339)
* `file_name` - The file name
* `file_size` - The file size in bytes
* `file_tag` - The file tag
##### Group (proxmox_virtual_environment_group)
###### Arguments
* `acl` - (Optional) The access control list (multiple blocks supported)
* `path` - The path
* `propagate` - Whether to propagate to child paths
* `role_id` - The role id
* `comment` - (Optional) The group comment
* `group_id` - (Required) The group id
###### Attributes
* `members` - The group members as a list with `username@realm` entries
##### Pool (proxmox_virtual_environment_pool)
###### Arguments
* `comment` - (Optional) The pool comment
* `pool_id` - (Required) The pool id
###### Attributes
* `members` - The pool members
* `datastore_id` - The datastore id
* `id` - The member id
* `node_name` - The node name
* `type` - The member type
* `vm_id` - The virtual machine id
##### Role (proxmox_virtual_environment_role)
###### Arguments
* `privileges` - (Required) The role privileges
* `role_id` - (Required) The role id
###### Attributes
This resource doesn't expose any additional attributes.
##### User (proxmox_virtual_environment_user)
###### Arguments
* `acl` - (Optional) The access control list (multiple blocks supported)
* `path` - The path
* `propagate` - Whether to propagate to child paths
* `role_id` - The role id
* `comment` - (Optional) The user comment
* `email` - (Optional) The user's email address
* `enabled` - (Optional) Whether the user account is enabled
* `expiration_date` - (Optional) The user account's expiration date (RFC 3339)
* `first_name` - (Optional) The user's first name
* `groups` - (Optional) The user's groups
* `keys` - (Optional) The user's keys
* `last_name` - (Optional) The user's last name
* `password` - (Required) The user's password
* `user_id` - (Required) The user id
###### Attributes
This resource doesn't expose any additional attributes.
##### VM (proxmox_virtual_environment_vm)
###### Arguments
* `agent` - (Optional) The QEMU agent configuration
* `enabled` - (Optional) Whether to enable the QEMU agent (defaults to `false`)
* `trim` - (Optional) Whether to enable the FSTRIM feature in the QEMU agent (defaults to `false`)
* `type` - (Optional) The QEMU agent interface type (defaults to `virtio`)
* `cdrom` - (Optional) The CDROM configuration
* `enabled` - (Optional) Whether to enable the CDROM drive (defaults to `false`)
* `file_id` - (Optional) A file ID for an ISO file (defaults to `cdrom` as in the physical drive)
* `cloud_init` - (Optional) The cloud-init configuration (conflicts with `cdrom`)
* `dns` - (Optional) The DNS configuration
* `domain` - (Optional) The DNS search domain
* `server` - (Optional) The DNS server
* `ip_config` - (Optional) The IP configuration (one block per network device)
* `ipv4` - (Optional) The IPv4 configuration
* `address` - (Optional) The IPv4 address (use `dhcp` for autodiscovery)
* `gateway` - (Optional) The IPv4 gateway (must be omitted when `dhcp` is used as the address)
* `ipv6` - (Optional) The IPv4 configuration
* `address` - (Optional) The IPv6 address (use `dhcp` for autodiscovery)
* `gateway` - (Optional) The IPv6 gateway (must be omitted when `dhcp` is used as the address)
* `user_account` - (Required) The user account configuration
* `keys` - (Required) The SSH keys
* `username` - (Required) The SSH username
* `cpu` - (Optional) The CPU configuration
* `cores` - (Optional) The number of CPU cores (defaults to `1`)
* `hotplugged` - (Optional) The number of hotplugged vCPUs (defaults to `0`)
* `sockets` - (Optional) The number of CPU sockets (defaults to `1`)
* `description` - (Optional) The description
* `disk` - (Optional) The disk configuration (multiple blocks supported)
* `datastore_id` - (Optional) The ID of the datastore to create the disk in (defaults to `local-lvm`)
* `enabled` - (Optional) Whether to enable the disk (defaults to `true`)
* `file_format` - (Optional) The file format (defaults to `qcow2`)
* `file_id` - (Optional) The file ID for a disk image
* `size` - (Optional) The disk size in gigabytes (defaults to `8`)
* `keyboard_layout` - (Optional) The keyboard layout (defaults to `en-us`)
* `memory` - (Optional) The memory configuration
* `dedicated` - (Optional) The dedicated memory in megabytes (defaults to `512`)
* `floating` - (Optional) The floating memory in megabytes (defaults to `0`)
* `shared` - (Optional) The shared memory in megabytes (defaults to `0`)
* `name` - (Optional) The name
* `network_device` - (Optional) The network device configuration (multiple blocks supported)
* `bridge` - (Optional) The name of the network bridge (defaults to `vmbr0`)
* `enabled` - (Optional) Whether to enable the network device (defaults to `true`)
* `mac_address` - (Optional) The MAC address
* `model` - (Optional) The network device model (defaults to `virtio`)
* `vlan_id` - (Optional) The VLAN identifier
* `node_name` - (Required) The name of the node to assign the virtual machine to
* `os_type` - (Optional) The OS type (defaults to `other`)
* `pool_id` - (Optional) The ID of a pool to assign the virtual machine to
* `vm_id` - (Optional) The ID
###### Attributes
This resource doesn't expose any additional attributes.
## Developing the Provider
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.13+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#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.
```sh
$ 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`.
```sh
$ make test
```
Tests are limited to regression tests, ensuring backwards compability.
View Git Blame Copy Permalink