astefanutti/kubebox

Kubebox

Kubebox是一个Kubernetes的终端和Web控制台，旨在提供便捷的集群管理和监控功能。它支持多种部署方式，适用于集群管理员和开发人员进行日常的Kubernetes资源管理、日志查看、事件监控及容器交互等操作。

核心功能和特性

• 配置支持：从kubeconfig文件（通过KUBECONFIG环境变量或$HOME/.kube目录）加载配置
• 上下文切换：交互式切换Kubernetes集群上下文
• 认证支持：包括Bearer token、基本认证、私钥/证书、OAuth、OpenID Connect、Amazon EKS、Google Kubernetes Engine、Digital Ocean等
• 命名空间与Pod管理：命名空间选择及Pod列表实时监控
• 容器日志：日志滚动查看与实时监控
• 资源使用监控：容器内存、CPU、网络、文件系统使用情况图表（需部署cAdvisor DaemonSet）
• 远程执行终端：容器内远程shell访问
• 事件监控：集群、命名空间、Pod级别的事件查看

使用场景和适用范围

• Kubernetes集群日常管理与监控
• 容器日志实时查看与问题排查
• 资源使用情况分析与优化
• 多集群环境下的上下文快速切换
• 开发环境中容器内命令执行与调试

使用方法和配置说明

可执行文件方式

下载对应操作系统的独立可执行文件：

shell
# Linux (x86_64)
curl -Lo kubebox https://github.com/astefanutti/kubebox/releases/download/v0.9.0/kubebox-linux && chmod +x kubebox

# Linux (ARMv7)
curl -Lo kubebox https://github.com/astefanutti/kubebox/releases/download/v0.9.0/kubebox-linux-arm && chmod +x kubebox

# OSX
curl -Lo kubebox https://github.com/astefanutti/kubebox/releases/download/v0.9.0/kubebox-macos && chmod +x kubebox

# Windows
curl -Lo kubebox.exe https://github.com/astefanutti/kubebox/releases/download/v0.9.0/kubebox-windows.exe

运行：

shell
./kubebox

Kubernetes集群内Server方式

可将Kubebox部署为集群内服务，通过Web界面访问（基于Xterm.js终端模拟）：

shell
kubectl apply -f https://raw.github.com/astefanutti/kubebox/master/kubernetes.yaml

清理资源：

shell
kubectl delete namespace kubebox

注意：Ingress资源需要集群已部署Ingress控制器，详见Ingress控制器文档。

OpenShift集群部署：

shell
oc new-app -f https://raw.github.com/astefanutti/kubebox/master/openshift.yaml

Kubectl方式

通过kubectl在集群内运行客户端：

shell
kubectl run kubebox -it --rm --env="TERM=xterm" --image=astefanutti/kubebox --restart=Never

若启用RBAC，需指定具有足够权限的服务账户：

shell
kubectl run kubebox -it --rm --env="TERM=xterm" --image=astefanutti/kubebox --restart=Never --serviceaccount=<service-account-name>

Docker方式

直接通过Docker运行：

shell
docker run -it --rm astefanutti/kubebox

挂载本地kubeconfig文件（推荐）：

shell
docker run -it --rm -v ~/.kube/:/home/node/.kube/:ro astefanutti/kubebox

在线方式

可通过浏览器访问在线版本：https://astefanutti.github.com/kubebox

注意：需确保Kubernetes API服务器允许该地址的CORS请求，可通过API服务器参数配置：

shell
kube-apiserver --cors-allowed-origins .*

认证支持

Kubebox支持多种与kubectl兼容的认证策略，不同使用方式的支持情况如下：

若使用方式不支持所需认证策略，可手动刷新认证令牌/证书并更新kubeconfig文件。

cAdvisor配置

Kubebox依赖cAdvisor获取资源使用指标。自0.8.0版本起，需将cAdvisor部署为DaemonSet（原Kubelet内置cAdvisor端点已弃用）：

shell
kubectl apply -f https://raw.githubusercontent.com/astefanutti/kubebox/master/cadvisor.yaml

推荐使用上述cadvisor.yaml文件，已测试兼容Kubebox。cAdvisor容器需以特权模式运行，以访问节点上的容器运行时。

可调整cadvisor.yaml中容器参数：

• --storage_duration：存储窗口时长（默认5m0s）
• --housekeeping_interval：采样周期（默认10s）
• 若容器运行时 socket 路径非默认，需额外指定

快捷键

通用

登录

Pods

常见问题

资源使用指标不可用？

1. cAdvisor部署问题：自0.8.0版本起，需部署cAdvisor DaemonSet（详见cAdvisor配置）。
2. RBAC权限问题：需确保服务账户具有以下权限：

   shell
   # 列出cadvisor命名空间下的Pod（通过spec.nodeName字段选择器）
   kubectl auth can-i list pods -n cadvisor
   # 代理cadvisor Pod以调用其REST API
   kubectl auth can-i get pod --subresource proxy -n cadvisor
   

开发

shell
git clone https://github.com/astefanutti/kubebox.git
cd kubebox
npm install
node index.js

截图

集群事件

!https://astefanutti.github.io/kubebox/events.png

容器内Shell

!https://astefanutti.github.io/kubebox/exec.png

终端主题支持

!https://astefanutti.github.io/kubebox/theme.png

Web浏览器版本

!https://astefanutti.github.io/kubebox/web.png