chore(cicd): Update CLI documentation

ksctl · Dec 1, 2024 · e70820c · e70820c
1 parent d6e271a
commit e70820c
Show file tree

Hide file tree

Showing 30 changed files with 1,439 additions and 0 deletions.
diff --git a/content/en/docs/develop/Reference/ksctl.md b/content/en/docs/develop/Reference/ksctl.md
@@ -0,0 +1,39 @@
+---
+title: ksctl
+description: Command documentation for ksctl
+---
+
+## ksctl
+
+CLI tool for managing multiple K8s clusters
+
+### Synopsis
+
+
+░  ░░░░  ░░░      ░░░░      ░░░        ░░  ░░░░░░░
+▒  ▒▒▒  ▒▒▒  ▒▒▒▒▒▒▒▒  ▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒▒▒
+▓     ▓▓▓▓▓▓      ▓▓▓  ▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+▓  ▓▓▓  ▓▓▓▓▓▓▓▓▓  ▓▓  ▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+█  ████  ███      ████      ██████  █████        █
+
+CLI tool which can manage multiple K8s clusters from local clusters to cloud provider specific clusters.
+
+### Options
+
+```
+  -h, --help     help for ksctl
+  -t, --toggle   Help message for toggle
+```
+
+### SEE ALSO
+
+* [ksctl connect-cluster](ksctl_connect-cluster.md)	 - Use to switch between clusters
+* [ksctl create-cluster](ksctl_create-cluster.md)	 - Use to create a cluster
+* [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 self-update](ksctl_self-update.md)	 - update the ksctl cli
+* [ksctl version](ksctl_version.md)	 - Print the version number of ksctl
+
+###### Auto generated by spf13/cobra on 1-Dec-2024
diff --git a/content/en/docs/develop/Reference/ksctl_connect-cluster.md b/content/en/docs/develop/Reference/ksctl_connect-cluster.md
@@ -0,0 +1,64 @@
+---
+title: ksctl_connect-cluster
+description: Command documentation for ksctl_connect-cluster
+---
+
+## ksctl connect-cluster
+
+Use to switch between clusters
+
+### Synopsis
+
+
+░  ░░░░  ░░░      ░░░░      ░░░        ░░  ░░░░░░░
+▒  ▒▒▒  ▒▒▒  ▒▒▒▒▒▒▒▒  ▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒▒▒
+▓     ▓▓▓▓▓▓      ▓▓▓  ▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+▓  ▓▓▓  ▓▓▓▓▓▓▓▓▓  ▓▓  ▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+█  ████  ███      ████      ██████  █████        █
+
+It is used to switch cluster with the given ClusterName from user.
+
+```
+ksctl connect-cluster [flags]
+```
+
+### Examples
+
+```
+
+ksctl connect-context --provider civo --name <clustername> --region <region>
+ksctl connect --provider civo --name <clustername> --region <region>
+ksctl switch --provider civo --name <clustername> --region <region>
+ksctl connect --provider civo --name <clustername> --region <region>
+ksctl connect-context --provider local --name <clustername>
+ksctl connect-context --provider azure --name <clustername> --region <region>
+ksctl connect-context --provider ha-civo --name <clustername> --region <region>
+ksctl connect-context --provider ha-azure --name <clustername> --region <region>
+ksctl connect-context --provider ha-aws --name <clustername> --region <region>
+ksctl connect-context --provider aws --name <clustername> --region <region>
+
+	For Storage specific
+
+ksctl connect-context -s store-local -p civo -n <clustername> -r <region>
+ksctl connect-context -s external-store-mongodb -p civo -n <clustername> -r <region>
+
+```
+
+### Options
+
+```
+      --feature-flags string   Experimental Features: Supported values with comma seperated: [autoscale]
+  -h, --help                   help for connect-cluster
+  -m, --mode string            Mode of access can be shell or k9s or none
+  -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 1-Dec-2024
diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster.md b/content/en/docs/develop/Reference/ksctl_create-cluster.md
@@ -0,0 +1,46 @@
+---
+title: ksctl_create-cluster
+description: Command documentation for ksctl_create-cluster
+---
+
+## ksctl create-cluster
+
+Use to create a cluster
+
+### Synopsis
+
+
+░  ░░░░  ░░░      ░░░░      ░░░        ░░  ░░░░░░░
+▒  ▒▒▒  ▒▒▒  ▒▒▒▒▒▒▒▒  ▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒▒▒
+▓     ▓▓▓▓▓▓      ▓▓▓  ▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+▓  ▓▓▓  ▓▓▓▓▓▓▓▓▓  ▓▓  ▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+█  ████  ███      ████      ██████  █████        █
+
+It is used to create cluster with the given name from user
+
+### Examples
+
+```
+
+ksctl create --help
+	
+```
+
+### Options
+
+```
+  -h, --help   help for create-cluster
+```
+
+### SEE ALSO
+
+* [ksctl](ksctl.md)	 - CLI tool for managing multiple K8s clusters
+* [ksctl create-cluster aws](ksctl_create-cluster_aws.md)	 - Use to create a EKS cluster in Aws
+* [ksctl create-cluster azure](ksctl_create-cluster_azure.md)	 - Use to create a AKS cluster in Azure
+* [ksctl create-cluster civo](ksctl_create-cluster_civo.md)	 - Use to create a Civo managed k3s cluster
+* [ksctl create-cluster ha-aws](ksctl_create-cluster_ha-aws.md)	 - Use to create a self-managed Highly Available cluster on AWS
+* [ksctl create-cluster ha-azure](ksctl_create-cluster_ha-azure.md)	 - Use to create a self-managed Highly-Available cluster on Azure
+* [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-Dec-2024
diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_aws.md b/content/en/docs/develop/Reference/ksctl_create-cluster_aws.md
@@ -0,0 +1,54 @@
+---
+title: ksctl_create-cluster_aws
+description: Command documentation for ksctl_create-cluster_aws
+---
+
+## ksctl create-cluster aws
+
+Use to create a EKS cluster in Aws
+
+### Synopsis
+
+
+░  ░░░░  ░░░      ░░░░      ░░░        ░░  ░░░░░░░
+▒  ▒▒▒  ▒▒▒  ▒▒▒▒▒▒▒▒  ▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒▒▒
+▓     ▓▓▓▓▓▓      ▓▓▓  ▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+▓  ▓▓▓  ▓▓▓▓▓▓▓▓▓  ▓▓  ▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+█  ████  ███      ████      ██████  █████        █
+
+It is used to create cluster with the given name from user
+
+```
+ksctl create-cluster aws [flags]
+```
+
+### Examples
+
+```
+
+ksctl create-cluster aws -n demo -r ap-south-1 -s store-local --nodeSizeMP t2.micro --noMP 3
+
+```
+
+### Options
+
+```
+      --bootstrap string       Kubernetes Bootstrap
+      --cni string             CNI
+      --feature-flags string   Experimental Features: Supported values with comma seperated: [autoscale]
+  -h, --help                   help for aws
+  -n, --name string            Cluster Name (default "demo")
+      --noMP int               Number of Managed Nodes (default -1)
+      --nodeSizeMP string      Node size of managed cluster nodes
+  -r, --region string          Region
+  -s, --storage string         storage provider
+  -v, --verbose int            for verbose output
+      --version string         Kubernetes Version
+  -y, --yes                    approval to avoid showMsg (default true)
+```
+
+### SEE ALSO
+
+* [ksctl create-cluster](ksctl_create-cluster.md)	 - Use to create a cluster
+
+###### Auto generated by spf13/cobra on 1-Dec-2024
diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_azure.md b/content/en/docs/develop/Reference/ksctl_create-cluster_azure.md
@@ -0,0 +1,54 @@
+---
+title: ksctl_create-cluster_azure
+description: Command documentation for ksctl_create-cluster_azure
+---
+
+## ksctl create-cluster azure
+
+Use to create a AKS cluster in Azure
+
+### Synopsis
+
+
+░  ░░░░  ░░░      ░░░░      ░░░        ░░  ░░░░░░░
+▒  ▒▒▒  ▒▒▒  ▒▒▒▒▒▒▒▒  ▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒▒▒
+▓     ▓▓▓▓▓▓      ▓▓▓  ▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+▓  ▓▓▓  ▓▓▓▓▓▓▓▓▓  ▓▓  ▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+█  ████  ███      ████      ██████  █████        █
+
+It is used to create cluster with the given name from user
+
+```
+ksctl create-cluster azure [flags]
+```
+
+### Examples
+
+```
+
+ksctl create-cluster azure -n demo -r eastus -s store-local --nodeSizeMP Standard_DS2_v2 --noMP 3
+
+```
+
+### Options
+
+```
+      --bootstrap string       Kubernetes Bootstrap
+      --cni string             CNI
+      --feature-flags string   Experimental Features: Supported values with comma seperated: [autoscale]
+  -h, --help                   help for azure
+  -n, --name string            Cluster Name (default "demo")
+      --noMP int               Number of Managed Nodes (default -1)
+      --nodeSizeMP string      Node size of managed cluster nodes
+  -r, --region string          Region
+  -s, --storage string         storage provider
+  -v, --verbose int            for verbose output
+      --version string         Kubernetes Version
+  -y, --yes                    approval to avoid showMsg (default true)
+```
+
+### SEE ALSO
+
+* [ksctl create-cluster](ksctl_create-cluster.md)	 - Use to create a cluster
+
+###### Auto generated by spf13/cobra on 1-Dec-2024
diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_civo.md b/content/en/docs/develop/Reference/ksctl_create-cluster_civo.md
@@ -0,0 +1,54 @@
+---
+title: ksctl_create-cluster_civo
+description: Command documentation for ksctl_create-cluster_civo
+---
+
+## ksctl create-cluster civo
+
+Use to create a Civo managed k3s cluster
+
+### Synopsis
+
+
+░  ░░░░  ░░░      ░░░░      ░░░        ░░  ░░░░░░░
+▒  ▒▒▒  ▒▒▒  ▒▒▒▒▒▒▒▒  ▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒▒▒
+▓     ▓▓▓▓▓▓      ▓▓▓  ▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+▓  ▓▓▓  ▓▓▓▓▓▓▓▓▓  ▓▓  ▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+█  ████  ███      ████      ██████  █████        █
+
+It is used to create cluster with the given name from user
+
+```
+ksctl create-cluster civo [flags]
+```
+
+### Examples
+
+```
+
+ksctl create-cluster civo --name demo --region LON1 --storage store-local --nodeSizeMP g4s.kube.small --noMP 3
+
+```
+
+### Options
+
+```
+      --bootstrap string       Kubernetes Bootstrap
+      --cni string             CNI
+      --feature-flags string   Experimental Features: Supported values with comma seperated: [autoscale]
+  -h, --help                   help for civo
+  -n, --name string            Cluster Name (default "demo")
+      --noMP int               Number of Managed Nodes (default -1)
+      --nodeSizeMP string      Node size of managed cluster nodes
+  -r, --region string          Region
+  -s, --storage string         storage provider
+  -v, --verbose int            for verbose output
+      --version string         Kubernetes Version
+  -y, --yes                    approval to avoid showMsg (default true)
+```
+
+### SEE ALSO
+
+* [ksctl create-cluster](ksctl_create-cluster.md)	 - Use to create a cluster
+
+###### Auto generated by spf13/cobra on 1-Dec-2024
diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_ha-aws.md b/content/en/docs/develop/Reference/ksctl_create-cluster_ha-aws.md
@@ -0,0 +1,60 @@
+---
+title: ksctl_create-cluster_ha-aws
+description: Command documentation for ksctl_create-cluster_ha-aws
+---
+
+## ksctl create-cluster ha-aws
+
+Use to create a self-managed Highly Available cluster on AWS
+
+### Synopsis
+
+
+░  ░░░░  ░░░      ░░░░      ░░░        ░░  ░░░░░░░
+▒  ▒▒▒  ▒▒▒  ▒▒▒▒▒▒▒▒  ▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒▒▒
+▓     ▓▓▓▓▓▓      ▓▓▓  ▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+▓  ▓▓▓  ▓▓▓▓▓▓▓▓▓  ▓▓  ▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓▓▓▓
+█  ████  ███      ████      ██████  █████        █
+
+It is used to create cluster with the given name from user.
+
+```
+ksctl create-cluster ha-aws [flags]
+```
+
+### Examples
+
+```
+
+ksctl create-cluster ha-aws -n demo -r us-east-1 --bootstrap k3s -s store-local --nodeSizeCP t2.medium --nodeSizeWP t2.medium --nodeSizeLB t2.micro --nodeSizeDS t2.small --noWP 1 --noCP 3 --noDS 3 --cni [email protected]
+
+```
+
+### Options
+
+```
+      --bootstrap string       Kubernetes Bootstrap
+      --cni string             CNI
+      --feature-flags string   Experimental Features: Supported values with comma seperated: [autoscale]
+  -h, --help                   help for ha-aws
+  -n, --name string            Cluster Name (default "demo")
+      --noCP int               Number of ControlPlane Nodes (default -1)
+      --noDS int               Number of DataStore Nodes (default -1)
+      --noWP int               Number of WorkerPlane Nodes (default -1)
+      --nodeSizeCP string      Node size of self-managed controlplane nodes
+      --nodeSizeDS string      Node size of self-managed datastore nodes
+      --nodeSizeLB string      Node size of self-managed loadbalancer node
+      --nodeSizeWP string      Node size of self-managed workerplane nodes
+  -r, --region string          Region
+  -s, --storage string         storage provider
+  -v, --verbose int            for verbose output
+      --version string         Kubernetes Version
+  -y, --yes                    approval to avoid showMsg (default true)
+```
+
+### SEE ALSO
+
+* [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-Dec-2024