diff --git a/README.md b/README.md index 08842d8..53b8df4 100644 --- a/README.md +++ b/README.md @@ -101,17 +101,15 @@ v3.0 is a fully API-driven custom storage plugin. No SSH keys required. > > For live VM migration with TPM, the TPM state disk must also be on shared filesystem storage (NFS or CephFS), not on this plugin's storage. -### v2.x (current stable) +### v2.x (legacy) -1. **SSH keys** configured between Proxmox and TrueNAS — required for ZFS pool listing by the Proxmox core (see the [Proxmox wiki](https://pve.proxmox.com/wiki/Storage:_ZFS_over_iSCSI), section starting with `mkdir /etc/pve/priv/zfs`). +> v2.x is no longer the recommended version. See [Migrating from v2.x](docs/migrating-from-v2.md). -2. On **TrueNAS**, an iSCSI **target** and **initiator group** must exist and be configured. The plugin manages extents and target-to-extent mappings, but the target itself must be pre-created. +1. **SSH keys** configured between each Proxmox node and TrueNAS — required by the Proxmox core for ZFS pool listing (see the [Proxmox wiki](https://pve.proxmox.com/wiki/Storage:_ZFS_over_iSCSI), section starting with `mkdir /etc/pve/priv/zfs`). -3. On **TrueNAS SCALE** or **TrueNAS CORE 13+**, generate an API key: - - TrueNAS SCALE: *System Settings → API Keys → Add* - - TrueNAS CORE 13: *gear icon (top-right) → API Keys → Add* +2. On **TrueNAS**, a pre-created iSCSI **target** and **initiator group**. - Copy the key — you will need it during storage configuration in Proxmox. +3. A TrueNAS API key (SCALE: *System Settings → API Keys*; CORE 13: *gear icon → API Keys*). --- diff --git a/docs/architecture.md b/docs/architecture.md index 8ae4088..6ec40f5 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -44,7 +44,7 @@ The plugin does NOT manage the iSCSI initiator side. QEMU's built-in libiscsi op ### What the Plugin Does Not Do -- **Pool listing**: Proxmox's `status()` call returns pool capacity via the TrueNAS API, but ZFS pool enumeration for the "Add Storage" wizard still requires SSH access through PVE's upstream `ZFSPoolPlugin.pm`. This is a Proxmox limitation outside the plugin's scope. +- **Pool name auto-discovery**: The user types the TrueNAS pool name directly in the Add Storage dialog. The plugin does not enumerate available pools. Pool capacity is returned via the TrueNAS API (`GET /pool/dataset`), not SSH. - **Snapshots on PVE 8.x**: The `volume_snapshot` family of methods is defined but will return an unsupported error on PVE 8. PVE 9.0's Snapshot-as-Volume-Chains feature is the target integration point (v3.1.0, ADR-008). - **TPM state disks**: swtpm (the virtual TPM backend) cannot use `iscsi://` URIs; it requires a local filesystem path. TPM disks must be placed on a different storage type.