Skip to content

Commit f2fe6eb

Browse files
OriHochOriHoch
committed
update documentation to latest schema (cloudcli-server v0.1.3)
1 parent 5a5d88c commit f2fe6eb

19 files changed

Lines changed: 120 additions & 25 deletions

‎CONTRIBUTING.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,16 @@ Run all tests:
6161
```
6262
bin/test.sh all
6363
```
64+
65+
66+
## Updating the documentation
67+
68+
Run the following from the project directory:
69+
70+
```
71+
cloudcli init --docs-dir `pwd`/docs --docs-format markdown
72+
```
73+
74+
Update README.md manually
75+
76+
Commit the updated docs

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,14 @@ cloudcli --help
3232

3333
#### Server management
3434

35+
* [cloudcli server attach](docs/cloudcli_server_attach.md) - Connect to the server via SSH
3536
* [cloudcli server create](docs/cloudcli_server_create.md) - Create a server
3637
* [cloudcli server info](docs/cloudcli_server_info.md) - Get server overview/information
3738
* [cloudcli server list](docs/cloudcli_server_list.md) - List servers
3839
* [cloudcli server options](docs/cloudcli_server_options.md) - List server options
3940
* [cloudcli server poweroff](docs/cloudcli_server_poweroff.md) - Power Off server/s
4041
* [cloudcli server poweron](docs/cloudcli_server_poweron.md) - Power On server/s
42+
* [cloudcli server reboot](docs/cloudcli_server_reboot.md) - Reboot server/s
4143
* [cloudcli server terminate](docs/cloudcli_server_terminate.md) - Terminate server/s
4244

4345
#### Task queue management

‎docs/cloudcli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ it's recommended to use a configuration file with appropriate permissions and lo
4141
* [cloudcli server](cloudcli_server.md) - Server management
4242
* [cloudcli version](cloudcli_version.md) - Get the cloudcli version
4343

44-
###### Auto generated by spf13/cobra on 24-Jun-2019
44+
###### Auto generated by spf13/cobra on 21-Jul-2019

‎docs/cloudcli_init.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ cloudcli init [flags]
3535

3636
* [cloudcli](cloudcli.md) - Cloudcli server management
3737

38-
###### Auto generated by spf13/cobra on 24-Jun-2019
38+
###### Auto generated by spf13/cobra on 21-Jul-2019

‎docs/cloudcli_queue.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ Task queue management
3131
* [cloudcli queue detail](cloudcli_queue_detail.md) - Get details of tasks
3232
* [cloudcli queue list](cloudcli_queue_list.md) - List all tasks in queue
3333

34-
###### Auto generated by spf13/cobra on 24-Jun-2019
34+
###### Auto generated by spf13/cobra on 21-Jul-2019

‎docs/cloudcli_queue_detail.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ cloudcli queue detail [flags]
3737

3838
* [cloudcli queue](cloudcli_queue.md) - Task queue management
3939

40-
###### Auto generated by spf13/cobra on 24-Jun-2019
40+
###### Auto generated by spf13/cobra on 21-Jul-2019

‎docs/cloudcli_queue_list.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ cloudcli queue list [flags]
3333

3434
* [cloudcli queue](cloudcli_queue.md) - Task queue management
3535

36-
###### Auto generated by spf13/cobra on 24-Jun-2019
36+
###### Auto generated by spf13/cobra on 21-Jul-2019

‎docs/cloudcli_server.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,14 @@ Server management
2828
### SEE ALSO
2929

3030
* [cloudcli](cloudcli.md) - Cloudcli server management
31+
* [cloudcli server attach](cloudcli_server_attach.md) - Connect to the server via SSH
3132
* [cloudcli server create](cloudcli_server_create.md) - Create a server
3233
* [cloudcli server info](cloudcli_server_info.md) - Get server overview/information
3334
* [cloudcli server list](cloudcli_server_list.md) - List servers
3435
* [cloudcli server options](cloudcli_server_options.md) - List server options
3536
* [cloudcli server poweroff](cloudcli_server_poweroff.md) - Power Off server/s
3637
* [cloudcli server poweron](cloudcli_server_poweron.md) - Power On server/s
38+
* [cloudcli server reboot](cloudcli_server_reboot.md) - Reboot server/s
3739
* [cloudcli server terminate](cloudcli_server_terminate.md) - Terminate server/s
3840

39-
###### Auto generated by spf13/cobra on 24-Jun-2019
41+
###### Auto generated by spf13/cobra on 21-Jul-2019

‎docs/cloudcli_server_attach.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## cloudcli server attach
2+
3+
Connect to the server via SSH
4+
5+
### Synopsis
6+
7+
Connect to the server via SSH
8+
9+
```
10+
cloudcli server attach [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for attach
17+
--id string Specific server UUID
18+
--name string Server name or regular expression matching a single server
19+
--password string The server SSH password.
20+
```
21+
22+
### Options inherited from parent commands
23+
24+
```
25+
--api-clientid string API Client ID
26+
--api-secret string API Secret
27+
--api-server string API Server Hostname
28+
--config string config file (default is $HOME/.cloudcli.yaml)
29+
--debug enable debug output to stderr
30+
--dryrun enable dry run mode, does not perform actions
31+
--format string output format, default format is a human readable summary
32+
--no-config disable loading from config file
33+
```
34+
35+
### SEE ALSO
36+
37+
* [cloudcli server](cloudcli_server.md) - Server management
38+
39+
###### Auto generated by spf13/cobra on 21-Jul-2019

‎docs/cloudcli_server_create.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,29 @@ cloudcli server create [flags]
1313
### Options
1414

1515
```
16-
--billingcycle string Servers' Billing Cycle. (hourly | monthly) (optional, default: hourly) (default "hourly")
17-
--cpu string CPU count and type. (optional, default: 1B) (default "1B")
18-
--dailybackup string Set Daily Backup (yes | no). (optional, default: no) (default "no")
16+
--name string Server name (a-zA-Z0-9()_-). (must be at least 4 characters long, mandatory)
1917
--datacenter string Server datacenter (EU, US-NY2, AS.. see server options subcommand). (mandatory)
18+
--image string Server image name or image ID (see server options subcommand). (mandatory)
19+
--cpu string CPU count and type. (optional, default: 1B) (default "1B")
20+
--ram string Size of server ram in MiB. (optional, default: 1024) (default "1024")
2021
--disk stringArray Configure Persistent Disks, Up to 4 disks allowed. (at least 1 is mandatory)
2122
--disk id=ID,size=SIZE --disk <DISK2>..
2223
ID: first disk # is 0. (optional, default is auto-incremented starting from 0)
2324
SIZE: in GiB. (optional, defaults to one 20GB disk) (default ["id=0,size=20"])
24-
-h, --help help for create
25-
--image string Server image name or image ID (see server options subcommand). (mandatory)
26-
--managed string Set Managed Hosting Services (yes | no). (optional, default: no) (default "no")
27-
--monthlypackage string Monthly billing cycle package (see server options subcommand). (optional in monthly billing cycle, default: t5000) (default "t5000")
28-
--name string Server name (a-zA-Z0-9()_-). (must be at least 4 characters long, mandatory)
2925
--network stringArray Configure networking, up to 4 networks allowed. (at least 1 is mandatory)
3026
--network id=ID,name=NAME,ip=IP --network <NETWORK2>..
3127
ID: first network # is 0. (optional, default is auto-incremented starting from 0)
3228
NAME: Set the network VLAN name, set 'wan' for wan interface, otherwise, set the name of an existing lan. (mandatory)
3329
IP: Set the IP address of the server’s network interface. Set 'auto' for auto allocation. (mandatory) (default ["id=0,name=wan,ip=auto"])
3430
--password string Server password (a-z, A-Z, 0-9, !@#$^&*()~). (must be 10-20 characters long with at least 1 capital letter, 1 small letter and 1 digit, mandatory)
35-
--poweronaftercreate string Power on server after server created. (optional, default: yes) (default "yes")
31+
--dailybackup string Set Daily Backup (yes | no). (optional, default: no) (default "no")
32+
--managed string Set Managed Hosting Services (yes | no). (optional, default: no) (default "no")
3633
--quantity string Number of servers to create, up to 50 servers. (optional, default: 1) (default "1")
37-
--ram string Size of server ram in MiB. (optional, default: 1024) (default "1024")
34+
--billingcycle string Servers' Billing Cycle. (hourly | monthly) (optional, default: hourly) (default "hourly")
35+
--monthlypackage string Monthly billing cycle package (see server options subcommand). (optional in monthly billing cycle, default: t5000) (default "t5000")
36+
--poweronaftercreate string Power on server after server created. (optional, default: yes) (default "yes")
3837
--wait Wait for command execution to finish only then exit cli.
38+
-h, --help help for create
3939
```
4040

4141
### Options inherited from parent commands
@@ -55,4 +55,4 @@ cloudcli server create [flags]
5555

5656
* [cloudcli server](cloudcli_server.md) - Server management
5757

58-
###### Auto generated by spf13/cobra on 24-Jun-2019
58+
###### Auto generated by spf13/cobra on 21-Jul-2019

0 commit comments

Comments
 (0)