kxd

README

kxd - Kubeconfig Switcher

kxd is a command-line utility that allows you to easily switch between Kubernetes configuration files (kubeconfig) and contexts. This tool is designed to simplify the management of multiple Kubernetes clusters and contexts.

Features

• Switch between different kubeconfig files.
• Switch between Kubernetes contexts within a kubeconfig file.

Installation

Make sure you have Go installed. You can download it from here.

Homebrew

brew tap radiusmethod/kxd
brew install kxd

or just

brew install radiusmethod/kxd/kxd

Makefile

make install

To Finish Installation

Add the following to your bash profile or zshrc then open new terminal or source that file

alias kxd="source _kxd"

Ex. echo -ne '\nalias kxd="source _kxd"' >> ~/.zshrc

Configuration

By default, Kubeconfig Switcher looks for files with an extension of .conf. You can customize the behavior by setting an environment variable. This can be a single matcher or a comma seperated string for multiple matchers.

• KXD_MATCHER: The file matcher(s) used to identify kubeconfig files (default is .conf).

Usage

• See docs for more info kxd

Switching Kubeconfig Files

It is possible to shortcut the menu selection by passing the config name you want to switch to as an argument.

> kxd dev.conf
Config dev.conf set.

To switch between different kubeconfig files using the menu, use the following command:

kxd f s

This command will display a list of available kubeconfig files in your ~/.kube directory. Select the one you want to use.

Switching Kubernetes Contexts

To switch between Kubernetes contexts within a kubeconfig file, use the following command:

kxd ctx s

This command will display a list of available contexts in your current kubeconfig file. Select the one you want to switch to.

Getting Current Kubeconfig or Kubernetes Context

To get the currently set Kubeconfig or Kubernetes Context, use the following commands:

kxd f c

This command will display the currently set kubeconfig file.

kxd ctx c

This command will display the currently set Kubernetes Context.

Version

To check the version of Kubeconfig Switcher, use the following command:

kxd version

Persist KUBECONFIG across new shells

To persist the set config when you open new terminal windows, you can add the following to your bash profile or zshrc.

export KUBECONFIG=$(kxd file current)

Show your set kubeconfig in your shell prompt

For better visibility into what your shell is set to it can be helpful to configure your prompt to show the value of the env variable KUBECONFIG.

Here's a sample of my zsh prompt config using oh-my-zsh themes

# Kubeconfig info
local kxd_info='$(kxd_config)'
function kxd_config {
  local config="${KUBECONFIG:=}"
    if [ -z "$config" ]
    then
          echo -n ""
    else
          config=$(basename $config)
          echo -n "%{$fg_bold[blue]%}kx:(%{$fg[cyan]%}${config}%{$fg_bold[blue]%})%{$reset_color%} "
    fi
}

PROMPT='OTHER_PROMPT_STUFF $(kxd_info)'

Add autocompletion

You can add autocompletion when passing config as argument by creating a script with the following. I put it in ~/bin/kxd_autocomplete.sh, then source that script and add to your bash profile or zshrc file. source ~/bin/kxd_autocomplete.sh

[ "$BASH_VERSION" ] && KXD_CMD="kxd" || KXD_CMD="_kxd"
_kxd_completion() {
    local cur=${COMP_WORDS[COMP_CWORD]}
    local suggestions=$(kxd file list)
    COMPREPLY=($(compgen -W "$suggestions" -- $cur))
    return 0
}
complete -o nospace -F _kxd_completion "${KXD_CMD}"

Now you can do kxd my-k and hit tab and if you had a config my-kubeconfig it would autocomplete and find it.

Contributing

If you encounter any issues or have suggestions for improvements, please open an issue or create a pull request on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.