mirror of
https://github.com/ahmetb/kubectx.git
synced 2025-10-22 03:30:40 +00:00
139 lines
4.6 KiB
Markdown
139 lines
4.6 KiB
Markdown
This repository provides both `kubectx` and `kubens` tools.
|
||
|
||
|
||
**`kubectx`** helps you switch between clusters back and forth:
|
||
|
||
|
||
**`kubens`** helps you switch between Kubernetes namespaces smoothly:
|
||
|
||
|
||
# kubectx(1)
|
||
|
||
kubectx is an utility to manage and switch between kubectl(1) contexts.
|
||
|
||
```
|
||
USAGE:
|
||
kubectx : list the contexts
|
||
kubectx <NAME> : switch to context <NAME>
|
||
kubectx - : switch to the previous context
|
||
kubectx <NEW_NAME>=<NAME> : rename context <NAME> to <NEW_NAME>
|
||
kubectx <NEW_NAME>=. : rename current-context to <NEW_NAME>
|
||
kubectx -d <NAME> : delete context <NAME> ('.' for current-context)
|
||
(this command won't delete the user/cluster entry
|
||
that is used by the context)
|
||
```
|
||
|
||
### Usage
|
||
|
||
```sh
|
||
$ kubectx minikube
|
||
Switched to context "minikube".
|
||
|
||
$ kubectx -
|
||
Switched to context "oregon".
|
||
|
||
$ kubectx -
|
||
Switched to context "minikube".
|
||
|
||
$ kubectx dublin=gke_ahmetb_europe-west1-b_dublin
|
||
Context "dublin" set.
|
||
Aliased "gke_ahmetb_europe-west1-b_dublin" as "dublin".
|
||
```
|
||
|
||
`kubectx` supports <kbd>Tab</kbd> completion on bash/zsh/fish shells to help with
|
||
long context names. You don't have to remember full context names anymore.
|
||
|
||
-----
|
||
|
||
# kubens(1)
|
||
|
||
kubens is an utility to switch between Kubernetes namespaces.
|
||
|
||
```
|
||
USAGE:
|
||
kubens : list the namespaces
|
||
kubens <NAME> : change the active namespace
|
||
kubens - : switch to the previous namespace
|
||
```
|
||
|
||
|
||
### Usage
|
||
|
||
```sh
|
||
$ kubens kube-system
|
||
Context "test" set.
|
||
Active namespace is "kube-system".
|
||
|
||
$ kubens -
|
||
Context "test" set.
|
||
Active namespace is "default".
|
||
```
|
||
|
||
`kubens` also supports <kbd>Tab</kbd> completion on bash/zsh/fish shells.
|
||
|
||
-----
|
||
|
||
## Installation
|
||
|
||
**macOS:**
|
||
|
||
:confetti_ball: Use the [Homebrew](https://brew.sh/) package manager:
|
||
|
||
brew install kubectx
|
||
|
||
This command will set up bash/zsh/fish completion scripts automatically.
|
||
|
||
|
||
- Running `brew install` with `--with-short-names` will install tools with names
|
||
`kctx` and `kns` to prevent prefix collision with `kubectl` name.
|
||
|
||
- If you like to add context/namespace info to your shell prompt (`$PS1`),
|
||
I recommend trying out [kube-ps1](https://github.com/jonmosco/kube-ps1).
|
||
|
||
**Linux:**
|
||
|
||
Since `kubectx`/`kubens` are written in Bash, you should be able to instal
|
||
them to any POSIX environment that has Bash installed.
|
||
|
||
- Download the `kubectx`, and `kubens` scripts.
|
||
- Either:
|
||
- save them all to somewhere in your `PATH`,
|
||
- or save them to a directory, then create symlinks to `kubectx`/`kubens` from
|
||
somewhere in your `PATH`, like `/usr/local/bin`
|
||
- Make `kubectx` and `kubens` executable (`chmod +x ...`)
|
||
- Figure out how to install bash/zsh/fish [completion scripts](completion/).
|
||
|
||
Example installation steps:
|
||
|
||
``` bash
|
||
sudo git clone https://github.com/ahmetb/kubectx /opt/kubectx
|
||
sudo ln -s /opt/kubectx/kubectx /usr/local/bin/kubectx
|
||
sudo ln -s /opt/kubectx/kubens /usr/local/bin/kubens
|
||
```
|
||
|
||
-----
|
||
|
||
#### Users
|
||
|
||
| What are others saying about kubectx? |
|
||
| ---- |
|
||
| _“Thank you for kubectx & kubens - I use them all the time & have them in my k8s toolset to maintain happiness :) ”_ – [@pbouwer](https://twitter.com/pbouwer/status/925896377929949184) |
|
||
| _“I can't imagine working without kubectx and especially kubens anymore. It's pure gold.”_ – [@timoreimann](https://twitter.com/timoreimann/status/925801946757419008) |
|
||
| _“I'm liking kubectx from @ahmetb, makes it super-easy to switch #Kubernetes contexts [...]”_ — [@lizrice](https://twitter.com/lizrice/status/928556415517589505) |
|
||
| _“Also using it on a daily basis. This and my zsh config that shows me the current k8s context 😉”_ – [@puja108](https://twitter.com/puja108/status/928742521139810305) |
|
||
| _“Lately I've found myself using the kubens command more than kubectx. Both very useful though :-)”_ – [@stuartleeks](https://twitter.com/stuartleeks/status/928562850464907264) |
|
||
| _“yeah kubens rocks!”_ – [@embano1](https://twitter.com/embano1/status/928698440732815360) |
|
||
| _“Special thanks to Ahmet Alp Balkan for creating kubectx, kubens, and kubectl aliases, as these tools made my life better.”_ – [@strebeld](https://medium.com/@strebeld/5-ways-to-enhance-kubectl-ux-97c8893227a)
|
||
|
||
> If you liked `kubectx`, you may like my [`kubectl-aliases`](https://github.com/ahmetb/kubectl-aliases) project, too.
|
||
|
||
-----
|
||
|
||
Disclaimer: This is not an official Google product.
|
||
|
||
|
||
#### Stargazers over time
|
||
|
||
[](https://starcharts.herokuapp.com/ahmetb/kubectx)
|
||
|