Merge pull request TheGrandWazoo#131 from TheGrandWazoo/master

Version 2.3.0-1

Author: TheGrandWazoo

.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

README.md

@@ -1,63 +1,66 @@
-# FreeNAS ZFS over iSCSI interface  [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TCLNEMBUYQUXN&source=url)
-
-## Thank you for all that have donated to the project
+# TrueNAS ZFS over iSCSI interface  [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TCLNEMBUYQUXN&source=url)
+
+### Updates 2023-02-12<br/>  - Added `systemctl restart pvescheduler.service` command to the package.
+#### Roadmap
+* Fix automated builds.
+  * Production - 'main' repo component.
+* Package the patches with the deb package.
+  * Remove the need for the git dependency.
+* Change to LWP::UserAgent
+  * Remove depenancy of the REST::Client because LWP::UserAgent is already installed and used by Proxmox VE.
+* Change from FreeNAS to TrueNAS.
+  * Cleanup the FreeNAS repo and name everything to TrueNAS to be inline with the product.
+* Add API key for direct TrueNAS services.
+  * Will be a new enable field and API key and will only be used by the plugin.
+  * You will still need the SSH keys, username, and password because of Proxmox VE using `iscsiadm` to get the list of disks.
+    * This is tricky because the format needs to be that of the output of 'zfs list' which is not part of the LunCmd but that of the backend Proxmox VE system and the API's do a bunch of JSON stuff.
+
+## Thank you for all that have recently donated to the project - Updated 2022-06-04
+    Alexander Finkhäuser - Recurring
+    Bjarte Kvamme - Recurring
+    Jonathan Schober - Recurring
+    Frederic Silvi
+    Security Camera
+    Vincent Cui
+    Jakub Jochec
+    
+    Mark Komarinski
+    Jesse Bryan
+    Maksym Vasylenko
+    Daniel Most
+    Velocity Host
+    Robert Hancock
     Clevvi Technology
-    Mark Elkins - Reoccuring
+    Mark Elkins
     Marc Hodler
     Martin Gonzalez
 
+### 'main' repo (Follows a release branch - Current 2.x) Currently unavailable.
+Will be production ready code that has been tested (as best as possible) from the 'testing' repo.
 
-I have created a debian repo that holds a package to install scripts into the Proxmox VE system that will automatically do all the necessary patching when one or any combo of the following files are changed in the Proxmox VE stream:
-```
-/usr/share/pve-manager/js/pvemanagerlib.js    <- From package pve-manager
-/usr/share/pve-docs/api-viewer/apidoc.js      <- From package pve-docs
-/usr/share/perl5/PVE/Storage/ZFSPlugin.pm     <- From package libpve-storage-perl
-```
-It will also install the /usr/share/perl5/PVE/Storage/LunCmd/FreeNAS.pm (The FreeNAS API plugin), git and librest-client-perl
+### 'testing' repo (Follows the master branch)
+Will be 'beta' code for features, bugs, and updates.
 
-If you wish, you may remove the directory 'freenas-proxmox' where your system is currently
-housing the repo and then issue the following to have a clean system before installing the
-package.
-
-On Proxmox 5
+## New Installs.
+Issue the following from a command line:
 ```bash
-apt install --reinstall pve-manager pve-docs libpve-storage-perl
+curl https://ksatechnologies.jfrog.io/artifactory/ksa-repo-gpg/ksatechnologies-release.gpg -o /etc/apt/trusted.gpg.d/ksatechnologies-release.gpg
+curl https://ksatechnologies.jfrog.io/artifactory/ksa-repo-gpg/ksatechnologies-repo.list -o /etc/apt/sources.list.d/ksatechnologies-repo.list
 ```
 
-On Proxmox 6
-```bash
-apt reinstall pve-manager pve-docs libpve-storage-perl
-```
-
-Issue the following to install the repo and get your Proxmox VE updating the FreeNAS patches automatically:
-```bash
-wget http://repo.ksatechnologies.com/debian/pve/ksatechnologies-release.gpg -O /etc/apt/trusted.gpg.d/ksatechnologies-repo.gpg
-echo "deb http://repo.ksatechnologies.com/debian/pve stable freenas-proxmox" > /etc/apt/sources.list.d/ksatechnologies-repo.list
-```
-
-### I will be using a 'testing' repo to develop the new phase of the Proxmox VE FreeNAS plugin.
-#### This next phase will introduce the following...
-* Auto detection of the Proxmox VE version
-* Auto detection of the FreeNAS version so it will use the V1 or V2 API's or you can select it manually via the Proxmox VE FreeNAS modal
-* Remove the need for SSH keys and use the API
-  * This is tricky because the format needs to be that of the output of'zfs list' which is not part of the LunCmd but that of the backend Proxmox VE system and the API's do a bunch of JSON stuff.
-
-#### If you'd like, you may also issue the following commands now or later to use the 'testing' repo.
-#### Just comment the 'stable' line and uncomment the 'testing' line in 
-#### /etc/apt/sources.list.d/ksatechnologies-repo.list to use. 'testing' is disabled be default.
+Then issue the following to install the package
 ```bash
-echo "" >> /etc/apt/sources.list.d/ksatechnologies-repo.list
-echo "# deb http://repo.ksatechnologies.com/debian/pve testing freenas-proxmox" >> /etc/apt/sources.list.d/ksatechnologies-repo.list
+apt update
+apt install freenas-proxmox
 ```
 
-Then issue the following to install the package
+Before freenas-proxmox-2.2.0-0-beta8 please issue the following:
 ```
-apt update
-apt install freenas-proxmox
+systemctl restart pvescheduler.service
 ```
+due to this post https://github.com/TheGrandWazoo/freenas-proxmox/issues/109#issuecomment-1367527917
 
-Then just do your regular upgrade via apt to your system; the package will automatically
-issue all commands to patch the files.
+Then just do your regular upgrade via apt at the command line or the Proxmox Update subsystem; the package will automatically issue all commands to patch the files.
 ```bash
 apt update
 apt [full|dist]-upgrade
@@ -67,16 +70,16 @@ If you wish not to use the package you may remove it at anytime with
 ```
 apt [remove|purge] freenas-proxmox
 ```
-This will place you back to a normal and unpatched Proxmox VE install.
+This will place you back to a normal and non-patched Proxmox VE install.
 
-Please be aware that this plugin uses the FreeNAS APIs and NOT the ssh/scp interface like the other plugins use, but...
+#### NOTE: Please be aware that this plugin uses the TrueNAS APIs but still uses SSH keys due to the underlying Proxmox VE perl modules that use the ```iscsiadm``` command.
 
-You will still need to configure the SSH connector for listing the ZFS Pools because this is currently being done in a Proxmox module (ZFSPoolPlugin.pm). To configure this please follow the steps at https://pve.proxmox.com/wiki/Storage:_ZFS_over_iSCSI that have to do with SSH between Proxmox VE and FreeNAS. The code segment should start out `mkdir /etc/pve/priv/zfs`.
+You will still need to configure the SSH connector for listing the ZFS Pools because this is currently being done in a Proxmox module (ZFSPoolPlugin.pm). To configure this please follow the steps at https://pve.proxmox.com/wiki/Storage:_ZFS_over_iSCSI that have to do with SSH between Proxmox VE and TrueNAS. The code segment should start out `mkdir /etc/pve/priv/zfs`.
 
 1. Remember to follow the instructions mentioned above for the SSH keys.
 
-1. Refresh the Proxmox GUI in your browser to load the new Javascript code.
+2. Refresh the Proxmox GUI in your browser to load the new Javascript code.
 
-1. Add your new FreeNAS ZFS-over-iSCSI storage using the FreeNAS-API.
+3. Add your new TrueNAS ZFS-over-iSCSI storage using the TrueNAS-API.
 
-1. Thanks for your support.
+4. Thanks for your support.