Crates.io | kubie |
lib.rs | kubie |
version | 0.23.1 |
source | src |
created_at | 2020-04-04 05:35:02.693093 |
updated_at | 2024-07-01 00:27:05.948242 |
description | A more powerful alternative to kubectx and kubens. |
homepage | https://github.com/sbstp/kubie |
repository | https://github.com/sbstp/kubie |
max_upload_size | |
id | 226146 |
size | 145,998 |
kubie
is an alternative to kubectx
, kubens
and the k on
prompt modification script. It offers context switching,
namespace switching and prompt modification in a way that makes each shell independent from others. It also has
support for split configuration files, meaning it can load Kubernetes contexts from multiple files. You can configure
the paths where kubie will look for contexts, see the settings section.
Kubie also has other nice features such as kubie exec
which allows you to execute commands in a context and a
namespace without having to spawn a shell and kubie lint
which scans your k8s config files for issues and informs
you of what they are.
Thanks to @ahermant for the lovely logo!
You can download a binary for Linux or OS X on the GitHub releases page. You
can use curl
or wget
to download it. Don't forget to chmod +x
the file!
You can build kubie
from source using cargo
and crates.io. If you do not have a Rust compiler installed, go to
rustup.rs to get one. Then you can run cargo install kubie
and kubie will be downloaded from
crates.io and then built.
You can install kubie
from Homebrew by running brew install kubie
.
You can also install kubie
from MacPorts by running sudo port install kubie
.
There is a kubie
Nix package maintained by @illiusdope that you can install.
kubie
is available in the extra repository and it can be installed by running pacman -S kubie
.
If you want autocompletion for kubie ctx
, kubie ns
and kubie exec
, please install this script:
sudo cp ./completion/kubie.bash /etc/bash_completion.d/kubie
Then spawn new shell or source copied file:
. /etc/bash_completion.d/kubie
Install the completions script kubie.fish by copying it, eg.:
cp completion/kubie.fish ~/.config/fish/completions/
Then reopen fish or source the file.
Selectable menus will be available when using kubie ctx
and kubie ns
.
kubie ctx
display a selectable menu of contextskubie ctx <context>
switch the current shell to the given context (spawns a shell if not a kubie shell)kubie ctx -
switch back to the previous contextkubie ctx <context> -r
spawn a recursive shell in the given contextkubie ctx <context> -n <namespace>
spawn a shell in the given context and namespacekubie ns
display a selectable menu of namespaceskubie ns <namespace>
switch the current shell to the given namespacekubie ns -
switch back to the previous namespacekubie ns <namespace> -r
spawn a recursive shell in the given namespacekubie exec <context> <namespace> <cmd> <args>...
execute a command in the given context and namespacekubie exec <wildcard> <namespace> <cmd> <args>...
execute a command in all the contexts matched by the wildcard and
in the given namespacekubie exec <wildcard> <namespace> -e <cmd> <args>...
execute a command in all the contexts matched by the wildcard and
in the given namespace but fail early if any of the commands executed return a non-zero exit codekubie export <context> <namespace>
prints the path to an isolated config file for a context and namespacekubie edit
display a selectable menu of contexts to editkubie edit <context>
edit the file that contains this contextkubie edit-config
edit kubie's own config filekubie lint
lint k8s config files for issueskubie info ctx
print name of current contextkubie info ns
print name of current namespacekubie info depth
print depth of recursive contextskubie update
will check the latest kubie version and update your local installation if neededYou can customize kubie's behavior with the ~/.kube/kubie.yaml
file. The settings available and their defaults are
available below.
# Force kubie to use a particular shell, if unset detect shell currently in use.
# Possible values: bash, dash, fish, xonsh, zsh
# Default: unset
shell: bash
# Configure where to look for kubernetes config files.
configs:
# Include these globs.
# Default: values listed below.
include:
- ~/.kube/config
- ~/.kube/*.yml
- ~/.kube/*.yaml
- ~/.kube/configs/*.yml
- ~/.kube/configs/*.yaml
- ~/.kube/kubie/*.yml
- ~/.kube/kubie/*.yaml
# Exclude these globs.
# Default: values listed below.
# Note: kubie's own config file is always excluded.
exclude:
- ~/.kube/kubie.yaml
# Prompt settings.
prompt:
# Disable kubie's custom prompt inside of a kubie shell. This is useful
# when you already have a prompt displaying kubernetes information.
# Default: false
disable: true
# When using recursive contexts, show depth when larger than 1.
# Default: true
show_depth: true
# When using zsh, show context and namespace on the right-hand side using RPS1.
# Default: false
zsh_use_rps1: false
# When using fish, show context and namespace on the right-hand side.
# Default: false
fish_use_rprompt: false
# When using xonsh, show context and namespace on the right-hand side.
# Default: false
xonsh_use_right_prompt: false
# Behavior
behavior:
# Make sure the namespace exists with `kubectl get namespaces` when switching
# namespaces. If you do not have the right to list namespaces, disable this.
# Default: true
validate_namespaces: true
# Enable or disable the printing of the 'CONTEXT => ...' headers when running
# `kubie exec`.
# Valid values:
# auto: Prints context headers only if stdout is a TTY. Piping/redirecting
# kubie output will auto-disable context headers.
# always: Always prints context headers, even if stdout is not a TTY.
# never: Never prints context headers.
# Default: auto
print_context_in_exec: auto
# Optional start and stop hooks
hooks:
# A command hook to run when a CTX is started.
# This example re-labels your terminal window
# Default: none
start_ctx: >
echo -en "\033]1; `kubie info ctx`|`kubie info ns` \007"
# A command hook to run when a CTX is stopped
# This example sets the terminal back to the shell name
# Default: none
stop_ctx: >
echo -en "\033]1; $SHELL \007"
Since 0.19.0
, the self update functionality is behind a feature. You can use cargo build --release --no-default-features
to produce a binary without the self update functionality. It's probably better if people rely on the distro's package
manager for updates over this functionality. The binary produced is also quite smaller since it has fewer dependencies.