redactor register center of cluster (DataLinkDC#2745)

docs/docs/administrator_guide/register_center/cluster_manage.md

@@ -1,104 +1,164 @@
 ---
 position: 1
 id: cluster_manage
-title: 集群管理
+title: 集群
 ---
 
+# 集群管理
 
-提交 FlinkSQL 作业时，首先要保证安装了 Flink 集群。Flink 当前支持的集群模式包括：
+:::warning 注意
 
-- Standalone 集群
-- Yarn 集群
-- Kubernetes 集群
+在 Dinky，将 Flink 运行模式拆分为了 `Flink实例` 和 `集群配置` 两个概念。请按需选择使用。
+
+:::
+
+## Flink实例
+
+> Flink实例是指已经启动的 Flink 集群
+
+> Flink实例仅可以注册模式为 Local, Standalone, Yarn Session, Kubernetes Session 的 Flink 实例
 
-对于以上的三种集群而言，Dinky 为用户提供了两种集群管理方式，一种是集群实例管理，一种是集群配置管理。
 
-:::tip 说明
+:::warning 注意
 
-- Standalone 集群适用于既可以做为查询使用，又可以将作业异步提交到远程集群
-- Yarn Session 和 Kubernetes Session 适用于既可以做为查询使用，又可以将作业异步提交到远程集群
-- Yarn Per-job，Yarn Application 和 Kubernetes Application 适用于异步提交
+1. 在 Flink 实例中，仅可以注册模式为 Local, Standalone, Yarn Session, Kubernetes Session 的 Flink 实例
+2. 在 Flink 实例中，区分了自动注册和手动注册两种方式，手动启动的 Flink 实例需要手动注册, 由`集群配置/application模式`任务启动后的 Flink 实例会自动注册
+3. 自动注册的集群无需关心注册过多的情况, 系统会定时清理过期的 自动注册的 Flink 实例,手动注册的无影响
+4. 手动注册的集群需要手动管理 Flink 实例, 如需删除 Flink 实例，请鼠标悬浮某一 Flink 实例，点击删除按钮即可删除 Flink 实例
+5. 提供手动进行心跳检测
 
+如需查看 自动注册 和 手动注册 下的 Flink 实例，请点击切换按钮进行查看
 :::
 
-## 集群实例管理
+### 手动注册
 
-集群实例管理适用于 Standalone，Yarn Session 和 Kubernetes Session 这三种集群实例的注册。
+![cluster_instance_m_list](http://www.aiwenmo.com/dinky/docs/test/cluster_instance_m_list.png)
 
-对于已经注册的集群实例，您可以对集群实例做编辑、删除、搜索、心跳检测和回收等。
+### 自动注册
 
-### 注册集群实例
+![cluster_instance_a_list](http://www.aiwenmo.com/dinky/docs/test/cluster_instance_a_list.png)
 
-**注册中心 > 集群管理 > 集群实例管理 > 新建**
 
-![cluster_manager_list](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator_guide/register_center/cluster_manage/cluster_manager_list.png)
 
-![create_flink_cluster](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator_guide/register_center/cluster_manage/create_flink_cluster.png)
 
-**参数配置说明：** 
 
-- **名称：** 自定义(必填)
-- **别名：** 自定义，默认同名称
-- **类型：** 支持 Standalone，Yarn Session 和 Kubernetes Session 三种类型的集群提交任务，其他类型的集群只能查看作业信息
-- **JobManager HA地址：** JobManager 的 RestAPI 地址，当 HA 部署时，将可能出现的多个 RestAPI 地址均写入，且采用英文逗号隔开
-- **注释：** 自定义
+### 参数解读
 
+| 参数              | 说明                                                                          | 是否必填 |  默认值  |      示例值      |
+|-----------------|-----------------------------------------------------------------------------|:----:|:-----:|:-------------:|
+| 集群名称            | 集群名称, 用于区分不同集群                                                              |  是   |   无   | flink-session |
+| 集群别名            | 集群别名, 用于区分不同集群, 如不填默认同集群名称                                                  |  否   | 同集群名称 | flink-session |
+| 集群类型            | 集群类型, 目前支持 Local, Standalone, Yarn Session, Kubernetes Session              |  是   |   无   |  Standalone   |
+| JobManger 高可用地址 | 添加 Flink 集群的 JobManager 的 RestApi 地址。当 HA 模式时，地址间用英文逗号分隔，例如：192.168.123.101 |  是   |   无   |
+| 备注              | 备注, 用于备注集群信息                                                                |  否   |   无   | flink-session |
 
 
-## 集群配置管理
+## 集群配置
 
-集群配置管理适用于 Yarn Per-job、Yarn Application 和 Kubernetes Application 这三种类型配置。
+> 集群配置是指 预先定义的 Flink 集群配置, 用于提交 Flink 作业时,会自动启动 Flink 集群
 
-对于已经注册的集群配置，您可以对集群配置做编辑、删除和搜索等。
+> 集群配置仅可以注册模式为 Yarn Per-Job, Yarn Application, Kubernetes Application 的 Flink 实例
 
-### 集群配置
+:::warning 注意
 
-单击**注册中心 > 集群管理 > 集群配置管理 > 新建 **
+1. 在集群配置中，仅可以注册模式为 Yarn(可用于Yarn Per-Job, Yarn Application)，Kubernetes Native，Kubernetes Operator的 Flink 配置
+2. 在此模式中支持可以以配置方式 启动一个 YarnSession/KubernetesSession 的 Flink实例, 启动成功后,会自动注册到 `Flink实例` 中
+3. 支持手动心跳检测
 
-![create_cluster_config_1](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator_guide/register_center/cluster_manage/create_cluster_config_1.png)
+注意: 在集群配置中,如果使用Yarn 模式,需要有 Hadoop 与 Flink 集成的 jar 包,如果使用Kubernetes 模式,需要有Flink运行时的jar包,否则会导致启动失败,如遇到依赖加载问题,请查看详细日志进行排查
+:::
 
-![create_cluster_config_2](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator_guide/register_center/cluster_manage/create_cluster_config_2.png)
+### 集群配置列表
 
-**参数配置说明:**
+![cluster_config_list](http://www.aiwenmo.com/dinky/docs/test/cluster_config_list.png)
 
-- **类型：** 支持 Flink on Yarn 和 Flink on Kubernetes
-- **hadoop 配置**
-  - **配置文件路径：** hadoop 配置文件路径，指定配置文件路径（末尾无/），需要包含以下文件：core-site.xml,hdfs-site.xml,yarn-site.xml
-  - **自定义配置（高优先级，目前不生效，请跳过）**
-    - **ha.zookeeper.quorum：** zookeeper 访问地址
-    - **其他配置：** hadoop 的其他参数配置（默认不填写）
-- **Flink 配置**
-  - **lib 路径：** 指定 lib 的 hdfs 路径（末尾无/），需要包含 Flink 运行时的依赖
-  - **配置文件路径：** 指定 flink-conf.yaml 的具体路径（末尾无/），必填
-  - **自定义配置（高优先级）：** Flink参数配置
-- **基本配置**
-  - **标识:** 唯一英文标识（必填）
-  - **名称:** 自定义，默认同标识
-  - **注释:** 自定义
-  - **是否启用:** 默认禁用，需要开启
+### 参数解读
 
-## 查看集群信息
 
-创建集群后可在**集群实例管理**后者**集群配置**中查看集群信息。
+- 基本配置-公共配置
 
-集群信息相关字段含义如下：
+| 参数     | 说明                                                     | 是否必填 | 默认值 |    示例值     |
+|--------|--------------------------------------------------------|:----:|:---:|:----------:|
+| 类型     | 集群类型, 目前支持 Yarn, Kubernetes Native，Kubernetes Operator |  是   |  无  |  Yarn |
+| 集群配置名称 | 集群配置名称, 用于区分不同集群配置                                     |  是   |  无  | flink-yarn |
+| 备注     | 描述信息                                                   |  否   |  无  |  |
+| 是否启用   | 标志是否启用该集群配置,如果不启用，则该集群配置不会在数据开发集群列表下拉框中显示              |  是   |  无  |  |
 
-|      字段      |                             说明                             |
-| :------------: | :----------------------------------------------------------: |
-|      名称      |                         名称是唯一的                         |
-|      别名      |                            自定义                            |
-|      类型      | Standalone<br/>Yarn Session<br/>Yarn Per-job<br/>Yarn Application<br/>Kubernetes Session<br/>Kubernetes Application |
-| JobManager地址 |                         Rest API地址                         |
-|      版本      |                          Flink 版本                          |
-|      状态      |                        正常<br/> 异常                        |
-|    是否启用    |                      已启用<br/> 已禁用                      |
-|    注册方式    |                        手动<br/> 自动                        |
-|  最近更新时间  |                       集群信息修改时间                       |
-|      操作      |                    对集群做编辑、删除操作                    |
+- 提交 FlinkSQL 配置项 (Application 模式必填)-公共配置
 
-:::warning 注意事项
+| 参数     | 说明                                                                                                       | 是否必填 | 默认值 |      示例值       |
+|--------|----------------------------------------------------------------------------------------------------------|:----:|:---:|:--------------:|
+| Jar 文件路径     | 指定 Jar 文件路径,如果该集群配置用于提交 Application 模式任务时 则必填<br/>需要包含以下文件：dinky-app-{version}-jar-with-dependencies.jar |  否   |  无  | hdfs:///dinky/dinky-app-1.16-1.0.0-SNAPSHOT-jar-with-dependencies.jar |
 
-   当非Session类作业提交和发布后，作业会成为一个集群实例而存在
 
-:::
+
+- Flink 预设配置（高优先级）-公共配置
+
+| 参数              | 说明 | 是否必填 | 默认值 | 示例值 |
+|-----------------|----|:----:|:---:|:--:|
+| JobManager 内存   | JobManager 内存大小! |  否   |  无  | 1g |
+| TaskManager 内存  |  TaskManager 内存大小! |  否   |  无  | 1g |
+| TaskManager 堆内存 |  TaskManager 堆内存大小! |  否   |  无  | 1g |
+| 插槽数             | 插槽数量  |  否   |  无  | 2  |
+| 保存点路径                | 对应SavePoint目录  |  否   |  无  | hdfs:///flink/savepoint   |
+| 检查点路径                | 对应CheckPoint目录 |  否   |  无  | hdfs:///flink/checkpoint  |
+
+
+--- 
+
+#### Yarn 模式
+
+- Hadoop 配置
+
+| 参数     | 说明                                                                | 是否必填 | 默认值 |    示例值     |
+|--------|-------------------------------------------------------------------|:----:|:---:|:----------:|
+| Hadoop 配置文件路径     | 指定配置文件路径（末尾无/），需要包含以下文件：core-site.xml,hdfs-site.xml,yarn-site.xml ！ |  是   |  无  |   |
+| Hadoop 自定义配置（高优先级） | Hadoop 的其他参数配置                                                    |  否   |  无  |  |
+
+- Flink 配置
+
+
+| 参数       | 说明                                        | 是否必填 | 默认值 |        示例值        |
+|----------|-------------------------------------------|:----:|:---:|:-----------------:|
+| Flink Lib 路径 | 指定 lib 的 hdfs 路径（末尾无/），需要包含 Flink 运行时的依赖！ |  是   |  无  | hdfs:///flink/lib |
+| Flink 配置文件路径 | 仅指定到文件夹，dinky会自行读取文件夹下的配置文件，k8s模式下此参数可选填  |  是   |  无  |  /opt/flink/conf  |
+| Flink 自定义配置（高优先级） | Flink 的其他参数配置                                          |  否   |  无  |                   |
+
+
+---
+
+#### Kubernetes Native 模式
+
+- Kubernetes 配置
+
+| 参数               | 说明                                       | 是否必填 | 默认值 |   示例值    |
+|------------------|------------------------------------------|:----:|:---:|:--------:|
+| 暴露端口类型           | 指定暴露端口类型, 目前支持 NodePort, ClusterIP       |  是   |  无  | NodePort | 
+| Kubernetes 命名空间  | 指定 Kubernetes 命名空间                       |  是   |  无  |  flink   |
+| Kubernetes 提交账号  | 指定 Kubernetes 提交账号                       |  是   |  无  |  flink   |
+| Flink 镜像地址       | 指定 Flink 镜像地址                            |  是   |  无  |  flink:1.16.0   |
+| JobManager CPU 配置 | 指定 JobManager CPU 配置                     |  否   |  无  | 1000m   |
+| TaskManager CPU 配置 | 指定 TaskManager CPU 配置                    |  否   |  无  | 1000m   |
+| Flink 配置文件路径     | 仅指定到文件夹，dinky会自行读取文件夹下的配置文件，k8s模式下此参数可选填 |  否   |  无  | /opt/flink/conf   |
+| 自定义配置            | Flink 的其他参数配置                            |  否   |  无  |   |
+| K8s KubeConfig       | 指定 K8s KubeConfig,支持从本地上传并加载             |  否   |  无  |   |
+| Default Pod Template | 指定 Default Pod Template,支持从本地上传并加载       |  否   |  无  |   |
+| JM Pod Template     | 指定 JobManager Pod Template,支持从本地上传并加载        |  否   |  无  |   |
+| TM Pod Template     | 指定 TaskManager Pod Template,支持从本地上传并加载            |  否   |  无  |   |
+
+
+---
+
+#### Kubernetes Operator 模式
+
+- Kubernetes 配置
+> 注意: 与 Kubernetes Native 模式不同的是, Kubernetes Operator 模式下, 需要指定 Flink 版本而不需要指定暴露端口类型, 其他配置项都一致,以下仅列出不同的配置项
+
+| 参数               | 说明                                   | 是否必填 | 默认值 |   示例值    |
+|------------------|--------------------------------------|:----:|:---:|:--------:|
+| Flink 版本       | 指定 Flink 版本,支持 Flink1.15 - Flink1.18 |  是   |  无  |  1.16.0   |
+
+
+
+---