diff --git a/install/v3/install-built-in.md b/install/v3/install-built-in.md index 510d134..01f0109 100644 --- a/install/v3/install-built-in.md +++ b/install/v3/install-built-in.md @@ -26,13 +26,13 @@ meta: 安装 Kuboard 之前，假设： * 您已经准备好了一个 Linux 服务器用于安装 Kuboard-V3，并且该机器上的 docker 版本不低于 19.03 -* 用于安装 Kuboard v3.0 的机器已经安装了 docker，并且版本不低于 docker 19.03 +* 用于安装 Kuboard v3.x 的机器已经安装了 docker，并且版本不低于 docker 19.03 * 您已经有自己的 Kubernetes 集群，并且版本不低于 Kubernetes v1.13 点击此处可以查看 ## 安装 -安装 Kuboard v3.0 版本的指令如下： +安装 Kuboard v3.x 版本的指令如下： ``` sh {10} sudo docker run -d \ @@ -68,9 +68,9 @@ sudo docker run -d \ * 第 10 行，将持久化数据 `/data` 目录映射到宿主机的 `/root/kuboard-data` 路径，请根据您自己的情况调整宿主机路径； ::: -## 访问 Kuboard v3.0 +## 访问 Kuboard v3.x -在浏览器输入 `http://your-host-ip:10080` 即可访问 Kuboard v3.0 的界面，登录方式： +在浏览器输入 `http://your-host-ip:10080` 即可访问 Kuboard v3.x 的界面，登录方式： * 用户名： `admin` * 密 码： `Kuboard123` diff --git a/install/v3/install-github.md b/install/v3/install-github.md index 0ef5c30..4249471 100644 --- a/install/v3/install-github.md +++ b/install/v3/install-github.md @@ -22,7 +22,7 @@ Kuboard 支持多种认证方式： ## 前提条件 -* 用于安装 Kuboard v3.0 的机器已经安装了 docker，并且版本不低于 docker 19.03 +* 用于安装 Kuboard v3.x 的机器已经安装了 docker，并且版本不低于 docker 19.03 * 您已经有自己的 Kubernetes 集群，并且版本不低于 Kubernetes v1.13 * 您已经安装好了 github ee 或者您打算直接使用 github.com 中的账号 @@ -61,7 +61,7 @@ Kuboard 支持多种认证方式： | -------------------------- | ----------------------------------------- | ------------------------------------------------------------ | | Application name | kuboard-v3 | 标识用，填写任意名称即可 | | Homepage URL | http://外网IP:10080 | 根据 [部署计划](#部署计划)，此处应该填写 http://外网IP:10080 | - | Application description | Kuboard v3.0.0 | 描述，可以为空 | + | Application description | Kuboard v3.x | 描述，可以为空 | | Authorization callback URL | http://外网IP:10080/sso/callback | 根据 [部署计划](#部署计划)，此处应该填写 http://外网IP:10080/sso/callback，`/sso/callback` 为 Kuboard 中处理 OAuth 回调的 URL 路径 | ![image-20210109221355583](./install-github.assets/image-20210109221355583.png) @@ -106,10 +106,10 @@ sudo docker run -d \ ::: tip 参数说明 * 建议将此命令保存为一个 shell 脚本，例如 `start-kuboard.sh`，后续升级 Kuboard 或恢复 Kuboard 时，需要通过此命令了解到最初安装 Kuboard 时所使用的参数； -* 第 4 行，Kuboard v3.0 需要暴露 `80` 端口，如安装指令的第三行所示，默认映射到了宿主机的 `10080` 端口，您可以根据自己的情况选择宿主机的其他端口； -* 第 5、6 行，Kuboard v3.0 需要暴露 `10081` 端口 TCP / UDP，默认映射到了宿主机的 `10081` 端口，您可以根据自己的情况选择宿主机的其他端口； -* 第 7 行，Kuboard v3.0 的持久化数据存储在 `/data` 目录，默认映射到了宿主机的 `/root/kuboard-data` 路径，请根据您自己的情况进行调整； -* 第 8 行，将 Kuboard v3.0 与 GitHub 进行单点登录集成时，必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `github` （适用于 github.com / github-ee）； +* 第 4 行，Kuboard v3.x 需要暴露 `80` 端口，如安装指令的第三行所示，默认映射到了宿主机的 `10080` 端口，您可以根据自己的情况选择宿主机的其他端口； +* 第 5、6 行，Kuboard v3.x 需要暴露 `10081` 端口 TCP / UDP，默认映射到了宿主机的 `10081` 端口，您可以根据自己的情况选择宿主机的其他端口； +* 第 7 行，Kuboard v3.x 的持久化数据存储在 `/data` 目录，默认映射到了宿主机的 `/root/kuboard-data` 路径，请根据您自己的情况进行调整； +* 第 8 行，将 Kuboard v3.x 与 GitHub 进行单点登录集成时，必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `github` （适用于 github.com / github-ee）； * 第 9 行，必须指定 `KUBOARD_ENDPOINT` 环境变量为访问 Kuboard 界面的 URL；（如 [部署计划](#部署计划) 中所描述，本例子中，使用 `http://内网IP:10080` 作为通过执行此命令启动的 Kuboard 的访问 URL）；此参数不能以 `/` 结尾； * 第 10、11 行，指定 KUBOARD_AGENT_SERVER 的端口为 `10081`，此参数与第 5、6 行中的宿主机端口应保持一致，修改此参数不会改变容器内监听的端口 `10081`； * 第 12 行，必须指定 `KUBOARD_ROOT_USER`，使用该 GitHub 用户登录到 Kuboard 以后，该用户具备 Kuboard 的所有权限； diff --git a/install/v3/install-gitlab.md b/install/v3/install-gitlab.md index 51ecc8d..67f081c 100644 --- a/install/v3/install-gitlab.md +++ b/install/v3/install-gitlab.md @@ -21,7 +21,7 @@ Kuboard 支持多种认证方式： ## 前提条件 -* 用于安装 Kuboard v3.0 的机器已经安装了 docker，并且版本不低于 docker 19.03 +* 用于安装 Kuboard v3.x 的机器已经安装了 docker，并且版本不低于 docker 19.03 * 您已经有自己的 Kubernetes 集群，并且版本不低于 Kubernetes v1.13 * 您已经安装好了 gitlab-ce 或者 gitlab-ee，又或者您打算直接使用 gitlab.com 中的账号 @@ -100,10 +100,10 @@ sudo docker run -d \ ::: tip 参数说明 * 建议将此命令保存为一个 shell 脚本，例如 `start-kuboard.sh`，后续升级 Kuboard 或恢复 Kuboard 时，需要通过此命令了解到最初安装 Kuboard 时所使用的参数； -* 第 4 行，Kuboard v3.0 需要暴露 `80` 端口，如安装指令的第三行所示，默认映射到了宿主机的 `10080` 端口，您可以根据自己的情况选择宿主机的其他端口； -* 第 5、6 行，Kuboard v3.0 需要暴露 `10081` 端口 TCP / UDP，默认映射到了宿主机的 `10081` 端口，您可以根据自己的情况选择宿主机的其他端口； -* 第 7 行，Kuboard v3.0 的持久化数据存储在 `/data` 目录，默认映射到了宿主机的 `/root/kuboard-data` 路径，请根据您自己的情况进行调整； -* 第 8 行，将 Kuboard v3.0 与 GitLab 进行单点登录集成时，必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `gitlab` （适用于 gitlab.com / gitlab-ee / gitlab-ce）； +* 第 4 行，Kuboard v3.x 需要暴露 `80` 端口，如安装指令的第三行所示，默认映射到了宿主机的 `10080` 端口，您可以根据自己的情况选择宿主机的其他端口； +* 第 5、6 行，Kuboard v3.x 需要暴露 `10081` 端口 TCP / UDP，默认映射到了宿主机的 `10081` 端口，您可以根据自己的情况选择宿主机的其他端口； +* 第 7 行，Kuboard v3.x 的持久化数据存储在 `/data` 目录，默认映射到了宿主机的 `/root/kuboard-data` 路径，请根据您自己的情况进行调整； +* 第 8 行，将 Kuboard v3.x 与 GitLab 进行单点登录集成时，必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `gitlab` （适用于 gitlab.com / gitlab-ee / gitlab-ce）； * 第 9 行，必须指定 `KUBOARD_ENDPOINT` 环境变量为访问 Kuboard 界面的 URL；（如 [部署计划](#部署计划) 中所描述，本例子中，使用 `http://内网IP:10080` 作为通过执行此命令启动的 Kuboard 的访问 URL）；此参数不能以 `/` 结尾； * 第 10、11 行，指定 KUBOARD_AGENT_SERVER 的端口为 `10081`，此参数与第 5、6 行中的宿主机端口应保持一致，修改此参数不会改变容器内监听的端口 `10081`； * 第 12 行，必须指定 `KUBOARD_ROOT_USER`，使用该 GitLab 用户登录到 Kuboard 以后，该用户具备 Kuboard 的所有权限； diff --git a/install/v3/install-ldap.md b/install/v3/install-ldap.md index 1c7372e..41218ac 100644 --- a/install/v3/install-ldap.md +++ b/install/v3/install-ldap.md @@ -22,7 +22,7 @@ Kuboard 支持多种认证方式： ## 前提条件 -* 用于安装 Kuboard v3.0 的机器已经安装了 docker，并且版本不低于 docker 19.03 +* 用于安装 Kuboard v3.x 的机器已经安装了 docker，并且版本不低于 docker 19.03 * 您已经有自己的 Kubernetes 集群，并且版本不低于 Kubernetes v1.13 ## 部署计划 @@ -170,10 +170,10 @@ sudo docker run -d \ ::: tip 参数说明 * 建议将此命令保存为一个 shell 脚本，例如 `start-kuboard.sh`，后续升级 Kuboard 或恢复 Kuboard 时，需要通过此命令了解到最初安装 Kuboard 时所使用的参数； -* 第 4 行，Kuboard v3.0 需要暴露 `80` 端口，如安装指令的第三行所示，默认映射到了宿主机的 `10080` 端口，您可以根据自己的情况选择宿主机的其他端口； -* 第 5、6 行，Kuboard v3.0 需要暴露 `10081` 端口 TCP / UDP，默认映射到了宿主机的 `10081` 端口，您可以根据自己的情况选择宿主机的其他端口； -* 第 7 行，Kuboard v3.0 的持久化数据存储在 `/data` 目录，默认映射到了宿主机的 `/root/kuboard-data` 路径，请根据您自己的情况进行调整； -* 第 8 行，将 Kuboard v3.0 与 GitLab 进行单点登录集成时，必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `gitlab` （适用于 gitlab.com / gitlab-ee / gitlab-ce）； +* 第 4 行，Kuboard v3.x 需要暴露 `80` 端口，如安装指令的第三行所示，默认映射到了宿主机的 `10080` 端口，您可以根据自己的情况选择宿主机的其他端口； +* 第 5、6 行，Kuboard v3.x 需要暴露 `10081` 端口 TCP / UDP，默认映射到了宿主机的 `10081` 端口，您可以根据自己的情况选择宿主机的其他端口； +* 第 7 行，Kuboard v3.x 的持久化数据存储在 `/data` 目录，默认映射到了宿主机的 `/root/kuboard-data` 路径，请根据您自己的情况进行调整； +* 第 8 行，将 Kuboard v3.x 与 GitLab 进行单点登录集成时，必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `gitlab` （适用于 gitlab.com / gitlab-ee / gitlab-ce）； * 第 9 行，必须指定 `KUBOARD_ENDPOINT` 环境变量为访问 Kuboard 界面的 URL；（如 [部署计划](#部署计划) 中所描述，本例子中，使用 `http://内网IP:10080` 作为通过执行此命令启动的 Kuboard 的访问 URL）；此参数不能以 `/` 结尾； * 第 10、11 行，指定 KUBOARD_AGENT_SERVER 的端口为 `10081`，此参数与第 5、6 行中的宿主机端口应保持一致，修改此参数不会改变容器内监听的端口 `10081`； * 第 12 行，必须指定 `KUBOARD_ROOT_USER`，使用该 GitLab 用户登录到 Kuboard 以后，该用户具备 Kuboard 的所有权限； diff --git a/install/v3/install.md b/install/v3/install.md index ee61104..d948c5c 100644 --- a/install/v3/install.md +++ b/install/v3/install.md @@ -10,11 +10,11 @@ meta: -## Kuboard v3.0 版本说明 +## Kuboard v3.x 版本说明 -Kuboard v3.0 支持 Kubernetes 多集群管理。如果您从 Kuboard v1.0.x 或者 Kuboard v2.0.x 升级到 Kuboard，请注意： -* 您可以同时使用 Kuboard v3.0.x 和 Kuboard v2.0.x； -* Kuboard v3.0.x 支持 amd64 (x86) 架构和 arm68 (armv8) 架构的 CPU； +Kuboard v3.x 支持 Kubernetes 多集群管理。如果您从 Kuboard v1.0.x 或者 Kuboard v2.0.x 升级到 Kuboard，请注意： +* 您可以同时使用 Kuboard v3.x 和 Kuboard v2.0.x； +* Kuboard v3.x 支持 amd64 (x86) 架构和 arm68 (armv8) 架构的 CPU； 点击此处可以查看 @@ -23,16 +23,16 @@ Kuboard v3.0 支持 Kubernetes 多集群管理。如果您从 Kuboard v1.0.x 或 | Kubernetes 版本 | Kuboard 版本 | 兼容性 | 说明 | | --------------- | -------------- | ------ | ------------------------------------------------------------ | -| v1.20 | v3.0.x | 😄 | 已验证 | -| v1.19 | v3.0.x | 😄 | 已验证 | -| v1.18 | v3.0.x | 😄 | 已验证 | -| v1.17 | v3.0.x | 😄 | 已验证 | -| v1.16 | v3.0.x | 😄 | 已验证 | -| v1.15 | v3.0.x | 😄 | 已验证 | -| v1.14 | v3.0.x | 😄 | 已验证 | -| v1.13 | v3.0.x | 😄 | 已验证 | -| v1.12 | v3.0.x | 😐 | Kubernetes Api v1.12 不支持 dryRun，
Kuboard 不支持 Kubernetes v1.12 | -| v1.11 | v3.0.x | 😐 | Kuboard 不支持 Kubernetes v1.11 | +| v1.20 | v3.x | 😄 | 已验证 | +| v1.19 | v3.x | 😄 | 已验证 | +| v1.18 | v3.x | 😄 | 已验证 | +| v1.17 | v3.x | 😄 | 已验证 | +| v1.16 | v3.x | 😄 | 已验证 | +| v1.15 | v3.x | 😄 | 已验证 | +| v1.14 | v3.x | 😄 | 已验证 | +| v1.13 | v3.x | 😄 | 已验证 | +| v1.12 | v3.x | 😐 | Kubernetes Api v1.12 不支持 dryRun，
Kuboard 不支持 Kubernetes v1.12 | +| v1.11 | v3.x | 😐 | Kuboard 不支持 Kubernetes v1.11 | ## 安装方式 @@ -45,12 +45,12 @@ Kuboard v3.0 支持 Kubernetes 多集群管理。如果您从 Kuboard v1.0.x 或 Kuboard 作为一个管理界面，通常单节点部署就可以满足可用性方面的要求，如果您期望您安装的 Kuboard 获得更高的可用性，请考虑：[将 Kuboard 安装到 Kubernetes 集群中](./install-in-k8s.html) -## 从 v2.0.x 升级到 v3.0.x +## 从 v2.0.x 升级到 v3.x -与 v2.0.x 相比，v3.0.x 不再部署在 Kubernetes 中，而是作为一个独立的容器运行。 +与 v2.0.x 相比，v3.x 不再部署在 Kubernetes 中，而是作为一个独立的容器运行。 -* 由于运行模式不同，v2.0.x 与 v3.0.x 可以同时存在互不干扰。 +* 由于运行模式不同，v2.0.x 与 v3.x 可以同时存在互不干扰。 -* Kuboard v3.0.x 将 Kuboard 部署的大部分内容从 kube-system 名称空间迁移到 kuboard 名称空间，这也使得两个版本能够同时存在于同一个 Kubernetes 集群。 +* Kuboard v3.x 将 Kuboard 部署的大部分内容从 kube-system 名称空间迁移到 kuboard 名称空间，这也使得两个版本能够同时存在于同一个 Kubernetes 集群。 * 如果您最终决定从 Kuboard v2.0.x 迁移到 Kuboard v3，请在 Kuboard v2.0.x 的界面中卸载掉 Kuboard 套件，并在 Kuboard v3 中重新安装 Kuboard 套件。