Skip to content

Commit 56b7246

Browse files
scaleway-botremyleone
scaleway-bot
and
remyleone
authored
docs(elastic-metal): update bmc docs (#2236)
Co-authored-by: Rémy Léone <[email protected]>
1 parent f5d79e4 commit 56b7246

File tree

6 files changed

+18
-3
lines changed

6 files changed

+18
-3
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
33
Start BMC (Baseboard Management Controller) access associated with the given 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.
57

68
USAGE:
79
scw baremetal bmc start [arg=value ...]

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
33
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.
6+
Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723.
7+
And finally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
58

69
USAGE:
710
scw baremetal bmc <command>

‎docs/commands/baremetal.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ Elastic metal API
2626

2727
Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
2828
For instance, your KVM-IP management console could be accessed with it.
29+
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.
30+
Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723.
31+
And finally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
2932

3033

3134

@@ -53,6 +56,8 @@ scw baremetal bmc get [arg=value ...]
5356

5457
Start BMC (Baseboard Management Controller) access associated with the given ID.
5558
The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
59+
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.
60+
After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
5661

5762

5863
**Usage:**

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ require (
1717
github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98
1818
github.com/mattn/go-colorable v0.1.12
1919
github.com/mattn/go-isatty v0.0.14
20-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220325110112-a8da26092f72
20+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220331162939-ba30fab1df65
2121
github.com/spf13/cobra v1.4.0
2222
github.com/spf13/pflag v1.0.5
2323
github.com/stretchr/testify v1.7.1

‎go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE
5757
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
5858
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
5959
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
60-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220325110112-a8da26092f72 h1:pWmhgGVHNImWrErdC7ttqh2TH2ITnucGn5HngFXegxg=
61-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220325110112-a8da26092f72/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
60+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220331162939-ba30fab1df65 h1:ufOy3H0qLn6HVaqu4udEBGiKbHBi997fG1pu+4JVrOo=
61+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220331162939-ba30fab1df65/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
6262
github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
6363
github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
6464
github.com/spf13/cobra v1.4.0 h1:y+wJpx64xcgO1V+RcnwW0LEHxTKRi2ZDPSBjWnrg88Q=

‎internal/namespaces/baremetal/v1/baremetal_cli.go‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,9 @@ func baremetalBmc() *core.Command {
7070
Short: `Baseboard Management Controller (BMC) management commands`,
7171
Long: `Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
7272
For instance, your KVM-IP management console could be accessed with it.
73+
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.
74+
Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723.
75+
And finally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
7376
`,
7477
Namespace: "baremetal",
7578
Resource: "bmc",
@@ -626,6 +629,8 @@ func baremetalBmcStart() *core.Command {
626629
Short: `Start BMC (Baseboard Management Controller) access for a given elastic metal server`,
627630
Long: `Start BMC (Baseboard Management Controller) access associated with the given ID.
628631
The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
632+
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.
633+
After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
629634
`,
630635
Namespace: "baremetal",
631636
Resource: "bmc",

0 commit comments

Comments
 (0)