Skip to content

Commit 3adee9e

Browse files
docs(instances): revamp api docs (#2974)
Co-authored-by: Rémy Léone <rleone@scaleway.com>
1 parent 17b307a commit 3adee9e

File tree

69 files changed

+802
-885
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+802
-885
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create an instance image.
3+
Create an Instance image from the specified snapshot ID.
44

55
USAGE:
66
scw instance image create [arg=value ...]
77

88
EXAMPLES:
9-
Create an image named 'foobar' for x86_64 instances from the given snapshot ID
10-
scw instance image create name=foobar snapshot-id=11111111-1111-1111-1111-111111111111 arch=x86_64
9+
Create an image named 'foobar' for x86_64 Instances from the specified snapshot ID
10+
scw instance server image create name=foobar snapshot-id=11111111-1111-1111-1111-111111111111 arch=x86_64
1111

1212
ARGS:
1313
[name=<generated>] Name of the image
@@ -19,7 +19,7 @@ ARGS:
1919
[additional-snapshots.{index}.volume-type] Underlying volume type of the additional snapshot (l_ssd | b_ssd | unified)
2020
[additional-snapshots.{index}.project-id] Project ID that own the additional snapshot
2121
[project-id] Project ID to use. If none is passed the default project ID will be used
22-
[tags.{index}] The tags of the image
22+
[tags.{index}] Tags of the image
2323
[public] True to create a public image
2424
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
2525
[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)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete the image with the given ID.
3+
Delete the image with the specified ID.
44

55
USAGE:
66
scw instance image delete <image-id ...> [arg=value ...]
77

88
EXAMPLES:
9-
Delete an image in the default zone with the given ID
9+
Delete an image in the default zone with the specified ID
1010
scw instance image delete 11111111-1111-1111-1111-111111111111
1111

12-
Delete an image in fr-par-1 zone with the given ID
12+
Delete an image in fr-par-1 zone with the specified ID
1313
scw instance image delete 11111111-1111-1111-1111-111111111111 zone=fr-par-1
1414

1515
ARGS:

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get details of an image with the given ID.
3+
Get details of an image with the specified ID.
44

55
USAGE:
66
scw instance image get <image-id ...> [arg=value ...]
77

88
EXAMPLES:
9-
Get an image in the default zone with the given ID
9+
Get an image in the default zone with the specified ID
1010
scw instance image get 11111111-1111-1111-1111-111111111111
1111

12-
Get an image in fr-par-1 zone with the given ID
12+
Get an image in fr-par-1 zone with the specified ID
1313
scw instance image get 11111111-1111-1111-1111-111111111111 zone=fr-par-1
1414

1515
ARGS:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List all images available in an account.
3+
List all existing Instance images.
44

55
USAGE:
66
scw instance image list [arg=value ...]

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Images are backups of your instances.
4-
You can reuse that image to restore your data or create a series of instances with a predefined configuration.
5-
6-
An image is a complete backup of your server including all volumes.
3+
Images are backups of your Instances.
4+
One image will contain all of the volumes of your Instance, and can be used to restore your Instance and its data. You can also use it to create a series of Instances with a predefined configuration.
5+
To copy not all but only one specified volume of an Instance, you can use the snapshot feature instead.
76

87
USAGE:
98
scw instance image <command>
109

1110
AVAILABLE COMMANDS:
12-
create Create an instance image
13-
delete Delete an instance image
14-
get Get an instance image
15-
list List instance images
11+
create Create an Instance image
12+
delete Delete an Instance image
13+
get Get an Instance image
14+
list List Instance images
1615
update Update an instance image
1716

1817
WORKFLOW COMMANDS:

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Reserve a flexible IP.
3+
Reserve a flexible IP and attach it to the specified Instance.
44

55
USAGE:
66
scw instance ip create [arg=value ...]
@@ -12,13 +12,13 @@ EXAMPLES:
1212
Create an IP in fr-par-1 zone
1313
scw instance ip create zone=fr-par-1
1414

15-
Create an IP and attach it to the given server
15+
Create an IP and attach it to the specified Instance
1616
scw instance ip create server=11111111-1111-1111-1111-111111111111
1717

1818
ARGS:
1919
[project-id] Project ID to use. If none is passed the default project ID will be used
20-
[tags.{index}] The tags of the IP
21-
[server] UUID of the server you want to attach the IP to
20+
[tags.{index}] Tags of the IP
21+
[server] UUID of the Instance you want to attach the IP to
2222
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
2323
[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)
2424

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete the IP with the given ID.
3+
Delete the IP with the specified ID.
44

55
USAGE:
66
scw instance ip delete <ip ...> [arg=value ...]
77

88
EXAMPLES:
9-
Delete an IP in the default zone with the given ID
9+
Delete an IP in the default zone with the specified ID
1010
scw instance ip delete 11111111-1111-1111-1111-111111111111
1111

12-
Delete an IP in fr-par-1 zone with the given ID
12+
Delete an IP in fr-par-1 zone with the specified ID
1313
scw instance ip delete 11111111-1111-1111-1111-111111111111 zone=fr-par-1
1414

15-
Delete an IP using directly the given IP address
15+
Delete an IP using directly the specified IP address
1616
scw instance ip delete 51.15.253.183
1717

1818
ARGS:
19-
ip The ID or the address of the IP to delete
19+
ip ID or address of the IP to delete
2020
[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)
2121

2222
FLAGS:

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get details of an IP with the given ID or address.
3+
Get details of an IP with the specified ID or address.
44

55
USAGE:
66
scw instance ip get <ip ...> [arg=value ...]
77

88
EXAMPLES:
9-
Get an IP in the default zone with the given ID
9+
Get an IP in the default zone with the specified ID
1010
scw instance ip get 11111111-1111-1111-1111-111111111111
1111

12-
Get an IP in fr-par-1 zone with the given ID
12+
Get an IP in fr-par-1 zone with the specified ID
1313
scw instance ip get 11111111-1111-1111-1111-111111111111 zone=fr-par-1
1414

15-
Get an IP using directly the given IP address
15+
Get an IP, directly using the specified IP address
1616
scw instance ip get 51.15.253.183
1717

1818
ARGS:
19-
ip The IP ID or address to get
19+
ip IP ID or address to get
2020
[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)
2121

2222
FLAGS:

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List all flexible IPs.
3+
List all flexible IPs in a specified zone.
44

55
USAGE:
66
scw instance ip list [arg=value ...]
@@ -13,10 +13,10 @@ EXAMPLES:
1313
scw instance ip list zone=fr-par-1
1414

1515
ARGS:
16-
[project-id] The project ID the IPs are reserved in
16+
[project-id] Project ID in which the IPs are reserved
1717
[tags.{index}] Filter IPs with these exact tags (to filter with several tags, use commas to separate them)
1818
[name] Filter on the IP address (Works as a LIKE operation on the IP address)
19-
[organization-id] The organization ID the IPs are reserved in
19+
[organization-id] Organization ID in which the IPs are reserved
2020
[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)
2121

2222
FLAGS:

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update a flexible IP.
3+
Update a flexible IP in the specified zone with the specified ID.
44

55
USAGE:
66
scw instance ip update <ip ...> [arg=value ...]
77

88
EXAMPLES:
9-
Update an IP in the default zone with the given ID
9+
Update an IP in the default zone with the specified ID
1010
scw instance ip update 11111111-1111-1111-1111-111111111111 reverse=example.com
1111

12-
Update an IP in fr-par-1 zone with the given ID
12+
Update an IP in fr-par-1 zone with the specified ID
1313
scw instance ip update 11111111-1111-1111-1111-111111111111 zone=fr-par-1 reverse=example.com
1414

15-
Update an IP using directly the given IP address
15+
Update an IP using directly the specified IP address
1616
scw instance ip update 51.15.253.183 reverse=example.com
1717

1818
ARGS:

0 commit comments

Comments
 (0)