Files
pulse/docs/PBS-AGENT.md
T
Pulse Monitor 5b32f47587 feat: add PBS system stats display (addresses #259)
- Grant enhanced Audit permissions to PBS tokens for system stats access
- Create PBSCard component to display CPU, memory, disk, uptime metrics
- Detect Docker PBS instances and show appropriate info without stats
- Add adaptive node layout on dashboard for better scalability
- Move PBS status card to Backups tab above frequency chart
- Create CompactNodeCard for handling many nodes efficiently
- Update PBS setup script to grant Audit role to both user and token

This addresses the request in issue #259 to show PBS system stats on the dashboard.
The implementation uses read-only Audit permissions to access the /nodes endpoint
while maintaining security. Docker PBS instances are detected and handled gracefully
since they cannot provide host system statistics.
2025-08-18 15:08:04 +00:00

1.6 KiB

PBS Agent (Push Mode)

For PBS servers behind firewalls or in isolated networks that can't be reached by Pulse directly.

Installation

The PBS agent needs to be manually installed on your PBS server. Build from source or download from releases.

Configuration

Edit /etc/pulse-pbs-agent/config.json:

{
  "pulse_url": "http://your-pulse-server:7655",
  "api_key": "your-api-key-from-pulse-settings",
  "poll_interval": 30,
  "pbs_url": "https://localhost:8007",
  "pbs_username": "apiuser@pbs",
  "pbs_token_name": "pulse",
  "pbs_token_value": "uuid-from-pbs"
}

Start Agent

sudo systemctl enable --now pulse-pbs-agent
sudo systemctl status pulse-pbs-agent

Get API Key

In Pulse web UI: Settings → General → API Key → Generate

Create PBS Token

In PBS web UI:

  1. Configuration → Access Control → API Tokens
  2. Add Token
  3. User: Choose user with appropriate permissions:
    • Basic monitoring: Datastore.Audit on /datastore/* (backups only)
    • Full monitoring: Audit on / (backups + CPU/memory/uptime stats)
  4. Copy token ID (username@pbs!tokenname) and secret

Note: For full monitoring visibility including system stats, use Audit on /. This is still read-only access.

Verify

Check agent logs:

journalctl -u pulse-pbs-agent -f

In Pulse UI, PBS data should appear within 1 minute.

Uninstall

sudo systemctl stop pulse-pbs-agent
sudo systemctl disable pulse-pbs-agent
sudo rm -rf /etc/pulse-pbs-agent
sudo rm /usr/local/bin/pulse-pbs-agent
sudo rm /etc/systemd/system/pulse-pbs-agent.service