Skip to content

Commit 940712f

Browse files
committed
update descriptions
1 parent f5ea206 commit 940712f

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/stackit_beta_server_create.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,23 @@ stackit beta server create [flags]
2727

2828
```
2929
--affinity-group string The affinity group the server is assigned to
30-
--availability-zone string Availability zone
30+
--availability-zone string The availability zone of the server
3131
--boot-volume-delete-on-termination Delete the volume during the termination of the server. Defaults to false
3232
--boot-volume-performance-class string Boot volume performance class
33-
--boot-volume-size int Boot volume size (GB). Size is required for the image type boot volumes
33+
--boot-volume-size source_type The size of the boot volume in GB. Must be provided when source_type is `image`
3434
--boot-volume-source-id string ID of the source object of boot volume. It can be either 'image-id' or 'volume-id'
3535
--boot-volume-source-type string Type of the source object of boot volume. It can be either 'image' or 'volume'
3636
-h, --help Help for "stackit beta server create"
37-
--image-id string ID of the image. Either image-id or boot volume is required
38-
--keypair-name string The SSH keypair used during the server creation
37+
--image-id string The image ID to be used for an ephemeral disk on the server. Either image-id or boot volume is required
38+
--keypair-name string The name of the SSH keypair used during the server creation
3939
--labels stringToString Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...' (default [])
40-
--machine-type string Machine type the server shall belong to
40+
--machine-type string Name of the type of the machine for the server. Possible values are documented in [Virtual machine flavors](https://docs.stackit.cloud/stackit/en/virtual-machine-flavors-75137231.html)
4141
-n, --name string Server name
4242
--network-id string ID of the network for the initial networking setup for the server creation
4343
--network-interface-ids strings List of network interface IDs for the initial networking setup for the server creation
4444
--security-groups strings The initial security groups for the server creation
4545
--service-account-emails strings List of the service account mails
46-
--user-data string User data that is provided to the server
46+
--user-data string User data that is passed via cloud-init to the server
4747
--volumes strings The list of volumes attached to the server
4848
```
4949

internal/cmd/beta/server/create/create.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,22 +140,22 @@ func NewCmd(p *print.Printer) *cobra.Command {
140140

141141
func configureFlags(cmd *cobra.Command) {
142142
cmd.Flags().StringP(nameFlag, "n", "", "Server name")
143-
cmd.Flags().String(machineTypeFlag, "", "Machine type the server shall belong to")
143+
cmd.Flags().String(machineTypeFlag, "", "Name of the type of the machine for the server. Possible values are documented in [Virtual machine flavors](https://docs.stackit.cloud/stackit/en/virtual-machine-flavors-75137231.html)")
144144
cmd.Flags().String(affinityGroupFlag, "", "The affinity group the server is assigned to")
145-
cmd.Flags().String(availabilityZoneFlag, "", "Availability zone")
145+
cmd.Flags().String(availabilityZoneFlag, "", "The availability zone of the server")
146146
cmd.Flags().String(bootVolumeSourceIdFlag, "", "ID of the source object of boot volume. It can be either 'image-id' or 'volume-id'")
147147
cmd.Flags().String(bootVolumeSourceTypeFlag, "", "Type of the source object of boot volume. It can be either 'image' or 'volume'")
148-
cmd.Flags().Int64(bootVolumeSizeFlag, 0, "Boot volume size (GB). Size is required for the image type boot volumes")
148+
cmd.Flags().Int64(bootVolumeSizeFlag, 0, "The size of the boot volume in GB. Must be provided when `source_type` is `image`")
149149
cmd.Flags().String(bootVolumePerformanceClassFlag, "", "Boot volume performance class")
150150
cmd.Flags().Bool(bootVolumeDeleteOnTerminationFlag, false, "Delete the volume during the termination of the server. Defaults to false")
151-
cmd.Flags().String(imageIdFlag, "", "ID of the image. Either image-id or boot volume is required")
152-
cmd.Flags().String(keypairNameFlag, "", "The SSH keypair used during the server creation")
151+
cmd.Flags().String(imageIdFlag, "", "The image ID to be used for an ephemeral disk on the server. Either image-id or boot volume is required")
152+
cmd.Flags().String(keypairNameFlag, "", "The name of the SSH keypair used during the server creation")
153153
cmd.Flags().StringToString(labelFlag, nil, "Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...'")
154154
cmd.Flags().String(networkIdFlag, "", "ID of the network for the initial networking setup for the server creation")
155155
cmd.Flags().StringSlice(networkInterfaceIdsFlag, []string{}, "List of network interface IDs for the initial networking setup for the server creation")
156156
cmd.Flags().StringSlice(securityGroupsFlag, []string{}, "The initial security groups for the server creation")
157157
cmd.Flags().StringSlice(serviceAccountEmailsFlag, []string{}, "List of the service account mails")
158-
cmd.Flags().String(userDataFlag, "", "User data that is provided to the server")
158+
cmd.Flags().String(userDataFlag, "", "User data that is passed via cloud-init to the server")
159159
cmd.Flags().StringSlice(volumesFlag, []string{}, "The list of volumes attached to the server")
160160

161161
err := flags.MarkFlagsRequired(cmd, nameFlag, machineTypeFlag)

0 commit comments

Comments
 (0)