muhlba91 / pulumi-proxmoxve

A Pulumi provider for creating and managing Proxmox VE resources
Apache License 2.0
130 stars 14 forks source link
proxmox proxmox-ve pulumi pulumi-provider

Proxmox VE Resource Provider

Buy Me A Coffee

The Proxmox VE Resource Provider for Pulumi 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/muhlba91/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 @muhlba91/pulumi-proxmoxve

or yarn:

yarn add @muhlba91/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/muhlba91/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 '@muhlba91/pulumi-proxmoxve';

const provider = new proxmox.Provider('proxmoxve', {
  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.

Contributors

Thanks goes to these wonderful people (emoji key):

Daniel Mühlbachler-Pietrzykowski
Daniel Mühlbachler-Pietrzykowski

🚧 💻 📖
Nelson Costa Martins
Nelson Costa Martins

💡
Guinevere Saenger
Guinevere Saenger

📖
Susan Evans
Susan Evans

📖
zamrih
zamrih

💻

This project follows the all-contributors specification. Contributions of any kind welcome!