The Below CLI Command Reference are mapped from ksctl/cli
repo
CLI Command Reference
Docs are available now in cli repo Here are the links for the documentation files
This is the multi-page printable view of this section. Click here to print.
The Below CLI Command Reference are mapped from ksctl/cli
repo
Docs are available now in cli repo Here are the links for the documentation files
CLI tool for managing multiple K8s clusters
Ksctl ascii [logo]
-h, --help help for ksctl
-t, --toggle Help message for toggle
Use to switch between clusters
Ksctl ascii [logo]
ksctl connect-cluster [flags]
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>
--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
Use to create a cluster
Ksctl ascii [logo]
ksctl create --help
-h, --help help for create-cluster
Use to create a EKS cluster in Aws
Ksctl ascii [logo]
ksctl create-cluster aws [flags]
ksctl create-cluster aws -n demo -r ap-south-1 -s store-local --nodeSizeMP t2.micro --noMP 3
--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)
Use to create a AKS cluster in Azure
Ksctl ascii [logo]
ksctl create-cluster azure [flags]
ksctl create-cluster azure -n demo -r eastus -s store-local --nodeSizeMP Standard_DS2_v2 --noMP 3
--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)
Use to create a Civo managed k3s cluster
Ksctl ascii [logo]
ksctl create-cluster civo [flags]
ksctl create-cluster civo --name demo --region LON1 --storage store-local --nodeSizeMP g4s.kube.small --noMP 3
--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)
Use to create a self-managed Highly Available cluster on AWS
Ksctl ascii [logo]
ksctl create-cluster ha-aws [flags]
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]
--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)
Use to add more worker nodes in self-managed Highly-Available cluster on Aws
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]
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
-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)
Use to create a self-managed Highly-Available cluster on Azure
Ksctl ascii [logo]
ksctl create-cluster ha-azure [flags]
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 [email protected]
--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)
Use to add more worker nodes in self-managed Highly-Available cluster on Azure
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]
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
--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)
Use to create a self-managed Highly Available cluster on Civo
Ksctl ascii [logo]
ksctl create-cluster ha-civo [flags]
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 [email protected]
--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)
Use to add more worker nodes in self-managed Highly-Available cluster on Civo
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]
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
--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)
Use to create a kind cluster
Ksctl ascii [logo]
ksctl create-cluster local [flags]
ksctl create-cluster local --name demo --storage store-local --noMP 3
--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)
Login to your Cloud-provider Credentials
Ksctl ascii [logo]
ksctl cred [flags]
-h, --help help for cred
-s, --storage string storage provider
-v, --verbose for verbose output (default true)
Use to delete a cluster
Ksctl ascii [logo]
ksctl delete --help
-h, --help help for delete-cluster
Use to deletes a EKS cluster
Ksctl ascii [logo]
ksctl delete-cluster aws [flags]
ksctl delete aws --name demo --region ap-south-1 --storage store-local
-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)
Use to deletes a AKS cluster
Ksctl ascii [logo]
ksctl delete-cluster azure [flags]
ksctl delete azure --name demo --region eastus --storage store-local
--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)
Use to delete a Civo managed k3s cluster
Ksctl ascii [logo]
ksctl delete-cluster civo [flags]
ksctl delete civo --name demo --region LON1 --storage store-local
--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)
Use to delete a self-managed Highly Available cluster on AWS
Ksctl ascii [logo]
ksctl delete-cluster ha-aws [flags]
ksctl delete ha-aws --name demo --region us-east-1 --storage store-local
--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)
Use to remove worker nodes in self-managed Highly-Available cluster on Aws
It is used to delete cluster with the given name from user
ksctl delete-cluster ha-aws del-nodes [flags]
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
-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)
Use to delete a self-managed Highly Available cluster on Azure
Ksctl ascii [logo]
ksctl delete-cluster ha-azure [flags]
ksctl delete ha-azure --name demo --region eastus --storage store-local
--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)
Use to remove worker nodes in self-managed Highly-Available cluster on Azure
It is used to delete cluster with the given name from user
ksctl delete-cluster ha-azure del-nodes [flags]
ksctl delete ha-azure del-nodes -n demo -r eastus -s store-local --noWP 1 # Here the noWP is the desired count of workernodes
--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)
Use to delete a self-managed Highly Available cluster on Civo
Ksctl ascii [logo]
ksctl delete-cluster ha-civo [flags]
ksctl delete ha-civo --name demo --region LON1 --storage store-local
--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)
Use to remove worker nodes in self-managed Highly-Available cluster on Civo
It is used to delete cluster with the given name from user
ksctl delete-cluster ha-civo del-nodes [flags]
ksctl delete ha-civo del-nodes -n demo -r LON1 -s store-local --noWP 1 # Here the noWP is the desired count of workernodes
--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)
Use to delete a kind cluster
Ksctl ascii [logo]
ksctl delete-cluster local [flags]
ksctl delete local --name demo --storage store-local
--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)
Use to get clusters
Ksctl ascii [logo]
ksctl get-clusters [flags]
ksctl get --provider all --storage store-local
--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
Use to info cluster
Ksctl ascii [logo]
ksctl info-cluster [flags]
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
--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
update the ksctl cli
Ksctl ascii [logo]
ksctl self-update [flags]
-h, --help help for self-update
-s, --storage string storage provider
-v, --verbose for verbose output (default true)
Print the version number of ksctl
ksctl version [flags]
-h, --help help for version