Skip to content

Commit 80ed4a3

Browse files
remyleoneremyleone
authored
docs: update generated documentation (#1444)
1 parent bc4caec commit 80ed4a3

File tree

11 files changed

+2235
-166
lines changed

11 files changed

+2235
-166
lines changed

‎docs/commands/account.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@
33
Account API
44

55
- [SSH keys management commands](#ssh-keys-management-commands)
6-
- [Add a SSH key to your organization](#add-a-ssh-key-to-your-organization)
7-
- [Get a SSH key from your organization](#get-a-ssh-key-from-your-organization)
6+
- [Add an SSH key to your project](#add-an-ssh-key-to-your-project)
7+
- [Get an SSH key from your project](#get-an-ssh-key-from-your-project)
88
- [Initialize SSH key](#initialize-ssh-key)
9-
- [List all SSH keys of your organization](#list-all-ssh-keys-of-your-organization)
10-
- [Remove a SSH key from your organization](#remove-a-ssh-key-from-your-organization)
11-
- [Update a SSH key on your organization](#update-a-ssh-key-on-your-organization)
9+
- [List all SSH keys of your project](#list-all-ssh-keys-of-your-project)
10+
- [Remove an SSH key from your project](#remove-an-ssh-key-from-your-project)
11+
- [Update an SSH key on your project](#update-an-ssh-key-on-your-project)
1212

1313

1414
## SSH keys management commands
1515

1616
SSH keys management commands.
1717

1818

19-
### Add a SSH key to your organization
19+
### Add an SSH key to your project
2020

21-
Add a SSH key to your organization.
21+
Add an SSH key to your project.
2222

2323
**Usage:**
2424

@@ -33,24 +33,24 @@ scw account ssh-key add [arg=value ...]
3333
|------|---|-------------|
3434
| name | | The name of the SSH key |
3535
| public-key | Required | SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported |
36-
| project-id | | Project owning the resource |
37-
| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config |
36+
| project-id | | Project ID to use. If none is passed the default project ID will be used |
37+
| organization-id | | Organization ID to use. If none is passed the default organization ID will be used |
3838

3939

4040
**Examples:**
4141

4242

4343
Add a given ssh key
4444
```
45-
scw account ssh-key add name=foobar public_key="$(cat <path/to/your/public/key>)"
45+
scw account ssh-key add name=foobar public-key="$(cat <path/to/your/public/key>)"
4646
```
4747

4848

4949

5050

51-
### Get a SSH key from your organization
51+
### Get an SSH key from your project
5252

53-
Get a SSH key from your organization.
53+
Get an SSH key from your project.
5454

5555
**Usage:**
5656

@@ -79,9 +79,9 @@ scw account ssh-key init
7979

8080

8181

82-
### List all SSH keys of your organization
82+
### List all SSH keys of your project
8383

84-
List all SSH keys of your organization.
84+
List all SSH keys of your project.
8585

8686
**Usage:**
8787

@@ -101,9 +101,9 @@ scw account ssh-key list [arg=value ...]
101101

102102

103103

104-
### Remove a SSH key from your organization
104+
### Remove an SSH key from your project
105105

106-
Remove a SSH key from your organization.
106+
Remove an SSH key from your project.
107107

108108
**Usage:**
109109

@@ -130,9 +130,9 @@ scw account ssh-key remove 11111111-1111-1111-1111-111111111111
130130

131131

132132

133-
### Update a SSH key on your organization
133+
### Update an SSH key on your project
134134

135-
Update a SSH key on your organization.
135+
Update an SSH key on your project.
136136

137137
**Usage:**
138138

@@ -146,7 +146,7 @@ scw account ssh-key update <ssh-key-id ...> [arg=value ...]
146146
| Name | | Description |
147147
|------|---|-------------|
148148
| ssh-key-id | Required | |
149-
| name | | |
149+
| name | | Name of the SSH key |
150150

151151

152152

‎docs/commands/baremetal.md‎

Lines changed: 89 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
# Documentation for `scw baremetal`
33
Baremetal API
44

5+
- [Baseboard Management Controller (BMC) management commands](#baseboard-management-controller-(bmc)-management-commands)
6+
- [Get BMC (Baseboard Management Controller) access for a given baremetal server](#get-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server)
7+
- [Start BMC (Baseboard Management Controller) access for a given baremetal server](#start-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server)
8+
- [Stop BMC (Baseboard Management Controller) access for a given baremetal server](#stop-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server)
59
- [Operating System (OS) management commands](#operating-system-(os)-management-commands)
610
- [Get an OS with a given ID](#get-an-os-with-a-given-id)
711
- [List all available OS that can be install on a baremetal server](#list-all-available-os-that-can-be-install-on-a-baremetal-server)
@@ -10,14 +14,84 @@ Baremetal API
1014
- [Delete a baremetal server](#delete-a-baremetal-server)
1115
- [Get a specific baremetal server](#get-a-specific-baremetal-server)
1216
- [Install a baremetal server](#install-a-baremetal-server)
13-
- [List baremetal servers](#list-baremetal-servers)
17+
- [List baremetal servers for organization](#list-baremetal-servers-for-organization)
1418
- [Reboot a baremetal server](#reboot-a-baremetal-server)
1519
- [Start a baremetal server](#start-a-baremetal-server)
1620
- [Stop a baremetal server](#stop-a-baremetal-server)
1721
- [Update a baremetal server](#update-a-baremetal-server)
1822
- [Wait for a server to reach a stable state (delivery and installation)](#wait-for-a-server-to-reach-a-stable-state-(delivery-and-installation))
1923

2024

25+
## Baseboard Management Controller (BMC) management commands
26+
27+
Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
28+
For instance, your KVM-IP management console could be accessed with it.
29+
30+
31+
32+
### Get BMC (Baseboard Management Controller) access for a given baremetal server
33+
34+
Get the BMC (Baseboard Management Controller) access associated with the given ID.
35+
36+
**Usage:**
37+
38+
```
39+
scw baremetal bmc get [arg=value ...]
40+
```
41+
42+
43+
**Args:**
44+
45+
| Name | | Description |
46+
|------|---|-------------|
47+
| server-id | Required | ID of the server |
48+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
49+
50+
51+
52+
### Start BMC (Baseboard Management Controller) access for a given baremetal server
53+
54+
Start BMC (Baseboard Management Controller) access associated with the given ID.
55+
The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
56+
57+
58+
**Usage:**
59+
60+
```
61+
scw baremetal bmc start [arg=value ...]
62+
```
63+
64+
65+
**Args:**
66+
67+
| Name | | Description |
68+
|------|---|-------------|
69+
| server-id | Required | ID of the server |
70+
| ip | Required | The IP authorized to connect to the given server |
71+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
72+
73+
74+
75+
### Stop BMC (Baseboard Management Controller) access for a given baremetal server
76+
77+
Stop BMC (Baseboard Management Controller) access associated with the given ID.
78+
79+
**Usage:**
80+
81+
```
82+
scw baremetal bmc stop [arg=value ...]
83+
```
84+
85+
86+
**Args:**
87+
88+
| Name | | Description |
89+
|------|---|-------------|
90+
| server-id | Required | ID of the server |
91+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
92+
93+
94+
2195
## Operating System (OS) management commands
2296

2397
An Operating System (OS) is the underlying software installed on your server
@@ -93,11 +167,15 @@ scw baremetal server create [arg=value ...]
93167

94168
| Name | | Description |
95169
|------|---|-------------|
170+
| project-id | | Project ID to use. If none is passed the default project ID will be used |
96171
| name | Required<br />Default: `<generated>` | Name of the server (≠hostname) |
97172
| description | | Description associated to the server, max 255 characters |
98173
| type | Default: `GP-BM1-S`<br />One of: `GP-BM1-L`, `GP-BM1-M`, `GP-BM1-S`, `HC-BM1-L`, `HC-BM1-S`, `HM-BM1-XL`, `HM-BM1-M` | Server commercial type |
99174
| tags.{index} | | Tags to associate to the server |
100-
| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config |
175+
| install.os-id | | |
176+
| install.hostname | | |
177+
| install.ssh-key-ids.{index} | | |
178+
| organization-id | | Organization ID to use. If none is passed the default organization ID will be used |
101179
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
102180

103181

@@ -211,9 +289,9 @@ scw baremetal server install 11111111-1111-1111-1111-111111111111 os-id=11111111
211289

212290

213291

214-
### List baremetal servers
292+
### List baremetal servers for organization
215293

216-
List baremetal servers.
294+
List baremetal servers for organization.
217295

218296
**Usage:**
219297

@@ -230,6 +308,7 @@ scw baremetal server list [arg=value ...]
230308
| tags.{index} | | Filter servers by tags |
231309
| status.{index} | | Filter servers by status |
232310
| name | | Filter servers by name |
311+
| project-id | | Filter servers by project ID |
233312
| organization-id | | Filter servers by organization ID |
234313
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
235314

@@ -297,6 +376,7 @@ scw baremetal server start <server-id ...> [arg=value ...]
297376
| Name | | Description |
298377
|------|---|-------------|
299378
| server-id | Required | ID of the server to start |
379+
| boot-type | One of: `unknown_boot_type`, `normal`, `rescue` | The type of boot |
300380
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
301381

302382

@@ -308,6 +388,11 @@ Start a baremetal server
308388
scw baremetal server start 11111111-1111-1111-1111-111111111111
309389
```
310390

391+
Start a server in rescue mode
392+
```
393+
scw baremetal server start 11111111-1111-1111-1111-111111111111 boot-type=rescue
394+
```
395+
311396

312397

313398

‎docs/commands/config.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Read more about the config management engine at https://github.com/scaleway/scal
2424
- [Dump the config file](#dump-the-config-file)
2525
- [Get a value from the config file](#get-a-value-from-the-config-file)
2626
- [Allows the deletion of a profile from the config file](#allows-the-deletion-of-a-profile-from-the-config-file)
27+
- [Mark a profile as active in the config file](#mark-a-profile-as-active-in-the-config-file)
2728
- [Delete a profile from the config file](#delete-a-profile-from-the-config-file)
2829
- [Reset the config](#reset-the-config)
2930
- [Set a line from the config file](#set-a-line-from-the-config-file)
@@ -85,6 +86,25 @@ scw -p prod config get default_region
8586

8687

8788

89+
### Mark a profile as active in the config file
90+
91+
92+
93+
**Usage:**
94+
95+
```
96+
scw config profile activate <profile-name ...> [arg=value ...]
97+
```
98+
99+
100+
**Args:**
101+
102+
| Name | | Description |
103+
|------|---|-------------|
104+
| profile-name | Required | |
105+
106+
107+
88108
### Delete a profile from the config file
89109

90110

0 commit comments

Comments
 (0)