Skip to content

Commit 7b6f37a

Browse files
authored
docs(baremetal): rework documentation api bare metal product (#2870)
1 parent a7378dd commit 7b6f37a

File tree

36 files changed

+297
-297
lines changed

36 files changed

+297
-297
lines changed

cmd/scw/testdata/test-all-usage-baremetal-bmc-get-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-
Get the BMC (Baseboard Management Controller) access associated with the given ID.
3+
Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect.
44

55
USAGE:
66
scw baremetal bmc get [arg=value ...]

cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Start BMC (Baseboard Management Controller) access associated with the given ID.
3+
Start BMC (Baseboard Management Controller) access associated with the ID.
44
The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
5-
You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option.
6-
After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
5+
You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
6+
After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.
77

88
USAGE:
99
scw baremetal bmc start [arg=value ...]
1010

1111
ARGS:
1212
server-id ID of the server
13-
ip The IP authorized to connect to the given server
13+
ip The IP authorized to connect to the server
1414
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1515

1616
FLAGS:

cmd/scw/testdata/test-all-usage-baremetal-bmc-stop-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-
Stop BMC (Baseboard Management Controller) access associated with the given ID.
3+
Stop BMC (Baseboard Management Controller) access associated with the ID.
44

55
USAGE:
66
scw baremetal bmc stop [arg=value ...]

cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
3+
A Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
44
For instance, your KVM-IP management console could be accessed with it.
5-
You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option.
5+
You need first to create an Remote Access option. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option.
66
Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723.
77
And finally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
88

99
USAGE:
1010
scw baremetal bmc <command>
1111

1212
AVAILABLE COMMANDS:
13-
get Get BMC (Baseboard Management Controller) access for a given elastic metal server
14-
start Start BMC (Baseboard Management Controller) access for a given elastic metal server
15-
stop Stop BMC (Baseboard Management Controller) access for a given elastic metal server
13+
get Get BMC access
14+
start Start BMC access
15+
stop Stop BMC access
1616

1717
FLAGS:
1818
-h, --help help for bmc

cmd/scw/testdata/test-all-usage-baremetal-offer-get-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Return specific offer for the given ID.
3+
Get details of an offer identified by its offer ID.
44

55
USAGE:
66
scw baremetal offer get [arg=value ...]
77

88
EXAMPLES:
9-
Get a server offer with the given ID
9+
Get a server offer with the ID
1010
scw baremetal offer get zone=fr-par-1 offer-id=11111111-1111-1111-1111-111111111111
1111

1212
ARGS:

cmd/scw/testdata/test-all-usage-baremetal-offer-list-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List all available server offers.
3+
List all available Elastic Metal server configurations.
44

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

1515
ARGS:
16-
[subscription-period] Period of subscription to filter offers (unknown_subscription_period | hourly | monthly)
16+
[subscription-period] Subscription period type to filter offers by (unknown_subscription_period | hourly | monthly)
1717
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all)
1818

1919
FLAGS:

cmd/scw/testdata/test-all-usage-baremetal-offer-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Server offers will answer with all different elastic metal server ranges available in a given zone.
4-
Each of them will contain all the features of the server (cpus, memories, disks) with their associated pricing.
3+
Server offers will answer with all different Elastic Metal server ranges available in a zone.
4+
Each of them will contain all the features of the server (CPUs, memory, disks) with their associated pricing.
55

66
USAGE:
77
scw baremetal offer <command>

cmd/scw/testdata/test-all-usage-baremetal-options-add-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Add an option to a specific server.
3+
Add an option, such as Private Networks, to a specific server.
44

55
USAGE:
66
scw baremetal options add [arg=value ...]
77

88
EXAMPLES:
9-
Add a given option to a server
9+
Add an option, such as Private Networks, to a server
1010
scw baremetal options add server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111
1111

1212
ARGS:

cmd/scw/testdata/test-all-usage-baremetal-options-delete-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ USAGE:
66
scw baremetal options delete [arg=value ...]
77

88
EXAMPLES:
9-
Delete a given option from a server
9+
Delete an option from a server
1010
scw baremetal options delete server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111
1111

1212
ARGS:

cmd/scw/testdata/test-all-usage-baremetal-options-get-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Return specific option for the given ID.
3+
Return specific option for the ID.
44

55
USAGE:
66
scw baremetal options get [arg=value ...]
77

88
EXAMPLES:
9-
Get a server option with the given ID
9+
Get a server option with the ID
1010
scw baremetal options get zone=fr-par-1 option-id=11111111-1111-1111-1111-111111111111
1111

1212
ARGS:

0 commit comments

Comments
 (0)