kubectx + kubens: kubectl 的强大工具

本仓库提供了 kubectx 和 kubens 两个工具。 安装 →

什么是 kubectx 和 kubens？

kubectx 是一个用于在 kubectl 上更快切换上下文（集群）的工具。<br/> kubens 是一个用于轻松切换 Kubernetes 命名空间（并为 kubectl 配置）的工具。

这是 kubectx 的演示：

...这是 kubens 的演示：

示例

# 切换到 kubeconfig 中的另一个集群
$ kubectx minikube
已切换到上下文 "minikube"。

# 切换回之前的集群
$ kubectx -
已切换到上下文 "oregon"。

# 重命名上下文
$ kubectx dublin=gke_ahmetb_europe-west1-b_dublin
上下文 "gke_ahmetb_europe-west1-b_dublin" 已重命名为 "dublin"。

# 更改 kubectl 的活动命名空间
$ kubens kube-system
已设置上下文 "test"。
当前命名空间是 "kube-system"。

# 返回到之前的命名空间
$ kubens -
已设置上下文 "test"。
当前命名空间是 "default"。

# 即使命名空间不存在也更改活动命名空间
$ kubens not-found-namespace --force
已设置上下文 "test"。
当前命名空间是 "not-found-namespace"。
---
$ kubens not-found-namespace -f
已设置上下文 "test"。
当前命名空间是 "not-found-namespace"。

如果您安装了 fzf，您还可以交互式地选择上下文或集群，或通过输入几个字符进行模糊搜索。要了解更多信息，请阅读交互模式 →

kubectx 和 kubens 都支持在 bash/zsh/fish shell 上使用 <kbd>Tab</kbd> 补全，以帮助处理长上下文名称。您不再需要记住完整的上下文名称。

---

安装

kubectx 和 kubens 的稳定版本是您可以在此仓库中找到的小型 bash 脚本。

从 v0.9.0 开始，kubectx 和 kubens 现在用 Go 重写。它们应该以相同的方式工作（我们会保留基于 bash 的实现），但新功能将添加到新的 Go 程序中。请通过从发布页面 →下载二进制文件来帮助我们测试这个新的 Go 实现

安装选项：

• 作为 kubectl 插件（macOS 和 Linux）
• 使用 Homebrew（macOS 和 Linux）
• 使用 MacPorts（macOS）
• 使用 apt（Debian）
• 使用 pacman（Arch Linux）
• 使用 Chocolatey（Windows）
• Windows 安装（使用 Scoop）
• 使用 winget（Windows）
• 手动安装（macOS 和 Linux）

如果您想在 shell 提示符（$PS1）中添加上下文/命名空间信息，可以尝试使用 kube-ps1。

Kubectl 插件（macOS 和 Linux）

您可以安装和使用 Krew kubectl 插件管理器来获取 kubectx 和 kubens。

注意： 这不会安装 shell 补全脚本。如果您需要它们，*请选择另一种安装方法或手动安装脚本。

kubectl krew install ctx
kubectl krew install ns

安装后，这些工具将作为 kubectl ctx 和 kubectl ns 可用。

Homebrew（macOS 和 Linux）

如果您使用 Homebrew，可以这样安装：

brew install kubectx

此命令将自动设置 bash/zsh/fish 补全脚本。确保您配置 shell 以加载已安装的 Homebrew 公式的补全。

MacPorts（macOS）

如果您使用 MacPorts，可以这样安装：

sudo port install kubectx

apt（Debian）

sudo apt install kubectx

较新版本可能在如下仓库中可用： Debian Buster（测试版）， Sid（不稳定版） （如果您不熟悉 Debian 发布过程以及如何启用测试/不稳定仓库，请查看 Debian Wiki）：

pacman（Arch Linux）

可作为官方 Arch Linux 软件包安装。通过以下命令安装：

sudo pacman -S kubectx

Windows 安装 (使用 Chocolatey)

可在 Chocolatey 上作为软件包安装

choco install kubens kubectx

Windows 安装 (使用 Scoop)

可在 Scoop 上作为软件包安装

scoop bucket add main
scoop install main/kubens main/kubectx

Windows 安装 (使用 winget)

可在 winget 上作为软件包安装

winget install --id ahmetb.kubectx
winget install --id ahmetb.kubens

手动安装 (macOS 和 Linux)

由于 kubectx 和 kubens 是用 Bash 编写的，您应该能够将它们安装到任何安装了 Bash 的 POSIX 环境中。

• 下载 kubectx 和 kubens 脚本。
• 选择以下方式之一：
  • 将它们全部保存到 PATH 中的某个位置，
  • 或将它们保存到一个目录中，然后从 PATH 中的某个位置（如 /usr/local/bin）创建指向 kubectx/kubens 的符号链接
• 使 kubectx 和 kubens 可执行（chmod +x ...）

安装步骤示例：

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

如果您还想要shell补全功能，请为补全脚本选择最适合您系统的安装方法：使用 antibody 的 zsh、普通 zsh、bash 或 fish。

使用 antibody 的 zsh 补全脚本

将此行添加到您的插件文件（例如 ~/.zsh_plugins.txt）中：

ahmetb/kubectx path:completion kind:fpath

根据您的设置，在加载插件文件后，您可能需要在 ~/.zshrc 中调用 compinit 或 autoload -U compinit && compinit。如果您使用 oh-my-zsh，请在加载 oh-my-zsh 之前加载补全，因为 oh-my-zsh 会调用 compinit。

普通 zsh 补全脚本

补全脚本必须位于属于 $fpath 的路径中。可以将它们链接或复制到现有文件夹。

使用 oh-my-zsh 的示例：

mkdir -p ~/.oh-my-zsh/custom/completions
chmod -R 755 ~/.oh-my-zsh/custom/completions
ln -s /opt/kubectx/completion/_kubectx.zsh ~/.oh-my-zsh/custom/completions/_kubectx.zsh
ln -s /opt/kubectx/completion/_kubens.zsh ~/.oh-my-zsh/custom/completions/_kubens.zsh
echo "fpath=($ZSH/custom/completions $fpath)" >> ~/.zshrc

如果补全不起作用，请将 autoload -U compinit && compinit 添加到您的 .zshrc 中（类似于 zsh-completions）。

如果您没有使用 oh-my-zsh，您可以链接到 /usr/share/zsh/functions/Completion（可能需要 sudo），具体取决于您的 zsh 安装的 $fpath。

如果出现错误，调用 compaudit 可能会有所帮助。

bash 补全脚本

git clone https://github.com/ahmetb/kubectx.git ~/.kubectx
COMPDIR=$(pkg-config --variable=completionsdir bash-completion)
ln -sf ~/.kubectx/completion/kubens.bash $COMPDIR/kubens
ln -sf ~/.kubectx/completion/kubectx.bash $COMPDIR/kubectx
cat << EOF >> ~/.bashrc


#kubectx and kubens
export PATH=~/.kubectx:\$PATH
EOF

fish 补全脚本

mkdir -p ~/.config/fish/completions
ln -s /opt/kubectx/completion/kubectx.fish ~/.config/fish/completions/
ln -s /opt/kubectx/completion/kubens.fish ~/.config/fish/completions/

---

交互模式

如果您希望 kubectx 和 kubens 命令为您提供带有模糊搜索的交互式菜单，只需要在您的 $PATH 中安装 fzf。

如果您已安装 fzf，但想要退出使用此功能，请设置环境变量 KUBECTX_IGNORE_FZF=1。

如果您想保留 fzf 交互模式但需要命令的默认行为，可以通过将输出管道传递给另一个命令来实现（例如 kubectx | cat ）。

---

自定义颜色

如果您想自定义指示当前命名空间或上下文的颜色，请设置环境变量 KUBECTX_CURRENT_FGCOLOR 和 KUBECTX_CURRENT_BGCOLOR（参考此处的颜色代码）：

export KUBECTX_CURRENT_FGCOLOR=$(tput setaf 6) # 蓝色文本
export KUBECTX_CURRENT_BGCOLOR=$(tput setab 7) # 白色背景

通过设置 NO_COLOR 环境变量可以禁用输出中的颜色。

---

如果你喜欢kubectx，你可能也会喜欢我的kubectl-aliases项目。我建议将kubectx和kubens与fzf和kube-ps1搭配使用。

随时间变化的星标数

<!-- TODO 自2021年8月起失效，因为igrigorik离开了谷歌 -->