diff options
| author | Shaun Tabone <shauntab@gmail.com> | 2019-12-29 05:37:38 +0100 |
|---|---|---|
| committer | Robby Russell <robby@planetargon.com> | 2019-12-28 20:37:38 -0800 |
| commit | 8ed19ab54d6980da777ccea185658e213b26f533 (patch) | |
| tree | 1853dffdc8ed861b44366d4f5823e660180093b6 /plugins/microk8s/README.md | |
| parent | 6bac9eb103fe6c777182746e3a6e84dfc882338b (diff) | |
| download | zsh-8ed19ab54d6980da777ccea185658e213b26f533.tar.gz zsh-8ed19ab54d6980da777ccea185658e213b26f533.tar.bz2 zsh-8ed19ab54d6980da777ccea185658e213b26f533.zip | |
Added MicroK8s plugin for ZSH (#8499)
* Added MicroK8s plugin for ZSH
* Added caching for kubectl and helm commands
* Added title in compadd and enhanced README
Diffstat (limited to 'plugins/microk8s/README.md')
| -rw-r--r-- | plugins/microk8s/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/plugins/microk8s/README.md b/plugins/microk8s/README.md new file mode 100644 index 000000000..2b4ea206f --- /dev/null +++ b/plugins/microk8s/README.md @@ -0,0 +1,24 @@ +# MicroK8s plugin + +This plugin provides completion and useful aliases for [MicroK8s](https://microk8s.io/). + +To use it, add `microk8s` to the plugins array in your zshrc file. + +```zsh +plugins=(... microk8s) +``` + +## Aliases + +| Alias | Command | Description | +|-------|------------------|----------------------------------------------------------------------------------------------------------| +| mco | microk8s.config | Shows the Kubernetes config file. | +| mct | microk8s.ctr | Interact with containerd CLI. | +| mdi | microk8s.disable | Disables an addon. | +| me | microk8s.enable | Enables an addon. | +| mh | microk8s.helm | Interact with Helm CLI. | +| mis | microk8s.istio | Interact with Istio CLI. | +| mk | microk8s.kubectl | Interact with Kubernetes CLI. | +| msp | microk8s.stop | Stops all Kubernetes services. | +| mst | microk8s.start | Starts MicroK8s after it is being stopped. | +| msts | microk8s.status | Provides an overview of the MicroK8s state (running / not running) as well as the set of enabled addons. |
\ No newline at end of file |