docs: update to v1.3.1

tkestack · Aug 24, 2020 · f649c2e · f649c2e
1 parent e12f2d3
commit f649c2e
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@
 
 ```shell
 # Choose installation package according to your installation node CPU architecture [amd64, arm64]
-arch=amd64 version=v1.3.0 && wget https://tke-release-1251707795.cos.ap-guangzhou.myqcloud.com/tke-installer-linux-$arch-$version.run{,.sha256} && sha256sum --check --status tke-installer-linux-$arch-$version.run.sha256 && chmod +x tke-installer-linux-$arch-$version.run && ./tke-installer-linux-$arch-$version.run
+arch=amd64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzhou.myqcloud.com/tke-installer-linux-$arch-$version.run{,.sha256} && sha256sum --check --status tke-installer-linux-$arch-$version.run.sha256 && chmod +x tke-installer-linux-$arch-$version.run && ./tke-installer-linux-$arch-$version.run
 ```
 
 3. **Configure Console:** Open your browser to http:https://`INSTALLER-NODE-IP`:8080/index.html, the Web GUI will guide you to initialize and install the TKEStack's **Global Cluster and Console**. You can refer to [installation-procedures](docs/guide/zh-CN/installation/installation-procedures.md)

diff --git a/docs/guide/zh-CN/QuickStart/快速入门.md b/docs/guide/zh-CN/QuickStart/快速入门.md
@@ -90,7 +90,6 @@ TKEStack还可以另外**新建独立集群**以及**导入已有集群**实现*
 - **名称**： 被导入集群的名称，最长60字符
 - **API Server**： 
  - 被导入集群的API server的域名或IP地址，注意域名不能加上https://
- - 端口，此处用的是https协议，端口应填443。
 - **CertFile**： 输入被导入集群的cert 文件内容
 - **Token**： 输入被导入集群创建时的token值
 

diff --git a/docs/guide/zh-CN/README.md b/docs/guide/zh-CN/README.md
@@ -17,6 +17,7 @@
  [切换控制台](products/controlpannel.md)
 
  * [平台侧](products/platform)
+ * [概览](products/platform/overview.md)
  * [集群管理](products/platform/cluster.md)
  * [业务管理](products/platform/business.md)
  * [扩展组件](products/platform/extender.md)

diff --git a/docs/guide/zh-CN/installation/installation-procedures.md b/docs/guide/zh-CN/installation/installation-procedures.md
@@ -6,7 +6,7 @@
 
 ## 2. Installer安装
 
-为了简化平台安装过程，容器服务开源版基于 tke-installer 安装器提供了一个向导式的图形化安装指引界面。
+为了简化平台安装过程，TKEStack基于 tke-installer 安装器提供了一个向导式的图形化安装指引界面。
 
 在您 Installer 节点的终端，执行如下脚本：
 
@@ -69,7 +69,7 @@ arch=arm64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzho
 
 ![img](../../../images/step-3-2.png)
 
-* **高级设置**（非必须）：可以自定义 Global 集群的 Docker、kube-apiserver、kube-controller-manager、kube-scheduler、kubelet 运行参数
+* **高级设置**（非必须）：可以自定义 Global 集群的 Docker、kube-apiserver、kube-controller-manager、kube-scheduler、kubelet 运行参数，查看对应的帮助文档链接可获取详细信息。
 
 3. 填写 TKEStack 控制台认证信息。（建议使用**TKE提供**）
 
@@ -116,7 +116,7 @@ arch=arm64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzho
 
 ![img](../../../images/step-8.png)
 
-9. 开始安装 TKEStack 控制台，安装成功后界面如下，最下面出现【查看指引】的按钮。
+9. 开始安装 TKEStack 控制台，**安装需要30min左右，请耐心等待**。安装成功后界面如下，最下面出现【查看指引】的按钮。
 
 ![img](../../../images/step-9.png)
 

diff --git a/docs/guide/zh-CN/installation/installation-requirement.md b/docs/guide/zh-CN/installation/installation-requirement.md
@@ -4,9 +4,10 @@
 
 > **特别注意**：
 >
-> 1. 安装的时候，至少需要**一个Installer节点**和**一个作为Global集群的master节点**。业务集群的节点是在部署完Global集群的master节点之后再添加的。
-> 2. **Installer节点**：是单独的用作安装的节点，不能作为Global集群的节点使用。因为在安装Global集群时，需要多次重启docker，此时如果Global集群里面有Installer节点，重启docker会中断Global集群的安装。该节点需要一台**系统盘100G**的机器，系统盘要保证剩余**50GB可用的空间**，all-in-one模式还需要更多的空间。
+> 1. 安装的时候，至少需要**一个Installer节点**和**一个作为Global集群的master节点**。**v1.3.0之后的版本可直接使用all-in-one的安装模式，此时installer节点也可以作为global集群的节点。**但注意：此时Installer的节点配置要以global集群的节点配置为准，否则Installer节点配置太低很容易安装失败。
+> 2. **Installer节点**：是单独的用作安装的节点，不能作为Global集群的节点使用。（**v1.3.0之后支持作为global集群的节点使用，但注意此时Installer节点配置已global集群的节点为准**）因为在安装Global集群时，需要多次重启docker，此时如果Global集群里面有Installer节点，重启docker会中断Global集群的安装。该节点需要一台**系统盘100G**的机器，系统盘要保证剩余**50GB可用的空间**。
 > 3. **Global集群**：至少需要一台**8核16G内存，100G系统盘**的机器。
+> 4. **业务集群**：业务集群是在部署完Global集群之后再添加的。
 
 
 * **最小化部署配置：**
@@ -52,10 +53,6 @@
  </tr>
  </table>
 
-
-
-
-
 * **推荐配置：**
 
 <table>
@@ -104,8 +101,6 @@
 
 ## 软件要求
 
-
-
 > **注意，以下要求针对所有节点。**
 
 | 需求项 | 具体要求 | 参考<br>（以CentOS7.6为例） |

diff --git a/docs/guide/zh-CN/products/platform/business.md b/docs/guide/zh-CN/products/platform/business.md
@@ -2,8 +2,7 @@
 ## 概念
 **在这里用户可以管理线上业务。**
 
-## 操作步骤
-### 新建业务
+## 新建业务
 
 > 注：业务可以实现跨集群资源的使用
 
@@ -23,30 +22,23 @@
 
 4. 单击最下方 【完成】 按钮即可创建业务。
 
-### 添加业务成员
+## 添加业务成员
 1. 登录 TKEStack。
 2. 切换至 【平台管理】控制台，点击【业务管理】。
 3. 在“业务管理”页面中，可以看到已创建的业务列表。鼠标移动到要修改的业务上(无需点击)，成员列会出现修改图标按钮。如下图所示：
  ![修改图标按钮](../../../../images/修改业务成员图标.png)
 
  > 注意：修改业务成员仅限状态为Active的业务，这里可以新建和删除成员。
 
-### 查看业务监控
+## 查看业务监控
 1. 登录 TKEStack。
 2. 切换至 【管理】控制台，点击【业务管理】。
 3. 在“业务管理”页面中，可以看到已创建的业务列表。点击监控按钮，如下图所示：
 ![监控按钮](../../../../images/查看业务监控.png)
 5. 在右侧弹出窗口里查看业务监控情况，如下图所示：
 ![业务监控详情](../../../../images/业务监控详情.png)
 
-### 删除业务
-1. 登录 TKEStack。
-2. 切换至 【平台管理】控制台，点击【业务管理】。
-3. 在“业务管理”页面中，可以看到已创建的业务列表。点击删除按钮，如下图所示：
-![删除业务](../../../../images/删除业务.png)
-> 注意：删除业务成员仅限状态为Active的业务
-
-### 对业务的操作
+## 对业务的操作
 
 1. 登录 TKEStack。
 
@@ -56,7 +48,7 @@
 
  ![业务信息](../../../../images/业务信息1.png)
 
- b. **成员列表：** 在这里可以对业务名称、关联的集群、关联集群的资源进行限制等操作。
+ b. **成员列表：** 在这里可以管理用户的用户，可以新增或删除用户，可以调整用户对该业务的角色权限等操作。
 
  ![业务信息](../../../../images/成员列表设置.png)
 
@@ -76,4 +68,13 @@
 
   **集群**：`my-business`业务中的集群，这里以`global`集群为例
 
-  *资源限制**：这里可以限制当前命名空间下各种资源的使用量，可以不设置。
+  **资源限制**：这里可以限制当前命名空间下各种资源的使用量，可以不设置。
+
+## 删除业务
+
+1. 登录 TKEStack。
+2. 切换至 【平台管理】控制台，点击【业务管理】。
+3. 在“业务管理”页面中，可以看到已创建的业务列表。点击删除按钮，如下图所示：
+ ![删除业务](../../../../images/删除业务.png)
+
+> 注意：删除业务成员仅限状态为Active的业务
diff --git a/docs/guide/zh-CN/products/platform/cluster.md b/docs/guide/zh-CN/products/platform/cluster.md
@@ -1,11 +1,9 @@
 # 集群管理
 
-# 概念
+## 概念
 **在这里可以管理你的 Kubernetes 集群。**
 
-> 注意：由于【平台管理】控制台下对集群的大多数操作与【业务管理】控制台完全一致，因此除了集群的【基本信息】和【节点管理】之外，其他栏目（包括命名空间、负载、服务、配置、存储、日志、事件）请参考【业务管理】控制台下[相应部分](../business-control-pannel/application)
-
-# 操作步骤
+> 注意：由于【平台管理】控制台下对集群的大多数操作与【业务管理】控制台完全一致，因此除了集群的【基本信息】和【节点管理】之外，其他栏目（包括命名空间、负载、服务、配置、存储、日志、事件）请参考【业务管理】控制台下相应部分.
 
 平台安装之后，可在【平台管理】控制台的【集群管理】中看到global集群。如下图所示：
  ![Global集群](../../../../images/cluster.png)
@@ -84,11 +82,11 @@ TKEStack还可以另外**新建独立集群**以及**导入已有集群**实现*
 
 - **名称**： 被导入集群的名称，最长60字符
 - **API Server**： 
- - 被导入集群的API server的域名或IP地址
+ - 被导入集群的API server的域名或IP地址，必须是以https开头
 - **CertFile**： 输入被导入集群的cert 文件内容
 - **Token**： 输入被导入集群创建时的token值
 
-1. 单击最下方 【提交】 按钮 。
+5. 单击最下方 【提交】 按钮 。
 
 ## **对集群的操作**
 
@@ -113,7 +111,7 @@ TKEStack还可以另外**新建独立集群**以及**导入已有集群**实现*
  5. 网卡名称
  6. 容器网络
  7. 集群凭证：在本地主机安装kubectl后，可用过用户名密码或集群CA证书登陆到集群。
- 8. 超售比：Kubernetes对象在申请资源时，如果申请总额大于硬件配置，则无法申请，但是很多时候部分对象并没有占用这么多资源，因此可以设置超售比来扩大资源申请总额，以提高硬件资源利用率。可通过超售比最后面的笔的符号对超售比更改
+ 8. 超售比：Kubernetes对象在申请资源时，如果申请总额大于硬件配置，则无法申请，但是很多时候部分对象并没有占用这么多资源，因此可以设置超售比来扩大资源申请总额，以提高硬件资源利用率。
  9. 创建时间
 
 #### 节点管理
@@ -167,4 +165,8 @@ TKEStack还可以另外**新建独立集群**以及**导入已有集群**实现*
  2. 远程登录：登录到该pod的shell里
  2. 事件：关于该节点上资源的事件
  3. 详情：包括节点主机信息以及Kubernetes信息
- 4. YAML：节点的YAML文件
+ 4. YAML：节点的YAML文件
+
+#### 其他操作
+
+注意：由于【平台管理】控制台下对集群的大多数操作与【业务管理】控制台完全一致，因此除了集群的【基本信息】和【节点管理】之外，其他栏目（包括命名空间、负载、服务、配置、存储、日志、事件）请参考【业务管理】控制台下相应部分.
diff --git a/docs/guide/zh-CN/products/platform/extender.md b/docs/guide/zh-CN/products/platform/extender.md
@@ -3,8 +3,7 @@
 ## 概念
 **这里用户可以管理集群扩展组件。**
 
-## 操作步骤
-### 创建组件
+## 创建组件
  1. 登录 TKEStack。
 
  2. 切换至 【平台管理】控制台，选择【扩展组件】页面。

diff --git a/docs/guide/zh-CN/products/platform/overview.md b/docs/guide/zh-CN/products/platform/overview.md
@@ -0,0 +1,13 @@
+# 概览
+
+平台概览页面，可查看TKEStack控制台管理资源的概览。
+
+如下图所示，在【平台管理】页面点击【概览】，此处可以展现：
+
+1. 平台的资源概览
+2. 集群的资源状态
+3. 快速入口
+4. 实用提示
+
+![image-20200821171320826](../../../../images/overview.png)
+
diff --git a/docs/images/overview.png b/docs/images/overview.png