From a4eb3e5557dd46faae7070aa2e0a9cd9f69345fe Mon Sep 17 00:00:00 2001 From: Kevin Adams Date: Sun, 24 May 2026 16:22:06 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20split=20Prerequisites=20by=20version=20?= =?UTF-8?q?=E2=80=94=20v3.0=20needs=20no=20SSH=20keys=20or=20pre-created?= =?UTF-8?q?=20targets?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit v3.0 is fully API-driven: no SSH keys, no pre-created iSCSI targets. v2.x still requires both. Separating them prevents confusion for users on either version and removes incorrect guidance from the v3.0 path. Co-Authored-By: Claude Sonnet 4.6 --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 687d6bd..14431b6 100644 --- a/README.md +++ b/README.md @@ -77,16 +77,28 @@ Check the [Releases page](https://github.com/TheGrandWazoo/freenas-proxmox/relea ## Prerequisites -Before installing, ensure the following are in place on your **Proxmox VE node**: +### v3.0 (upcoming) + +v3.0 is a fully API-driven custom storage plugin. No SSH keys required. + +1. On **TrueNAS**, ensure the iSCSI service is running and an iSCSI **portal** and **initiator group** are configured. The plugin creates per-VM iSCSI targets automatically — you do not need to pre-create a target. + +2. Generate a TrueNAS API key: + - TrueNAS SCALE: *System Settings → API Keys → Add* + - TrueNAS CORE 13: *gear icon (top-right) → API Keys → Add* + + Copy the key — you will need it during storage configuration in Proxmox. + +### v2.x (current stable) 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`). -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. +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. 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* - + Copy the key — you will need it during storage configuration in Proxmox. ---