Giter VIP home page Giter VIP logo

terraform-provider-proxmox's Introduction

Terraform Provider for Proxmox

Fork of https://github.com/zarichard/terraform-provider-proxmox adding very specific functionality for my use-case:

Persistent virtual disk resource

Hacky way to preserve VM disks when the VM is destroyed, without requiring twice the storage. Meant to be used for persistent storage on nodes that should be kept during a reprovisioning. Only tested on zfs based storage and is not a very generic solution.

Passthrough physical disk

A field in VM resources to allow for passthrough disks to be specified.

Compatibility Matrix

Proxmox version Provider version
6.x <= 0.4.4
7.x >= 0.4.5

Requirements

  • Terraform 1.2+
  • Go 1.19+ (to build the provider plugin)
  • GoReleaser v1.15+ (to build the provider plugin)

Table of Contents

Building the provider

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

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

    cd "${GOPATH}/src/github.com/zarichard/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.

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

terraform-provider-proxmox's People

Contributors

danitso-dp avatar bpg avatar dependabot[bot] avatar luhahn avatar zarichard avatar blz-ea avatar abdo-farag avatar otopetrik avatar kugo12 avatar kaje783 avatar qazbnm456 avatar 1-cameron avatar magikid avatar wombelix avatar xonvanetta avatar frankkkkk avatar groggemans avatar henriaw avatar shortmann avatar krzysztof-magosa avatar mattburchett avatar moyiz avatar wbpascal avatar patricol avatar prajwalborkar avatar tumetsu avatar michalg91 avatar mleone87 avatar release-please[bot] avatar ryan4yin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.