Skip to content

Commit fb72f54

Browse files
OriHochOriHoch
committed
update k8s docs
1 parent 361104e commit fb72f54

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+340
-46
lines changed

‎README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,5 +75,11 @@ cloudcli --help
7575
#### Kubernetes management (BETA)
7676

7777
* [cloudcli k8s create_cluster](docs/cloudcli_k8s_create_cluster.md) - Create a Kubernetes cluster (BETA)
78-
* [cloudcli k8s add_worker](docs/cloudcli_k8s_add_worker.md) - Add a Kubernetes worker node to a nodepool (BETA)
78+
* [cloudcli k8s create_node](docs/cloudcli_k8s_create_node.md) - Create a node (BETA)
79+
* [cloudcli k8s create_nodepool](docs/cloudcli_k8s_create_nodepool.md) - Create a nodepool (BETA)
80+
* [cloudcli k8s kubeconfig](docs/cloudcli_k8s_kubeconfig.md) - Get cluster kubeconfig (BETA)
7981
* [cloudcli k8s status](docs/cloudcli_k8s_status.md) - Get Kubernetes cluster status (BETA)
82+
* [cloudcli k8s task_status](docs/cloudcli_k8s_task_status.md) - Get task status
83+
* [cloudcli k8s update_cluster](docs/cloudcli_k8s_update_cluster.md) - Update a Kubernetes cluster (BETA)
84+
* [cloudcli k8s update_node](docs/cloudcli_k8s_update_node.md) - Update a node (BETA)
85+
* [cloudcli k8s update_nodepool](docs/cloudcli_k8s_update_nodepool.md) - Update a nodepool (BETA)

‎docs/cloudcli.md

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

45-
###### Auto generated by spf13/cobra on 19-Oct-2024
45+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_init.md

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

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

37-
###### Auto generated by spf13/cobra on 19-Oct-2024
37+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,14 @@ Kubernetes management
2727
### SEE ALSO
2828

2929
* [cloudcli](cloudcli.md) - Cloudcli server management
30-
* [cloudcli k8s add_worker](cloudcli_k8s_add_worker.md) - Add a Kubernetes worker node to a nodepool (BETA)
3130
* [cloudcli k8s create_cluster](cloudcli_k8s_create_cluster.md) - Create a Kubernetes cluster (BETA)
31+
* [cloudcli k8s create_node](cloudcli_k8s_create_node.md) - Create a node (BETA)
32+
* [cloudcli k8s create_nodepool](cloudcli_k8s_create_nodepool.md) - Create a nodepool (BETA)
33+
* [cloudcli k8s kubeconfig](cloudcli_k8s_kubeconfig.md) - Get cluster kubeconfig (BETA)
3234
* [cloudcli k8s status](cloudcli_k8s_status.md) - Get Kubernetes cluster status (BETA)
35+
* [cloudcli k8s task_status](cloudcli_k8s_task_status.md) - Get task status
36+
* [cloudcli k8s update_cluster](cloudcli_k8s_update_cluster.md) - Update a Kubernetes cluster (BETA)
37+
* [cloudcli k8s update_node](cloudcli_k8s_update_node.md) - Update a node (BETA)
38+
* [cloudcli k8s update_nodepool](cloudcli_k8s_update_nodepool.md) - Update a nodepool (BETA)
3339

34-
###### Auto generated by spf13/cobra on 19-Oct-2024
40+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_create_cluster.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ Create a Kubernetes cluster (BETA)
66

77
Create a Kubernetes cluster (BETA)
88

9+
Create a new cluster or create all node pools / nodes in an existing cluster.
10+
Safe to run multiple times, only new nodes will be created and added to the relevant node pools in the cluster.
11+
912
```
1013
cloudcli k8s create_cluster [flags]
1114
```
@@ -16,7 +19,6 @@ cloudcli k8s create_cluster [flags]
1619
-h, --help help for create_cluster
1720
--kconfig string Path to Kamatera cluster configuration file in JSON or YAML format
1821
Use our server configuration interface at https://kamatera.github.io/kamateratoolbox/serverconfiggen_k8s.html to generate this configuration file
19-
--wait Wait for command execution to finish only then exit cli.
2022
```
2123

2224
### Options inherited from parent commands
@@ -35,4 +37,4 @@ cloudcli k8s create_cluster [flags]
3537

3638
* [cloudcli k8s](cloudcli_k8s.md) - Kubernetes management
3739

38-
###### Auto generated by spf13/cobra on 19-Oct-2024
40+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_create_node.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## cloudcli k8s create_node
2+
3+
Create a node (BETA)
4+
5+
### Synopsis
6+
7+
Create a node (BETA)
8+
9+
Create a new node in an existing nodepool.
10+
Safe to run multiple times, the node will be added only if it does not already exist in the nodepool.
11+
12+
```
13+
cloudcli k8s create_node [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-h, --help help for create_node
20+
--kconfig string Path to Kamatera cluster configuration file in JSON or YAML format
21+
Use our server configuration interface at https://kamatera.github.io/kamateratoolbox/serverconfiggen_k8s.html to generate this configuration file
22+
--node_number string Node number
23+
--nodepool_name string Nodepool name
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
--api-clientid string API Client ID
30+
--api-secret string API Secret
31+
--config string config file (default is $HOME/.cloudcli.yaml)
32+
--debug enable debug output to stderr
33+
--dryrun enable dry run mode, does not perform actions
34+
--format string output format, default format is a human readable summary
35+
--no-config disable loading from config file
36+
```
37+
38+
### SEE ALSO
39+
40+
* [cloudcli k8s](cloudcli_k8s.md) - Kubernetes management
41+
42+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_create_nodepool.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## cloudcli k8s create_nodepool
2+
3+
Create a nodepool (BETA)
4+
5+
### Synopsis
6+
7+
Create a nodepool (BETA)
8+
9+
Create a new nodepool in an existing cluster or create additional nodes in an existing nodepool.
10+
Safe to run multiple times, only new nodes will be created and added to the nodepool.
11+
12+
```
13+
cloudcli k8s create_nodepool [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-h, --help help for create_nodepool
20+
--kconfig string Path to Kamatera cluster configuration file in JSON or YAML format
21+
Use our server configuration interface at https://kamatera.github.io/kamateratoolbox/serverconfiggen_k8s.html to generate this configuration file
22+
--nodepool_name string Nodepool name
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--api-clientid string API Client ID
29+
--api-secret string API Secret
30+
--config string config file (default is $HOME/.cloudcli.yaml)
31+
--debug enable debug output to stderr
32+
--dryrun enable dry run mode, does not perform actions
33+
--format string output format, default format is a human readable summary
34+
--no-config disable loading from config file
35+
```
36+
37+
### SEE ALSO
38+
39+
* [cloudcli k8s](cloudcli_k8s.md) - Kubernetes management
40+
41+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_kubeconfig.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## cloudcli k8s kubeconfig
2+
3+
Get cluster kubeconfig (BETA)
4+
5+
### Synopsis
6+
7+
Get cluster kubeconfig (BETA)
8+
9+
Get the kubeconfig file for the cluster.
10+
11+
```
12+
cloudcli k8s kubeconfig [flags]
13+
```
14+
15+
### Options
16+
17+
```
18+
-h, --help help for kubeconfig
19+
--kconfig string Path to Kamatera cluster configuration file in JSON or YAML format
20+
Use our server configuration interface at https://kamatera.github.io/kamateratoolbox/serverconfiggen_k8s.html to generate this configuration file
21+
```
22+
23+
### Options inherited from parent commands
24+
25+
```
26+
--api-clientid string API Client ID
27+
--api-secret string API Secret
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 k8s](cloudcli_k8s.md) - Kubernetes management
38+
39+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_status.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Get Kubernetes cluster status (BETA)
66

77
Get Kubernetes cluster status (BETA)
88

9+
Get the status of the cluster and all it's node-pools and nodes.
10+
911
```
1012
cloudcli k8s status [flags]
1113
```
@@ -34,4 +36,4 @@ cloudcli k8s status [flags]
3436

3537
* [cloudcli k8s](cloudcli_k8s.md) - Kubernetes management
3638

37-
###### Auto generated by spf13/cobra on 19-Oct-2024
39+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_task_status.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## cloudcli k8s task_status
2+
3+
Get task status
4+
5+
### Synopsis
6+
7+
Get task status
8+
9+
```
10+
cloudcli k8s task_status [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for task_status
17+
--task_id string Task ID
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
--api-clientid string API Client ID
24+
--api-secret string API Secret
25+
--config string config file (default is $HOME/.cloudcli.yaml)
26+
--debug enable debug output to stderr
27+
--dryrun enable dry run mode, does not perform actions
28+
--format string output format, default format is a human readable summary
29+
--no-config disable loading from config file
30+
```
31+
32+
### SEE ALSO
33+
34+
* [cloudcli k8s](cloudcli_k8s.md) - Kubernetes management
35+
36+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_update_cluster.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## cloudcli k8s update_cluster
2+
3+
Update a Kubernetes cluster (BETA)
4+
5+
### Synopsis
6+
7+
Update a Kubernetes cluster (BETA)
8+
9+
Update an existing cluster and all node-pools and nodes - in case of configuration changes. Does not cause down-time.
10+
11+
```
12+
cloudcli k8s update_cluster [flags]
13+
```
14+
15+
### Options
16+
17+
```
18+
-h, --help help for update_cluster
19+
--kconfig string Path to Kamatera cluster configuration file in JSON or YAML format
20+
Use our server configuration interface at https://kamatera.github.io/kamateratoolbox/serverconfiggen_k8s.html to generate this configuration file
21+
```
22+
23+
### Options inherited from parent commands
24+
25+
```
26+
--api-clientid string API Client ID
27+
--api-secret string API Secret
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 k8s](cloudcli_k8s.md) - Kubernetes management
38+
39+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_update_node.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## cloudcli k8s update_node
2+
3+
Update a node (BETA)
4+
5+
### Synopsis
6+
7+
Update a node (BETA)
8+
9+
Update a single node - in case of configuration changes. Does not cause down-time.
10+
11+
```
12+
cloudcli k8s update_node [flags]
13+
```
14+
15+
### Options
16+
17+
```
18+
-h, --help help for update_node
19+
--kconfig string Path to Kamatera cluster configuration file in JSON or YAML format
20+
Use our server configuration interface at https://kamatera.github.io/kamateratoolbox/serverconfiggen_k8s.html to generate this configuration file
21+
--node_number string Node number
22+
--nodepool_name string Nodepool name
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--api-clientid string API Client ID
29+
--api-secret string API Secret
30+
--config string config file (default is $HOME/.cloudcli.yaml)
31+
--debug enable debug output to stderr
32+
--dryrun enable dry run mode, does not perform actions
33+
--format string output format, default format is a human readable summary
34+
--no-config disable loading from config file
35+
```
36+
37+
### SEE ALSO
38+
39+
* [cloudcli k8s](cloudcli_k8s.md) - Kubernetes management
40+
41+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_k8s_update_nodepool.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## cloudcli k8s update_nodepool
2+
3+
Update a nodepool (BETA)
4+
5+
### Synopsis
6+
7+
Update a nodepool (BETA)
8+
9+
Update an existing nodepool and all it's nodes - in case of configuration changes. Does not cause down-time.
10+
11+
```
12+
cloudcli k8s update_nodepool [flags]
13+
```
14+
15+
### Options
16+
17+
```
18+
-h, --help help for update_nodepool
19+
--kconfig string Path to Kamatera cluster configuration file in JSON or YAML format
20+
Use our server configuration interface at https://kamatera.github.io/kamateratoolbox/serverconfiggen_k8s.html to generate this configuration file
21+
--nodepool_name string Nodepool name
22+
```
23+
24+
### Options inherited from parent commands
25+
26+
```
27+
--api-clientid string API Client ID
28+
--api-secret string API Secret
29+
--config string config file (default is $HOME/.cloudcli.yaml)
30+
--debug enable debug output to stderr
31+
--dryrun enable dry run mode, does not perform actions
32+
--format string output format, default format is a human readable summary
33+
--no-config disable loading from config file
34+
```
35+
36+
### SEE ALSO
37+
38+
* [cloudcli k8s](cloudcli_k8s.md) - Kubernetes management
39+
40+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_network.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Network management
3535
* [cloudcli network subnet_edit](cloudcli_network_subnet_edit.md) - Edit a network subnet, all values which are different then existing values will be updated
3636
* [cloudcli network subnet_list](cloudcli_network_subnet_list.md) - List network subnets
3737

38-
###### Auto generated by spf13/cobra on 19-Oct-2024
38+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_network_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ cloudcli network create [flags]
4040

4141
* [cloudcli network](cloudcli_network.md) - Network management
4242

43-
###### Auto generated by spf13/cobra on 19-Oct-2024
43+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_network_delete.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ cloudcli network delete [flags]
3434

3535
* [cloudcli network](cloudcli_network.md) - Network management
3636

37-
###### Auto generated by spf13/cobra on 19-Oct-2024
37+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_network_list.md

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

3434
* [cloudcli network](cloudcli_network.md) - Network management
3535

36-
###### Auto generated by spf13/cobra on 19-Oct-2024
36+
###### Auto generated by spf13/cobra on 22-Oct-2024

‎docs/cloudcli_network_subnet_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ cloudcli network subnet_create [flags]
4040

4141
* [cloudcli network](cloudcli_network.md) - Network management
4242

43-
###### Auto generated by spf13/cobra on 19-Oct-2024
43+
###### Auto generated by spf13/cobra on 22-Oct-2024

0 commit comments

Comments
 (0)