Skip to content

Commit f134e9b

Browse files
authored
doc(instance): update image documentation (#703)
1 parent 9814600 commit f134e9b

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

internal/namespaces/instance/v1/instance_cli.go

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -455,28 +455,28 @@ func instanceServerUpdate() *core.Command {
455455
},
456456
{
457457
Name: "volumes.{key}.id",
458-
Short: `The volumes unique ID`,
458+
Short: `UUID of the volume`,
459459
Required: false,
460460
},
461461
{
462462
Name: "volumes.{key}.name",
463-
Short: `The volumes name`,
463+
Short: `Name of the volume`,
464464
Required: false,
465465
},
466466
{
467467
Name: "volumes.{key}.size",
468-
Short: `The volumes disk size`,
468+
Short: `Disk size of the volume`,
469469
Required: false,
470470
},
471471
{
472472
Name: "volumes.{key}.volume-type",
473-
Short: `The volumes type`,
473+
Short: `Type of the volume`,
474474
Required: false,
475475
EnumValues: []string{"l_ssd", "b_ssd"},
476476
},
477477
{
478478
Name: "volumes.{key}.organization",
479-
Short: `The organization ID`,
479+
Short: `Organization ID of the volume`,
480480
Required: false,
481481
},
482482
{
@@ -753,50 +753,55 @@ func instanceImageCreate() *core.Command {
753753
ArgSpecs: core.ArgSpecs{
754754
{
755755
Name: "name",
756+
Short: `Name of the image`,
756757
Required: false,
757758
Default: core.RandomValueGenerator("img"),
758759
},
759760
{
760761
Name: "root-volume",
762+
Short: `UUID of the snapshot`,
761763
Required: true,
762764
},
763765
{
764766
Name: "arch",
767+
Short: `Architecture of the image`,
765768
Required: true,
766769
EnumValues: []string{"x86_64", "arm"},
767770
},
768771
{
769772
Name: "default-bootscript",
773+
Short: `Default bootscript of the image`,
770774
Required: false,
771775
},
772776
{
773777
Name: "extra-volumes.{key}.id",
774-
Short: `The volumes unique ID`,
778+
Short: `UUID of the volume`,
775779
Required: false,
776780
},
777781
{
778782
Name: "extra-volumes.{key}.name",
779-
Short: `The volumes name`,
783+
Short: `Name of the volume`,
780784
Required: false,
781785
},
782786
{
783787
Name: "extra-volumes.{key}.size",
784-
Short: `The volumes disk size`,
788+
Short: `Disk size of the volume`,
785789
Required: false,
786790
},
787791
{
788792
Name: "extra-volumes.{key}.volume-type",
789-
Short: `The volumes type`,
793+
Short: `Type of the volume`,
790794
Required: false,
791795
EnumValues: []string{"l_ssd", "b_ssd"},
792796
},
793797
{
794798
Name: "extra-volumes.{key}.organization",
795-
Short: `The organization ID`,
799+
Short: `Organization ID of the volume`,
796800
Required: false,
797801
},
798802
{
799803
Name: "public",
804+
Short: `True to create a public image`,
800805
Required: false,
801806
},
802807
core.OrganizationArgSpec(),

0 commit comments

Comments
 (0)