mirror of https://github.com/easzlab/kubeasz.git
112 lines
4.7 KiB
Markdown
112 lines
4.7 KiB
Markdown
# 安装 Kuboard
|
||
|
||
## Kuboard 介绍
|
||
|
||
Kuboard 官方文档请参考 [https://kuboard.cn](https://kuboard.cn)
|
||
|
||
Kuboard 是一款免费的 Kubernetes 管理工具，提供了丰富的功能：
|
||
|
||
* Kubernetes 基本管理功能
|
||
* 节点管理
|
||
* 名称空间管理
|
||
* 存储类/存储卷管理
|
||
* 控制器（Deployment/StatefulSet/DaemonSet/CronJob/Job/ReplicaSet）管理
|
||
* Service/Ingress 管理
|
||
* ConfigMap/Secret 管理
|
||
* CustomerResourceDefinition 管理
|
||
* Kubernetes 问题诊断
|
||
* Top Nodes / Top Pods
|
||
* 事件列表及通知
|
||
* 容器日志及终端
|
||
* KuboardProxy (kubectl proxy 的在线版本)
|
||
* PortForward (kubectl port-forward 的快捷版本)
|
||
* 复制文件 （kubectl cp 的在线版本）
|
||
* 认证与授权
|
||
* Github/GitLab 单点登录
|
||
* KeyCloak 认证
|
||
* LDAP 认证
|
||
* 完整的 RBAC 权限管理
|
||
* Kuboard 特色功能
|
||
* Kuboard 官方套件
|
||
* Grafana+Prometheus 资源监控
|
||
* Grafana+Loki+Promtail 日志聚合
|
||
* Kuboard 自定义名称空间布局
|
||
* Kuboard 中英文语言包
|
||
|
||
## 安装前提
|
||
|
||
Kuboard 只依赖于 Kubernetes API，您可以在多种情况下使用 Kuboard：
|
||
* 使用 kubeadm 安装的 Kubernetes 集群
|
||
* 使用二进制方式安装的 Kubernetes 集群
|
||
* 阿里云/腾讯云等云供应商托管的 Kubernetes 集群
|
||
|
||
Kuboard 对 Kubernetes 的版本兼容性，如下表所示：
|
||
|
||
| Kubernetes 版本 | Kuboard 版本 | 兼容性 | 说明 |
|
||
| --------------- | -------------- | ------ | ------------------------------------------------------------ |
|
||
| v1.18 | v1.0.x， v2.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.17 | v1.0.x， v2.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.16 | v1.0.x， v2.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.15 | v1.0.x， v2.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.14 | v1.0.x， v2.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.13 | v1.0.x， v2.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.12 | v1.0.x， v2.0.x | <span style="font-size: 24px;">😐</span> | Kubernetes Api v1.12 不支持 dryRun，<br />Kuboard 不支持 Kubernetes v1.12 |
|
||
| v1.11 | v1.0.x， v2.0.x | <span style="font-size: 24px;">😐</span> | Kuboard 不支持 Kubernetes v1.11 |
|
||
|
||
|
||
## 安装
|
||
|
||
### 安装 Kuboard。
|
||
|
||
``` sh
|
||
kubectl apply -f https://kuboard.cn/install-script/kuboard.yaml
|
||
kubectl apply -f https://addons.kuboard.cn/metrics-server/0.3.6/metrics-server.yaml
|
||
```
|
||
|
||
### 卸载 Kuboard
|
||
|
||
``` sh
|
||
kubectl delete -f https://kuboard.cn/install-script/kuboard.yaml
|
||
kubectl delete -f https://addons.kuboard.cn/metrics-server/0.3.6/metrics-server.yaml
|
||
```
|
||
|
||
## 获取 Token
|
||
|
||
您可以获得管理员用户、只读用户的Token
|
||
|
||
### 管理员用户
|
||
|
||
**拥有的权限**
|
||
|
||
* 此Token拥有 ClusterAdmin 的权限，可以执行所有操作
|
||
|
||
**执行命令**
|
||
|
||
```bash
|
||
echo $(kubectl -n kube-system get secret $(kubectl -n kube-system get secret | grep kuboard-user | awk '{print $1}') -o go-template='{{.data.token}}' | base64 -d)
|
||
```
|
||
|
||
**输出**
|
||
|
||
取输出信息中 token 字段
|
||
```{13}
|
||
eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJrdWJlLXN5c3RlbSIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJhZG1pbi11c2VyLXRva2VuLWc4aHhiIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6ImFkbWluLXVzZXIiLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC51aWQiOiI5NDhiYjVlNi04Y2RjLTExZTktYjY3ZS1mYTE2M2U1ZjdhMGYiLCJzdWIiOiJzeXN0ZW06c2VydmljZWFjY291bnQ6a3ViZS1zeXN0ZW06YWRtaW4tdXNlciJ9.DZ6dMTr8GExo5IH_vCWdB_MDfQaNognjfZKl0E5VW8vUFMVvALwo0BS-6Qsqpfxrlz87oE9yGVCpBYV0D00811bLhHIg-IR_MiBneadcqdQ_TGm_a0Pz0RbIzqJlRPiyMSxk1eXhmayfPn01upPdVCQj6D3vAY77dpcGplu3p5wE6vsNWAvrQ2d_V1KhR03IB1jJZkYwrI8FHCq_5YuzkPfHsgZ9MBQgH-jqqNXs6r8aoUZIbLsYcMHkin2vzRsMy_tjMCI9yXGiOqI-E5efTb-_KbDVwV5cbdqEIegdtYZ2J3mlrFQlmPGYTwFI8Ba9LleSYbCi4o0k74568KcN_w
|
||
```
|
||
|
||
|
||
## 访问 Kuboard
|
||
|
||
您可以通过NodePort、port-forward 两种方式当中的任意一种访问 Kuboard
|
||
|
||
### 通过NodePort访问
|
||
|
||
Kuboard Service 使用了 NodePort 的方式暴露服务，NodePort 为 32567；您可以按如下方式访问 Kuboard。
|
||
|
||
`
|
||
http://任意一个Worker节点的IP地址:32567/
|
||
`
|
||
|
||
输入前一步骤中获得的 token，可进入 **Kubernetes 集群概览**，界面如下所示：
|
||
|
||
|