doc: add examples on instance namespace (#725)

Author: scaleway-bot

cmd/scw/testdata/test-all-usage-instance-image-create-usage.stderr.golden

@@ -3,6 +3,10 @@ Create image.
 USAGE:
   scw [global-flags] instance image create [flags] [arg=value ...]
 
+EXAMPLES:
+  Create an image named 'foobar' for x86_64 instances from the given root_volume ID (root_volume ID needs to be a snapshot UUID)
+    scw instance image create
+
 ARGS:
   [name=<generated>]                        Name of the image
   snapshot-id                               UUID of the snapshot

cmd/scw/testdata/test-all-usage-instance-image-delete-usage.stderr.golden

@@ -3,6 +3,13 @@ Delete the image with the given ID.
 USAGE:
   scw [global-flags] instance image delete [flags] [arg=value ...]
 
+EXAMPLES:
+  Delete an image in the default zone with the given ID
+    scw instance image delete image-id=11111111-1111-1111-1111-111111111111
+
+  Delete an image in fr-par-1 zone with the given ID
+    scw instance image delete zone=fr-par-1 image-id=11111111-1111-1111-1111-111111111111
+
 ARGS:
   image-id   
   [zone]     Zone to target. If none is passed will use default zone from the config (fr-par-1 | nl-ams-1)

cmd/scw/testdata/test-all-usage-instance-image-get-usage.stderr.golden

@@ -3,6 +3,13 @@ Get details of an image with the given ID.
 USAGE:
   scw [global-flags] instance image get [flags] [arg=value ...]
 
+EXAMPLES:
+  Get an image in the default zone with the given ID
+    scw instance image get image-id=11111111-1111-1111-1111-111111111111
+
+  Get an image in fr-par-1 zone with the given ID
+    scw instance image get zone=fr-par-1 image-id=11111111-1111-1111-1111-111111111111
+
 ARGS:
   image-id   
   [zone]     Zone to target. If none is passed will use default zone from the config (fr-par-1 | nl-ams-1)

cmd/scw/testdata/test-all-usage-instance-image-list-usage.stderr.golden

@@ -4,7 +4,7 @@ USAGE:
   scw [global-flags] instance image list [flags] [arg=value ...]
 
 EXAMPLES:
-  List all public images in your default zone
+  List all public images in the default zone
     scw instance image list
 
 ARGS:

cmd/scw/testdata/test-all-usage-instance-ip-create-usage.stderr.golden

@@ -3,6 +3,16 @@ Reserve an IP.
 USAGE:
   scw [global-flags] instance ip create [flags] [arg=value ...]
 
+EXAMPLES:
+  Create an IP in the default zone
+    scw instance ip create
+
+  Create an IP in fr-par-1 zone
+    scw instance ip create zone=fr-par-1
+
+  Create an IP and attach it to the given server
+    scw instance ip create server=11111111-1111-1111-1111-111111111111
+
 ARGS:
   [server]         UUID of the server you want to attach the IP to
   [tags.{index}]   An array of keywords you want to tag this IP with

cmd/scw/testdata/test-all-usage-instance-ip-delete-usage.stderr.golden

@@ -3,6 +3,16 @@ Delete the IP with the given ID.
 USAGE:
   scw [global-flags] instance ip delete [flags] [arg=value ...]
 
+EXAMPLES:
+  Delete an IP in the default zone with the given ID
+    scw instance ip delete ip=11111111-1111-1111-1111-111111111111
+
+  Delete an IP in fr-par-1 zone with the given ID
+    scw instance ip delete zone=fr-par-1 ip=11111111-1111-1111-1111-111111111111
+
+  Delete an IP using directly the given IP address
+    scw instance ip delete ip=51.15.253.183
+
 ARGS:
   ip       The ID or the address of the IP to delete
   [zone]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | nl-ams-1)

cmd/scw/testdata/test-all-usage-instance-ip-get-usage.stderr.golden

@@ -3,6 +3,16 @@ Get details of an IP with the given ID or address.
 USAGE:
   scw [global-flags] instance ip get [flags] [arg=value ...]
 
+EXAMPLES:
+  Get an IP in the default zone with the given ID
+    scw instance ip get ip=11111111-1111-1111-1111-111111111111
+
+  Get an IP in fr-par-1 zone with the given ID
+    scw instance ip get zone=fr-par-1 ip=11111111-1111-1111-1111-111111111111
+
+  Get an IP using directly the given IP address
+    scw instance ip get
+
 ARGS:
   ip       The IP ID or address to get
   [zone]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | nl-ams-1)

cmd/scw/testdata/test-all-usage-instance-ip-list-usage.stderr.golden

@@ -3,6 +3,13 @@ List IPs.
 USAGE:
   scw [global-flags] instance ip list [flags] [arg=value ...]
 
+EXAMPLES:
+  List all IPs in the default zone
+    scw instance ip list
+
+  List all IPs in fr-par-1 zone
+    scw instance ip list zone=fr-par-1
+
 ARGS:
   [name]           Filter on the IP address (Works as a LIKE operation on the IP address)
   [organization]   The organization ID the IPs are reserved in

cmd/scw/testdata/test-all-usage-instance-ip-update-usage.stderr.golden

@@ -3,6 +3,16 @@ Update IP.
 USAGE:
   scw [global-flags] instance ip update [flags] [arg=value ...]
 
+EXAMPLES:
+  Update an IP in the default zone with the given ID
+    scw instance ip update ip=11111111-1111-1111-1111-111111111111 reverse=example.com
+
+  Update an IP in fr-par-1 zone with the given ID
+    scw instance ip update zone=fr-par-1 ip=11111111-1111-1111-1111-111111111111 reverse=example.com
+
+  Update an IP using directly the given IP address
+    scw instance ip update ip=51.15.253.183 reverse=example.com
+
 ARGS:
   ip          IP ID or IP address
   [reverse]   Reverse domain name

cmd/scw/testdata/test-all-usage-instance-placement-group-delete-usage.stderr.golden

@@ -3,6 +3,13 @@ Delete the given placement group.
 USAGE:
   scw [global-flags] instance placement-group delete [flags] [arg=value ...]
 
+EXAMPLES:
+  Delete a placement group in the default zone with the given ID
+    scw instance placement-group delete placement-group-id=11111111-1111-1111-1111-111111111111
+
+  Delete a placement group in fr-par-1 zone with the given ID
+    scw instance placement-group delete zone=fr-par-1 placement-group-id=11111111-1111-1111-1111-111111111111
+
 ARGS:
   placement-group-id   
   [zone]               Zone to target. If none is passed will use default zone from the config (fr-par-1 | nl-ams-1)

cmd/scw/testdata/test-all-usage-instance-placement-group-list-usage.stderr.golden

@@ -4,7 +4,7 @@ USAGE:
   scw [global-flags] instance placement-group list [flags] [arg=value ...]
 
 EXAMPLES:
-  List all placement groups in your default zone
+  List all placement groups in the default zone
     scw instance placement-group list
 
   List placement groups that match a given name ('cluster1' will return 'cluster100' and 'cluster1' but not 'foo')

cmd/scw/testdata/test-all-usage-instance-server-type-list-usage.stderr.golden

@@ -3,6 +3,13 @@ Get server types technical details.
 USAGE:
   scw [global-flags] instance server-type list [flags] [arg=value ...]
 
+EXAMPLES:
+  List all server-types in the default zone
+    scw instance server-type list
+
+  List all server-types in fr-par-1 zone
+    scw instance server-type list zone=fr-par-1
+
 ARGS:
   [zone]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | nl-ams-1)
 

cmd/scw/testdata/test-all-usage-instance-server-update-usage.stderr.golden

@@ -3,6 +3,25 @@ Update server.
 USAGE:
   scw [global-flags] instance server update [flags] [arg=value ...]
 
+EXAMPLES:
+  Update the name of a given server
+    scw instance server update
+
+  Put a given instance in rescue mode (reboot is required to access rescue mode)
+    scw instance server update
+
+  Overwrite tags of a given server
+    scw instance server update
+
+  Enable IPv6 on a given server
+    scw instance server update
+
+  Apply the given security group to a given server
+    scw instance server update
+
+  Put a given server in the given placement group. Server must be off
+    scw instance server update
+
 ARGS:
   server-id               UUID of the server
   [name]                  Name of the server

cmd/scw/testdata/test-all-usage-instance-snapshot-create-usage.stderr.golden

@@ -3,6 +3,16 @@ Create snapshot.
 USAGE:
   scw [global-flags] instance snapshot create [flags] [arg=value ...]
 
+EXAMPLES:
+  Create a snapshot in the default zone from the given volume ID
+    scw instance snapshot create volume-id=11111111-1111-1111-1111-111111111111
+
+  Create a snapshot in fr-par-1 zone from the given volume ID
+    scw instance snapshot create zone=fr-par-1 volume-id=11111111-1111-1111-1111-111111111111
+
+  Create a named snapshot from the given volume ID
+    scw instance snapshot create name=foobar volume-id=11111111-1111-1111-1111-111111111111
+
 ARGS:
   [name=<generated>]   Name of the snapshot
   volume-id            UUID of the volume

cmd/scw/testdata/test-all-usage-instance-snapshot-delete-usage.stderr.golden

@@ -3,6 +3,13 @@ Delete the snapshot with the given ID.
 USAGE:
   scw [global-flags] instance snapshot delete [flags] [arg=value ...]
 
+EXAMPLES:
+  Delete a snapshot in the default zone with the given ID
+    scw instance snapshot delete snapshot-id=11111111-1111-1111-1111-111111111111
+
+  Delete a snapshot in fr-par-1 zone with the given ID
+    scw instance snapshot delete zone=fr-par-1 snapshot-id=11111111-1111-1111-1111-111111111111
+
 ARGS:
   snapshot-id   
   [zone]        Zone to target. If none is passed will use default zone from the config (fr-par-1 | nl-ams-1)

cmd/scw/testdata/test-all-usage-instance-snapshot-get-usage.stderr.golden

@@ -3,6 +3,13 @@ Get details of a snapshot with the given ID.
 USAGE:
   scw [global-flags] instance snapshot get [flags] [arg=value ...]
 
+EXAMPLES:
+  Get a snapshot in the default zone with the given ID
+    scw instance snapshot get snapshot-id=11111111-1111-1111-1111-111111111111
+
+  Get a snapshot in fr-par-1 zone with the given ID
+    scw instance snapshot get zone=fr-par-1 snapshot-id=11111111-1111-1111-1111-111111111111
+
 ARGS:
   snapshot-id   
   [zone]        Zone to target. If none is passed will use default zone from the config (fr-par-1 | nl-ams-1)

cmd/scw/testdata/test-all-usage-instance-snapshot-list-usage.stderr.golden

@@ -3,6 +3,13 @@ List snapshots.
 USAGE:
   scw [global-flags] instance snapshot list [flags] [arg=value ...]
 
+EXAMPLES:
+  List all snapshots in the default zone
+    scw instance snapshot list
+
+  List all snapshots in fr-par-1 zone
+    scw instance snapshot list zone=fr-par-1
+
 ARGS:
   [name]           
   [organization]   

cmd/scw/testdata/test-all-usage-instance-usage.stderr.golden

@@ -4,7 +4,7 @@ USAGE:
   scw [global-flags] instance <command> [flags]
 
 AVAILABLE COMMANDS:
-  image                  An image is a backups of an instance
+  image                  An image is a backup of an instance
   ip                     A flexible IP address is an IP address which holden independently of any server
   placement-group        A placement group allows to express a preference regarding the physical position of a group of instances
   placement-group-server A placement group allows to express a preference regarding the physical position of a group of instances