diff --git a/Service-Widgets.md b/Service-Widgets.md index ccc0011..007e0b0 100644 --- a/Service-Widgets.md +++ b/Service-Widgets.md @@ -423,6 +423,47 @@ widget: key: api_token ``` + +## Proxmox + +This widget shows the running and total counts of both QEMU VMs and LX Containers in the Proxmox cluster. It also shows the CPU and memory usage of the first node in the cluster. + +You will need to generate an API Token for an existing user. Here is an example of how to do this. + +1. Navigate to the Proxmox portal, click on Datacenter +2. Expand Permissions, click on Groups +3. Click the Create button +4. Name the group something informative, like api-ro-users +5. Click on the Permissions "folder" +6. Click Add -> Group Permission + * Path: / + * Group: group from bullet 4 above + * Role: PVEAuditor + * Propagate: Checked +7. Expand Permissions, click on Users +8. Click the Add button + * User name: something informative like `api` + * Realm: Linux PAM standard authentication + * Group: group from bullet 4 above +9. Click on the Permissions "folder" +10. Click the Add button + * User: user from bullet 8 above + * Token ID: something informative like the application or purpose like `homepage` + * Privilege Separation: Unchecked + +Use `Token ID` as the `username` setting and `Secret` as the `password` setting. + +Allowed fields: `["vms", "lxc", "cpu", "mem"]`. + +```yaml +widget: + type: proxmox + url: http://proxmox.host.or.ip:8006 + username: api_token_id + password: api_token_secret +``` + + # System Utilities & Services System specific utilities and tools like message queues, databases, etc.