herbrandson/k8dash

skooner - Kubernetes 仪表盘

(温馨提示：我们正将名称从 "k8dash" 改为 "skooner"！请耐心等待我们完成所有文档和代码库的名称更新。)

skooner 是管理Kubernetes集群最简便的方式。

• 全集群管理：支持命名空间、节点、Pod、副本集、部署、存储、RBAC等资源管理
• 极速且实时：无需刷新页面即可查看集群最新状态
• 集群健康概览：实时图表帮助快速定位性能不佳的资源
• 便捷的CRUD与缩放：内置API文档，轻松理解各字段功能
• 100%响应式设计：支持在手机/平板上运行
• 简单的OpenID集成：无需特殊代理
• 安装便捷：使用提供的yaml资源，1分钟内即可启动运行（真的！）
• 查看skooner实际效果：
  https://raw.githubusercontent.com/indeedeng/k8dash/master/docs/videoThumbnail.png]([***] "skooner - Kubernetes Dashboard")

目录

• 前提条件
• 快速开始
• kubectl proxy
• 登录方式
  • 服务账户令牌
  • OIDC
  • NodePort
  • 指标监控
• 开发指南
• skooner架构
  • 服务端
  • 客户端
• 许可证

前提条件

• 运行中的Kubernetes集群（例如 https://kubernetes.io/docs/tasks/tools/install-minikube/%EF%BC%89%EF%BC%8C%E9%9C%80%E6%BB%A1%E8%B6%B3%EF%BC%9A
  • 已安装 https://github.com/kubernetes-incubator/metrics-server%EF%BC%88%E5%8F%AF%E9%80%89%EF%BC%8C%E4%BD%86%E5%BC%BA%E7%83%88%E6%8E%A8%E8%8D%90%EF%BC%89
  • 已配置 https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens 认证（可选）

(返回 目录)

快速开始

使用以下命令部署skooner：

注意：请勿信任从互联网下载的文件。在运行以下脚本前，请务必检查 https://raw.githubusercontent.com/indeedeng/k8dash/master/kubernetes-k8dash.yaml 的内容。

bash
kubectl apply -f https://raw.githubusercontent.com/indeedeng/k8dash/master/kubernetes-k8dash.yaml

若需公开访问skooner，可通过Ingress配置路由：

yaml
kind: Ingress
apiVersion: extensions/v1beta1
metadata:
  name: skooner
  namespace: kube-system
spec:
  rules:
  -
    host: skooner.example.com
    http:
      paths:
      -
        path: /
        backend:
          serviceName: skooner
          servicePort: 80

(返回 目录)

kubectl proxy

遗憾的是，kubectl proxy 无法用于访问skooner。根据 https://github.com/kubernetes/kubernetes/issues/38775#issuecomment-277915961%EF%BC%8C%60kubectl proxy` 在代理请求时会剥离Authorization头。

这是预期行为。通过apiserver进行"代理"不会提供标准的代理行为（端到端保留Authorization头），因为API并非用作标准代理。

(返回 目录)

登录方式

skooner支持多种登录方式：服务账户令牌、OIDC 和 NodePort。

服务账户令牌

最简单的方式是创建专用服务账户：

bash
# 在当前命名空间（默认假设为default）创建服务账户
kubectl create serviceaccount skooner-sa

# 授予该账户集群管理员权限
kubectl create clusterrolebinding skooner-sa --clusterrole=cluster-admin --serviceaccount=default:skooner-sa

# 查找为该账户创建的包含令牌的secret
kubectl get secrets

# 查看secret内容以提取令牌
kubectl describe secret skooner-sa-token-xxxxx

复制secret中的token值，输入到登录界面即可访问仪表盘。

OIDC

skooner简化了OpenId Connect认证的使用。假设集群已配置OIDC，只需创建包含凭证的secret并应用 https://raw.githubusercontent.com/indeedeng/k8dash/master/kubernetes-k8dash-oidc.yaml%E3%80%82

若需了解如何配置集群OIDC，可参考以下链接：

• https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens
• Kubernetes Day 2 Operations: AuthN/AuthZ with OIDC and a Little Help From Keycloak | by Bob Killen | Medium
• kubectl with OpenID Connect. TL;DR | by Hidetake Iwata | Medium
• https://www.google.com/search?q=kubernetes+configure+oidc

使用以下脚本部署支持OIDC的skooner：

注意：请勿信任从互联网下载的文件。在运行以下脚本前，请务必检查 https://raw.githubusercontent.com/indeedeng/k8dash/master/kubernetes-k8dash-oidc.yaml 的内容。

bash
OIDC_URL=<输入你的端点URL，例如https://accounts.google.com>
OIDC_ID=<输入你的ID，例如blah-blah-blah.apps.googleusercontent.com>
OIDC_SECRET=<输入你的OIDC密钥>

kubectl create secret -n kube-system generic skooner \
--from-literal=url="$OIDC_URL" \
--from-literal=id="$OIDC_ID" \
--from-literal=secret="$OIDC_SECRET"

kubectl apply -f https://raw.githubusercontent.com/indeedeng/k8dash/master/kubernetes-k8dash-oidc.yaml

此外，可通过以下环境变量配置其他OIDC选项：

• OIDC_SCOPES：默认值为openid email，可添加额外范围（如OIDC_SCOPES="openid email groups"）
• OIDC_METADATA：skooner使用优秀的 https://github.com/panva/node-openid-client 模块。OIDC_METADATA接受JSON字符串并传递给Client构造函数，文档见 https://github.com/panva/node-openid-client/blob/master/docs/README.md#client%E3%80%82%E4%BE%8B%E5%A6%82%EF%BC%9A%60OIDC_METADATA='%7B%22token_endpoint_auth_method%22:%22client_secret_post%22%7D'%60

NodePort

若未配置Ingress，可使用 https://raw.githubusercontent.com/indeedeng/k8dash/master/kubernetes-k8dash-nodeport.yaml 中的NodePort服务。这适用于单节点集群或快速启动场景。

该配置会将skooner的4654端口映射到节点上的随机端口。可通过以下命令查看分配的端口：

$ kubectl get svc --namespace=kube-system

NAME       TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGE
skooner     NodePort    10.107.107.62   <none>        4654:32565/TCP   1m

指标监控

skooner依赖 https://github.com/kubernetes-incubator/metrics-server 显示实时集群指标。强烈建议安装metrics-server以获得最佳体验。

• https://github.com/kubernetes-incubator/metrics-server
• 在kubeadm集群中运行metrics-server

(返回 目录)

开发指南

需准备：

• 运行中的Kubernetes集群
  • 安装并运行 https://kubernetes.io/docs/tasks/tools/install-minikube/ 是简便方式
  • 安装minikube后，可通过minikube start --driver=docker启动
• 集群启动后，按 上述步骤 创建登录凭证

(返回 目录)

skooner架构

服务端

要运行服务端，进入/server目录执行npm i安装依赖，然后npm start启动服务。服务端是基于express.js的简单服务器，主要负责代理Kubernetes API请求。

开发期间，服务端将使用~/.kube/config中的配置连接目标集群。例如，使用minikube时，可运行kubectl config set-context minikube确保~/.kube/config配置正确。

客户端

客户端是使用TypeScript的React应用，依赖极少。

要运行客户端，打开新终端标签，进入/client目录，执行npm i和npm start。这将在浏览器中打开本地skooner仪表盘。若编译成功，页面加载后可能会弹出错误信息Unhandled Rejection (Error): Api request error: Forbidden...，点击右上角的'X'关闭即可看到输入令牌的UI界面。

(返回 目录)

许可证

https://raw.githubusercontent.com/indeedeng/k8dash/master/LICENSE

https://app.fossa.com/api/projects/git%2Bgithub.com%2Findeedeng%2Fk8dash.svg?type=large](https://app.fossa.com/projects/git%2Bgithub.com%2Findeedeng%2Fk8dash?ref=badge_large)

(返回 目录)