Started README doc, removed support for xenial and bionic, added configs coming from the upstream cinder-backend

README.md

@@ -2,7 +2,10 @@
 
 ## Description
 
-TODO: Describe your charm in a few paragraphs of Markdown
+
+Cinder is the OpenStack block storage (volume) service and allow for different backends to be used to provision volumes.
+
+The cinder 3PAR charm provides integration between Cinder service and HPE 3PAR storage array solution. Users can request volumes using OpenStack APIs and get them provisioned on 3PAR and distributed with either Fiber Channel or iSCSI connection.
 
 ## Usage
 

config.yaml

@@ -1,43 +1,84 @@
 # Copyright 2021 pguimaraes
 # See LICENSE file for licensing details.
-#
-# This is only an example, and you should edit to suit your needs.
-# If you don't need config, you can remove the file entirely.
-# 
-# options:
-#   thing:
-#     default: 🎁
-#     description: A thing used by the charm.
-#     type: string
 options:
+  debug:
+    type: boolean
+    default: False
+    description: |
+      Sets debug mode to cinder 3PAR.
+  driver-type:
+    type: string
+    default: 'fc'
+    description: |
+      3PAR integration accepts either FC or iSCSI backend.
+      If set to 'fc', Fiber Channel will be used. Otherwise,
+      iscsi is selected.
+  hpe3par-iscsi-ips:
+    type: string
+    default: ''
+    description: |
+      Comma-separated list of IP:PORT to be used for the iscsi connection.
+  hpe3par-iscsi-chap-enabled:
+    type: boolean
+    default: True
+    description: |
+      If iscsi enabled, this option enables CHAP authentication or not.
+  hpe3par-snapshot-expiration:
+    type: int
+    default: 48
+    description: |
+      Time in hours when a snapshot expires and is deleted.
+  hpe3par-snapshot-retention:
+    type: int
+    default: 72
+    description: |
+      Time in hours a snapshot cannot be deleted.
   san-ip:
     type: string
-    description: IP address of SAN controller for SSH access to the array
+    description: | 
+      IP address of SAN controller for SSH access to the array
     default: ''
   san-login:
     type: string
-    description: Username for SAN controller for SSH access to the array
+    description: |
+      Username for SAN controller for SSH access to the array
     default: '' 
   san-password:
     type: string
-    description: Password for SAN controller for SSH access to the array
+    description: |
+      Password for SAN controller for SSH access to the array
     default: ''
   hpe3par-username:
     type: string
-    description: 3PAR username with the 'edit' role
+    description: |
+      3PAR username with the 'edit' role
     default: ''
   hpe3par-password:
     type: string
-    description: 3PAR password for the user specified in hpe3par_username
+    description: |
+      3PAR password for the user specified in hpe3par_username
     default: ''
   hpe3par-api-url:
     type: string
-    description: 3PAR WS API Server URL
+    description: |
+      3PAR WS API Server URL
     default: ''
   hpe3par-cpg:
     type: string
-    description: 3PAR CPG to use for volume creation
+    description: |
+      3PAR CPG to use for volume creation
     default: ''
+  hpe3par_cpg_snap:
+    type: string
+    default: ''
+    description: |
+      Sets the CPG name for the snapshot.
+      If empty, use the userCPG will be used.
+  hpe3par_target_nsp:
+    type: string
+    default: ''
+    description: |
+      
   volume-backend-name:
     type: string
     description: |

metadata.yaml

@@ -14,8 +14,6 @@ tags:
 - storage-array
 - misc
 series:
-- xenial
-- bionic
 - focal
 - groovy
 - hirsute