Skip to content

docs: update generated documentation #1444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 15, 2020
Merged

docs: update generated documentation #1444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25cf958
docs: update generated documentation
remyleone Sep 15, 2020
860cc8e
Merge branch 'master' into update_docs
remyleone Sep 15, 2020
3c7b8b5
Merge branch 'master' into update_docs
remyleone Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions docs/commands/account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
Account API

- [SSH keys management commands](#ssh-keys-management-commands)
- [Add a SSH key to your organization](#add-a-ssh-key-to-your-organization)
- [Get a SSH key from your organization](#get-a-ssh-key-from-your-organization)
- [Add an SSH key to your project](#add-an-ssh-key-to-your-project)
- [Get an SSH key from your project](#get-an-ssh-key-from-your-project)
- [Initialize SSH key](#initialize-ssh-key)
- [List all SSH keys of your organization](#list-all-ssh-keys-of-your-organization)
- [Remove a SSH key from your organization](#remove-a-ssh-key-from-your-organization)
- [Update a SSH key on your organization](#update-a-ssh-key-on-your-organization)
- [List all SSH keys of your project](#list-all-ssh-keys-of-your-project)
- [Remove an SSH key from your project](#remove-an-ssh-key-from-your-project)
- [Update an SSH key on your project](#update-an-ssh-key-on-your-project)


## SSH keys management commands

SSH keys management commands.


### Add a SSH key to your organization
### Add an SSH key to your project

Add a SSH key to your organization.
Add an SSH key to your project.

**Usage:**

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


**Examples:**


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




### Get a SSH key from your organization
### Get an SSH key from your project

Get a SSH key from your organization.
Get an SSH key from your project.

**Usage:**

Expand Down Expand Up @@ -79,9 +79,9 @@ scw account ssh-key init



### List all SSH keys of your organization
### List all SSH keys of your project

List all SSH keys of your organization.
List all SSH keys of your project.

**Usage:**

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



### Remove a SSH key from your organization
### Remove an SSH key from your project

Remove a SSH key from your organization.
Remove an SSH key from your project.

**Usage:**

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



### Update a SSH key on your organization
### Update an SSH key on your project

Update a SSH key on your organization.
Update an SSH key on your project.

**Usage:**

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



93 changes: 89 additions & 4 deletions docs/commands/baremetal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
# Documentation for `scw baremetal`
Baremetal API

- [Baseboard Management Controller (BMC) management commands](#baseboard-management-controller-(bmc)-management-commands)
- [Get BMC (Baseboard Management Controller) access for a given baremetal server](#get-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server)
- [Start BMC (Baseboard Management Controller) access for a given baremetal server](#start-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server)
- [Stop BMC (Baseboard Management Controller) access for a given baremetal server](#stop-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server)
- [Operating System (OS) management commands](#operating-system-(os)-management-commands)
- [Get an OS with a given ID](#get-an-os-with-a-given-id)
- [List all available OS that can be install on a baremetal server](#list-all-available-os-that-can-be-install-on-a-baremetal-server)
Expand All @@ -10,14 +14,84 @@ Baremetal API
- [Delete a baremetal server](#delete-a-baremetal-server)
- [Get a specific baremetal server](#get-a-specific-baremetal-server)
- [Install a baremetal server](#install-a-baremetal-server)
- [List baremetal servers](#list-baremetal-servers)
- [List baremetal servers for organization](#list-baremetal-servers-for-organization)
- [Reboot a baremetal server](#reboot-a-baremetal-server)
- [Start a baremetal server](#start-a-baremetal-server)
- [Stop a baremetal server](#stop-a-baremetal-server)
- [Update a baremetal server](#update-a-baremetal-server)
- [Wait for a server to reach a stable state (delivery and installation)](#wait-for-a-server-to-reach-a-stable-state-(delivery-and-installation))


## Baseboard Management Controller (BMC) management commands

Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
For instance, your KVM-IP management console could be accessed with it.



### Get BMC (Baseboard Management Controller) access for a given baremetal server

Get the BMC (Baseboard Management Controller) access associated with the given ID.

**Usage:**

```
scw baremetal bmc get [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| server-id | Required | ID of the server |
| 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 |



### Start BMC (Baseboard Management Controller) access for a given baremetal server

Start BMC (Baseboard Management Controller) access associated with the given ID.
The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.


**Usage:**

```
scw baremetal bmc start [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| server-id | Required | ID of the server |
| ip | Required | The IP authorized to connect to the given server |
| 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 |



### Stop BMC (Baseboard Management Controller) access for a given baremetal server

Stop BMC (Baseboard Management Controller) access associated with the given ID.

**Usage:**

```
scw baremetal bmc stop [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| server-id | Required | ID of the server |
| 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 |



## Operating System (OS) management commands

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

| Name | | Description |
|------|---|-------------|
| project-id | | Project ID to use. If none is passed the default project ID will be used |
| name | Required<br />Default: `<generated>` | Name of the server (≠hostname) |
| description | | Description associated to the server, max 255 characters |
| 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 |
| tags.{index} | | Tags to associate to the server |
| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config |
| install.os-id | | |
| install.hostname | | |
| install.ssh-key-ids.{index} | | |
| organization-id | | Organization ID to use. If none is passed the default organization ID will be used |
| 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 |


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



### List baremetal servers
### List baremetal servers for organization

List baremetal servers.
List baremetal servers for organization.

**Usage:**

Expand All @@ -230,6 +308,7 @@ scw baremetal server list [arg=value ...]
| tags.{index} | | Filter servers by tags |
| status.{index} | | Filter servers by status |
| name | | Filter servers by name |
| project-id | | Filter servers by project ID |
| organization-id | | Filter servers by organization ID |
| 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 |

Expand Down Expand Up @@ -297,6 +376,7 @@ scw baremetal server start <server-id ...> [arg=value ...]
| Name | | Description |
|------|---|-------------|
| server-id | Required | ID of the server to start |
| boot-type | One of: `unknown_boot_type`, `normal`, `rescue` | The type of boot |
| 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 |


Expand All @@ -308,6 +388,11 @@ Start a baremetal server
scw baremetal server start 11111111-1111-1111-1111-111111111111
```

Start a server in rescue mode
```
scw baremetal server start 11111111-1111-1111-1111-111111111111 boot-type=rescue
```




Expand Down
20 changes: 20 additions & 0 deletions docs/commands/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Read more about the config management engine at https://github.com/scaleway/scal
- [Dump the config file](#dump-the-config-file)
- [Get a value from the config file](#get-a-value-from-the-config-file)
- [Allows the deletion of a profile from the config file](#allows-the-deletion-of-a-profile-from-the-config-file)
- [Mark a profile as active in the config file](#mark-a-profile-as-active-in-the-config-file)
- [Delete a profile from the config file](#delete-a-profile-from-the-config-file)
- [Reset the config](#reset-the-config)
- [Set a line from the config file](#set-a-line-from-the-config-file)
Expand Down Expand Up @@ -85,6 +86,25 @@ scw -p prod config get default_region



### Mark a profile as active in the config file



**Usage:**

```
scw config profile activate <profile-name ...> [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| profile-name | Required | |



### Delete a profile from the config file


Expand Down
Loading