我开源了一款k8s命令行工具，提供命令输入提示和自动补全功能

logo

kubectlx是一款基于go-prompt库开发的k8s命令行工具，目的是简化kubectl工具的一些常用命令的使用，并提供命令输入提示、自动补全。

前往GitHub：https://github.com/kubectlx/kubectlx

kubectlx

主要功能特性：

多k8s集群切换，便于管理多个k8s集群
namespace切换，减少kubectl每条命令都加’-n namesapce’
命令输入提示和自动补全，命令的每个部分都支持输入提示和TAG键补全
输入提示和自动补全支持自定义的CRD资源
提供额外的扩展命令，简化一些场景需要多条命令组合才能完成的情况

支持多k8s集群

1.可通过启动参数指定会话连接的k8s集群

kubectlx --kubeconfig=~/.kube/my_k8s_cluster_config

2.在kubectlx进程中使用use命令切换集群，例如：

kubectlx >>> use cluster ~/.kube/my_k8s_cluster_config
success

use_cluster

支持会话默认namespace

进程中可以指定默认的namespace，减少每条命令都输入-n <namespace>，并且可以切换namespace。默认namespace为”default”。

可以使用use命令切换namespace，例如：

kubectlx >>> use namespace xx
success

use_namespace

查询当前选择的k8s集群和namespace

如果忘记了当前kubectlx进程选择的是哪个k8s集群，或者哪个namespace，可以使用context命令查看。

例如：

kubectlx >>> context
use cluster: /Users/wjy/.kube/config
use namespace: default

context

退出和清屏

退出kubectlx进程

kubectlx >>> exit

清空屏幕

Bye!
Exiting.

使用帮助命令

使用help查询kubectl支持的命令，例如：

kubectlx >>> help
System Command:
  exit  退出
  clear 清空屏幕
Context Command:
  context       显示当前会话的配置
  use   使用该命令切换集群或Namespace
Kube Command:
  logs  查看容器日记
  get   资源查询
  delete        删除资源
  apply 通过yaml文件来创建或更新Kubernetes资源对象
  edit  编辑资源
......省略

还可以使用’-h’或者’-help’查看子命令的帮助文档，例如：

kubectlx >>> get pods -h
pods:
  (POD_NAME)    回车查看所有pod，或指定pod名称可查看指定pod
  flags:
  -h    查看当前命令帮助文档
  -help 查看当前命令的帮助文档
  options:
    -A  扫描所有Namespace
    -o  输出格式：json|yaml|wide，例如：-o yaml

扩展的命令

除了支持常用的kubectl支持的命令外，kubectlx还扩展了一些命令应对常见的工作场景需求。

1.查询资源的状态，资源名称支持前缀模糊搜索

kubectlx >>> status <资源类型> <资源名称> [options]
Results:
  Type: pods
- ResName: <资源名称> 
    Status:
      状态信息

2.查询资源树，不支持自定义资源

kubectlx >>> tree <资源类型> <资源名称>

例如：

kubectlx >>> tree jobs xxx
jobs    xxx  Complete
  |----pods     yyy    Succeeded

tree_cmd

3.简化事件查询命令

kubectlx >>> tree <资源类型> <资源名称>

例如：

event pods xxxx
LAST SEEN     TYPE     REASON      OBJECT         MESSAGE
76s          Normal    Parsed     pods/xxxx      xxxxxxxxxxx

extended_event_cmd

4.资源有Finalizers，而可能某些Finalizers有问题，导致无法删除，通过–force强制删除也无法删除，需要先移除所有的Finalizers，才能删除，为了简化这个步骤，kubectlx提供一个扩展命令来实现真正的强制删除。

kubectlx >>> forcedel <资源类型> <资源名称>

extended_forcedel_cmd

5.明文显示Secret资源

secret show secret资源名称

支持参数： * -o：指定输出格式，支持json|yaml，默认为yaml * –show-data=true：只输出data

例如：

kubectlx >>> secret show variable-xxx --show-data=true
TF_VAR_alb_name: chenyuntest
TF_VAR_is_internal: "true"
.......

服务器上下载使用

使用wget命令下载

Linux(Intel)：

wget -O kubectlx https://github.com/kubectlx/kubectlx/releases/download/这里替换为最新版本号/kubectlx_linux_amd64

Linux:

wget -O kubectlx https://github.com/kubectlx/kubectlx/releases/download/这里替换为最新版本号/kubectlx_linux_arm64

给执行文件添加执行权限

chmod -R 755 kubectlx

使用工具

./kubectlx --kubeconfig={kubeconfig文件的路径}