Installing the StorPool Proxmox integration

Install the StorPool storage plugin file

Perform these steps on all the Proxmox VE hosts which will need to access StorPool-backed volumes and snapshots:

  1. Make sure the StorPool client (the storpool_block service) is installed on the Proxmox host.

  2. Point Apt at the StorPool Debian package repository backports suite for your release.

    For example, this can be bookworm-backports if you are running Proxmox VE 8 (based on bookworm). This is what your /etc/apt/sources.list.d/storpool-backports.sources file would look like:

    Types: deb deb-src
URIs: https://repo.storpool.com/public/contrib/debian/
Suites: bookworm-backports
Components: main
Signed-By: /usr/share/keyrings/storpool-keyring.gpg

  3. Install the pve-storpool package:

    apt install pve-storpool

Check the status of the StorPool and Proxmox installation

Make sure all of the following conditions are met:

  • The StorPool client (the storpool_block service) is operational:

    systemctl status storpool_block.service

  • The StorPool configuration includes the API access variables:

    storpool_confshow -e SP_API_HTTP_HOST SP_API_HTTP_PORT SP_AUTH_TOKEN SP_OURID

  • The StorPool cluster sees this client as operational:

    storpool service list
storpool client status

  • The Proxmox cluster is operational and has a sensible name configured:

    pvesh get /cluster/status
pvesh get /cluster/status -output-format json | jq -r '.[] | select(.id == "cluster") | .name'

Create a StorPool-backed Proxmox VE storage

Note

This part may be partly automated by a command-line helper tool.

  1. Choose a StorPool template to use for the storage entry:

    storpool template list

  2. Create a storage entry, specifying the StorPool template to use and some additional tags to set on each StorPool volume and snapshot, e.g. specifying a QoS tier:

    pvesm add \
'storpool' \
'sp-nvme' \
-shared true \
-content 'images,iso' \
-extra-tags 'tier=high' \
-template 'nvme'

  3. Make sure Proxmox VE can query the status of the created storage:

    pvesm status

Enable StorPool’s HCI HA watchdog

When enabling StorPool HA watchdog replacement, the host will be put in maintenance mode in the Proxmox VE cluster, which will migrate away all HA resources to another machine. After the watchdog service is replaced, the host will be returned to online mode.

Note

Replacement must be done one host at a time!

To enable the StorPool watchdog replacement on a host:

/opt/storpool/pve/set-pve-watchdog storpool

You can also revert to the default PVE watchdog service if necessary:

/opt/storpool/pve/set-pve-watchdog pve

If the chosen watchdog service is already enabled, the script will exit early. You can verify the status of the StorPool and PVE watchdogs:

systemctl status sp-watchdog-mux.service
systemctl status watchdog-mux.service

The service that is currently disabled will be masked.