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
These cli commands are available with cli specific versions from ksctl@v1.2.0 onwards v1.2.0 cli references
CLI tool for managing multiple K8s clusters
CLI tool which can manage multiple K8s clusters from local clusters to cloud provider specific clusters.
--debug-cli Its used to run debug mode against cli's menudriven interface
-h, --help help for ksctl
-t, --toggle Help message for toggle
-v, --verbose Enable verbose output
Use to work with clusters
It is used to work with cluster
ksctl cluster --help
-h, --help help for cluster
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to work with addons
It is used to work with addons
ksctl addons --help
-h, --help help for addons
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to disable an addon
It is used to disable an addon
ksctl cluster addons disable [flags]
ksctl addons disable --help
-h, --help help for disable
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to enable an addon
It is used to enable an addon
ksctl cluster addons enable [flags]
ksctl addons enable --help
-h, --help help for enable
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Connect to existing cluster
It is used to connect to existing cluster
ksctl cluster connect [flags]
ksctl connect --help
-h, --help help for connect
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to create a cluster
It is used to create cluster with the given name from user
ksctl cluster create [flags]
ksctl create --help
-h, --help help for create
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to delete a cluster
It is used to delete cluster with the given name from user
ksctl cluster delete [flags]
ksctl delete --help
-h, --help help for delete
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to get the cluster
It is used to get the cluster created by the user
ksctl cluster get [flags]
ksctl get --help
-h, --help help for get
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to list all the clusters
It is used to list all the clusters created by the user
ksctl cluster list [flags]
ksctl list --help
-h, --help help for list
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to manually scaledown a selfmanaged cluster
It is used to manually scaledown a selfmanaged cluster
ksctl cluster scaledown [flags]
ksctl update scaledown --help
-h, --help help for scaledown
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to manually scaleup a selfmanaged cluster
It is used to manually scaleup a selfmanaged cluster
ksctl cluster scaleup [flags]
ksctl update scaleup --help
-h, --help help for scaleup
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to get summary of the created cluster
It is used to get summary cluster
ksctl cluster summary [flags]
ksctl cluster summary --help
-h, --help help for summary
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Generate shell completion scripts
To load completions:
Bash:
$ source <(ksctl completion bash)
$ ksctl completion bash > /etc/bash_completion.d/ksctl
$ ksctl completion bash > /usr/local/etc/bash_completion.d/ksctl
Zsh:
$ echo “autoload -U compinit; compinit” » ~/.zshrc $ ksctl completion zsh > “${fpath[1]}/_ksctl”
Fish:
$ ksctl completion fish | source
$ ksctl completion fish > ~/.config/fish/completions/ksctl.fish
ksctl completion [bash|zsh|fish] [flags]
-h, --help help for completion
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Configure ksctl cli
It will display the current ksctl cli configuration
ksctl configure [flags]
-h, --help help for configure
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Configure cloud
It will help you to configure the cloud
ksctl configure cloud [flags]
-h, --help help for cloud
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Configure storage
It will help you to configure the storage
ksctl configure storage [flags]
-h, --help help for storage
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Configure telemetry
It will help you to configure the telemetry
ksctl configure telemetry [flags]
-h, --help help for telemetry
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
Use to update the ksctl cli
It is used to update the ksctl cli
ksctl self-update [flags]
ksctl self-update --help
-h, --help help for self-update
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output
ksctl version
To get version for ksctl components
ksctl version [flags]
ksctl version --help
-h, --help help for version
--debug-cli Its used to run debug mode against cli's menudriven interface
-v, --verbose Enable verbose output