Skip to content

docs: add documentation strings #2336

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 1 commit into from
Jun 6, 2022
Merged

docs: add documentation strings #2336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ ARGS:
[description] Description associated to the server, max 255 characters
[type] Server commercial type
[tags.{index}] Tags to associate to the server
[install.os-id]
[install.hostname]
[install.ssh-key-ids.{index}]
[install.user]
[install.password]
[install.service-user]
[install.service-password]
[install.os-id] ID of the OS to install on the server
[install.hostname] Hostname of the server
[install.ssh-key-ids.{index}] SSH key IDs authorized on the server
[install.user] User used for the installation
[install.password] Password used for the installation
[install.service-user] User used for the service to install
[install.service-password] Password used for the service to install
[option-ids.{index}] IDs of options to enable on server
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
[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)
Expand Down
14 changes: 7 additions & 7 deletions docs/commands/baremetal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,13 +177,13 @@ scw baremetal server create [arg=value ...]
| description | | Description associated to the server, max 255 characters |
| type | | Server commercial type |
| tags.{index} | | Tags to associate to the server |
| install.os-id | | |
| install.hostname | | |
| install.ssh-key-ids.{index} | | |
| install.user | | |
| install.password | | |
| install.service-user | | |
| install.service-password | | |
| install.os-id | | ID of the OS to install on the server |
| install.hostname | | Hostname of the server |
| install.ssh-key-ids.{index} | | SSH key IDs authorized on the server |
| install.user | | User used for the installation |
| install.password | | Password used for the installation |
| install.service-user | | User used for the service to install |
| install.service-password | | Password used for the service to install |
| option-ids.{index} | | IDs of options to enable on server |
| 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-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config |
Expand Down
7 changes: 7 additions & 0 deletions internal/namespaces/baremetal/v1/baremetal_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,42 +239,49 @@ func baremetalServerCreate() *core.Command {
},
{
Name: "install.os-id",
Short: `ID of the OS to install on the server`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "install.hostname",
Short: `Hostname of the server`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "install.ssh-key-ids.{index}",
Short: `SSH key IDs authorized on the server`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "install.user",
Short: `User used for the installation`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "install.password",
Short: `Password used for the installation`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "install.service-user",
Short: `User used for the service to install`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "install.service-password",
Short: `Password used for the service to install`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down