Skip to content

About

QuantaStor Storage Plugin

Resources

Contributing

Stars

3 stars

Watchers

2 watching

Forks

Latest commit

 

History

86 Commits

Folders and files

Repository files navigation

QuantaStor PVE Plugin

A Proxmox VE storage plugin that integrates QuantaStor as a first-class iSCSI (or Fibre Channel) block storage backend for virtual machines and containers.


Status

Component State
QuantaStor/APIClient.pm Complete — clean REST client, 58 unit tests
QuantaStor/ISCSIManager.pm Complete — clean iSCSI lifecycle, 61 unit tests
QuantaStor/FCManager.pm Complete — Fibre Channel attach and detach, 18 unit tests against a simulated /sys and /dev
Custom/QuantaStor.pm (first-class type) Complete — all PVE hooks implemented, 118 unit tests
Debian packaging Complete — pve-storage-quantastor_1.2.0-1_all.deb

Quick start

Install the package on every node in the cluster. Use apt so the dependencies (open-iscsi, multipath-tools) are installed too:

apt install ./pve-storage-quantastor_1.2.0-1_all.deb

Then add the storage from any node:

pvesm add quantastor qs-storage-1 \
  --api_host 10.0.0.10 \
  --username admin \
  --password '<password>' \
  --pool_id <pool-name-or-uuid> \
  --content images,rootdir

--pool_id is the QuantaStor storage pool to create volumes in, by name or UUID. The web UI works too: refresh the browser after installing, then Datacenter → Storage → Add → QuantaStor.


Documentation

Topic Covers
Installation Package install, upgrading and downgrading, upgrading from the patch-based alpha, manual install, building the package
Configuration Credentials, API tokens, the web UI and CLI options, QuantaStor HA storage pools, multiple Proxmox clusters, verifying the setup
Multipath (DM-MPIO) Using every iSCSI portal the appliance advertises, path loss behavior, network layout
Fibre Channel Attaching volumes over FC instead of iSCSI: requirements, zoning, adding the storage, troubleshooting
Container (LXC) support How container volumes work and their limitations
Troubleshooting Common errors and how to resolve them
Known limitations and supported versions Behavior to know about, sharing a pool between clusters, linked clones, supported Proxmox VE versions, mixed-version clusters
Architecture How the plugin sits between Proxmox VE and the QuantaStor REST API
Source layout and module reference What each file does, the Perl module interfaces, the PVE hooks
Running the tests Unit and integration tests
Contributing Development workflow and roadmap

The user guide is also published on the QuantaStor wiki: Proxmox Storage Plugin.


Troubleshooting

See docs/troubleshooting.md.

Multipath (DM-MPIO)

See docs/multipath.md.

Upgrading from the patch-based alpha

See Upgrading from the patch-based alpha in the installation guide.


License

See LICENSE in the repository root for license information.

About

QuantaStor Storage Plugin

Resources

Contributing

Stars

3 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages