mirrors/terraform-provider-proxmox
0
0
Fork 0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-06-29 18:21:10 +00:00
Code
Terraform / OpenTofu Provider for Proxmox VE
1 Commit 8 Branches 151 Tags 13 MiB
Go 96.3%
HCL 2.1%
Shell 1.2%
Makefile 0.3%
5a79f039c1
Go to file
Dan Petersen 5a79f039c1 Initial work
2019-12-07 19:58:29 +01:00
example Initial work 2019-12-07 19:58:29 +01:00
proxmox Initial work 2019-12-07 19:58:29 +01:00
.gitignore Initial work 2019-12-07 19:58:29 +01:00
CHANGELOG.md Initial work 2019-12-07 19:58:29 +01:00
data_source_virtual_environment_version_test.go Initial work 2019-12-07 19:58:29 +01:00
data_source_virtual_environment_version.go Initial work 2019-12-07 19:58:29 +01:00
go.mod Initial work 2019-12-07 19:58:29 +01:00
go.sum Initial work 2019-12-07 19:58:29 +01:00
LICENSE Initial work 2019-12-07 19:58:29 +01:00
main.go Initial work 2019-12-07 19:58:29 +01:00
Makefile Initial work 2019-12-07 19:58:29 +01:00
provider_test.go Initial work 2019-12-07 19:58:29 +01:00
provider.go Initial work 2019-12-07 19:58:29 +01:00
README.md Initial work 2019-12-07 19:58:29 +01:00
version.go Initial work 2019-12-07 19:58:29 +01:00

README.md

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.
    • password - (Required) The password for the Proxmox Virtual Environment API.
    • username - (Required) The username for the Proxmox Virtual Environment API.

Data Sources

Virtual Environment

Version (proxmox_ve_version)
Arguments

This data source doesn't accept arguments.

Attributes
  • keyboard - The keyboard layout.
  • release - The release information.
  • repository_id - The repository id.
  • version - The version information.

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.