Skip to content

Commit

Permalink
[CHANGE] docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eijei521 committed Aug 29, 2022
1 parent 93df47e commit bf0b258
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 27 deletions.
1 change: 1 addition & 0 deletions docs/cherryctl_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ Server operations: create, get, list, delete, start, stop, reboot and reinstall.
* [cherryctl server reinstall](cherryctl_server_reinstall.md) - Reinstall a server.
* [cherryctl server start](cherryctl_server_start.md) - Starts a server.
* [cherryctl server stop](cherryctl_server_stop.md) - Stop a server.
* [cherryctl server update](cherryctl_server_update.md) - Update server.

11 changes: 5 additions & 6 deletions docs/cherryctl_server_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,26 @@ Delete a server.
Deletes the specified server with a confirmation prompt. To skip the confirmation use --force.

```
cherryctl server delete -i <server_id> [flags]
cherryctl server delete ID [-f] [flags]
```

### Examples

```
# Deletes the specified server:
cherryctl server delete -i 12345
cherryctl server delete 12345
>
✔ Are you sure you want to delete server 12345: y
# Deletes a server, skipping confirmation:
cherryctl server delete -f -i 12345
cherryctl server delete 12345 -f
```

### Options

```
-f, --force Skips confirmation for the server deletion.
-h, --help help for delete
-i, --server-id int The ID of a server.
-f, --force Skips confirmation for the server deletion.
-h, --help help for delete
```

### Options inherited from parent commands
Expand Down
10 changes: 4 additions & 6 deletions docs/cherryctl_server_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,21 @@ Retrieves server details.
Retrieves the details of the specified server.

```
cherryctl server get {-i <server_id> | --hostname} [-p <project_id>] [flags]
cherryctl server get {ID | HOSTNAME} [-p <project_id>] [flags]
```

### Examples

```
# Gets the details of the specified server:
cherryctl server get -i 12345
cherryctl server get 12345
```

### Options

```
-h, --help help for get
--hostname string The Hostname of a server.
-p, --project-id int The project's ID.
-i, --server-id int The ID of a server.
-h, --help help for get
-p, --project-id int The project's ID.
```

### Options inherited from parent commands
Expand Down
7 changes: 3 additions & 4 deletions docs/cherryctl_server_reboot.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,20 @@ Reboot a server.
Reboot the specified server.

```
cherryctl server reboot -i <server_id> [flags]
cherryctl server reboot ID [flags]
```

### Examples

```
# Reboot the specified server:
cherryctl server reboot -i 12345
cherryctl server reboot 12345
```

### Options

```
-h, --help help for reboot
-i, --server-id int The ID of a server.
-h, --help help for reboot
```

### Options inherited from parent commands
Expand Down
5 changes: 2 additions & 3 deletions docs/cherryctl_server_reinstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Reinstall a server.
Reinstall the specified server.

```
cherryctl server reinstall -i <server_id> --hostname --image <image_slug> --password <password> [--ssh-keys <ssh_key_ids>] [--os-partition-size <size>] [flags]
cherryctl server reinstall ID --hostname <hostname> --image <image_slug> --password <password> [--ssh-keys <ssh_key_ids>] [--os-partition-size <size>] [flags]
```

### Examples

```
# Reinstall the specified server:
cherryctl server reinstall -i 12345 -h staging-server-1 --image ubuntu_20_04 --password G1h2e_39Q9oT
cherryctl server reinstall 12345 -hostname staging-server-1 --image ubuntu_20_04 --password G1h2e_39Q9oT
```

### Options
Expand All @@ -25,7 +25,6 @@ cherryctl server reinstall -i <server_id> --hostname --image <image_slug> --pass
--image string Operating system slug for the server.
--os-partition-size int OS partition size in GB.
--password string Server password.
-i, --server-id int The ID of a server.
--ssh-keys strings Comma separated list of SSH key IDs to be embed in the Server.
```

Expand Down
7 changes: 3 additions & 4 deletions docs/cherryctl_server_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,20 @@ Starts a server.
Starts or powers on a server that is currently stopped or powered off.

```
cherryctl server start -i <server_id> [flags]
cherryctl server start ID [flags]
```

### Examples

```
# Starts the specified server:
cherryctl server start -i 12345
cherryctl server start 12345
```

### Options

```
-h, --help help for start
-i, --server-id int The ID of a server.
-h, --help help for start
```

### Options inherited from parent commands
Expand Down
7 changes: 3 additions & 4 deletions docs/cherryctl_server_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,20 @@ Stop a server.
Stops or powers off a server that is currently powered on.

```
cherryctl server stop -i <server_id> [flags]
cherryctl server stop ID [flags]
```

### Examples

```
# Stops the specified server:
cherryctl server stop -i 12345
cherryctl server stop 12345
```

### Options

```
-h, --help help for stop
-i, --server-id int The ID of a server.
-h, --help help for stop
```

### Options inherited from parent commands
Expand Down
41 changes: 41 additions & 0 deletions docs/cherryctl_server_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## cherryctl server update

Update server.

### Synopsis

Update server.

```
cherryctl server update ID [--name <server_name>] [--hostname] [--tags] [--bgp] [flags]
```

### Examples

```
# Update server to change tags:
cherryctl server update 12345 --tags="env=stage"
```

### Options

```
-b, --bgp True to enable BGP in a server.
-h, --help help for update
--hostname string Server hostname.
--tags strings Tag or list of tags for the server: --tags="key=value,env=prod".
```

### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--fields strings Comma separated object field names to output in result. Fields can be used for list and get actions.
-o, --output string Output format (*table, json, yaml)
--token string API Token (CHERRY_AUTH_TOKEN)
```

### SEE ALSO

* [cherryctl server](cherryctl_server.md) - Server operations. For more information on provisioning on Cherry Servers, visit https://docs.cherryservers.com/knowledge/product-docs.

0 comments on commit bf0b258

Please sign in to comment.