Merge pull request #876 from SoftLayer/issues733

Updated help message for some block and file commands

Author: allmightyspiff

plugin/commands/block/volume_modify.go

@@ -28,7 +28,9 @@ func NewVolumeModifyCommand(sl *metadata.SoftlayerStorageCommand) *VolumeModifyC
 	cobraCmd := &cobra.Command{
 		Use:   "volume-modify " + T("IDENTIFIER"),
 		Short: T("Modify an existing block storage volume"),
-		Long: T(`${COMMAND_NAME} sl {{.storageType}} volume-modify VOLUME_ID [OPTIONS]
+		Long: T(`Valid size and iops options can be found here:
+https://cloud.ibm.com/docs/BlockStorage/index.html#provisioning-considerations
+https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-orderingBlockStorage&interface=cli
 
    EXAMPLE:
 	  ${COMMAND_NAME} sl {{.storageType}} volume-modify 12345678 --new-size 1000 --new-iops 4000 
@@ -42,7 +44,7 @@ func NewVolumeModifyCommand(sl *metadata.SoftlayerStorageCommand) *VolumeModifyC
 	}
 	cobraCmd.Flags().IntVarP(&thisCmd.NewSize, "new-size", "c", 0, T("New Size of block volume in GB. ***If no size is given, the original size of volume is used.***\n      Potential Sizes: [20, 40, 80, 100, 250, 500, 1000, 2000, 4000, 8000, 12000]\n      Minimum: [the original size of the volume]"))
 	cobraCmd.Flags().IntVarP(&thisCmd.NewIops, "new-iops", "i", 0, T("Performance Storage IOPS, between 100 and 6000 in multiples of 100 [only for performance volumes] ***If no IOPS value is specified, the original IOPS value of the volume will be used.***"))
-	cobraCmd.Flags().Float64VarP(&thisCmd.NewTier, "new-tier", "t", 0, T("Endurance Storage Tier (IOPS per GB) [only for endurance volumes] ***If no tier is specified, the original tier of the volume will be used.***"))
+	cobraCmd.Flags().Float64VarP(&thisCmd.NewTier, "new-tier", "t", 0, T("Endurance Storage Tier (IOPS per GB) [only for endurance volumes] ***If no tier is specified, the original tier of the volume will be used.***") + "\n" + T("Tiers: [0.25, 2, 4, 10]"))
 	cobraCmd.Flags().BoolVarP(&thisCmd.Force, "force", "f", false, T("Force operation without confirmation"))
 	thisCmd.Command = cobraCmd
 	return thisCmd

plugin/commands/block/volume_options.go

@@ -31,12 +31,11 @@ func NewVolumeOptionsCommand(sl *metadata.SoftlayerStorageCommand) *VolumeOption
 	}
 	cobraCmd := &cobra.Command{
 		Use:   "volume-options",
-		Short: T("List all options for ordering a block storage"),
-		Long: T(`${COMMAND_NAME} sl {{.storageType}} volume-options
-	
-EXAMPLE:
-   ${COMMAND_NAME} sl {{.storageType}} volume-options
-   This command lists all options for creating a block storage volume, including storage type, volume size, OS type, IOPS, tier level, datacenter, and snapshot size.`, sl.StorageI18n),
+		Short: T("List all options for ordering a block or file storage volume"),
+		Long: T("List all options for ordering a block or file storage volume") + "\n\n" +
+				T("See Also:") + "\n" + 
+				"\thttps://cloud.ibm.com/docs/BlockStorage/index.html#provisioning-considerations\n" +
+				"\thttps://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-orderingBlockStorage&interface=cli\n" ,
 		Args: metadata.NoArgs,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return thisCmd.Run(args)

plugin/commands/block/volume_order.go

@@ -38,9 +38,7 @@ func NewVolumeOrderCommand(sl *metadata.SoftlayerStorageCommand) *VolumeOrderCom
 	cobraCmd := &cobra.Command{
 		Use:   "volume-order",
 		Short: T("Order a block storage volume"),
-		Long: T(`${COMMAND_NAME} sl {{.storageType}} volume-order [OPTIONS]
-
-EXAMPLE:
+		Long: T(`EXAMPLE:
    ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type performance --size 1000 --iops 4000 --os-type LINUX -d dal09
    This command orders a performance volume with size is 1000GB, IOPS is 4000, OS type is LINUX, located at dal09.
    ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type endurance --size 500 --tier 4 --os-type XEN -d dal09 --snapshot-size 500

plugin/commands/file/file.go

@@ -52,6 +52,7 @@ func SetupCobraCommands(sl *metadata.SoftlayerCommand) *cobra.Command {
 	cobraCmd.AddCommand(block.NewVolumeRefreshCommand(StorageCommand).Command)
 	cobraCmd.AddCommand(block.NewVolumeConvertCommand(StorageCommand).Command)
 	cobraCmd.AddCommand(block.NewSnapshotOrderCommand(StorageCommand).Command)
+	cobraCmd.AddCommand(block.NewVolumeOptionsCommand(StorageCommand).Command)
 
 	// Unique File Commands, even these can likely be merged in a later version.
 	cobraCmd.AddCommand(NewAccessAuthorizeCommand(StorageCommand).Command)
@@ -65,6 +66,5 @@ func SetupCobraCommands(sl *metadata.SoftlayerCommand) *cobra.Command {
 	cobraCmd.AddCommand(NewVolumeListCommand(StorageCommand).Command)
 	cobraCmd.AddCommand(NewVolumeOrderCommand(StorageCommand).Command)
 	cobraCmd.AddCommand(NewVolumeModifyCommand(StorageCommand).Command)
-	cobraCmd.AddCommand(NewVolumeOptionsCommand(StorageCommand).Command)
 	return cobraCmd
 }

plugin/commands/file/volume_options.go

@@ -38,9 +38,7 @@ func NewVolumeOrderCommand(sl *metadata.SoftlayerStorageCommand) *VolumeOrderCom
 	cobraCmd := &cobra.Command{
 		Use:   "volume-order",
 		Short: T("Order a file storage volume"),
-		Long: T(`${COMMAND_NAME} sl {{.storageType}} volume-order [OPTIONS]
-
-EXAMPLE:
+		Long: T(`EXAMPLE:
    ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type performance --size 1000 --iops 4000 --os-type LINUX -d dal09
    This command orders a performance volume with size is 1000GB, IOPS is 4000, OS type is LINUX, located at dal09.
    ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type endurance --size 500 --tier 4 --os-type XEN -d dal09 --snapshot-size 500

plugin/commands/file/volume_options_test.go

@@ -413,7 +413,7 @@
   "${COMMAND_NAME} sl {{.storageType}} volume-list [OPTIONS]\n\nEXAMPLE:\n   ${COMMAND_NAME} sl {{.storageType}} volume-list -d dal09 -t endurance --sortby capacity_gb\n   This command lists all endurance volumes on current account that are located at dal09, and sorts them by capacity.": {
     "other": "${COMMAND_NAME} sl {{.storageType}} volume-list [OPTIONEN]\n \nBEISPIEL:\n ${COMMAND_NAME} sl {{.storageType}} volume-list -d dal09 -t endurance --sortby capacity_gb\n Dieser Befehl listet alle Endurance-Datenträger für das aktuelle Konto in dal09 auf und sortiert sie nach Kapazität."
   },
-  "${COMMAND_NAME} sl {{.storageType}} volume-modify VOLUME_ID [OPTIONS]\n\n   EXAMPLE:\n\t  ${COMMAND_NAME} sl {{.storageType}} volume-modify 12345678 --new-size 1000 --new-iops 4000 \n\t  This command modify a volume 12345678 with size is 1000GB, IOPS is 4000.\n\t  ${COMMAND_NAME} sl {{.storageType}} volume-modify 12345678 --new-size 500 --new-tier 4\n\t  This command modify a volume 12345678 with size is 500GB, tier level is 4 IOPS per GB.": {
+  "Valid size and iops options can be found here:\nhttps://cloud.ibm.com/docs/BlockStorage/index.html#provisioning-considerations\nhttps://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-orderingBlockStorage&interface=cli\nEXAMPLE:\n\t  ${COMMAND_NAME} sl {{.storageType}} volume-modify 12345678 --new-size 1000 --new-iops 4000 \n\t  This command modify a volume 12345678 with size is 1000GB, IOPS is 4000.\n\t  ${COMMAND_NAME} sl {{.storageType}} volume-modify 12345678 --new-size 500 --new-tier 4\n\t  This command modify a volume 12345678 with size is 500GB, tier level is 4 IOPS per GB.": {
     "other": "${COMMAND_NAME} sl {{.storageType}} volume-modify DATENTRÄGER_ID [OPTIONEN]\n\n BEISPIEL:\n ${COMMAND_NAME} sl {{.storageType}} volume-modify 12345678 --new-size 1000 --new-iops 4000 \n Dieser Befehl ändert einen Datenträger 12345678 mit der Größe 1000 GB, E/A-Operationen pro Sekunde sind 4000.\n ${COMMAND_NAME} sl {{.storageType}} volume-modify 12345678 --new-size 500 --new-tier 4\n Dieser Befehl ändert einen Datenträger 12345678 mit einer Größe von 500 GB und einer Tierebene von 4 E/A-Operationen pro Sekunde pro GB."
   },
   "${COMMAND_NAME} sl {{.storageType}} volume-options\n\t\nEXAMPLE:\n   ${COMMAND_NAME} sl {{.storageType}} volume-options\n   This command lists all options for creating a block storage volume, including storage type, volume size, OS type, IOPS, tier level, datacenter, and snapshot size.": {
@@ -422,7 +422,7 @@
   "${COMMAND_NAME} sl {{.storageType}} volume-options\n\t\nEXAMPLE:\n   ${COMMAND_NAME} sl {{.storageType}} volume-options\n   This command lists all options for creating a file storage volume, including storage type, volume size, IOPS, tier level, datacenter, and snapshot size.": {
     "other": "${COMMAND_NAME} sl {{.storageType}} volume-options\n \nBEISPIEL:\n ${COMMAND_NAME} sl {{.storageType}} volume-options \n Dieser Befehl listet alle Optionen für die Erstellung eines Dateispeicherdatenträgers auf, einschließlich Speichertyp, Datenträgergröße, IOPS, Tierebene, Rechenzentrum und Snapshotgröße."
   },
-  "${COMMAND_NAME} sl {{.storageType}} volume-order [OPTIONS]\n\nEXAMPLE:\n   ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type performance --size 1000 --iops 4000 --os-type LINUX -d dal09\n   This command orders a performance volume with size is 1000GB, IOPS is 4000, OS type is LINUX, located at dal09.\n   ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type endurance --size 500 --tier 4 --os-type XEN -d dal09 --snapshot-size 500\n   This command orders a endurance volume with size is 500GB, tier level is 4 IOPS per GB, OS type is XEN, located at dal09, and additional snapshot space size is 500GB.": {
+  "EXAMPLE:\n   ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type performance --size 1000 --iops 4000 --os-type LINUX -d dal09\n   This command orders a performance volume with size is 1000GB, IOPS is 4000, OS type is LINUX, located at dal09.\n   ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type endurance --size 500 --tier 4 --os-type XEN -d dal09 --snapshot-size 500\n   This command orders a endurance volume with size is 500GB, tier level is 4 IOPS per GB, OS type is XEN, located at dal09, and additional snapshot space size is 500GB.": {
     "other": "${COMMAND_NAME} sl {{.storageType}} volume-order [OPTIONEN]\n\nBEISPIEL:\n ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type performance --size 1000 --iops 4000 --os-type LINUX -d dal09\n Dieser Befehl bestellt einen Leistungsdatenträger mit der Größe 1000 GB, IOPS 4000, OS LINUX, dal09.\n ${COMMAND_NAME} sl {{.storageType}} volume-order --storage-type endurance --size 500 --tier 4 --os-type XEN -d dal09 --snapshot-size 500\n Dieser Befehl bestellt einen Endurance-Datenträger mit der Größe 500 GB, die Tierebene ist 4 E/A-Operationen pro Sekunde pro GB, der Betriebssystemtyp ist XEN, befindet sich in dal09 und die Größe des zusätzlichen Snapshotbereichs ist 500 GB."
   },
   "${COMMAND_NAME} sl {{.storageType}} volume-refresh VOLUME_ID SNAPSHOT_ID\n\nEXAMPLE:\n\t${COMMAND_NAME} sl {{.storageType}} volume-refresh VOLUME_ID SNAPSHOT_ID\n\tRefresh a duplicate VOLUME_ID with a snapshot from its parent SNAPSHOT_ID.": {
@@ -4235,7 +4235,7 @@
   "List all images on your account": {
     "other": "Alle Images für eigenes Konto auflisten"
   },
-  "List all options for ordering a block storage": {
+  "List all options for ordering a block or file storage volume": {
     "other": "Alle Optionen für die Bestellung eines Blockspeichers auflisten"
   },
   "List all options for ordering a file storage": {