diff --git a/content/en/docs/stable/Reference/ksctl.md b/content/en/docs/stable/Reference/ksctl.md new file mode 100644 index 0000000..2791497 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl.md @@ -0,0 +1,32 @@ +--- +title: ksctl +description: Command documentation for ksctl +--- + +## ksctl + +CLI tool for managing multiple K8s clusters + +### Synopsis + +Ksctl ascii [logo] + +### 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/stable/Reference/ksctl_connect-cluster.md b/content/en/docs/stable/Reference/ksctl_connect-cluster.md new file mode 100644 index 0000000..a4efb92 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_connect-cluster.md @@ -0,0 +1,57 @@ +--- +title: ksctl_connect-cluster +description: Command documentation for ksctl_connect-cluster +--- + +## ksctl connect-cluster + +Use to switch between clusters + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl connect-cluster [flags] +``` + +### Examples + +``` + +ksctl connect-context --provider civo --name --region +ksctl connect --provider civo --name --region +ksctl switch --provider civo --name --region +ksctl connect --provider civo --name --region +ksctl connect-context --provider local --name +ksctl connect-context --provider azure --name --region +ksctl connect-context --provider ha-civo --name --region +ksctl connect-context --provider ha-azure --name --region +ksctl connect-context --provider ha-aws --name --region +ksctl connect-context --provider aws --name --region + + For Storage specific + +ksctl connect-context -s store-local -p civo -n -r +ksctl connect-context -s external-store-mongodb -p civo -n -r + +``` + +### 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/stable/Reference/ksctl_create-cluster.md b/content/en/docs/stable/Reference/ksctl_create-cluster.md new file mode 100644 index 0000000..d27c405 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster.md @@ -0,0 +1,39 @@ +--- +title: ksctl_create-cluster +description: Command documentation for ksctl_create-cluster +--- + +## ksctl create-cluster + +Use to create a cluster + +### Synopsis + +Ksctl ascii [logo] + +### 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/stable/Reference/ksctl_create-cluster_aws.md b/content/en/docs/stable/Reference/ksctl_create-cluster_aws.md new file mode 100644 index 0000000..6ece79f --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_aws.md @@ -0,0 +1,47 @@ +--- +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 + +Ksctl ascii [logo] + +``` +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/stable/Reference/ksctl_create-cluster_azure.md b/content/en/docs/stable/Reference/ksctl_create-cluster_azure.md new file mode 100644 index 0000000..364fc44 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_azure.md @@ -0,0 +1,47 @@ +--- +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 + +Ksctl ascii [logo] + +``` +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/stable/Reference/ksctl_create-cluster_civo.md b/content/en/docs/stable/Reference/ksctl_create-cluster_civo.md new file mode 100644 index 0000000..d189d6b --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_civo.md @@ -0,0 +1,47 @@ +--- +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 + +Ksctl ascii [logo] + +``` +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/stable/Reference/ksctl_create-cluster_ha-aws.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws.md new file mode 100644 index 0000000..4c18155 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws.md @@ -0,0 +1,53 @@ +--- +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 + +Ksctl ascii [logo] + +``` +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 cilium@v1.16.1 + +``` + +### 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 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws_add-nodes.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws_add-nodes.md new file mode 100644 index 0000000..79a1d41 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws_add-nodes.md @@ -0,0 +1,43 @@ +--- +title: ksctl_create-cluster_ha-aws_add-nodes +description: Command documentation for ksctl_create-cluster_ha-aws_add-nodes +--- + +## ksctl create-cluster ha-aws add-nodes + +Use to add more worker nodes in self-managed Highly-Available cluster on Aws + +### Synopsis + +It is used to add nodes to worker nodes in cluster with the given name from user. + +``` +ksctl create-cluster ha-aws add-nodes [flags] +``` + +### Examples + +``` + +ksctl create ha-aws add-nodes -n demo -r ap-south-1 -s store-local --noWP 3 --nodeSizeWP t2.medium # Here the noWP is the desired count of workernodes + +``` + +### Options + +``` + -h, --help help for add-nodes + -n, --name string Cluster Name (default "demo") + --noWP int Number of WorkerPlane Nodes (default -1) + --nodeSizeWP string Node size of self-managed workerplane nodes + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure.md new file mode 100644 index 0000000..335bc50 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure.md @@ -0,0 +1,54 @@ +--- +title: ksctl_create-cluster_ha-azure +description: Command documentation for ksctl_create-cluster_ha-azure +--- + +## ksctl create-cluster ha-azure + +Use to create a self-managed Highly-Available cluster on Azure + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl create-cluster ha-azure [flags] +``` + +### Examples + +``` + +ksctl create-cluster ha-azure --name demo --region eastus --bootstrap k3s --storage store-local --nodeSizeCP Standard_F2s --nodeSizeWP Standard_F2s --nodeSizeLB Standard_F2s --nodeSizeDS Standard_F2s --noWP 1 --noCP 3 --noDS 3 +ksctl create-cluster ha-azure --name demo --region eastus --bootstrap kubeadm --storage store-local --nodeSizeCP Standard_F2s --nodeSizeWP Standard_F4s --nodeSizeLB Standard_F2s --nodeSizeDS Standard_F2s --noWP 1 --noCP 3 --noDS 3 --cni cilium@v1.16.1 + +``` + +### Options + +``` + --bootstrap string Kubernetes Bootstrap + --cni string CNI + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for ha-azure + -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-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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure_add-nodes.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure_add-nodes.md new file mode 100644 index 0000000..ab3f539 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure_add-nodes.md @@ -0,0 +1,44 @@ +--- +title: ksctl_create-cluster_ha-azure_add-nodes +description: Command documentation for ksctl_create-cluster_ha-azure_add-nodes +--- + +## ksctl create-cluster ha-azure add-nodes + +Use to add more worker nodes in self-managed Highly-Available cluster on Azure + +### Synopsis + +It is used to add nodes to worker nodes in cluster with the given name from user + +``` +ksctl create-cluster ha-azure add-nodes [flags] +``` + +### Examples + +``` + +ksctl create ha-azure add-nodes -n demo -r eastus -s store-local --noWP 3 --nodeSizeWP Standard_F2s # Here the noWP is the desired count of workernodes + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for add-nodes + -n, --name string Cluster Name (default "demo") + --noWP int Number of WorkerPlane Nodes (default -1) + --nodeSizeWP string Node size of self-managed workerplane nodes + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo.md new file mode 100644 index 0000000..1b77b55 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo.md @@ -0,0 +1,54 @@ +--- +title: ksctl_create-cluster_ha-civo +description: Command documentation for ksctl_create-cluster_ha-civo +--- + +## ksctl create-cluster ha-civo + +Use to create a self-managed Highly Available cluster on Civo + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl create-cluster ha-civo [flags] +``` + +### Examples + +``` + +ksctl create-cluster ha-civo --name demo --region LON1 --bootstrap k3s --storage store-local --nodeSizeCP g3.small --nodeSizeWP g3.medium --nodeSizeLB g3.small --nodeSizeDS g3.small --noWP 1 --noCP 3 --noDS 3 +ksctl create-cluster ha-civo --name demo --region LON1 --bootstrap kubeadm --storage store-local --nodeSizeCP g3.medium --nodeSizeWP g3.large --nodeSizeLB g3.small --nodeSizeDS g3.small --noWP 1 --noCP 3 --noDS 3 --cni cilium@v1.16.1 + +``` + +### Options + +``` + --bootstrap string Kubernetes Bootstrap + --cni string CNI + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for ha-civo + -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-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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo_add-nodes.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo_add-nodes.md new file mode 100644 index 0000000..be44989 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo_add-nodes.md @@ -0,0 +1,44 @@ +--- +title: ksctl_create-cluster_ha-civo_add-nodes +description: Command documentation for ksctl_create-cluster_ha-civo_add-nodes +--- + +## ksctl create-cluster ha-civo add-nodes + +Use to add more worker nodes in self-managed Highly-Available cluster on Civo + +### Synopsis + +It is used to add nodes to worker nodes in cluster with the given name from user. + +``` +ksctl create-cluster ha-civo add-nodes [flags] +``` + +### Examples + +``` + +ksctl create ha-civo add-nodes -n demo -r LON1 -s store-local --noWP 3 --nodeSizeWP g3.medium # Here the noWP is the desired count of workernodes + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for add-nodes + -n, --name string Cluster Name (default "demo") + --noWP int Number of WorkerPlane Nodes (default -1) + --nodeSizeWP string Node size of self-managed workerplane nodes + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_local.md b/content/en/docs/stable/Reference/ksctl_create-cluster_local.md new file mode 100644 index 0000000..8a544cf --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_create-cluster_local.md @@ -0,0 +1,45 @@ +--- +title: ksctl_create-cluster_local +description: Command documentation for ksctl_create-cluster_local +--- + +## ksctl create-cluster local + +Use to create a kind cluster + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl create-cluster local [flags] +``` + +### Examples + +``` + +ksctl create-cluster local --name demo --storage store-local --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 local + -n, --name string Cluster Name (default "demo") + --noMP int Number of Managed Nodes (default -1) + -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/stable/Reference/ksctl_cred.md b/content/en/docs/stable/Reference/ksctl_cred.md new file mode 100644 index 0000000..461a52c --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_cred.md @@ -0,0 +1,30 @@ +--- +title: ksctl_cred +description: Command documentation for ksctl_cred +--- + +## ksctl cred + +Login to your Cloud-provider Credentials + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl cred [flags] +``` + +### Options + +``` + -h, --help help for cred + -s, --storage string storage provider + -v, --verbose for verbose output (default true) +``` + +### 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/stable/Reference/ksctl_delete-cluster.md b/content/en/docs/stable/Reference/ksctl_delete-cluster.md new file mode 100644 index 0000000..bf2ec15 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster.md @@ -0,0 +1,39 @@ +--- +title: ksctl_delete-cluster +description: Command documentation for ksctl_delete-cluster +--- + +## ksctl delete-cluster + +Use to delete a cluster + +### Synopsis + +Ksctl ascii [logo] + +### Examples + +``` + +ksctl delete --help + +``` + +### Options + +``` + -h, --help help for delete-cluster +``` + +### SEE ALSO + +* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters +* [ksctl delete-cluster aws](ksctl_delete-cluster_aws.md) - Use to deletes a EKS cluster +* [ksctl delete-cluster azure](ksctl_delete-cluster_azure.md) - Use to deletes a AKS cluster +* [ksctl delete-cluster civo](ksctl_delete-cluster_civo.md) - Use to delete a Civo managed k3s cluster +* [ksctl delete-cluster ha-aws](ksctl_delete-cluster_ha-aws.md) - Use to delete a self-managed Highly Available cluster on AWS +* [ksctl delete-cluster ha-azure](ksctl_delete-cluster_ha-azure.md) - Use to delete a self-managed Highly Available cluster on Azure +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_aws.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_aws.md new file mode 100644 index 0000000..d369478 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_aws.md @@ -0,0 +1,41 @@ +--- +title: ksctl_delete-cluster_aws +description: Command documentation for ksctl_delete-cluster_aws +--- + +## ksctl delete-cluster aws + +Use to deletes a EKS cluster + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl delete-cluster aws [flags] +``` + +### Examples + +``` + +ksctl delete aws --name demo --region ap-south-1 --storage store-local + +``` + +### Options + +``` + -h, --help help for aws + -n, --name string Cluster Name (default "demo") + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster + +###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_azure.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_azure.md new file mode 100644 index 0000000..e2fda62 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_azure.md @@ -0,0 +1,42 @@ +--- +title: ksctl_delete-cluster_azure +description: Command documentation for ksctl_delete-cluster_azure +--- + +## ksctl delete-cluster azure + +Use to deletes a AKS cluster + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl delete-cluster azure [flags] +``` + +### Examples + +``` + +ksctl delete azure --name demo --region eastus --storage store-local + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for azure + -n, --name string Cluster Name (default "demo") + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster + +###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_civo.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_civo.md new file mode 100644 index 0000000..bddfbc7 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_civo.md @@ -0,0 +1,42 @@ +--- +title: ksctl_delete-cluster_civo +description: Command documentation for ksctl_delete-cluster_civo +--- + +## ksctl delete-cluster civo + +Use to delete a Civo managed k3s cluster + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl delete-cluster civo [flags] +``` + +### Examples + +``` + +ksctl delete civo --name demo --region LON1 --storage store-local + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for civo + -n, --name string Cluster Name (default "demo") + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster + +###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws.md new file mode 100644 index 0000000..db9b63f --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws.md @@ -0,0 +1,43 @@ +--- +title: ksctl_delete-cluster_ha-aws +description: Command documentation for ksctl_delete-cluster_ha-aws +--- + +## ksctl delete-cluster ha-aws + +Use to delete a self-managed Highly Available cluster on AWS + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl delete-cluster ha-aws [flags] +``` + +### Examples + +``` + +ksctl delete ha-aws --name demo --region us-east-1 --storage store-local + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for ha-aws + -n, --name string Cluster Name (default "demo") + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md new file mode 100644 index 0000000..63c1d0b --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md @@ -0,0 +1,42 @@ +--- +title: ksctl_delete-cluster_ha-aws_del-nodes +description: Command documentation for ksctl_delete-cluster_ha-aws_del-nodes +--- + +## ksctl delete-cluster ha-aws del-nodes + +Use to remove worker nodes in self-managed Highly-Available cluster on Aws + +### Synopsis + +It is used to delete cluster with the given name from user + +``` +ksctl delete-cluster ha-aws del-nodes [flags] +``` + +### Examples + +``` + +ksctl delete ha-aws del-nodes -n demo -r us-east-1 -s store-local --noWP 1 # Here the noWP is the desired count of workernodes + +``` + +### Options + +``` + -h, --help help for del-nodes + -n, --name string Cluster Name (default "demo") + --noWP int Number of WorkerPlane Nodes (default -1) + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure.md new file mode 100644 index 0000000..8e355cb --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure.md @@ -0,0 +1,43 @@ +--- +title: ksctl_delete-cluster_ha-azure +description: Command documentation for ksctl_delete-cluster_ha-azure +--- + +## ksctl delete-cluster ha-azure + +Use to delete a self-managed Highly Available cluster on Azure + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl delete-cluster ha-azure [flags] +``` + +### Examples + +``` + +ksctl delete ha-azure --name demo --region eastus --storage store-local + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for ha-azure + -n, --name string Cluster Name (default "demo") + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md new file mode 100644 index 0000000..50becab --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md @@ -0,0 +1,43 @@ +--- +title: ksctl_delete-cluster_ha-azure_del-nodes +description: Command documentation for ksctl_delete-cluster_ha-azure_del-nodes +--- + +## ksctl delete-cluster ha-azure del-nodes + +Use to remove worker nodes in self-managed Highly-Available cluster on Azure + +### Synopsis + +It is used to delete cluster with the given name from user + +``` +ksctl delete-cluster ha-azure del-nodes [flags] +``` + +### Examples + +``` + +ksctl delete ha-azure del-nodes -n demo -r eastus -s store-local --noWP 1 # Here the noWP is the desired count of workernodes + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for del-nodes + -n, --name string Cluster Name (default "demo") + --noWP int Number of WorkerPlane Nodes (default -1) + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo.md new file mode 100644 index 0000000..94ec127 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo.md @@ -0,0 +1,43 @@ +--- +title: ksctl_delete-cluster_ha-civo +description: Command documentation for ksctl_delete-cluster_ha-civo +--- + +## ksctl delete-cluster ha-civo + +Use to delete a self-managed Highly Available cluster on Civo + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl delete-cluster ha-civo [flags] +``` + +### Examples + +``` + +ksctl delete ha-civo --name demo --region LON1 --storage store-local + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for ha-civo + -n, --name string Cluster Name (default "demo") + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md new file mode 100644 index 0000000..db0a5ed --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md @@ -0,0 +1,43 @@ +--- +title: ksctl_delete-cluster_ha-civo_del-nodes +description: Command documentation for ksctl_delete-cluster_ha-civo_del-nodes +--- + +## ksctl delete-cluster ha-civo del-nodes + +Use to remove worker nodes in self-managed Highly-Available cluster on Civo + +### Synopsis + +It is used to delete cluster with the given name from user + +``` +ksctl delete-cluster ha-civo del-nodes [flags] +``` + +### Examples + +``` + +ksctl delete ha-civo del-nodes -n demo -r LON1 -s store-local --noWP 1 # Here the noWP is the desired count of workernodes + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for del-nodes + -n, --name string Cluster Name (default "demo") + --noWP int Number of WorkerPlane Nodes (default -1) + -r, --region string Region + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [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-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_local.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_local.md new file mode 100644 index 0000000..657ea3e --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_delete-cluster_local.md @@ -0,0 +1,41 @@ +--- +title: ksctl_delete-cluster_local +description: Command documentation for ksctl_delete-cluster_local +--- + +## ksctl delete-cluster local + +Use to delete a kind cluster + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl delete-cluster local [flags] +``` + +### Examples + +``` + +ksctl delete local --name demo --storage store-local + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for local + -n, --name string Cluster Name (default "demo") + -s, --storage string storage provider + -v, --verbose int for verbose output + -y, --yes approval to avoid showMsg (default true) +``` + +### SEE ALSO + +* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster + +###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_get-clusters.md b/content/en/docs/stable/Reference/ksctl_get-clusters.md new file mode 100644 index 0000000..aef3641 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_get-clusters.md @@ -0,0 +1,40 @@ +--- +title: ksctl_get-clusters +description: Command documentation for ksctl_get-clusters +--- + +## ksctl get-clusters + +Use to get clusters + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl get-clusters [flags] +``` + +### Examples + +``` + +ksctl get --provider all --storage store-local + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for get-clusters + -p, --provider string Provider + -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/stable/Reference/ksctl_info-cluster.md b/content/en/docs/stable/Reference/ksctl_info-cluster.md new file mode 100644 index 0000000..9c57de7 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_info-cluster.md @@ -0,0 +1,43 @@ +--- +title: ksctl_info-cluster +description: Command documentation for ksctl_info-cluster +--- + +## ksctl info-cluster + +Use to info cluster + +### Synopsis + +Ksctl ascii [logo] + +``` +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 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_self-update.md b/content/en/docs/stable/Reference/ksctl_self-update.md new file mode 100644 index 0000000..34b4cf4 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_self-update.md @@ -0,0 +1,30 @@ +--- +title: ksctl_self-update +description: Command documentation for ksctl_self-update +--- + +## ksctl self-update + +update the ksctl cli + +### Synopsis + +Ksctl ascii [logo] + +``` +ksctl self-update [flags] +``` + +### Options + +``` + -h, --help help for self-update + -s, --storage string storage provider + -v, --verbose for verbose output (default true) +``` + +### 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/stable/Reference/ksctl_switch-cluster.md b/content/en/docs/stable/Reference/ksctl_switch-cluster.md new file mode 100644 index 0000000..e0e2ed4 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_switch-cluster.md @@ -0,0 +1,48 @@ +## ksctl switch-cluster + +Use to switch between clusters + +### Synopsis + +It is used to switch cluster with the given ClusterName from user. + +``` +ksctl switch-cluster [flags] +``` + +### Examples + +``` + +ksctl switch-context --provider civo --name --region +ksctl switch-context --provider local --name +ksctl switch-context --provider azure --name --region +ksctl switch-context --provider ha-civo --name --region +ksctl switch-context --provider ha-azure --name --region +ksctl switch-context --provider ha-aws --name --region +ksctl switch-context --provider aws --name --region + + For Storage specific + +ksctl switch-context -s store-local -p civo -n -r +ksctl switch-context -s external-store-mongodb -p civo -n -r + +``` + +### Options + +``` + --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] + -h, --help help for switch-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 2-Aug-2024 diff --git a/content/en/docs/stable/Reference/ksctl_version.md b/content/en/docs/stable/Reference/ksctl_version.md new file mode 100644 index 0000000..965dee4 --- /dev/null +++ b/content/en/docs/stable/Reference/ksctl_version.md @@ -0,0 +1,24 @@ +--- +title: ksctl_version +description: Command documentation for ksctl_version +--- + +## ksctl version + +Print the version number of ksctl + +``` +ksctl version [flags] +``` + +### Options + +``` + -h, --help help for version +``` + +### SEE ALSO + +* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters + +###### Auto generated by spf13/cobra on 1-Dec-2024