README.md

direnv-k8s

This project makes it easy to switch between different k8s environments depending on the current working dir.

how it works

When you enter a directory with this enabled, it will set $KUBECONFIG, and create a directory for each namespace found on the cluster. Each directory will contain another direnv and a kubectl-wrapper, that points to the specific namespace. When entering one of these directories, that kubectl will end up first in $PATH. These kubectl's are created each time the root environment is loaded. Technically the same can be achieved just by using aliases containing an environment variable, but I found that broke tab completion.

Furthermore, $KUBECONFIG_NAMESPACE will also be set inside these directories, to make it easy to include the namespace name in the shell prompt.

This script will use the basename of the current working directory as a name for a kube config. That is, given a directory /home/adam/k8s/prod, it will export KUBECONFIG=/home/atu/.kube/prod.

installation

1. install direnv and make your shell load it (see https://direnv.net/)
2. create a kubeconfig named $name in ~/.kube/
3. create a directory named $name
4. create a symlink from create-environment.sh to $name/.envrc
5. cd into the directory, and notice that direnv complains about the env not being allowed yet
6. READ THROUGH THE ENTIRE .envrc (or create-environment.sh) SCRIPT, AND CONFIRM THAT IT DOESN'T DO ANYTHING NASTY!
7. if happy with the above, run direnv allow .

Repeat the above steps for each k8s environment you want to access.

oh-my-zsh integration

1. source zsh-integration from your theme
2. add ${k8s_info} somewhere in the PROMPT-definition

This will add something like k8s:cluster/namespace to the prompt. Colors can be controlled by writing the desired color name (e.g. "red") to ~/.config/direnv-k8s/$name/color, where $name has the same meaning as in the previous sections.

Done.

Example prompt

My theme is based on the "ys" theme, with the k8s info added just before the git part of the prompt.

Default with default namespace

Default with namespace

Custom colors