Skip to content

zamrih/terraform-provider-proxmox

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Terraform Provider for Proxmox

Go Report Card GoDoc GitHub release (latest by date) GitHub Release Date GitHub stars All Contributors Conventional Commits Buy Me A Coffee

A Terraform Provider which adds support for Proxmox solutions.

This repository is a fork of https://github.com/danitso/terraform-provider-proxmox which is no longer maintained.

Compatibility promise

This provider is compatible with the latest version of Proxmox VE (currently 8.0). While it may work with older 7.x versions, it is not guaranteed to do so.

While provider is on version 0.x, it is not guaranteed to be backwards compatible with all previous minor versions. However, we will try to keep the backwards compatibility between provider versions as much as possible.

Requirements

  • Terraform 1.2+
  • Go 1.21 (to build the provider plugin)

Building the provider

  • Clone the repository to $GOPATH/src/github.com/bpg/terraform-provider-proxmox:

    mkdir -p "${GOPATH}/src/github.com/bpg"
    cd "${GOPATH}/src/github.com/bpg"
    git clone git@github.com:bpg/terraform-provider-proxmox
  • Enter the provider directory and build it:

    cd "${GOPATH}/src/github.com/bpg/terraform-provider-proxmox"
    make build

Using the provider

You can find the latest release and its documentation in the Terraform Registry.

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 compatibility.

Deploying the example resources

There are number of TF examples in the examples directory, which can be used to deploy a Container, VM, or other Proxmox resources on your test Proxmox cluster. The following assumptions are made about the test Proxmox cluster:

  • It has one node named pve
  • The node has local storages named local and local-lvm

Create examples/terraform.tfvars with the following variables:

virtual_environment_username = "root@pam"
virtual_environment_password = "put-your-password-here"
virtual_environment_endpoint = "https://<your-cluster-endpoint>:8006/"

Then run make example to deploy the example resources.

Future work

The provider is using the Terraform SDKv2, which is considered legacy and is in maintenance mode. The work has started to migrate the provider to the new Terraform Plugin Framework, with aim to release it as a new major version 1.0.

Known issues

Disk images cannot be imported by non-PAM accounts

Due to limitations in the Proxmox VE API, certain actions need to be performed using SSH. This requires the use of a PAM account (standard Linux account).

Disk images from VMware cannot be uploaded or imported

Proxmox VE is not currently supporting VMware disk images directly. However, you can still use them as disk images by using this workaround:

resource "proxmox_virtual_environment_file" "vmdk_disk_image" {
  content_type = "iso"
  datastore_id = "datastore-id"
  node_name    = "node-name"

  source_file {
    # We must override the file extension to bypass the validation code
    # in the Proxmox VE API.
    file_name = "vmdk-file-name.img"
    path      = "path-to-vmdk-file"
  }
}

resource "proxmox_virtual_environment_vm" "example" {
  //...

  disk {
    datastore_id = "datastore-id"
    # We must tell the provider that the file format is vmdk instead of qcow2.
    file_format  = "vmdk"
    file_id      = "${proxmox_virtual_environment_file.vmdk_disk_image.id}"
  }

  //...
}

Snippets cannot be uploaded by non-PAM accounts

Due to limitations in the Proxmox VE API, certain files need to be uploaded using SFTP. This requires the use of a PAM account (standard Linux account).

Contributors

Dan R. Petersen
Dan R. Petersen

๐Ÿ’ป
Pavel Boldyrev
Pavel Boldyrev

๐Ÿ’ป ๐Ÿšง
Lucas Hahn
Lucas Hahn

๐Ÿ’ป
Alex Kulikovskikh
Alex Kulikovskikh

๐Ÿ’ป
Oto Petล™รญk
Oto Petล™รญk

๐Ÿ’ป ๐Ÿ’ฌ ๐Ÿ›
Boik
Boik

๐Ÿ’ป
Abdelfadeel Farag
Abdelfadeel Farag

๐Ÿ’ป
Szczepan Wiล›niowski
Szczepan Wiล›niowski

๐Ÿ’ป
Fabian Heib
Fabian Heib

๐Ÿ’ป
kaje783
kaje783

๐Ÿ’ป
michalg91
michalg91

๐Ÿ’ป
Cameron
Cameron

๐Ÿ’ป
Chris Jones
Chris Jones

๐Ÿ’ป
Dominik Wombacher
Dominik Wombacher

๐Ÿ’ป
Frank Villaro-Dixon
Frank Villaro-Dixon

๐Ÿ’ป
Gertjan Roggemans
Gertjan Roggemans

๐Ÿ’ป
Henri Williams
Henri Williams

๐Ÿ’ป
Jordan Keith
Jordan Keith

๐Ÿ’ป
Kai Kahllund
Kai Kahllund

๐Ÿ’ป
Kevin
Kevin

๐Ÿ’ป
Krzysztof Magosa
Krzysztof Magosa

๐Ÿ’ป
Matt Burchett
Matt Burchett

๐Ÿ’ป
Moyiz
Moyiz

๐Ÿ’ป
Pablo Escobar Lopez
Pablo Escobar Lopez

๐Ÿ’ป
Leah
Leah

๐Ÿ’ป
Pascal Wiedenbeck
Pascal Wiedenbeck

๐Ÿ’ป
Patrick Collins
Patrick Collins

๐Ÿ’ป
Prajwal
Prajwal

๐Ÿ’ป
Rafaล‚ Safin
Rafaล‚ Safin

๐Ÿ’ป
Remko Molier
Remko Molier

๐Ÿ’ป
Tuomas Salmi
Tuomas Salmi

๐Ÿ’ป
ikiris
ikiris

๐Ÿ’ป
mleone87
mleone87

๐Ÿ’ป
Ryan Yin
Ryan Yin

๐Ÿ’ป
zoop
zoop

๐Ÿ’ป
Simon Smith
Simon Smith

๐Ÿ› โš ๏ธ
grzeg1
grzeg1

๐Ÿ›
Moustafa Baiou
Moustafa Baiou

๐Ÿ› ๐Ÿ’ป
dandaolrian
dandaolrian

๐Ÿ’ป
Dmitry
Dmitry

๐Ÿ›
Michael Franzl
Michael Franzl

๐Ÿ›
Emmanuel Benoรฎt
Emmanuel Benoรฎt

๐Ÿ’ป ๐Ÿ› โš ๏ธ
mandrav
mandrav

๐Ÿ’ป ๐Ÿ›
Michael Iseli
Michael Iseli

๐Ÿ’ป ๐Ÿ›
Risto Oikarinen
Risto Oikarinen

๐Ÿ’ป
dawidole
dawidole

๐Ÿ›
Gerard Krupa
Gerard Krupa

โš ๏ธ
Simon Caron
Simon Caron

๐Ÿ’ป
Piotr Maksymiuk
Piotr Maksymiuk

๐Ÿ›
Kristopher
Kristopher

๐Ÿค”
Eric B
Eric B

โš ๏ธ ๐Ÿ“–
2b
2b

๐Ÿ›
TheNotary
TheNotary

๐Ÿ’ป โš ๏ธ
zamrih
zamrih

๐Ÿ› ๐Ÿ’ป
Ratiborus
Ratiborus

๐Ÿ› โš ๏ธ
Sean Kleinjung
Sean Kleinjung

๐Ÿ› ๐Ÿ’ต
Add your contributions

Stargazers

Star History Chart

Sponsorship

โค๏ธ This project is sponsored by:

Thanks again for your support, it is much appreciated! ๐Ÿ™

Releases

No releases published

Packages

No packages published

Languages

  • Go 96.2%
  • HCL 3.5%
  • Other 0.3%