Skip to content

Commit

Permalink
updated the docs for the cli
Browse files Browse the repository at this point in the history
Signed-off-by: Dipankar Das <[email protected]>
  • Loading branch information
dipankardas011 committed Jun 21, 2024
1 parent 5e19096 commit 0b15d41
Show file tree
Hide file tree
Showing 52 changed files with 136 additions and 50 deletions.
3 changes: 2 additions & 1 deletion gen/docs.md/ksctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ from local clusters to cloud provider specific clusters.
* [ksctl cred](ksctl_cred.md) - Login to your Cloud-provider Credentials
* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster
* [ksctl get-clusters](ksctl_get-clusters.md) - Use to get clusters
* [ksctl info-cluster](ksctl_info-cluster.md) - Use to info cluster
* [ksctl switch-cluster](ksctl_switch-cluster.md) - Use to switch between clusters
* [ksctl version](ksctl_version.md) - Print the version number of ksctl

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ ksctl create --help
* [ksctl create-cluster ha-civo](ksctl_create-cluster_ha-civo.md) - Use to create a self-managed Highly Available cluster on Civo
* [ksctl create-cluster local](ksctl_create-cluster_local.md) - Use to create a kind cluster

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ ksctl create-cluster azure -n demo -r eastus -s store-local --nodeSizeMP Standar

* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_civo.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ ksctl create-cluster civo --name demo --region LON1 --storage store-local --node

* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_ha-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ ksctl create-cluster ha-aws -n demo -r us-east-1 --bootstrap k3s -s store-local
* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster
* [ksctl create-cluster ha-aws add-nodes](ksctl_create-cluster_ha-aws_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Aws

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_ha-aws_add-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ ksctl create ha-aws add-nodes -n demo -r ap-south-1 -s store-local --noWP 3 --no

* [ksctl create-cluster ha-aws](ksctl_create-cluster_ha-aws.md) - Use to create a self-managed Highly Available cluster on AWS

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_ha-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ ksctl create-cluster ha-azure --name demo --region eastus --bootstrap kubeadm --
* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster
* [ksctl create-cluster ha-azure add-nodes](ksctl_create-cluster_ha-azure_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Azure

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_ha-azure_add-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ ksctl create ha-azure add-nodes -n demo -r eastus -s store-local --noWP 3 --node

* [ksctl create-cluster ha-azure](ksctl_create-cluster_ha-azure.md) - Use to create a self-managed Highly-Available cluster on Azure

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_ha-civo.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ ksctl create-cluster ha-civo --name demo --region LON1 --bootstrap kubeadm --sto
* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster
* [ksctl create-cluster ha-civo add-nodes](ksctl_create-cluster_ha-civo_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Civo

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_ha-civo_add-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ ksctl create ha-civo add-nodes -n demo -r LON1 -s store-local --noWP 3 --nodeSiz

* [ksctl create-cluster ha-civo](ksctl_create-cluster_ha-civo.md) - Use to create a self-managed Highly Available cluster on Civo

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_create-cluster_local.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ ksctl create-cluster local --name demo --storage store-local --noMP 3

* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_cred.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ ksctl cred [flags]

* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ ksctl delete --help
* [ksctl delete-cluster ha-civo](ksctl_delete-cluster_ha-civo.md) - Use to delete a self-managed Highly Available cluster on Civo
* [ksctl delete-cluster local](ksctl_delete-cluster_local.md) - Use to delete a kind cluster

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ ksctl delete azure --name demo --region eastus --storage store-local

* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_civo.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ ksctl delete civo --name demo --region LON1 --storage store-local

* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_ha-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ ksctl delete ha-aws --name demo --region us-east-1 --storage store-local
* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster
* [ksctl delete-cluster ha-aws del-nodes](ksctl_delete-cluster_ha-aws_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Aws

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_ha-aws_del-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ ksctl delete ha-aws del-nodes -n demo -r us-east-1 -s store-local --noWP 1 --boo

* [ksctl delete-cluster ha-aws](ksctl_delete-cluster_ha-aws.md) - Use to delete a self-managed Highly Available cluster on AWS

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_ha-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ ksctl delete ha-azure --name demo --region eastus --storage store-local
* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster
* [ksctl delete-cluster ha-azure del-nodes](ksctl_delete-cluster_ha-azure_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Azure

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_ha-azure_del-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ ksctl delete ha-azure del-nodes -n demo -r eastus -s store-local --noWP 1 --boot

* [ksctl delete-cluster ha-azure](ksctl_delete-cluster_ha-azure.md) - Use to delete a self-managed Highly Available cluster on Azure

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_ha-civo.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ ksctl delete ha-civo --name demo --region LON1 --storage store-local
* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster
* [ksctl delete-cluster ha-civo del-nodes](ksctl_delete-cluster_ha-civo_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Civo

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_ha-civo_del-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ ksctl delete ha-civo del-nodes -n demo -r LON1 -s store-local --noWP 1 --bootstr

* [ksctl delete-cluster ha-civo](ksctl_delete-cluster_ha-civo.md) - Use to delete a self-managed Highly Available cluster on Civo

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_delete-cluster_local.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ ksctl delete local --name demo --storage store-local

* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_get-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ ksctl get --provider all --storage store-local

* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
38 changes: 38 additions & 0 deletions gen/docs.md/ksctl_info-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ksctl info-cluster

Use to info cluster

### Synopsis

It is used to detailed data for a given cluster

```
ksctl info-cluster [flags]
```

### Examples

```
ksctl info --provider azure --name demo --region eastus --storage store-local
ksctl info -p ha-azure -n ha-demo-kubeadm -r eastus -s store-local --verbose -1
```

### Options

```
--feature-flags string Experimental Features: Supported values with comma seperated: [autoscale]
-h, --help help for info-cluster
-n, --name string Cluster Name (default "demo")
-p, --provider string Provider
-r, --region string Region
-s, --storage string storage provider
-v, --verbose int for verbose output
```

### SEE ALSO

* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters

###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_switch-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ ksctl switch-context -s external-store-mongodb -p civo -n <clustername> -r <regi

* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
2 changes: 1 addition & 1 deletion gen/docs.md/ksctl_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ ksctl version [flags]

* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters

###### Auto generated by spf13/cobra on 1-Jun-2024
###### Auto generated by spf13/cobra on 21-Jun-2024
3 changes: 2 additions & 1 deletion gen/docs.rst/ksctl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ SEE ALSO
* `ksctl cred <ksctl_cred.rst>`_ - Login to your Cloud-provider Credentials
* `ksctl delete-cluster <ksctl_delete-cluster.rst>`_ - Use to delete a cluster
* `ksctl get-clusters <ksctl_get-clusters.rst>`_ - Use to get clusters
* `ksctl info-cluster <ksctl_info-cluster.rst>`_ - Use to info cluster
* `ksctl switch-cluster <ksctl_switch-cluster.rst>`_ - Use to switch between clusters
* `ksctl version <ksctl_version.rst>`_ - Print the version number of ksctl

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO
* `ksctl create-cluster ha-civo <ksctl_create-cluster_ha-civo.rst>`_ - Use to create a self-managed Highly Available cluster on Civo
* `ksctl create-cluster local <ksctl_create-cluster_local.rst>`_ - Use to create a kind cluster

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ SEE ALSO

* `ksctl create-cluster <ksctl_create-cluster.rst>`_ - Use to create a cluster

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_civo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ SEE ALSO

* `ksctl create-cluster <ksctl_create-cluster.rst>`_ - Use to create a cluster

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_ha-aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ SEE ALSO
* `ksctl create-cluster <ksctl_create-cluster.rst>`_ - Use to create a cluster
* `ksctl create-cluster ha-aws add-nodes <ksctl_create-cluster_ha-aws_add-nodes.rst>`_ - Use to add more worker nodes in self-managed Highly-Available cluster on Aws

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_ha-aws_add-nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ SEE ALSO

* `ksctl create-cluster ha-aws <ksctl_create-cluster_ha-aws.rst>`_ - Use to create a self-managed Highly Available cluster on AWS

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_ha-azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ SEE ALSO
* `ksctl create-cluster <ksctl_create-cluster.rst>`_ - Use to create a cluster
* `ksctl create-cluster ha-azure add-nodes <ksctl_create-cluster_ha-azure_add-nodes.rst>`_ - Use to add more worker nodes in self-managed Highly-Available cluster on Azure

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_ha-azure_add-nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ SEE ALSO

* `ksctl create-cluster ha-azure <ksctl_create-cluster_ha-azure.rst>`_ - Use to create a self-managed Highly-Available cluster on Azure

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_ha-civo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ SEE ALSO
* `ksctl create-cluster <ksctl_create-cluster.rst>`_ - Use to create a cluster
* `ksctl create-cluster ha-civo add-nodes <ksctl_create-cluster_ha-civo_add-nodes.rst>`_ - Use to add more worker nodes in self-managed Highly-Available cluster on Civo

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_ha-civo_add-nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ SEE ALSO

* `ksctl create-cluster ha-civo <ksctl_create-cluster_ha-civo.rst>`_ - Use to create a self-managed Highly Available cluster on Civo

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_create-cluster_local.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ SEE ALSO

* `ksctl create-cluster <ksctl_create-cluster.rst>`_ - Use to create a cluster

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_cred.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ SEE ALSO

* `ksctl <ksctl.rst>`_ - CLI tool for managing multiple K8s clusters

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO
* `ksctl delete-cluster ha-civo <ksctl_delete-cluster_ha-civo.rst>`_ - Use to delete a self-managed Highly Available cluster on Civo
* `ksctl delete-cluster local <ksctl_delete-cluster_local.rst>`_ - Use to delete a kind cluster

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* `ksctl delete-cluster <ksctl_delete-cluster.rst>`_ - Use to delete a cluster

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_civo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* `ksctl delete-cluster <ksctl_delete-cluster.rst>`_ - Use to delete a cluster

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_ha-aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO
* `ksctl delete-cluster <ksctl_delete-cluster.rst>`_ - Use to delete a cluster
* `ksctl delete-cluster ha-aws del-nodes <ksctl_delete-cluster_ha-aws_del-nodes.rst>`_ - Use to remove worker nodes in self-managed Highly-Available cluster on Aws

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_ha-aws_del-nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO

* `ksctl delete-cluster ha-aws <ksctl_delete-cluster_ha-aws.rst>`_ - Use to delete a self-managed Highly Available cluster on AWS

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_ha-azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO
* `ksctl delete-cluster <ksctl_delete-cluster.rst>`_ - Use to delete a cluster
* `ksctl delete-cluster ha-azure del-nodes <ksctl_delete-cluster_ha-azure_del-nodes.rst>`_ - Use to remove worker nodes in self-managed Highly-Available cluster on Azure

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_ha-azure_del-nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ SEE ALSO

* `ksctl delete-cluster ha-azure <ksctl_delete-cluster_ha-azure.rst>`_ - Use to delete a self-managed Highly Available cluster on Azure

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_ha-civo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO
* `ksctl delete-cluster <ksctl_delete-cluster.rst>`_ - Use to delete a cluster
* `ksctl delete-cluster ha-civo del-nodes <ksctl_delete-cluster_ha-civo_del-nodes.rst>`_ - Use to remove worker nodes in self-managed Highly-Available cluster on Civo

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_ha-civo_del-nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ SEE ALSO

* `ksctl delete-cluster ha-civo <ksctl_delete-cluster_ha-civo.rst>`_ - Use to delete a self-managed Highly Available cluster on Civo

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_delete-cluster_local.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ SEE ALSO

* `ksctl delete-cluster <ksctl_delete-cluster.rst>`_ - Use to delete a cluster

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_get-clusters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* `ksctl <ksctl.rst>`_ - CLI tool for managing multiple K8s clusters

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
46 changes: 46 additions & 0 deletions gen/docs.rst/ksctl_info-cluster.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.. _ksctl_info-cluster:

ksctl info-cluster
------------------

Use to info cluster

Synopsis
~~~~~~~~


It is used to detailed data for a given cluster

::

ksctl info-cluster [flags]

Examples
~~~~~~~~

::


ksctl info --provider azure --name demo --region eastus --storage store-local
ksctl info -p ha-azure -n ha-demo-kubeadm -r eastus -s store-local --verbose -1


Options
~~~~~~~

::

--feature-flags string Experimental Features: Supported values with comma seperated: [autoscale]
-h, --help help for info-cluster
-n, --name string Cluster Name (default "demo")
-p, --provider string Provider
-r, --region string Region
-s, --storage string storage provider
-v, --verbose int for verbose output

SEE ALSO
~~~~~~~~

* `ksctl <ksctl.rst>`_ - CLI tool for managing multiple K8s clusters

*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_switch-cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ SEE ALSO

* `ksctl <ksctl.rst>`_ - CLI tool for managing multiple K8s clusters

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*
2 changes: 1 addition & 1 deletion gen/docs.rst/ksctl_version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ SEE ALSO

* `ksctl <ksctl.rst>`_ - CLI tool for managing multiple K8s clusters

*Auto generated by spf13/cobra on 1-Jun-2024*
*Auto generated by spf13/cobra on 21-Jun-2024*

0 comments on commit 0b15d41

Please sign in to comment.