Add Proxmox VE plugin by iBePixel · Pull Request #90 · squaredup/plugins

iBePixel · 2026-07-10T21:54:08Z

🔌 Plugin overview

Plugin name: Proxmox VE
Purpose / problem solved: Imports Nodes, VMs (QEMU/KVM), and LXC Containers from a Proxmox VE cluster into the SquaredUp graph, and ships four out-of-the-box dashboards (Overview, Node, VM, Container) covering cluster health and CPU/memory/disk/network utilisation.
Primary audience (e.g. platform teams, SREs, product teams): Platform/infra teams, SREs, and homelab admins running Proxmox VE clusters who want cluster/node/VM health alongside their other infrastructure.
Authentication method(s) (e.g. OAuth, Username/Password, API Key): API Key — a Proxmox API token (PVEAPIToken=USER@REALM!TOKENID=SECRET).

🖼️ Plugin screenshots

Plugin configuration

Default dashboards

Overview:

Node:

Container:

🧪 Testing

squaredup validate — passes clean (9 data streams, custom types, config validation, and default content all present)
Deployed to a live SquaredUp tenant
Configured against a real Proxmox VE host/token and confirmed Nodes, VMs, and Containers are imported correctly
Opened all four dashboards and confirmed tiles populate with live data from the imported objects

⚠️ Known limitations

Potential tweaks to the OOB dashboards (size, formatting etc.)
Look at if possible to retrieve update status for containers/ VMs
Potentially enable monitoring on OOBs for CPU/ Memory utilisation thresholds

📚 Checklist

Plugin, datastream and UI naming follow SquaredUp guidelines
Logo added
One or more dashboards added
README added including configuration guidance
No secrets or credentials included
I agree to the Code of Conduct

Summary by CodeRabbit

New Features
- Added Proxmox VE monitoring for nodes, virtual machines, and containers, including authentication validation and API version checking.
- Introduced cluster, node, VM, and container metrics (current status and historical performance).
- Added built-in dashboards for Overview, Nodes, VMs, and Containers, with scoped filtering (Nodes, Containers, VMs).
Documentation
- Added Proxmox VE plugin setup documentation, including prerequisites, dashboards, supported data, and known limitations.

coderabbitai · 2026-07-10T21:54:27Z

📝 Walkthrough

Walkthrough

Adds a Proxmox VE plugin with authenticated API configuration, indexed cluster resources, node/VM/container data streams, default dashboards, scopes, and setup documentation.

Changes

Proxmox VE integration

Layer / File(s)	Summary
Plugin configuration and authentication `plugins/ProxmoxVE/v1/metadata.json`, `ui.json`, `configValidation.json`, `custom_types.json`, `dataStreams/apiVersion.json`	Defines plugin metadata, required connection fields, authentication validation, Proxmox object types, and API-version discovery.
Cluster resource ingestion `plugins/ProxmoxVE/v1/dataStreams/scripts/clusterResources.js`, `dataStreams/clusterResources.json`, `indexDefinitions/default.json`	Fetches cluster resources, normalizes supported node, VM, and container records, and indexes their identifiers and resource fields.
Node, VM, and container data streams `plugins/ProxmoxVE/v1/dataStreams/{nodeStatus,nodeMetrics,nodeUpdates,vmStatus,vmMetrics,containerStatus,containerMetrics}.json`	Adds status, historical metric, and node update streams with Proxmox endpoint mappings, metadata schemas, source matching, and timeframe settings.
Scopes, dashboards, and documentation `plugins/ProxmoxVE/v1/defaultContent/*`, `plugins/ProxmoxVE/v1/docs/README.md`	Registers default dashboards, defines Node/Container/VM scopes, wires dashboard tiles to data streams, and documents setup and limitations.

Sequence Diagram(s)

sequenceDiagram
  participant Configuration
  participant ProxmoxAPI
  participant ResourceIndexer
  participant DataStreams
  participant Dashboards

  Configuration->>ProxmoxAPI: Authenticate with API token
  ResourceIndexer->>ProxmoxAPI: GET /cluster/resources
  ProxmoxAPI-->>ResourceIndexer: Return node, VM, and container resources
  DataStreams->>ProxmoxAPI: Request status or historical metrics
  ProxmoxAPI-->>DataStreams: Return mapped data
  Dashboards->>DataStreams: Render scoped tables and charts

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding the Proxmox VE plugin.
Description check	✅ Passed	The description covers plugin overview, screenshots, testing, known limitations, and checklist items.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@plugins/ProxmoxVE/v1/dataStreams/containerStatus.json`:
- Line 25: Update the vmid field’s displayName in the container status stream
from “VM ID” to “Container ID”, leaving the field name and shape unchanged.

In `@plugins/ProxmoxVE/v1/dataStreams/nodeMetrics.json`:
- Line 24: Update the `time` field definition in the `nodeMetrics`,
`containerMetrics`, and `vmMetrics` schemas from `shape: "date"` to `shape:
"timestamp"` so the Unix epoch RRDDATA value is parsed correctly.

In `@plugins/ProxmoxVE/v1/docs/README.md`:
- Around line 42-46: Add an “Ignore certificate errors” row to the configuration
fields table, documenting the `ignoreCertificateErrors` checkbox and its
behavior, required status, and security implications as appropriate. Update the
self-signed certificate note near the table to explicitly reference this option.
- Around line 13-16: Update the VM and Container perspective descriptions in the
README to mention network metrics alongside CPU, memory, and disk I/O metrics,
matching the metrics shown in their dashboards.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: 14e1ebcd-ba82-430f-8327-0a816cf45a60

📥 Commits

Reviewing files that changed from the base of the PR and between 18219a1 and ce60f7e.

⛔ Files ignored due to path filters (1)

plugins/ProxmoxVE/v1/icon.svg is excluded by !**/*.svg

📒 Files selected for processing (22)

plugins/ProxmoxVE/v1/configValidation.json
plugins/ProxmoxVE/v1/custom_types.json
plugins/ProxmoxVE/v1/dataStreams/apiVersion.json
plugins/ProxmoxVE/v1/dataStreams/clusterResources.json
plugins/ProxmoxVE/v1/dataStreams/containerMetrics.json
plugins/ProxmoxVE/v1/dataStreams/containerStatus.json
plugins/ProxmoxVE/v1/dataStreams/nodeMetrics.json
plugins/ProxmoxVE/v1/dataStreams/nodeStatus.json
plugins/ProxmoxVE/v1/dataStreams/nodeUpdates.json
plugins/ProxmoxVE/v1/dataStreams/scripts/clusterResources.js
plugins/ProxmoxVE/v1/dataStreams/vmMetrics.json
plugins/ProxmoxVE/v1/dataStreams/vmStatus.json
plugins/ProxmoxVE/v1/defaultContent/containerDashboard.dash.json
plugins/ProxmoxVE/v1/defaultContent/manifest.json
plugins/ProxmoxVE/v1/defaultContent/nodeDashboard.dash.json
plugins/ProxmoxVE/v1/defaultContent/overviewDashboard.dash.json
plugins/ProxmoxVE/v1/defaultContent/scopes.json
plugins/ProxmoxVE/v1/defaultContent/vmDashboard.dash.json
plugins/ProxmoxVE/v1/docs/README.md
plugins/ProxmoxVE/v1/indexDefinitions/default.json
plugins/ProxmoxVE/v1/metadata.json
plugins/ProxmoxVE/v1/ui.json

…r easy reference when adding plugin.

github-actions · 2026-07-21T20:50:28Z

🧩 Plugin PR Summary

📦 Modified Plugins

plugins/ProxmoxVE/v1

📋 Results

Step	Status
Validation	✅ Passed
Deployment	🚀 Deployed

🔍 Validation Details

✅ proxmox-ve

{
  "valid": true,
  "pluginName": "proxmox-ve",
  "pluginType": "hybrid",
  "summary": {
    "Data Streams": 9,
    "Import Definitions": 1,
    "UI Configuration": true,
    "Has Icon": true,
    "Has Default Content": true,
    "Config Validation": true,
    "Custom Types": true
  }
}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@plugins/ProxmoxVE/v1/docs/README.md`:
- Line 45: Update the “Ignore certificate errors” documentation entry in
README.md to explicitly warn that enabling it disables server certificate
verification and should only be used in controlled environments. Recommend
configuring the agent to trust the Proxmox CA instead.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: eaf5afea-bbb6-49d6-8b34-cebb06e26d4a

📥 Commits

Reviewing files that changed from the base of the PR and between ce60f7e and eb18a91.

📒 Files selected for processing (6)

plugins/ProxmoxVE/v1/dataStreams/containerMetrics.json
plugins/ProxmoxVE/v1/dataStreams/containerStatus.json
plugins/ProxmoxVE/v1/dataStreams/nodeMetrics.json
plugins/ProxmoxVE/v1/dataStreams/vmMetrics.json
plugins/ProxmoxVE/v1/docs/README.md
plugins/ProxmoxVE/v1/metadata.json

Initial plugin created with OOB dashboards.

ce60f7e

iBePixel requested a review from a team July 10, 2026 21:54

iBePixel added the new-plugin Used to PR newly added plugins label Jul 10, 2026

coderabbitai Bot reviewed Jul 10, 2026

View reviewed changes

Comment thread plugins/ProxmoxVE/v1/dataStreams/containerStatus.json Outdated

Comment thread plugins/ProxmoxVE/v1/dataStreams/nodeMetrics.json Outdated

Comment thread plugins/ProxmoxVE/v1/docs/README.md Outdated

Comment thread plugins/ProxmoxVE/v1/docs/README.md

iBePixel added 4 commits July 10, 2026 23:04

Changed Container Data stream ID name from 'VM ID' to 'Container ID'

4e1c9d5

Changed metric 'shapes' from date to timestamp.

a1536c3

Updated readme file to include network metrics for VMs and Containers.

16e481e

Updated readme to include relevant references to the ignore SSL option.

63ec260

andrewmumblebee reviewed Jul 13, 2026

View reviewed changes

Comment thread plugins/ProxmoxVE/v1/dataStreams/scripts/clusterResources.js

andrewmumblebee reviewed Jul 13, 2026

View reviewed changes

Comment thread plugins/ProxmoxVE/v1/docs/README.md Outdated

clarkd approved these changes Jul 21, 2026

View reviewed changes

Removed plugin name from README and moved Prerequisites to the top fo…

eb18a91

…r easy reference when adding plugin.

coderabbitai Bot reviewed Jul 21, 2026

View reviewed changes

Comment thread plugins/ProxmoxVE/v1/docs/README.md

clarkd approved these changes Jul 22, 2026

View reviewed changes

clarkd merged commit adcde10 into main Jul 22, 2026
1 check passed

clarkd deleted the work/el/add-proxmox-plugin branch July 22, 2026 13:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Proxmox VE plugin#90

Add Proxmox VE plugin#90
clarkd merged 6 commits into
mainfrom
work/el/add-proxmox-plugin

iBePixel commented Jul 10, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 10, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jul 21, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

iBePixel commented Jul 10, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔌 Plugin overview

🖼️ Plugin screenshots

Plugin configuration

Default dashboards

🧪 Testing

⚠️ Known limitations

📚 Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jul 21, 2026

🧩 Plugin PR Summary

📦 Modified Plugins

📋 Results

🔍 Validation Details

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

iBePixel commented Jul 10, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 10, 2026 •

edited

Loading