This is a fleeting plugin for Proxmox Virtual Environment.
See Releases for available versions and installation instructions.
| Parameter | Type | Default value | Description |
|---|---|---|---|
url |
string | N/A (required) | Proxmox VE URL. |
insecure_skip_tls_verify |
bool | false |
If true then TLS certificate verification is disabled. |
credentials_file_path |
string | N/A (required) | Path to Proxmox VE credentials file. |
pool |
string | N/A (required) | Name of the Proxmox VE pool to use. |
storage |
string | N/A (required if template is a VM) | Name of the Proxmox VE storage to use. |
template_id |
int | N/A (required) | ID of the Proxmox VE VM to create instances from. |
max_instances |
int | N/A (required) | Maximum instances than can be deployed. |
instance_network_interface |
string | ens18 |
Network interface to read instance's IPv4 address from. |
instance_name_creating |
string | fleeting-creating |
Name to set for instances during creation. |
instance_name_running |
string | fleeting-running |
Name to set for running instances. |
instance_name_removing |
string | fleeting-removing |
Name to set for instances during removal. |
| Parameter | Type | Description |
|---|---|---|
realm |
string | Authentication Realm |
username |
string | User name |
password |
string | User password |
otp |
string | One-time password for 2FA |
The template must be a bootable VM with enabled DHCP and QEMU guest agent installed. See Proxmox documentation for more details.
You MUST create a DEDICATED user, pool and storage for usage with this plugin. Any other configuration is untested and unsupported.
After creating a DEDICATED user, pool and storage follow procedure below to add required permissions:
- Add template VM as a member to the pool.
- Add storage as a member to the pool.
- Add following roles for the user to the pool:
PVEVMAdmin,PVEPoolUser,PVEDatastoreUser.
- Add following role for the user to the network that you will use for deployed VMs:
PVESDNAdmin.
- Add following role for the user to the node with the storage, network, template etc.:
PVEAuditorwithout propagation.
- Create and fill out
credentials.jsonfile in project root (see Credentials file for details)cp credentials.example.json credentials.json
- Create and fill out
config.jsonfile in project root (see Plugin settings for details)cp config.example.json config.json
- Run integration tests:
make integration-test