MCPcopy Index your code
hub / github.com/LukasK32/fleeting-plugin-proxmox

github.com/LukasK32/fleeting-plugin-proxmox @v1.2.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.2.0 ↗ · + Follow
44 symbols 121 edges 14 files 11 documented · 25%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Fleeting plugin for Proxmox Virtual Environment

This is a fleeting plugin for Proxmox Virtual Environment.

Installation

See Releases for available versions and installation instructions.

Configuration

Plugin settings

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_network_protocol any or ipv4 or ipv6 ipv4 Network protocol to look for when discovering instance's IP address. any prioritizes IPv6.
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.

Credentials file

Parameter Type Description
realm string Authentication Realm
username string User name
password string User password
otp string One-time password for 2FA

Template VM configuration

The template must be a bootable VM with enabled DHCP and QEMU guest agent installed. See Proxmox documentation for more details.

Proxmox configuration

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:

  1. Add template VM as a member to the pool.
  2. Add storage as a member to the pool.
  3. Add following roles for the user to the pool:
  4. PVEVMAdmin,
  5. PVEPoolUser,
  6. PVEDatastoreUser.
  7. Add following role for the user to the network that you will use for deployed VMs:
    • PVESDNAdmin.
  8. Add following role for the user to the node with the storage, network, template etc.:
    • PVEAuditor without propagation.

Development

Integration tests

  1. Create and fill out credentials.json file in project root (see Credentials file for details) bash cp credentials.example.json credentials.json
  2. Create and fill out config.json file in project root (see Plugin settings for details) bash cp config.example.json config.json
  3. Run integration tests: bash make integration-test

Core symbols most depended-on inside this repo

getProxmoxPool
called by 5
cmd/fleeting-plugin-proxmox/plugin/proxmox.go
getProxmoxCredentials
called by 5
cmd/fleeting-plugin-proxmox/plugin/proxmox.go
isProxmoxResourceAnInstance
called by 4
cmd/fleeting-plugin-proxmox/plugin/instances.go
getProxmoxVM
called by 3
cmd/fleeting-plugin-proxmox/plugin/proxmox.go
getProxmoxVMOnNode
called by 3
cmd/fleeting-plugin-proxmox/plugin/proxmox.go
FillWithDefaults
called by 3
cmd/fleeting-plugin-proxmox/plugin/settings.go
collectRemovedInstances
called by 3
cmd/fleeting-plugin-proxmox/plugin/collector.go
getProxmoxClient
called by 2
cmd/fleeting-plugin-proxmox/plugin/proxmox.go

Shape

Method 26
Function 14
Struct 4

Languages

Go100%

Modules by API surface

cmd/fleeting-plugin-proxmox/plugin/instance_group.go7 symbols
cmd/fleeting-plugin-proxmox/plugin/instances.go6 symbols
cmd/fleeting-plugin-proxmox/plugin/proxmox.go5 symbols
cmd/fleeting-plugin-proxmox/plugin/collector.go5 symbols
cmd/fleeting-plugin-proxmox/main.go4 symbols
cmd/fleeting-plugin-proxmox/plugin/settings.go3 symbols
test/integration/integration_test.go2 symbols
cmd/fleeting-plugin-proxmox/plugin/settings_test.go2 symbols
cmd/fleeting-plugin-proxmox/plugin/proxmox_test.go2 symbols
cmd/fleeting-plugin-proxmox/plugin/proxmox_session.go2 symbols
cmd/fleeting-plugin-proxmox/plugin/network.go2 symbols
cmd/fleeting-plugin-proxmox/plugin/instances_test.go2 symbols

For agents

$ claude mcp add fleeting-plugin-proxmox \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page