This is a collection of kubectl and bash/zsh shortcuts to make interactions with Kubernetes a bit easier.
beeline.k8s integrates into your bash or zsh shell to provide a number of useful shortcuts as well as the ability to keep individual kubectl config files for each cluster. The makes mangaging the configs much easier to read and manage in the end.
For more details about the solutions currently supported by beeline.k8s, please refer to the project status section below. We plan to continue adding support for many common functions required based on community demand and engagement in future releases.
To use the shortcut scripts it is required that you have setup either bash or zsh completion in advance. Beeline will enable kubectl's auto completion on your behalf. Also, you must have installed kubectl and helm both in /usr/local/bin and they must be executable.
This has been tested on macOS, Ubuntu, and Windows WSL2.
I highly recommend changing your login shell to zsh. It is now the macOS default. For Ubuntu or WSL2, the following will install zsh. If prompted, choose any defaults.
sudo apt install zsh
and to enable autocomplete for zsh on aly of the supported environments, install oh-my-zsh as follows:
sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
To enable these shortcuts you must source them into your shell. This is dependent on the shell you are using. You can either download the desired version you would like or if you are lazy like me do something like this if you use zsh:
##### Setup Beeline
## Defaults if you like
export KS_CONTEXT='cities'
export KS_NAMESPACE='kube-system'
[[ ! -f ~/.beeline.k8s ]] \
&& curl -s -L https://github.com/262life/beeline/releases/latest/download/beeline.sh > ~/.beeline.k8s
source ~/.beeline.k8s
##### End of Beeline
Take note to edit the KS_CONTEXT and KS_NAMESPACE values to your liking. Restart your shell and you should be good to go!
Now, review the usage documentation
- This is an entirely new concept that allows a different context/namespace in each terminal window. It supports multiple logins too...
- Significantly improves the performance
- Currently user should ONLY use zsh for your shell for the terminal. BASH is fine for scripting.
We made an improvement to kubectl config files to allow you to keep seperate kubectl files for each kubeernetes environment. Just create a single config file for each cluster and name it some clustername.cfg and put it in the kube folder. You can look in the examples folder for ideas. Please note that the tokens and certs are intentionlly non working so replace with your own of course.
We welcome contributions.
For filing bugs, suggesting improvements, or requesting new features, please open an issue.
Please use the following to reach members of the community:
- Email: support@262.life
If you find a vulnerability or a potential vulnerability in beeline.k8s please let us know immediately at support@262.life. We'll send a confirmation email to acknowledge your report, and we'll send an additional email when we've identified the issues positively or negatively.
We consider the latest release to be stable. If you use a release candidate proceed with caution.
Official releases of beeline.k8s can be found on the releases page. Please note that it is strongly recommended that you use official releases of beeline.k8s, as unreleased versions from the master branch are subject to changes and incompatibilities that will not be supported in the official releases. Builds from the master branch can have functionality changed and even removed at any time without compatibility support and without prior notice.
beeline.k8s is under the Apache 2.0 License.