Commit Graph

50 Commits

Author SHA1 Message Date
Kevin Adams 5919910b3c docs: update compatibility matrix to reflect actual tested state
- v3.x beta: tested on PVE 8.4.x, CORE 13.0-U6, SCALE 24.10 + 25.04 + 25.10
- v3.x PVE 9.x: split to planned row with known issue ref (#266)
- Version notices: PVE 8 now points to beta, PVE 9 warns of known issue
- Drop untested SCALE Cobia/Dragonfish from tested column
- "upcoming" → "beta", "In development" → "Beta — active development"

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-31 10:04:33 -04:00
Kevin Adams 9b2ecb8093 chore: rename package freenas-proxmox → truenas-proxmox (#262)
Introduces truenas-proxmox as the real package and freenas-proxmox as a
transitional meta-package that Depends on truenas-proxmox. Existing
users running apt upgrade automatically pull in the new package; the
migration one-liner (apt install truenas-proxmox && apt purge
freenas-proxmox) completes the transition. The freenas-proxmox package
name will not exist in v4.0.

Changes:
- packaging/DEBIAN/: Package renamed to truenas-proxmox, INSTALL_DIR
  and LOG_FILE updated to /usr/share/truenas-proxmox and
  /var/log/truenas-proxmox-install.log; Replaces/Breaks fields added
- packaging/DEBIAN-transitional/: new empty meta-package that pulls in
  truenas-proxmox and prints a deprecation notice on configure
- build.yml: PACKAGE_NAME=truenas-proxmox; both debs built and
  published to Cloudsmith; transitional postinst added to shellcheck
- All GitHub repo URLs updated to TheGrandWazoo/truenas-proxmox
- apt install/remove/purge commands in docs updated to truenas-proxmox
- GitHub repo rename to truenas-proxmox pending (gh repo rename step)

Closes #262

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-25 22:49:28 -04:00
Kevin Adams d6e7e159e3 docs: add prominent sponsor callout and expand Support section in README
Move sponsor ask above the fold with context (4M downloads, ISP/MSP
production use) so it reaches users who never scroll to the bottom.
Expand the Support section with tier descriptions and remove PayPal
in favour of GitHub Sponsors which has no platform fee.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-25 11:04:39 -04:00
Kevin Adams 0a8e7e7484 docs: add TPM limitation callout and v2.x→v3.0 migration path (#260, #228, #252)
- Add TPM state disk known limitation to v3.0 Prerequisites with clear
  workaround (local-lvm or NFS for tpmstate0, shared storage for live
  migration with TPM)
- Expand Upgrading section with v2.x→v3.0 Move Disk migration path,
  confirmed tested on PVE 8.4 with CORE 13.0-U6 and SCALE 24.10
- Note in-place rename is not supported; Move Disk is the supported path

Closes #260, #228, #252

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-25 08:34:40 -04:00
Kevin Adams eb058266a9 docs: mark CORE 13.0-U6 and SCALE Electric Eel (24.10) as tested in v3.0 matrix
Cobia and Dragonfish remain listed as compatible but are not yet tested
against v3.0 — would require reinstalling those versions in the lab.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-24 17:10:11 -04:00
Kevin Adams a4eb3e5557 docs: split Prerequisites by version — v3.0 needs no SSH keys or pre-created targets
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 <noreply@anthropic.com>
2026-05-24 16:22:06 -04:00
Kevin Adams 678bf7a850 docs: add troubleshooting layer guide to distinguish plugin vs iSCSI vs Proxmox errors
Closes #257. Many support issues are misrouted because users don't know
which layer generated the error — the plugin (REST API orchestration),
the iSCSI/QEMU data path, or the Proxmox core storage stack. Added a
new section at the top of Troubleshooting that explains all three layers
with example log lines and a quick-triage table.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-24 16:15:28 -04:00
Kevin Adams 187f3f9e3f docs: explain GiB vs GB disk size discrepancy in Troubleshooting
Proxmox enters and allocates disk sizes in GiB (base-2) while TrueNAS
and many storage UIs display sizes in GB (base-10). This causes the
reported size to appear ~7% larger than the number entered, which is
correct and expected behaviour. Adds a reference table for common sizes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-24 09:06:02 -04:00
Kevin Adams 6ec31f76a7 docs: fix TrueNAS CORE 13 API key navigation path
CORE 13 moved API Keys under the gear icon (top-right), not System menu.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-22 22:53:25 -04:00
Kevin Adams ee708f3148 docs: add SCALE 25.04 API key revocation warning and update volblocksize note
- New troubleshooting entry: SCALE 25.04 revokes existing API keys on
  upgrade; users must regenerate and update truenas_secret in PVE config.
  Also notes HTTPS enforcement and links to #243 for REST deprecation.
- Updated volblocksize entry: v2.4.0 auto-corrects blocksize, so the
  "fix" is now informational rather than a manual step.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-22 22:35:06 -04:00
Kevin Adams 6571ab23d1 fix: remove zvol delete from run_delete_lu to eliminate false negative (#240)
ZFSPlugin's free_image deletes the zvol via SSH after calling our
run_delete_lu. Our earlier addition of freenas_delete_zvol in
run_delete_lu caused a double-delete: SSH would fail, free_image's
error recovery would call run_create_lu on the now-missing zvol,
producing a spurious "Unable to create lun (rolled back)" in the task
log even though the migration had already succeeded.

freenas_delete_zvol remains in run_create_lu's rollback path where it
correctly cleans up zvols orphaned by a failed LUN creation (#239).

Also documents ZFS blocksize requirements for TrueNAS SCALE (16k) vs
CORE (8k) in README configuration and troubleshooting sections (#241).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-20 11:50:12 -04:00
Kevin Adams b41fefb72b docs: add PVE version compatibility warnings across all user touchpoints
Users on unsupported PVE versions now get clear guidance at every
layer — README, install time, and GitHub release notes — rather than
silently failing or getting confusing patch errors.

- README: replace bare compatibility table with a full matrix and
  prominent callout blocks for PVE 7 (last v2.x), PVE 8 (EOL
  2026-08-31), PVE 9+ (use v3.0), and PVE ≤6 (unsupported)
- postinst: add check_pve_version() that exits on PVE < 7, warns
  loudly on PVE 7 (stay on v2.x, do not upgrade to v3.0), notes
  the PVE 8 EOL date, and warns on PVE 9+ (v2.x not supported)
- build.yml release template: add a version compatibility table so
  every GitHub release prominently states who should and should not
  install it

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-19 18:33:13 -04:00
Kevin Adams 636cd06ff6 Phase 1 project revival + PR fixes (#207, #209, #213)
Project infrastructure:
- Replace MIT license with AGPL-3.0 (KSA Technologies, LLC)
- Full README rewrite with badges, compatibility table, token auth docs
- Add CHANGELOG, CONTRIBUTING, DONORS, SECURITY docs
- Add GitHub issue/PR templates, update FUNDING.yml and stale.yml
- Replace external packer repo dispatch with self-contained CI (build.yml)
- Add packaging/DEBIAN/ with postinst/postrm/triggers (no git clone at install)
- Add .perlcriticrc for static analysis
- Add .claude/cos/ ADRs, plans, and runbooks

Bug fixes from community PRs:
- Fix bearer token check in freenas_api_connect: defined() && value instead of
  defined() alone, so truenas_token_auth=0 no longer activates Bearer Token auth (#207)
- Fix LUN 0 falsy bug in ZFSPlugin patch: !$guid -> !defined $guid in both
  zfs_get_lun_number and zfs_get_wwid_number, fixing VMs on LUN 0 for PVE 9 (#209)
- Fix syslog typo "wtih" -> "with" in run_list_extent (#213)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-15 14:22:04 -04:00
Kevin Scott Adams ebc461a519 Updated README.md
- Updated README.md to announce the Bearer Token Authentication feature.
2024-01-07 09:43:56 -05:00
Kevin Scott Adams ea3637d29a
Update README.md
- Update README.md to be more structured and selective from a visitors view.
- Update the Roadmap section.
- Update the Donators list.
- Update the New Install Instructions section to allow the visitor to select the GPG location they want to use.
- Update the Activity section.
- Fix spelling errors.
2023-08-19 10:46:39 -04:00
Kevin Scott Adams b6e34be5e5
Update README.md for typo
- Fixed testing repo name in install section.
2023-08-16 09:05:06 -04:00
Kevin Scott Adams ca48a9e517
Update README.md for new repos
- Updated anchor.
- Added documentation to roadmap.
2023-08-16 09:03:20 -04:00
Kevin Scott Adams 65c1c250df
Update README.md
- Change announcement for the Cloudsmith repos.
- Changed the New Install section to include instructions for stable and development repos.
2023-08-16 08:54:15 -04:00
Kevin Scott Adams 3977be6daa
Update README.md
Changed Attention description to notify that a new repo is on the horizon.
2023-08-09 13:02:43 -04:00
Kevin Scott Adams a86bf3eb95
Update README.md
Update README.md

- Added ATTENTION due to JFrog canceling my subscription.
2023-07-13 09:09:22 -04:00
Kevin Scott Adams b05124592f Update README.md
- Updated Roadmap and Updates.
- Removed Attention
- Added a note about systemctl restart pvescheduler.service before
2.2.0-0-beta8.
2023-02-12 17:14:15 -05:00
Kevin Scott Adams d2f5c2b27f Update readme.MD.
- Updated new repo install.
- Updated Roadmap.
- Cleanup old information.
- Updated Donation list.
- Changed FreeNAS to TrueNAS in most of the instructions.
2022-06-04 09:58:34 -04:00
Kevin Scott Adams a2e395658d
Update README.md 2022-05-31 16:58:53 -04:00
Kevin Scott Adams 4039df8a59
Update README.md 2022-05-31 16:56:05 -04:00
Kevin Scott Adams aea45c992f
Update README.md 2022-05-25 21:46:55 -04:00
Kevin Scott Adams 2e9d736ebd
Update README.md 2022-05-25 21:45:15 -04:00
Kevin Scott Adams 7ecd64f79a
Update README.md 2022-05-25 21:34:58 -04:00
Kevin Scott Adams 50a474bea1
Update README.md
Updated Donators - Thank you again.
Updated messages of repo and development status.
2022-05-20 10:02:17 -04:00
Kevin Scott Adams bfb1962503
Update README.md 2022-05-11 15:45:14 -04:00
Kevin Scott Adams 4663fca8b0 Trigger a build.
- Just touch the README.md to trigger.
2022-04-03 13:25:58 -04:00
Kevin Scott Adams e4c9f12f03 Update README.md
- Trigger a build.
2022-04-03 11:10:13 -04:00
Kevin Scott Adams 8da7d98538 Update README.md
- Need to trigger a build.
2022-04-03 11:03:29 -04:00
Kevin Scott Adams 7976b1cfe8 Update README.md
- Possible outage due to lack of fundings.
2022-04-03 10:51:11 -04:00
Quinn Wood 94cc0a67f9
Removed Unicode character
in favor of inline code tags. The characters don't display on my machine, but this may just be me.
2020-11-28 22:16:22 -06:00
Kevin Scott Adams 739b6fb0f6 Update README.md
- Added Martin and sorted
2020-07-30 14:51:41 -04:00
Tristan Lostroh 2cd8ac2a1d
Update the Readme to more accurately reflect the donation 2020-07-28 15:18:08 +10:00
Kevin Scott Adams 9f9b6ed171 Formatting and spelling errors
- Change some formatting and placement of lines.
- Fixed a few typos
2020-06-02 08:31:44 -04:00
Kevin Scott Adams 2a9e478704 Update the README.md for new features.
- Instruct the use of the package system to auto update the needed files
on the Prommox system
- Archive original README.md in the WIKI.
2020-06-01 16:24:55 -04:00
Kevin Scott Adams 4b46f2240f Updated patches for the latest Proxmox VE updates and added donation
button.

- Update README.md to include a requested donation button for the
project. Thank you.
- Updated patch for pvemanagerlib.js for Proxmox VE pve-manager: 6.0-5
- Updated patch for apidoc.js for Proxmox VE pve-docs: 6.0-4
- Updated patch for ZFSPlugin.pm for Proxmox VE libpve-storage-perl:
6.0-6
2019-08-07 22:57:22 -04:00
Kevin Scott Adams 16b3bd1a0b Update the FreeNAS-API related files to the latest Proxmox VE
- Updated apidoc.js.patch to reflect pve-docs: 5.4-2
- New apidoc-5.4-2_1.js.patch
- Updated pvemanagerlib.js.patch to reflect pve-manager: 5.4-5
- New pvemanagerlib-5.4-5_1.js.patch
- Updated ZFSPlugin.pm.patch to reflect libpve-storage-perl: 5.0-42
- New ZFSPlugin-5.0-42.pm.patch
- Revised the README.md
2019-05-11 11:13:54 -04:00
KevinAdams 8e2f6673b0 Small grammer changes 2019-01-18 13:31:39 -05:00
KevinAdams 4c6856828e Added some additional notes and conditions. 2019-01-18 13:28:40 -05:00
Kevin Scott Adams 9a14130375 Updated files to latest Proxmox repo as of 2018-10-16.
- Updated pvemanagerlib.js.patch to reflect pve-manager version 5.2-9
- Updated ZFSPlugin.pm.patch to reflect libpve-storage-perl version
5.0-30
- Fixed issue with multipathing when NOT multipathing on the run_command
function.
- Fixed whitespace in README.md
2018-10-16 08:19:01 -04:00
Krzysztof Raczkowski bc463f1229 Updated README. 2018-07-11 12:43:08 +02:00
Kevin Scott Adams 23990fc008 Add tainted checking to iscsi_lunid
- So we do not have to change the /usr/bin/pvedaemon a small fix to
check the $item->{'iscsi_target'} varaible from the API call is needed.
This closes issue #3.
2018-06-26 15:00:09 -04:00
Kevin Scott Adams 1943a454a2 Small README.md update
- And the removed files did not take place on the last commit.
2018-06-10 23:07:40 -04:00
Kevin Scott Adams 4289fb28b5 Use the librest-client-perl package
- Why repo something that is already part of a package in the debian
system. Both files are exact except for one whilespace.
2018-06-10 23:04:04 -04:00
Eugene Chow 45e3a2c615 Added backup flag to patch command 2018-06-04 15:14:22 +08:00
Eugene Chow 041a44681d Updated README 2018-06-04 15:12:28 +08:00
Eugene Chow 4438cdae9d Converted README to markdown 2018-06-04 15:07:33 +08:00