Merge pull request #55 from amulet1/cleanup3

Cleanup

.perltidyrc

@@ -1,20 +1,24 @@
 # .perltidyrc - Configuration for perltidy
 
-# Indentation
+## Indentation
+
 --indent-columns=2
 --continuation-indentation=2
 --extended-continuation-indentation
 
-# Line length and wrapping
+## Line length and wrapping
+
 --maximum-line-length=160
 
-# Brackets spaces
+## Brackets spaces
+
 --paren-tightness=0
 --brace-tightness=0
 --block-brace-tightness=0
 
-# Comments
+## Comments
+
+## Blocks
 
-# Blocks
 --cuddled-else
 --cuddled-blocks

README.md

@@ -56,7 +56,7 @@ blacklist {
 }
 
 blacklist_exceptions {
-  wwid "624a9370.*"
+  wwid "3624a9370.*"
   device {
     vendor "PURE"
   }
@@ -73,7 +73,7 @@ To manually install the plugin, follow these steps:
 
 ```bash
 # Clone repository
-git clone git@github.com:kolesa-team/pve-purestorage.git
+git clone https://github.com/kolesa-team/pve-purestorage-plugin.git
 # Navigate to the Plugin Directory
 cd pve-purestorage
 # Create the custom plugin directory if it does not already exist
@@ -96,11 +96,23 @@ sudo apt install ./libpve-storage-purestorage-perl.deb
 
 ## Configuration
 
-After installing the plugin, you need to configure Proxmox VE to use it. Since Proxmox VE does not currently support adding custom storage plugins via the GUI, you will need to manually edit the storage configuration file `/etc/pve/storage.cfg`.
+After installing the plugin, you need to configure Proxmox VE to use it. Since Proxmox VE does not currently support adding custom storage plugins via the GUI, you will need to open shell and use `pvesm` command to add it:
+
+```bash
+pvesm add purestorage <storage_id> \
+   --nodes <proxmox_node_list> \
+   --address https://<purestorage_fqdn_or_ip> \
+   --token <purestorage_api_token> \
+   --vgname <purestorage_volume_group_name> \
+   --hgsuffix <purestorage_host_suffix>
+   --content images
+```
+
+Alternatively, you can manually edit the storage configuration file `/etc/pve/storage.cfg`.
 
 ```
-purestorage: pure
-  nodes: <proxmox_node_list>
+purestorage: <storage_id>
+  nodes <proxmox_node_list>
   address https://<purestorage_fqdn_or_ip>
   token <purestorage_api_token>
   vgname <purestorage_volume_group_name>
@@ -110,12 +122,16 @@ purestorage: pure
 
 | Parameter | Description |
 | --------- | ----------- |
+| storage_id | The storage identifier (name under which it will appear in the Storage list) |
 | nodes | (`optional`) A comma-separated list of Proxmox node names. Use this parameter to limit the plugin to specific nodes in your cluster. If omitted, the storage is available to all nodes. |
 | address | The URL or IP address of the Pure Storage API endpoint. Ensure that the Proxmox VE nodes can reach this address over the network. |
 | token | The API token used for authentication with the Pure Storage array. This token must have sufficient permissions to create and manage volumes. |
-| vgname | The name of the volume group where new virtual disks will be created. This should match the configuration on your Pure Storage array. |
+| vgname | (`optional`, conflicts with `podname`) The volume group name where virtual disks will be stored. This should match the configuration on your Pure Storage array. |
+| podname | (`optional`, conflicts with `vgname`) The pod name where virtual disks will be stored. This should match the configuration on your Pure Storage array. |
+| vnprefix | (`optional`) The prefix to prepend to name of virtual disks. |
 | hgsuffix | (`optional`) A suffix that is appended to the hostname when the plugin interacts with the Pure Storage array. This can help differentiate hosts if necessary. |
 | content | Specifies the types of content that can be stored. For virtual machine disk images, use images. |
+| protocol | (`optional`, default is `iscsi`) Specifies the storage protocol (iscsi, fc) |
 
 > **_NOTE:_** Ensure that the token and other sensitive information are kept secure and not exposed publicly.