description

guide/README.md

@@ -1,3 +1,7 @@
+---
+description: 熟悉 Kuboard on Kubernetes 的最佳途径。
+---
+
 # 使用手册
 
 **Kuboard 的设计目标**

guide/cluster/computing.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 管理 Kubernetes 计算节点
+---
+
 # 计算资源管理
 
 ## 前提
@@ -45,4 +49,4 @@
 >   kubadm reset
 >   ```
 >
->   
+>   

guide/cluster/namespace.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 管理 Kubernetes 名称空间。
+---
+
 # 名称空间管理
 
 ## 创建名称空间
@@ -48,4 +52,4 @@
 
   点击 *example* 名称空间后，可进入该名称空间的页面。刚刚初始化的名称空间的界面布局如下图所示：
 
-![image-20190723105830318](./namespace-create.assets/image-20190723105830318.png)
+![image-20190723105830318](./namespace-create.assets/image-20190723105830318.png)

guide/cluster/storage.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 管理 Kubernetes 存储类 Storage Class
+---
+
 # 存储空间管理
 
 ## 创建存储类
@@ -137,4 +141,4 @@
 
   此时可在存储资源列表中查看到刚创建的存储类
 
-![image-20190723113312360](./storage-create.assets/image-20190723113312360.png)
+![image-20190723113312360](./storage-create.assets/image-20190723113312360.png)

guide/diagonize/events.md

@@ -1,6 +1,10 @@
+---
+description: 使用 Kuboard 监听 Kubernetes 集群的最新事件，并通过这些事件对 Kubernetes 运行时的问题进行诊断。
+---
+
 # 集群事件
 
-通过观察 KUberetes 集群事件，可以快速诊断部署时发生的问题。
+通过观察 Kuberetes 集群事件，可以快速诊断部署时发生的问题。
 
 Kuboard 建立了与 kubernetes apiserver 的长连接，可以在第一时间将集群中的事件更新以通知的形式显示在 dashboad 上。
 
@@ -43,4 +47,3 @@ Kuboard 建立了与 kubernetes apiserver 的长连接，可以在第一时间
 容器组信息中包含了与该容器组相关的所有集群事件。
 
 ![image-20190721103324863](./events.assets/image-20190721103324863.png)
-

guide/diagonize/logs.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 打开并跟踪容器组的最新日志，以便对 Kubernetes 上容器组的最新运行情况进行了解和诊断问题。
+---
+
 # 日志及终端
 
 
@@ -32,4 +36,3 @@
   >   * vi 命令，临时修改容器内应用程序的配置，并在容器内重启应用程序，以临时性的尝试修复问题，如果有效再将修改更新到应用程序代码或者 Dockerfile
 
 ![image-20190721104522870](./logs.assets/image-20190721104522870.png)
-

guide/diagonize/port-forward.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 对 Kubernetes 上容器组的端口进行转发。
+---
+
 # 端口转发
 
 微服务环境中，各个服务都通过 TCP / UDP 端口的形式提供访问。按调用者所在位置、通信协议的形式来划分，大致有如下几种情况：
@@ -24,4 +28,3 @@
 
 
 Kuboard 计划实现类似 kubectl port-forward 的功能，提高问题诊断过程中的便利性。
-

guide/example/busybox.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 向 Kubernetes 部署一个最简单的 Deployment
+---
+
 # 部署 busybox
 
 ## 前提
@@ -100,4 +104,3 @@ Busybox 是一个非常小巧（不到5M）的容器，此处用它来展示如
   输入 *export* 并回车后，可查看该容器当前的环境变量。您也可以在终端中执行任何容器内部的命令。在您完成容器的部署之后，终端界面是非常有效的问题诊断工具之一。
 
 ![image-20190723120125425](./busybox.assets/image-20190723120125425.png)
-

guide/example/import.md

@@ -1,3 +1,7 @@
+---
+description: 通过 Kuboard 将一个预先定义好的 Spring Cloud 微服务样例程序导入到 Kubernetes 中。
+---
+
 # 导入 example 微服务
 
 ## 前提
@@ -148,4 +152,3 @@ example中用到了存储卷声明，请在 Kuboard 中 [创建存储类](/guide
 > ```
 >
 > 
-

guide/example/monitor.md

@@ -1,4 +1,6 @@
-
+---
+description: 使用 Kuboard 在 Kubernetes 上安装监控套件，并对 example 微服务实现资源层监控、中间件层监控、链路追踪和 APM 监控
+---
 
 # 监控 example <Badge text="alpha" type="warn"/>
 
@@ -212,4 +214,4 @@ kubectl -n kube-system create secret generic etcd-certs --from-file=/etc/kuberne
 
 
 
-![image-20190718121133160](./monitor.assets/image-20190718121133160.png)
+![image-20190718121133160](./monitor.assets/image-20190718121133160.png)

guide/monitor/README.md

@@ -1,6 +1,10 @@
+---
+description: Kubernetes 监控套件
+---
+
 # 监控套件 <Badge text="alpha" type="warn"/>
 
 文档建设中...
 
 > * 请参考 [监控 example](/guide/example/monitor.html) <Badge text="alpha" type="warn"/> 体验 Kuboard 在监控套件方面的设想
-> * 监控套件以插件的形式整合到 Kuboard，在不使用监控套件的情况下，Kuboard 的所有功能都可正常工作
+> * 监控套件以插件的形式整合到 Kuboard，在不使用监控套件的情况下，Kuboard 的所有功能都可正常工作

guide/monitor/apis.md

@@ -1,6 +1,10 @@
+---
+description: 如何基于 Kuboard API 实现自定义的 Kubernetes 监控套件
+---
+
 # 自定义监控套件 <Badge text="alpha" type="warn"/>
 
 文档建设中...
 
 > * 请参考 [监控 example](/guide/example/monitor.html) <Badge text="alpha" type="warn"/> 体验 Kuboard 在监控套件方面的设想
-> * 监控套件以插件的形式整合到 Kuboard，在不使用监控套件的情况下，Kuboard 的所有功能都可正常工作
+> * 监控套件以插件的形式整合到 Kuboard，在不使用监控套件的情况下，Kuboard 的所有功能都可正常工作

guide/namespace/adjustion.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 对 Kubernetes 进行日常调整，包括：批量删除容器组、批量调整镜像版本、批量调整工作负载数
+---
+
 # 日常调整
 
 
@@ -117,4 +121,3 @@
 ***调整容器镜像版本*** 的功能界面中，也可以用来调整工作负载的副本数，如下图所示：
 
 ![image-20190721100715898](./adjustion.assets/image-20190721100715898.png)
-

guide/namespace/configMap.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 配置 Kubernetes ConfigMap
+---
+
 # 配置
 
 配置： Kubernetes ConfigMap
@@ -44,4 +48,4 @@
 
 ![image-20190721113155991](./configMap.assets/image-20190721113155991.png)
 
-编辑、删除操作可直接按照提示完成
+编辑、删除操作可直接按照提示完成

guide/namespace/multi-env.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 将 Kubernetes 名称空间中安装的应用程序配置导出成 YAML 文件，并在一个新的环境中导入。
+---
+
 # 多环境
 
 在实际开发项目的过程中，我们必然会碰到如下场景：
@@ -108,5 +112,3 @@ Kuboard 针对这种场景，提供了导出配置、导入配置的功能，以
 ### 操作步骤
 
 请参考 [导入 example 微服务](/guide/example/import)
-
-

guide/namespace/pvc.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 配置 Kubernetes 的存储卷声明 Persistent Volume Claim
+---
+
 # 存储卷声明
 
 存储卷声明： Kubernetes Persistent Volume Claim
@@ -48,4 +52,4 @@
 
 
 
-编辑、删除操作可直接按照提示完成
+编辑、删除操作可直接按照提示完成

guide/namespace/secrets.md

@@ -1,3 +1,7 @@
+---
+description: 使用 Kuboard 配置 Kubernetes Secrets
+---
+
 # Secrets
 
 
@@ -53,4 +57,4 @@ Secrets 列表位于图中左上角，点击 ***放大*** 按钮，可以将列
 
 
 
-编辑、删除操作可直接按照提示完成
+编辑、删除操作可直接按照提示完成

guide/namespace/workload.md

@@ -1,3 +1,7 @@
+---
+description: Kuboard on Kubernetes 工作负载编辑器，无需编写 YAML 文件即可完成 Kubernetes 配置和管理。
+---
+
 # 工作负载
 
 
@@ -128,4 +132,3 @@
 
 * 通过 ls / cat / vi 等命令，查看该容器是否包含了最新的代码变更
 * 通过 vi 等命令，临时对容器中的配置文件进行修改，并在验证这种修改有效之后，才将其正式更新到代码库
-