/traefik-proxmox-plugin

Using Proxmox as a provider for traefik

Primary LanguageGoApache License 2.0Apache-2.0

Traefik Plugin for Proxmox

This plugin analyses all configured VMs and CTs running in a specific Proxmox Cluster.
Based on specific formattet content in the description (Notes) field, Traefik configurations can be exstracted.
All lines in the format:

"traefik.…":"value"

Will be parsed as Traefik values.

Example:

"traefik.enable": "true" 
"traefik.http.routers.umbrelvm.entrypoints": "http" 
"traefik.http.routers.umbrelvm.rule": "Host(`example.com`)" 
"traefik.http.services.umbrelvm.loadbalancer.server.port": "80"

This Content will be parsed as:

{
    "traefik.enable": "true",
    "traefik.http.routers.umbrelvm.entrypoints": "http",
    "traefik.http.routers.umbrelvm.rule": "Host(`example.com`)",
    "traefik.http.services.umbrelvm.loadbalancer.server.port": "80"
}

The plugin tries to get IPs from running VMs. This does only work, if the QEMU Guest Agent is installed, running and configured in Proxmox.

For running containers, the IP has to be set via the config like this:

"traefik.enable": "true"
"traefik.http.routers.web.entrypoints": "http"
"traefik.http.routers.web.rule": "Host(`web.example.com`)"
"traefik.http.services.web.loadbalancer.server.port": "80"
"traefik.http.services.web.loadbalancer.server.ipv4": "192.168.168.131"

Required Permissions

For this plugin to be able to access all PVE API Endpoints, the following permissions need to be setup:

token:root@pam!traefik:0:0::
role:API-READER:Datastore.Audit,SDN.Audit,Sys.Audit,VM.Audit,VM.Config.Options:
acl:1:/:root@pam!traefik:API-READER:

Config Values

You can configure the plugin using env variables.
At the moment they are injected using direnv.
For a detailed description have a look into the .envrc.example file.