/pulumi-proxmoxve

A Pulumi provider for creating and managing Proxmox VE resources.

Primary LanguagePythonApache License 2.0Apache-2.0

Proxmox VE Resource Provider

Buy Me A Coffee

The Proxmox VE Resource Provider lets you manage Proxmox VE resources.

The provider is built on https://github.com/bpg/terraform-provider-proxmox.

Installing

This package is available in many languages in the standard packaging formats.

Installing the Plugin

  1. Download the appropriate archive file from the Releases page: wget https://github.com/amildahl/pulumi-proxmoxve/releases/download/vX.Y.Z/pulumi-resource-proxmoxve-vX.Y.Z-OPERATING_SYSTEM-ARCH.tar.gz
  2. Add the plugin to Pulumi: pulumi plugin install resource proxmoxve X.Y.Z -f ./pulumi-resource-proxmoxve-vX.Y.Z-OPERATING_SYSTEM-ARCH.tar.gz

Node.js (JavaScript/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

npm install @amildahl/pulumi-proxmoxve

or yarn:

yarn add @amildahl/pulumi-proxmoxve

Python

To use from Python, install using pip:

pip install pulumi-proxmoxve

Go

To use from Go, use go get to grab the latest version of the library:

go get github.com/amildahl/pulumi-proxmoxve/sdk/go/...

.NET

To use from .NET, install using dotnet add package:

dotnet add package Pulumi.ProxmoxVE

Configuration

Unfortunately, configuration via environment variables is not (yet) working. To configure the provider you must create and pass it through.

Example for Typescript:

import * as proxmox from '@amildahl/pulumi-proxmoxve';

const provider = new proxmox.Provider('proxmoxve', {
  virtualEnvironment: {
    endpoint: process.env.PROXMOX_VE_ENDPOINT,
    insecure: process.env.PROXMOX_VE_INSECURE,
    username: process.env.PROXMOX_VE_USERNAME,
    password: process.env.PROXMOX_VE_PASSWORD
  }
});

const args = {};
const vm = new proxmox.vm.VirtualMachine(
  'vm',
  args,
  {
    provider: provider,
  },
);

Reference

For detailed reference documentation, please visit the upstream Terraform provider's documentation at: https://registry.terraform.io/providers/bpg/proxmox/latest.

Some input parameters are required as per the Proxmox API Viewer. Please refer to this documentation for more information regarding required parameters for your Proxmox VE version.