Add Proxmox VE plugin#90
Open
iBePixel wants to merge 6 commits into
Open
Conversation
Contributor
📝 WalkthroughWalkthroughAdds a Proxmox VE plugin with authenticated API configuration, indexed cluster resources, node/VM/container data streams, default dashboards, scopes, and setup documentation. ChangesProxmox VE integration
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)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
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
⛔ Files ignored due to path filters (1)
plugins/ProxmoxVE/v1/icon.svgis excluded by!**/*.svg
📒 Files selected for processing (22)
plugins/ProxmoxVE/v1/configValidation.jsonplugins/ProxmoxVE/v1/custom_types.jsonplugins/ProxmoxVE/v1/dataStreams/apiVersion.jsonplugins/ProxmoxVE/v1/dataStreams/clusterResources.jsonplugins/ProxmoxVE/v1/dataStreams/containerMetrics.jsonplugins/ProxmoxVE/v1/dataStreams/containerStatus.jsonplugins/ProxmoxVE/v1/dataStreams/nodeMetrics.jsonplugins/ProxmoxVE/v1/dataStreams/nodeStatus.jsonplugins/ProxmoxVE/v1/dataStreams/nodeUpdates.jsonplugins/ProxmoxVE/v1/dataStreams/scripts/clusterResources.jsplugins/ProxmoxVE/v1/dataStreams/vmMetrics.jsonplugins/ProxmoxVE/v1/dataStreams/vmStatus.jsonplugins/ProxmoxVE/v1/defaultContent/containerDashboard.dash.jsonplugins/ProxmoxVE/v1/defaultContent/manifest.jsonplugins/ProxmoxVE/v1/defaultContent/nodeDashboard.dash.jsonplugins/ProxmoxVE/v1/defaultContent/overviewDashboard.dash.jsonplugins/ProxmoxVE/v1/defaultContent/scopes.jsonplugins/ProxmoxVE/v1/defaultContent/vmDashboard.dash.jsonplugins/ProxmoxVE/v1/docs/README.mdplugins/ProxmoxVE/v1/indexDefinitions/default.jsonplugins/ProxmoxVE/v1/metadata.jsonplugins/ProxmoxVE/v1/ui.json
|
|
||
| Monitor your Proxmox VE cluster from SquaredUp. This plugin imports nodes, virtual machines (QEMU/KVM), and LXC containers into the SquaredUp graph and provides dashboards for cluster health, resource utilisation, and per-object metrics. | ||
|
|
||
| ## What this plugin monitors |
Contributor
There was a problem hiding this comment.
Defer to @clarkd, as this is what the skill currently does, but we might want to update the README.md guidance.
Generally HCPs go straight into setup instructions, so almost feel like it should be
# Plugin name
Sentence overview
## Setup
## What this monitors
## What this indexes
## Limitations```
Member
There was a problem hiding this comment.
I prefer to avoid using the plugin name as the first header, as this is usually shown on the data source setup screen which already shows the name... perhaps should just go straight into the intro paragraph?
Author
clarkd
approved these changes
Jul 21, 2026
…r easy reference when adding plugin.
🧩 Plugin PR Summary📦 Modified Plugins
📋 Results
🔍 Validation Details✅
|
Contributor
There was a problem hiding this comment.
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
📒 Files selected for processing (6)
plugins/ProxmoxVE/v1/dataStreams/containerMetrics.jsonplugins/ProxmoxVE/v1/dataStreams/containerStatus.jsonplugins/ProxmoxVE/v1/dataStreams/nodeMetrics.jsonplugins/ProxmoxVE/v1/dataStreams/vmMetrics.jsonplugins/ProxmoxVE/v1/docs/README.mdplugins/ProxmoxVE/v1/metadata.json
| | **Host URL** | Full URL to your Proxmox VE host, including port. Example: `https://192.168.1.100:8006` | Yes | | ||
| | **Token ID** | The full API token identifier in the format `USER@REALM!TOKENID`. Example: `monitoring@pam!squaredup` | Yes | | ||
| | **Token Secret** | The UUID secret displayed when the token was created. Example: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Yes | | ||
| | **Ignore certificate errors** | Skip TLS certificate validation. Enable if your Proxmox host uses a self-signed certificate you haven't configured your agent to trust. | No | |
Contributor
There was a problem hiding this comment.
🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win
Warn about the security impact of ignoring certificate errors.
Explicitly state that this disables server certificate verification and should only be used in controlled environments; prefer configuring the agent to trust the Proxmox CA.
🤖 Prompt for 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.
In `@plugins/ProxmoxVE/v1/docs/README.md` at 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔌 Plugin overview
🖼️ 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)📚 Checklist
Summary by CodeRabbit