derailed/k9s

K9s - 优雅管理Kubernetes集群的终端UI工具

概述

K9s提供终端UI界面，用于与Kubernetes集群交互，旨在简化集群导航、资源观察和应用管理。它持续监控Kubernetes集群变化，并提供与观察资源交互的后续命令，帮助用户更高效地管理Kubernetes环境。

核心功能与特性

• 终端UI界面：直观的终端用户界面，支持Vim风格操作，简化资源导航与管理。
• 实时监控：持续监控集群资源变化，自动更新视图，实时反映集群状态。
• 多资源支持：支持Pod、Deployment、Service、StatefulSet等多种Kubernetes核心资源的查看与管理。
• 多环境切换：便捷切换Kubernetes上下文（context）和命名空间（namespace），适应多集群管理需求。
• 只读模式：可启用只读模式运行，禁用所有集群修改命令，提升操作安全性。
• 日志集成：内置日志查看功能，支持实时日志流式输出、日志过滤与搜索。
• 配置自定义：支持自定义资源别名、快捷键、插件扩展，满足个性化使用习惯。
• 集群检查：与Popeye集成，提供集群健康检查和资源优化建议。
• 节点Shell：支持通过临时Pod进入集群节点，便于节点级故障排查与维护。

使用场景

• 集群管理员：日常监控集群状态、管理资源生命周期、执行故障排查。
• 开发人员：查看应用Pod状态、获取实时日志、调试部署在Kubernetes上的应用。
• 多集群环境：在复杂环境中高效切换和管理多个Kubernetes集群资源。
• CI/CD流程：作为终端工具集成到开发流程，快速验证资源部署与运行状态。

Docker部署与使用

运行官方Docker镜像

通过挂载本地Kubernetes配置文件（KUBECONFIG），可直接运行K9s官方镜像：

shell
# 使用环境变量KUBECONFIG指定配置文件路径
docker run --rm -it -v $KUBECONFIG:/root/.kube/config quay.io/derailed/k9s

若使用默认KUBECONFIG路径（~/.kube/config）：

shell
docker run --rm -it -v ~/.kube/config:/root/.kube/config quay.io/derailed/k9s

构建自定义Docker镜像

可基于项目Dockerfile构建自定义K9s镜像，支持指定kubectl版本：

shell
# 构建基础镜像
docker build -t k9s-docker:0.1 .

# 指定kubectl版本构建（示例：获取最新稳定版）
KUBECTL_VERSION=$(make kubectl-stable-version 2>/dev/null)
docker build --build-arg KUBECTL_VERSION=${KUBECTL_VERSION} -t k9s-docker:0.1 .

运行自定义镜像：

shell
docker run --rm -it -v ~/.kube/config:/root/.kube/config k9s-docker:0.1

命令行选项

shell
# 查看所有CLI选项
k9s help

# 获取K9s运行时信息（配置路径、日志位置等）
k9s info

# 在指定命名空间中运行K9s
k9s -n mycoolns

# 使用指定KubeConfig上下文启动
k9s --context coolCtx

# 以只读模式启动（禁用修改命令）
k9s --readonly

配置说明

K9s配置文件位于操作系统特定目录（可通过k9s info查看），主要配置文件包括config.yml、alias.yml、hotkey.yml和plugin.yml。

主配置文件（config.yml）

用于配置UI行为、集群偏好、日志设置等，示例：

yaml
k9s:
  refreshRate: 2                # UI刷新间隔（秒）
  maxConnRetry: 5               # API服务器连接失败重试次数
  enableMouse: true             # 启用鼠标支持
  readOnly: false               # 只读模式开关
  logger:
    tail: 200                   # 日志显示行数
    buffer: 500                 # 日志缓冲区大小
    sinceSeconds: 300           # 日志回溯时间（秒）
  currentContext: minikube      # 当前Kubernetes上下文
  currentCluster: minikube      # 当前Kubernetes集群
  clusters:
    coolio:
      namespace:
        active: coolio          # 默认激活命名空间
        favorites: [cassandra, default]  # 收藏的命名空间
      view:
        active: po              # 默认资源视图（pods）

资源别名配置（alias.yml）

自定义资源访问别名，简化命令输入，示例：

yaml
alias:
  pp: v1/pods                          # pp作为pods的别名
  crb: rbac.authorization.k8s.io/v1/clusterrolebindings  # crb作为clusterrolebindings的别名

快捷键配置（hotkey.yml）

自定义资源访问快捷键，示例：

yaml
hotKey:
  shift-0:
    shortCut: Shift-0
    description: 查看Pod
    command: pods
  shift-1:
    shortCut: Shift-1
    description: 查看Deployment
    command: dp

插件配置（plugin.yml）

扩展自定义命令，示例（Pod日志查看插件）：

yaml
plugin:
  fred:
    shortCut: Ctrl-L          # 快捷键
    confirm: false            # 是否需要确认
    description: Pod日志      # 描述
    scopes: [pods]            # 适用资源范围
    command: kubectl          # 执行命令
    args: [logs, -f, $NAME]   # 命令参数（$NAME为选中Pod名称）

环境变量设置

• TERM：需设置为256色终端模式，如export TERM=xterm-256color。
• EDITOR：指定资源编辑工具，如export EDITOR=vim（用于kubectl edit命令）。
• K9S_EDITOR：若编辑工具对流式文件处理特殊，可单独设置（如export K9S_EDITOR=nvim）。

常用快捷键

注意事项

• 确保终端支持256色模式（设置TERM=xterm-256color）。
• 运行前需挂载有效的KUBECONFIG文件，确保集群访问权限。
• 高级功能（如节点Shell）需在config.yml中启用对应特性开关（featureGates.nodeShell: true）。