15308555518/ kubekey
1
0
Fork 0
mirror of https://github.com/kubesphere/kubekey.git synced 2025-12-26 01:22:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add declaration of kubectl autocompletion

This commit is contained in:
calvinyv 2020-06-08 10:03:51 +08:00 committed by GitHub
parent 101e874aee
commit 698e90517d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -130,6 +130,25 @@ You can delete the cluster by the following command
```shell script
$ ./kk delete [-f config-sample.yaml]
```
#### Enable kubectl autocompletion
KubeKey doesn't enable kubectl autocompletion. Refer to the guide below and turn it on:
**Prerequisite**: make sure bash-autocompletion is installed and works.
In case that the OS is Linux based:
```shell script
# Install bash-completion
$ apt-get install bash-completion
# Source the completion script in your ~/.bashrc file
$ echo 'source <(kubectl completion bash)' >>~/.bashrc
# Add the completion script to the /etc/bash_completion.d directory
$ kubectl completion bash >/etc/bash_completion.d/kubectl
```
More detail reference could be found [here](https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion)
## Documents
* [Configuration example](docs/config-example.md)