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.
This commit is contained in:
Kevin Scott Adams
GitHub
parent
b6e34be5e5
commit
ea3637d29a
262
README.md
262
README.md
|
|
@ -1,32 +1,59 @@
|
|||
# TrueNAS ZFS over iSCSI interface [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TCLNEMBUYQUXN&source=url)
|
||||
# TrueNAS ZFS over iSCSI Plugin for Proxmox VE
|
||||
|
||||
## 📢: ATTENTION 2023-08-16 📢: New repos are now online at [Cloudsmith](#new-installs).
|
||||
|
||||
### Updates 2023-02-12<br/> - Added `systemctl restart pvescheduler.service` command to the package.
|
||||
#### Roadmap
|
||||
* Update the documentation.
|
||||
* 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.
|
||||
## Activity
|
||||
|
||||
## Thank you for all that have recently donated to the project - Updated 2022-06-04
|
||||
<details>
|
||||
<summary>Expand to see the activity tree</summary>
|
||||
|
||||
<blockquote>
|
||||
|
||||
<details>
|
||||
<summary>2023-08-18</summary>
|
||||
|
||||
- Update and cleanup the README.md
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>2023-08-16</summary>
|
||||
|
||||
- Fixed repos. https://github.com/TheGrandWazoo/freenas-proxmox/issues/151, https://github.com/TheGrandWazoo/freenas-proxmox/issues/152, https://github.com/TheGrandWazoo/freenas-proxmox/issues/153 See [New Installs](#new-installs).
|
||||
- Fixed PayPal issues. https://github.com/TheGrandWazoo/freenas-proxmox/issues/154
|
||||
- Updated README.md
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>2023-08-12</summary>
|
||||
|
||||
- Fixed postinst issue with Windows-based EOL. https://github.com/TheGrandWazoo/freenas-proxmox/issues/149
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>2023-02-12</summary>
|
||||
|
||||
- Added `systemctl restart pvescheduler.service` command to the package based on https://github.com/TheGrandWazoo/freenas-proxmox/issues/109#issuecomment-1367527917
|
||||
|
||||
</details>
|
||||
|
||||
</blockquote>
|
||||
</details>
|
||||
|
||||
## Donations [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TCLNEMBUYQUXN&source=url)
|
||||
|
||||
<details>Donators<summary>Thank you for all that have donated to the project - Updated 2023-08-18</summary>
|
||||
|
||||
Alexander Finkhäuser - Recurring
|
||||
Bjarte Kvamme - Recurring
|
||||
Jonathan Schober - Recurring
|
||||
Frederic Silvi
|
||||
Security Camera
|
||||
Vincent Cui
|
||||
Jakub Jochec
|
||||
Carlos Galvez from Security Camera
|
||||
Sebastian Fischer
|
||||
Eugene van der Merwe
|
||||
Martin Gonzalez
|
||||
|
||||
Jakub Jochec
|
||||
Frederic Silvi
|
||||
Vincent Cui
|
||||
Mark Komarinski
|
||||
Jesse Bryan
|
||||
Maksym Vasylenko
|
||||
|
|
@ -38,71 +65,156 @@
|
|||
Marc Hodler
|
||||
Martin Gonzalez
|
||||
|
||||
### 'truenas-proxmox' 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.
|
||||
</details>
|
||||
|
||||
### 'truenas-proxmox-testing' repo (Follows the master branch)
|
||||
Will be 'beta' code for features, bugs, and updates.
|
||||
Their donations have allowed for:
|
||||
- A 4 Node Proxmox VE Cluster for testing and development.
|
||||
- Spin up old and new revisions of FreeNAS and TrueNAS.
|
||||
- 10Gb Ethernet Testing.
|
||||
- Multihomed configuration testing.
|
||||
- In progress and as best I can in a flat network.
|
||||
|
||||
## New Installs
|
||||
## Roadmap
|
||||
<details><summary>Roadmap details</summary>
|
||||
|
||||
### For stable releases, issue the following from a command line:
|
||||
```bash
|
||||
keyring_location=/usr/share/keyrings/ksatechnologies-truenas-proxmox-keyring.gpg
|
||||
curl -1sLf 'https://dl.cloudsmith.io/public/ksatechnologies/truenas-proxmox/gpg.284C106104A8CE6D.key' | gpg --dearmor >> ${keyring_location}
|
||||
```
|
||||
* Update the documentation - <i>In Progress</i>.
|
||||
* Restructure the main README.md for better readability.
|
||||
* Add some screenshots.
|
||||
* Fix Max Lun Limit issue.
|
||||
* https://github.com/TheGrandWazoo/freenas-proxmox/issues/150
|
||||
* Fix automated builds - <i>In Progress</i>.
|
||||
* Production - 'main' repo component.
|
||||
* Autoinstall the SSH keys.
|
||||
* Tech spike to see if it is even doable.
|
||||
* Hashicorp Vault integration.
|
||||
* Pull in secrets from a Hashicorp Vault service.
|
||||
* Tech spike to see if it is even doable.
|
||||
* Package the patches with the deb package.
|
||||
* Remove the need for git dependency.
|
||||
* Change to LWP::UserAgent
|
||||
* Remove dependency of the REST::Client because LWP::UserAgent is already installed and used by Proxmox VE.
|
||||
* Change from FreeNAS to TrueNAS - <i>In Progress</i>.
|
||||
* Cleanup the FreeNAS repo and name everything to TrueNAS to be inline with the product.
|
||||
* Add API key for direct TrueNAS services - <i>In Progress</i>.
|
||||
* 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.
|
||||
|
||||
Copy the following to /etc/apt/sources.list.d/ksatechnologies-repo.list
|
||||
```bash
|
||||
# Source: KSATechnologies
|
||||
# Site: https://cloudsmith.io
|
||||
# Repository: KSATechnologies / truenas-proxmox
|
||||
# Description: TrueNAS plugin for Proxmox VE - Production
|
||||
deb [signed-by=/usr/share/keyrings/ksatechnologies-truenas-proxmox-keyring.gpg] https://dl.cloudsmith.io/public/ksatechnologies/truenas-proxmox/deb/debian any-version main
|
||||
```
|
||||
</details>
|
||||
|
||||
### For development releases, issue the following from a command line:
|
||||
```bash
|
||||
keyring_location=/usr/share/keyrings/ksatechnologies-truenas-proxmox-testing-keyring.gpg
|
||||
curl -1sLf 'https://dl.cloudsmith.io/public/ksatechnologies/truenas-proxmox-testing/gpg.CACC9EE03F2DFFCC.key' | gpg --dearmor >> ${keyring_location}
|
||||
```
|
||||
## New Install Instructions
|
||||
|
||||
Copy the following to /etc/apt/sources.list.d/ksatechnologies-testing-repo.list
|
||||
```bash
|
||||
# Source: KSATechnologies
|
||||
# Site: https://cloudsmith.io
|
||||
# Repository: KSATechnologies / truenas-proxmox-testing
|
||||
# Description: TrueNAS plugin for Proxmox VE - Testing
|
||||
#deb [signed-by=/usr/share/keyrings/ksatechnologies-truenas-proxmox-testing-keyring.gpg] https://dl.cloudsmith.io/public/ksatechnologies/truenas-proxmox-testing/deb/debian any-version main
|
||||
```
|
||||
Then enable it from the Proxmox UI if you wish to use it.
|
||||
### Select at least one `Step 1.x` based on your preference. Can be combined.
|
||||
|
||||
### Update apt
|
||||
Then issue the following to install the package
|
||||
```bash
|
||||
apt update
|
||||
apt install freenas-proxmox
|
||||
```
|
||||
<details><summary>Step 1.0: For stable releases. <b>Enabled</b> by default.</summary>
|
||||
|
||||
Before freenas-proxmox-2.2.0-0-beta8 please issue the following:
|
||||
```
|
||||
systemctl restart pvescheduler.service
|
||||
```
|
||||
due to this post https://github.com/TheGrandWazoo/freenas-proxmox/issues/109#issuecomment-1367527917
|
||||
### truenas-proxmox repo - Currently follows the 2.0 branch.
|
||||
|
||||
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
|
||||
```
|
||||
Select one of the following GPG Key locations based on your preference.
|
||||
|
||||
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 non-patched Proxmox VE install.
|
||||
```bash
|
||||
# Preferred - based on documentation. Copy and paste to bash command line:
|
||||
keyring_location=/usr/share/keyrings/ksatechnologies-truenas-proxmox-keyring.gpg
|
||||
```
|
||||
|
||||
#### 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.
|
||||
```bash
|
||||
# Alternative - If you wish to continue with the old ways. Copy and paste to bash command line:
|
||||
keyring_location=/etc/apt/trusted.gpg.d/ksatechnologies-truenas-proxmox.gpg
|
||||
```
|
||||
|
||||
Copy and paste to bash command line to load the GPG key to the location selected above:
|
||||
```bash
|
||||
curl -1sLf 'https://dl.cloudsmith.io/public/ksatechnologies/truenas-proxmox/gpg.284C106104A8CE6D.key' | gpg --dearmor >> ${keyring_location}
|
||||
```
|
||||
|
||||
Copy and paste the following code to bash command line to create '/etc/apt/sources.list.d/ksatechnologies-repo.list'
|
||||
```bash
|
||||
cat << EOF > /etc/apt/sources.list.d/ksatechnologies-repo.list
|
||||
# Source: KSATechnologies
|
||||
# Site: https://cloudsmith.io
|
||||
# Repository: KSATechnologies / truenas-proxmox
|
||||
# Description: TrueNAS plugin for Proxmox VE - Production
|
||||
deb [signed-by=${keyring_location}] https://dl.cloudsmith.io/public/ksatechnologies/truenas-proxmox/deb/debian any-version main
|
||||
|
||||
EOF
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Step 1.1: For development releases. <i>Disabled</i> by default.</summary>
|
||||
|
||||
### truenas-proxmox-testing repo - Follows the master branch and you wish to test before a stable release (beta).
|
||||
|
||||
Select one of the following GPG Key locations based on your preference.
|
||||
|
||||
```bash
|
||||
# Preferred - based on documentation. Copy and paste to bash command line:
|
||||
keyring_location=/usr/share/keyrings/ksatechnologies-truenas-proxmox-testing-keyring.gpg
|
||||
```
|
||||
|
||||
```bash
|
||||
# Alternative - If you wish to continue with the old ways. Copy and paste to bash command line:
|
||||
keyring_location=/etc/apt/trusted.gpg.d/ksatechnologies-truenas-proxmox-testing.gpg
|
||||
```
|
||||
|
||||
Copy and paste to bash command line to load the GPG key to the location selected above:
|
||||
```bash
|
||||
curl -1sLf 'https://dl.cloudsmith.io/public/ksatechnologies/truenas-proxmox-testing/gpg.CACC9EE03F2DFFCC.key' | gpg --dearmor >> ${keyring_location}
|
||||
```
|
||||
|
||||
Copy and paste the following code to bash command line to create '/etc/apt/sources.list.d/ksatechnologies-testing-repo.list'
|
||||
```bash
|
||||
cat << EOF > /etc/apt/sources.list.d/ksatechnologies-testing-repo.list
|
||||
# Source: KSATechnologies
|
||||
# Site: https://cloudsmith.io
|
||||
# Repository: KSATechnologies / truenas-proxmox-testing
|
||||
# Description: TrueNAS plugin for Proxmox VE - Testing
|
||||
deb [signed-by=${keyring_location}] https://dl.cloudsmith.io/public/ksatechnologies/truenas-proxmox-testing/deb/debian any-version main
|
||||
|
||||
EOF
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Step 2.0: Next step after completing any combination of the 1.x steps</summary>
|
||||
|
||||
### Update apt
|
||||
|
||||
Then issue the following to install the package
|
||||
```bash
|
||||
apt update
|
||||
apt install freenas-proxmox
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Step 3.0: Maintenance.</summary>
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
</details>
|
||||
|
||||
## Uninstall truenas-proxmox
|
||||
|
||||
<details><summary>If you wish not to use the package you may remove it at anytime with the following:</summary>
|
||||
|
||||
```
|
||||
apt [remove|purge] freenas-proxmox
|
||||
```
|
||||
|
||||
This will place you back to a normal and non-patched Proxmox VE install.
|
||||
|
||||
</details>
|
||||
|
||||
## Notes:
|
||||
|
||||
### 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 TrueNAS. The code segment should start out `mkdir /etc/pve/priv/zfs`.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue