prepare v0.1.0

LINBIT · Aug 29, 2019 · a2e5933 · a2e5933
1 parent b876e8d
commit a2e5933
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 12 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -18,8 +18,9 @@ var controller net.IP // create and delete
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-	Use:   "linstor-iscsi",
-	Short: "Manages Highly-Available iSCSI targets",
+	Use:     "linstor-iscsi",
+	Version: "0.1.0",
+	Short:   "Manages Highly-Available iSCSI targets",
 	Long: `linstor-iscsi manages higly available iSCSI targets by leveraging on linstor
 and Pacemaker. Setting linstor including storage pools and resource groups
 as well as Corosync and Pacemaker's properties a prerequisite to use this tool.`,

diff --git a/docs/md/linstor-iscsi_create.md b/docs/md/linstor-iscsi_create.md
@@ -14,7 +14,7 @@ prefixed with p_, contain the name and a resource type postfix.
 
 For example:
 linstor-iscsi create --iqn=iqn.2019-08.com.linbit:example --ip=192.168.122.181 \
- -username=foo --lun=0 --password=bar --resource_group=ssd_thin_2way --size=2G
+ -username=foo --lun=1 --password=bar --resource_group=ssd_thin_2way --size=2G
 
 Creates linstor resources example_lu0 and
 pacemaker primitives p_iscsi_example_ip, p_iscsi_example, p_iscsi_example_lu0
@@ -32,7 +32,7 @@ linstor-iscsi create [flags]
   -p, --password string         Set the password (required)
       --portals string          Set up portals, if unset, the service ip and default port
   -g, --resource-group string   Set the LINSTOR resource-group (default "default")
-      --size string             Set the size (required) (default "1G")
+      --size unit               Set a size (e.g, 1TiB) (default 1GiB)
   -u, --username string         Set the username (required)
 ```
 
@@ -41,7 +41,7 @@ linstor-iscsi create [flags]
 ```
   -i, --iqn string        Set the iSCSI Qualified Name (e.g., iqn.2019-08.com.linbit:unique) (required)
       --loglevel string   Set the log level (as defined by logrus) (default "info")
-  -l, --lun int           Set the LUN Number (required)
+  -l, --lun int           Set the LUN Number (required) (default 1)
 ```
 
 ### SEE ALSO

diff --git a/docs/md/linstor-iscsi_delete.md b/docs/md/linstor-iscsi_delete.md
@@ -8,7 +8,7 @@ Deletes an iSCSI target by stopping and deliting the pacemaker resource
 primitives and removing the linstor resources.
 
 For example:
-linstor-iscsi delete --iqn=iqn.2019-08.com.linbit:example --lun=0
+linstor-iscsi delete --iqn=iqn.2019-08.com.linbit:example --lun=1
 
 ```
 linstor-iscsi delete [flags]
@@ -26,7 +26,7 @@ linstor-iscsi delete [flags]
 ```
   -i, --iqn string        Set the iSCSI Qualified Name (e.g., iqn.2019-08.com.linbit:unique) (required)
       --loglevel string   Set the log level (as defined by logrus) (default "info")
-  -l, --lun int           Set the LUN Number (required)
+  -l, --lun int           Set the LUN Number (required) (default 1)
 ```
 
 ### SEE ALSO

diff --git a/docs/md/linstor-iscsi_list.md b/docs/md/linstor-iscsi_list.md
@@ -25,7 +25,7 @@ linstor-iscsi list [flags]
 ```
   -i, --iqn string        Set the iSCSI Qualified Name (e.g., iqn.2019-08.com.linbit:unique) (required)
       --loglevel string   Set the log level (as defined by logrus) (default "info")
-  -l, --lun int           Set the LUN Number (required)
+  -l, --lun int           Set the LUN Number (required) (default 1)
 ```
 
 ### SEE ALSO

diff --git a/docs/md/linstor-iscsi_start.md b/docs/md/linstor-iscsi_start.md
@@ -9,7 +9,7 @@ In case it does not start use your favourite pacemaker tools to analyze
 the root cause.
 
 For example:
-linstor-iscsi start --iqn=iqn.2019-08.com.linbit:example --lun=0
+linstor-iscsi start --iqn=iqn.2019-08.com.linbit:example --lun=1
 
 ```
 linstor-iscsi start [flags]
@@ -26,7 +26,7 @@ linstor-iscsi start [flags]
 ```
   -i, --iqn string        Set the iSCSI Qualified Name (e.g., iqn.2019-08.com.linbit:unique) (required)
       --loglevel string   Set the log level (as defined by logrus) (default "info")
-  -l, --lun int           Set the LUN Number (required)
+  -l, --lun int           Set the LUN Number (required) (default 1)
 ```
 
 ### SEE ALSO

diff --git a/docs/md/linstor-iscsi_stop.md b/docs/md/linstor-iscsi_stop.md
@@ -8,7 +8,7 @@ Sets the target role attribute of a Pacemaker primitive to stopped.
 This causes pacemaker to stop the components of an iSCSI target.
 
 For example:
-linstor-iscsi start --iqn=iqn.2019-08.com.linbit:example --lun=0
+linstor-iscsi start --iqn=iqn.2019-08.com.linbit:example --lun=1
 
 ```
 linstor-iscsi stop [flags]
@@ -25,7 +25,7 @@ linstor-iscsi stop [flags]
 ```
   -i, --iqn string        Set the iSCSI Qualified Name (e.g., iqn.2019-08.com.linbit:unique) (required)
       --loglevel string   Set the log level (as defined by logrus) (default "info")
-  -l, --lun int           Set the LUN Number (required)
+  -l, --lun int           Set the LUN Number (required) (default 1)
 ```
 
 ### SEE ALSO