feat(instance): enable missing cli generation (#2913)

scaleway-bot · remyleone · web-flow · commit d8d91d90f9e4 · 2023-03-22T20:05:01.000Z
Co-authored-by: Rémy Léone &lt;rleone@scaleway.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-instance-placement-group-get-servers-usage.golden b/cmd/scw/testdata/test-all-usage-instance-placement-group-get-servers-usage.golden
@@ -0,0 +1,19 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Get all servers belonging to the given placement group.
+
+USAGE:
+  scw instance placement-group get-servers [arg=value ...]
+
+ARGS:
+  placement-group-id   
+  [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for get-servers
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-placement-group-set-servers-usage.golden b/cmd/scw/testdata/test-all-usage-instance-placement-group-set-servers-usage.golden
@@ -0,0 +1,24 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Set all servers belonging to the given placement group.
+
+USAGE:
+  scw instance placement-group set-servers [arg=value ...]
+
+EXAMPLES:
+  Update the complete set of instances in a given placement group. (All instances must be down)
+    scw instance placement-group set-servers placement-group-id=ced0fd4d-bcf0-4479-85b6-7027e54456e6 servers.0=5a250608-24ec-4c31-9631-b3ded8c861cb servers.1=e54fd249-0787-4794-ab14-af6ee74df274
+
+ARGS:
+  placement-group-id   
+  [servers.{index}]    
+  [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for set-servers
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-placement-group-set-usage.golden b/cmd/scw/testdata/test-all-usage-instance-placement-group-set-usage.golden
@@ -0,0 +1,25 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Set all parameters of the given placement group.
+
+USAGE:
+  scw instance placement-group set [arg=value ...]
+
+ARGS:
+  placement-group-id   
+  [name]               
+  [policy-mode]         (optional | enforced)
+  [policy-type]         (max_availability | low_latency)
+  [project]            Project ID to use. If none is passed the default project ID will be used
+  [tags.{index}]       
+  [organization]       Organization ID to use. If none is passed the default organization ID will be used
+  [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for set
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-placement-group-update-servers-usage.golden b/cmd/scw/testdata/test-all-usage-instance-placement-group-update-servers-usage.golden
@@ -0,0 +1,20 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Update all servers belonging to the given placement group.
+
+USAGE:
+  scw instance placement-group update-servers [arg=value ...]
+
+ARGS:
+  placement-group-id   UUID of the placement group
+  servers.{index}      
+  [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for update-servers
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-placement-group-usage.golden b/cmd/scw/testdata/test-all-usage-instance-placement-group-usage.golden
@@ -23,11 +23,15 @@ USAGE:
   scw instance placement-group <command>
 
 AVAILABLE COMMANDS:
-  create      Create a placement group
-  delete      Delete the given placement group
-  get         Get a placement group
-  list        List placement groups
-  update      Update a placement group
+  create         Create a placement group
+  delete         Delete the given placement group
+  get            Get a placement group
+  get-servers    Get placement group servers
+  list           List placement groups
+  set            Set placement group
+  set-servers    Set placement group servers
+  update         Update a placement group
+  update-servers Update placement group servers
 
 FLAGS:
   -h, --help   help for placement-group
diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-create-rule-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-create-rule-usage.golden
@@ -0,0 +1,43 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Create rule.
+
+USAGE:
+  scw instance security-group create-rule [arg=value ...]
+
+EXAMPLES:
+  Allow incoming SSH
+    scw instance security-group create-rule security-group-id=1248283f-17de-464a-b03b-3f975ada3fa8 protocol=TCP direction=inbound action=accept ip-range=<nil> dest-port-from=22
+
+  Allow HTTP
+    scw instance security-group create-rule security-group-id=e8ba77c1-9ccb-4c0c-b08d-555cfd7f57e4 protocol=TCP direction=inbound action=accept ip-range=<nil> dest-port-from=80
+
+  Allow HTTPS
+    scw instance security-group create-rule security-group-id=e5906437-8650-4fe2-8ca7-32e1d7320c1b protocol=TCP direction=inbound action=accept ip-range=<nil> dest-port-from=443
+
+  Allow a specific IP range
+    scw instance security-group create-rule security-group-id=b6a58155-a2f8-48bd-9da9-3ff9783fa0d4 protocol=ANY direction=inbound action=accept ip-range=10.0.0.0/16
+
+  Allow FTP
+    scw instance security-group create-rule security-group-id=9c46df03-83c2-46fb-936c-16ecb44860e1 protocol=TCP direction=inbound action=accept ip-range=<nil> dest-port-from=20 dest-port-to=21
+
+ARGS:
+  security-group-id    UUID of the security group
+  protocol              (TCP | UDP | ICMP | ANY)
+  direction             (inbound | outbound)
+  action                (accept | drop)
+  ip-range=0.0.0.0/0   
+  [dest-port-from]     The beginning of the range of ports to apply this rule to (inclusive)
+  [dest-port-to]       The end of the range of ports to apply this rule to (inclusive)
+  [position]           The position of this rule in the security group rules list
+  [editable]           Indicates if this rule is editable (will be ignored)
+  [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for create-rule
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-delete-rule-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-delete-rule-usage.golden
@@ -0,0 +1,24 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Delete a security group rule with the given ID.
+
+USAGE:
+  scw instance security-group delete-rule [arg=value ...]
+
+EXAMPLES:
+  Delete a Security Group Rule with the given ID
+    scw instance security-group delete-rule security-group-id=a01a36e5-5c0c-42c1-ae06-167e587b7ac4 security-group-rule-id=b8c773ef-a6ea-4b50-a7c1-737864290a3f
+
+ARGS:
+  security-group-id        
+  security-group-rule-id   
+  [zone=fr-par-1]          Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for delete-rule
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-get-rule-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-get-rule-usage.golden
@@ -0,0 +1,24 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Get details of a security group rule with the given ID.
+
+USAGE:
+  scw instance security-group get-rule [arg=value ...]
+
+EXAMPLES:
+  Get details of a security group rule with the given ID
+    scw instance security-group get-rule security-group-id=d900fa38-2f0d-4b09-b6d7-f3e46a13f34c security-group-rule-id=1f9a16a5-7229-4c03-9327-253e257cf38a
+
+ARGS:
+  security-group-id        
+  security-group-rule-id   
+  [zone=fr-par-1]          Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for get-rule
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-list-default-rules-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-list-default-rules-usage.golden
@@ -0,0 +1,18 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Lists the default rules applied to all the security groups.
+
+USAGE:
+  scw instance security-group list-default-rules [arg=value ...]
+
+ARGS:
+  [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for list-default-rules
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-list-rules-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-list-rules-usage.golden
@@ -0,0 +1,19 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+List rules.
+
+USAGE:
+  scw instance security-group list-rules [arg=value ...]
+
+ARGS:
+  security-group-id   UUID of the security group
+  [zone=fr-par-1]     Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all)
+
+FLAGS:
+  -h, --help   help for list-rules
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-set-rules-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-set-rules-usage.golden
@@ -0,0 +1,29 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Replaces the rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request.
+
+USAGE:
+  scw instance security-group set-rules [arg=value ...]
+
+ARGS:
+  security-group-id                UUID of the security group to update the rules on
+  [rules.{index}.id]               UUID of the security rule to update. If no value is provided, a new rule will be created
+  [rules.{index}.action]           Action to apply when the rule matches a packet (accept | drop)
+  [rules.{index}.protocol]         Protocol family this rule applies to (TCP | UDP | ICMP | ANY)
+  [rules.{index}.direction]        Direction the rule applies to (inbound | outbound)
+  [rules.{index}.ip-range]         The range of IP address this rules applies to
+  [rules.{index}.dest-port-from]   Beginning of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY
+  [rules.{index}.dest-port-to]     End of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY, or if it is equal to dest_port_from
+  [rules.{index}.position]         Position of this rule in the security group rules list. If several rules are passed with the same position, the resulting order is undefined
+  [rules.{index}.editable]         Indicates if this rule is editable. Rules with the value false will be ignored
+  [rules.{index}.zone]             Zone of the rule. This field is ignored
+  [zone=fr-par-1]                  Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for set-rules
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-security-group-usage.golden b/cmd/scw/testdata/test-all-usage-instance-security-group-usage.golden
@@ -10,12 +10,18 @@ USAGE:
   scw instance security-group <command>
 
 AVAILABLE COMMANDS:
-  clear       Remove all rules of a security group
-  create      Create a security group
-  delete      Delete a security group
-  get         Get a security group
-  list        List security groups
-  update      Update security group
+  clear              Remove all rules of a security group
+  create             Create a security group
+  create-rule        Create rule
+  delete             Delete a security group
+  delete-rule        Delete rule
+  get                Get a security group
+  get-rule           Get rule
+  list               List security groups
+  list-default-rules Get default rules
+  list-rules         List rules
+  set-rules          Update all the rules of a security group
+  update             Update security group
 
 FLAGS:
   -h, --help   help for security-group
diff --git a/cmd/scw/testdata/test-all-usage-instance-server-list-actions-usage.golden b/cmd/scw/testdata/test-all-usage-instance-server-list-actions-usage.golden
@@ -0,0 +1,19 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+List all actions that can currently be performed on a server.
+
+USAGE:
+  scw instance server list-actions [arg=value ...]
+
+ARGS:
+  server-id         
+  [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for list-actions
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-server-type-get-usage.golden b/cmd/scw/testdata/test-all-usage-instance-server-type-get-usage.golden
@@ -0,0 +1,18 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Get availability for all server types.
+
+USAGE:
+  scw instance server-type get [arg=value ...]
+
+ARGS:
+  [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
+
+FLAGS:
+  -h, --help   help for get
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use
diff --git a/cmd/scw/testdata/test-all-usage-instance-server-type-usage.golden b/cmd/scw/testdata/test-all-usage-instance-server-type-usage.golden
@@ -7,6 +7,7 @@ USAGE:
   scw instance server-type <command>
 
 AVAILABLE COMMANDS:
+  get         Get availability
   list        List server types
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-instance-server-usage.golden b/cmd/scw/testdata/test-all-usage-instance-server-usage.golden
@@ -45,6 +45,7 @@ AVAILABLE COMMANDS:
   detach-volume Detach a volume from its server
   get           Get a server
   list          List all servers
+  list-actions  List server actions
   reboot        Reboot server
   ssh           SSH into a server
   standby       Put server in standby mode
diff --git a/docs/commands/instance.md b/docs/commands/instance.md
diff --git a/internal/namespaces/instance/v1/instance_cli.go b/internal/namespaces/instance/v1/instance_cli.go
