231 lines
7.4 KiB
Markdown
231 lines
7.4 KiB
Markdown
---
|
||
description: Kuboard 的安装手册，包括安装 Kuboard 的前提条件、与 Kubernetes 的版本兼容性、安装步骤、以及完成安装后如何访问 Kuboard 界面。
|
||
storyBook:
|
||
title: '安装 Kuboard'
|
||
initial: StoryBook
|
||
pages:
|
||
- name: overview
|
||
title: 前提条件
|
||
- name: install
|
||
title: 安装/卸载
|
||
- name: token
|
||
title: 获取 Token
|
||
- name: access
|
||
title: 访问 Kuboard
|
||
- name: next
|
||
title: 下一步
|
||
---
|
||
|
||
# 安装 Kuboard
|
||
|
||
<StoryBook>
|
||
|
||
<div slot="overview">
|
||
|
||
## 前提
|
||
|
||
安装 Kuboard 时，假设您已经有一个 Kubernetes 集群
|
||
|
||
如果没有 Kubernetes 集群：
|
||
|
||
* 初学者， 请参考 [安装 Kubernetes 单Master节点](install-k8s.html)
|
||
* 用于生产，请参考 [安装 Kubernetes 高可用](install-kubernetes.html)
|
||
|
||
## 兼容性
|
||
|
||
|
||
| Kubernetes 版本 | Kuboard 版本 | 兼容性 | 说明 |
|
||
| --------------- | -------------- | ------ | ------------------------------------------------------------ |
|
||
| v1.15 | v1.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.14 | v1.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.13 | v1.0.x | <span style="font-size: 24px;">😄</span> | 已验证 |
|
||
| v1.12 | v1.0.x | <span style="font-size: 24px;">😐</span> | Kubernetes Api v1.12 尚不支持 dryRun，<br />忽略Kuboard在执行命令时的参数校验错误，可正常工作 |
|
||
| v1.11 | v1.0.x | <span style="font-size: 24px;">😐</span> | 同上 |
|
||
|
||
</div>
|
||
|
||
<div slot="install">
|
||
|
||
## 安装
|
||
|
||
:::: tabs 安装 type:border-card
|
||
|
||
::: tab 安装
|
||
|
||
安装 Kuboard。
|
||
|
||
> 如果您参考 https://kuboard.cn 网站上提供的 Kubernetes 安装文档，可在 master 节点上执行以下命令。
|
||
|
||
``` sh
|
||
kubectl apply -f https://kuboard.cn/install-script/kuboard.yaml
|
||
```
|
||
|
||
:::
|
||
|
||
::: tab 卸载
|
||
|
||
卸载 Kuboard
|
||
|
||
``` sh
|
||
kubectl delete -f https://kuboard.cn/install-script/kuboard.yaml
|
||
```
|
||
:::
|
||
|
||
::::
|
||
|
||
</div>
|
||
|
||
<div slot="token">
|
||
|
||
## 获取 Token
|
||
|
||
您可以获得管理员用户、只读用户的Token
|
||
|
||
:::: tabs type:border-card
|
||
|
||
::: tab 管理员用户
|
||
|
||
**拥有的权限**
|
||
|
||
* 此Token拥有 ClusterAdmin 的权限，可以执行所有操作
|
||
|
||
**执行命令**
|
||
|
||
```bash
|
||
kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep kuboard-user | awk '{print $1}')
|
||
```
|
||
|
||
**输出**
|
||
|
||
取输出信息中 token 字段
|
||
```{13}
|
||
Name: admin-user-token-g8hxb
|
||
Namespace: kube-system
|
||
Labels: <none>
|
||
Annotations: [kubernetes.io/service-account.name](http://kubernetes.io/service-account.name): Kuboard-user
|
||
[kubernetes.io/service-account.uid](http://kubernetes.io/service-account.uid): 948bb5e6-8cdc-11e9-b67e-fa163e5f7a0f
|
||
|
||
Type: [kubernetes.io/service-account-token](http://kubernetes.io/service-account-token)
|
||
|
||
Data
|
||
====
|
||
ca.crt: 1025 bytes
|
||
namespace: 11 bytes
|
||
token: eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJrdWJlLXN5c3RlbSIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJhZG1pbi11c2VyLXRva2VuLWc4aHhiIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6ImFkbWluLXVzZXIiLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC51aWQiOiI5NDhiYjVlNi04Y2RjLTExZTktYjY3ZS1mYTE2M2U1ZjdhMGYiLCJzdWIiOiJzeXN0ZW06c2VydmljZWFjY291bnQ6a3ViZS1zeXN0ZW06YWRtaW4tdXNlciJ9.DZ6dMTr8GExo5IH_vCWdB_MDfQaNognjfZKl0E5VW8vUFMVvALwo0BS-6Qsqpfxrlz87oE9yGVCpBYV0D00811bLhHIg-IR_MiBneadcqdQ_TGm_a0Pz0RbIzqJlRPiyMSxk1eXhmayfPn01upPdVCQj6D3vAY77dpcGplu3p5wE6vsNWAvrQ2d_V1KhR03IB1jJZkYwrI8FHCq_5YuzkPfHsgZ9MBQgH-jqqNXs6r8aoUZIbLsYcMHkin2vzRsMy_tjMCI9yXGiOqI-E5efTb-_KbDVwV5cbdqEIegdtYZ2J3mlrFQlmPGYTwFI8Ba9LleSYbCi4o0k74568KcN_w
|
||
```
|
||
|
||
:::
|
||
|
||
|
||
::: tab 只读用户
|
||
|
||
**拥有的权限**
|
||
|
||
- view 可查看名称空间的内容
|
||
- system:node 可查看节点信息
|
||
- system:persistent-volume-provisioner 可查看存储类和存储卷声明的信息
|
||
|
||
**适用场景**
|
||
|
||
只读用户不能对集群的配置执行修改操作，非常适用于将开发环境中的 Kuboard 只读权限分发给开发者，以便开发者可以便捷地诊断问题
|
||
|
||
**执行命令**
|
||
|
||
执行如下命令可以获得 <span style="color: #F56C6C; font-weight: 500;">只读用户</span> 的 Token
|
||
|
||
```bash
|
||
kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep kuboard-viewer | awk '{print $1}')
|
||
```
|
||
|
||
**输出**
|
||
|
||
取输出信息中 token 字段
|
||
``` {13}
|
||
Name: admin-user-token-g8hxb
|
||
Namespace: kube-system
|
||
Labels: <none>
|
||
Annotations: [kubernetes.io/service-account.name](http://kubernetes.io/service-account.name): Kuboard-viewer
|
||
[kubernetes.io/service-account.uid](http://kubernetes.io/service-account.uid): 948bb5e6-8cdc-11e9-b67e-fa163e5f7a0f
|
||
|
||
Type: [kubernetes.io/service-account-token](http://kubernetes.io/service-account-token)
|
||
|
||
Data
|
||
====
|
||
ca.crt: 1025 bytes
|
||
namespace: 11 bytes
|
||
token: eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJrdWJlLXN5c3RlbSIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJhZG1pbi11c2VyLXRva2VuLWc4aHhiIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6ImFkbWluLXVzZXIiLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC51aWQiOiI5NDhiYjVlNi04Y2RjLTExZTktYjY3ZS1mYTE2M2U1ZjdhMGYiLCJzdWIiOiJzeXN0ZW06c2VydmljZWFjY291bnQ6a3ViZS1zeXN0ZW06YWRtaW4tdXNlciJ9.DZ6dMTr8GExo5IH_vCWdB_MDfQaNognjfZKl0E5VW8vUFMVvALwo0BS-6Qsqpfxrlz87oE9yGVCpBYV0D00811bLhHIg-IR_MiBneadcqdQ_TGm_a0Pz0RbIzqJlRPiyMSxk1eXhmayfPn01upPdVCQj6D3vAY77dpcGplu3p5wE6vsNWAvrQ2d_V1KhR03IB1jJZkYwrI8FHCq_5YuzkPfHsgZ9MBQgH-jqqNXs6r8aoUZIbLsYcMHkin2vzRsMy_tjMCI9yXGiOqI-E5efTb-_KbDVwV5cbdqEIegdtYZ2J3mlrFQlmPGYTwFI8Ba9LleSYbCi4o0k74568KcN_w
|
||
```
|
||
|
||
:::
|
||
|
||
::::
|
||
|
||
</div>
|
||
|
||
<div slot="access">
|
||
|
||
## 访问 Kuboard
|
||
|
||
您可以通过NodePort、port-forward 两种方式当中的任意一种访问 Kuboard
|
||
|
||
:::: tabs type:border-card
|
||
|
||
::: tab 通过NodePort访问 lazy
|
||
|
||
Kuboard Service 使用了 NodePort 的方式暴露服务，NodePort 为 32567；您可以按如下方式访问 Kuboard。
|
||
|
||
`
|
||
http://任意一个Worker节点的IP地址:32567/
|
||
`
|
||
|
||
输入前一步骤中获得的 token，可进入 **Kuboard 集群概览页**
|
||
|
||
::: tip
|
||
* 如果您使用的是阿里云、腾讯云等，请在其安全组设置里开放 worker 节点 32567 端口的入站访问，
|
||
* 您也可以修改 Kuboard.yaml 文件，使用自己定义的 NodePort 端口号
|
||
:::
|
||
|
||
::: tab 通过port-forward访问 lazy
|
||
|
||
|
||
在您的客户端电脑中执行如下命令
|
||
|
||
```sh
|
||
kubectl port-forward service/kuboard 8080:80 -n kube-system
|
||
```
|
||
|
||
在浏览器打开链接 （请使用 kubectl 所在机器的IP地址）
|
||
|
||
`http://localhost:8080`
|
||
|
||
输入前一步骤中获得的 token，可进入 **Kuboard 集群概览页**
|
||
|
||
|
||
::: tip
|
||
需要您先完成 [从客户端电脑远程管理 Kubernetes](install-kubectl.html) 的配置
|
||
:::
|
||
|
||
::::
|
||
|
||
</div>
|
||
|
||
<div slot="next">
|
||
|
||
::: warning
|
||
* 如果不能访问 Kuboard，请参考 [常见问题](faq/timeout.html)
|
||
|
||
* 如果仍然不能解决，请到 QQ 群提问
|
||
|
||
|
||
:::
|
||
|
||
**下一步**
|
||
|
||
- 使用 Kuboard 工作负载编辑器 [创建 busybox](/guide/example/busybox.html) （10分钟）
|
||
|
||
- 尝试 Kuboard 设计的其他 example [使用 Kuboard](/guide/index.html)
|
||
|
||
</div>
|
||
|
||
</StoryBook>
|