Skip to content

D
dlink
Unverified Commit 574c7403 authored by aiwenmo's avatar aiwenmo Committed by GitHub
Browse files
Options

[Document-345][doc] Fix document 

[Document-345][doc] Fix document
parents 403f1bd3 eb71b91d
Hide whitespace changes
Inline Side-by-side
Showing with 44 additions and 56 deletions
docs/zh-CN/_sidebar.md
View file @ 574c7403
......@@ -11,8 +11,8 @@
- [部署](/zh-CN/deploy/deploy.md)
- [Dinky 概览](/zh-CN/dinky_overview.md)
- 快速入门指南
- FlinkSQL作业快速入门
- 其他数据源作业快速入门
- FlinkSQL 作业快速入门
- DB SQL 作业快速入门
- 使用手册
- 实例管理
- 项目空间管理
......@@ -24,12 +24,13 @@
- 作业开发
- [作业概述](/zh-CN/administrator_guide/studio/job_dev/job_hosting.md)
- [环境配置](/zh-CN/administrator_guide/studio/job_dev/env_config.md)
- FlinkSQL开发指南
- FlinkSQL 开发指南
- [概述](/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/summary.md)
- [作业开发](/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/flinksql_job_dev.md)
- [作业提交](/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/flinksql_job_submit.md)
- [作业调试](/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/job_debug.md)
- 其他数据源开发指南
- DB SQL 开发指南
- [快捷键指南](/zh-CN/administrator_guide/hotkey.md)
- 作业运维
- [作业管理](/zh-CN/administrator_guide/studio/job_ops/job_manage.md)
- 作业配置
......@@ -45,7 +46,6 @@
- [jar管理](/zh-CN/administrator_guide/register_center/jar_manager.md)
- 文档管理
- [元数据管理](/zh-CN/administrator_guide/metadata.md)
- [快速使用快捷键](/zh-CN/administrator_guide/hotkey.md)
- 系统设置
- [用户管理](/zh-CN/administrator_guide/system_setting/user_management.md)
- [Flink设置](/zh-CN/administrator_guide/system_setting/Flink_Setting.md)
......
docs/zh-CN/administrator_guide/register_center/jar_manager.md
View file @ 574c7403
当用户使用 jar 包提交 Flink 应用时，可以在 j**ar管理**中对所需程序进行管理。
当用户使用 jar 包提交 Flink 应用时，可以在 **jar管理** 中对所需 jar 进行管理。
## Jar包配置
首先进入**注册中心** > **jar管理**，点击 **新建**，进入**创建Jar配置**界面。
**注册中心 > jar管理 > 新建 > 创建Jar配置**。
![新建](http://www.aiwenmo.com/dinky/dev/docs/%E6%96%B0%E5%BB%BA.png)
![创建jar配置](http://www.aiwenmo.com/dinky/dev/docs/%E5%88%9B%E5%BB%BAjar%E9%85%8D%E7%BD%AE.png)
**参数配置说明：**
- **Jar配置:**
- 默认:** User App
- **文件路径:** 指定 HDFS 上的文件路径,即Flink提交的jar包程序
- **启动类:** 指定可执行 Jar 的启动类，（可选）
- **执行参数:** 指定可执行 Jar 的启动类入参,（可选）
- **基本配置:**
- **标识:** 英文唯一标识(必选)
- **名称:** 自定义
- **注释:** 自定义
- **是否启用:** 默认启用
Jar包配置完成后，就可以正常提交运行。
- **Jar 配置：**
- **默认：** User App
- **文件路径：** 指定 HDFS 上的文件路径，即 Flink 提交的 jar 包
- **启动类：** 指定可执行 Jar 的启动类
- **执行参数：** 指定可执行 Jar 的启动类入参
- **基本配置：**
- **标识：** 英文唯一标识(必选)
- **名称：** 自定义
- **注释：** 自定义
- **是否启用：** 默认启用
如果可行性jar包出错，用户可以对其进行编辑修改。
Jar 包配置完成后，创建 **FlinkJar** 任务，详见。
## Jar包编辑
用户可以对所添加的可执行Jar包配置做编辑修改。
用户可以对所添加的可执行 Jar 包配置做编辑修改。
首先进入**注册中心** > **jar管理**，点击**编辑**，即可对可执行Jar配置进行修改。
![jar编辑](http://www.aiwenmo.com/dinky/dev/docs/jar%E7%BC%96%E8%BE%91.png)
![维护jar包配置](http://www.aiwenmo.com/dinky/dev/docs/%E7%BB%B4%E6%8A%A4jar%E5%8C%85%E9%85%8D%E7%BD%AE.png)
## Jar删除
用户可以对所添加的可执行Jar包配置做删除。
首先进入**注册中心** > **jar管理**，点击**删除**，即可对可执行Jar配置进行删除。
首先进入**注册中心** > **jar管理**，点击**删除**，即可对可执行 Jar 配置进行删除。
![jar配置删除](http://www.aiwenmo.com/dinky/dev/docs/jar%E9%85%8D%E7%BD%AE%E5%88%A0%E9%99%A4.png)
![删除jar](http://www.aiwenmo.com/dinky/dev/docs/%E5%88%A0%E9%99%A4jar.png)
**说明:** 目前jar包提交的方式还尚在开发阶段，不适合在生产使用。用户只能跑一些demo
\ No newline at end of file
**说明:** 目前 jar 包提交的方式只支持 Yarn Application 模式
\ No newline at end of file
docs/zh-CN/administrator_guide/studio/development_control/function_introduce.md
View file @ 574c7403
......@@ -2,11 +2,11 @@ Data Studio 提供了 Apache Flink 及其他 DBSQL 的开发、提交和运维
## 作业管理
创建目录、创建作业等，详情请参考[作业管理](/zh-CN/administrator-guide/Studio/job_manage.md)
创建目录、创建作业等，详情请参考[作业管理](/zh-CN/administrator_guide/studio/job_manage.md)
## 作业开发
开发作业、检查语法、发布作业等，详情请参考[作业开发]()
开发作业、检查语法、发布作业等，详情请参考[作业开发](/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/summary)
## 运维管理
......
docs/zh-CN/administrator_guide/studio/job_dev/env_config.md
View file @ 574c7403
......@@ -8,19 +8,19 @@
根据 Flink 官网手动部署一个 Flink Standalone 集群，并注册到 **集群实例** 中。
如何注册 Standalone 集群，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)的集群实例管理。
如何注册 Standalone 集群，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)的集群实例管理。
### Yarn Session 集群
根据 Flink 官网手动部署一个 Flink Yarn Session 集群，并注册到 **集群实例** 中。
如何注册 Yarn Session 集群，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)的集群实例管理。
如何注册 Yarn Session 集群，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)的集群实例管理。
### Yarn Per-Job 集群
在 **注册中心 > 集群管理 > 集群配置管理** 中注册 Hadoop 与 Flink 相关配置。
如何注册 Yarn Per-Job 的集群配置，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)的集群配置管理。
如何注册 Yarn Per-Job 的集群配置，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)的集群配置管理。
### Yarn Application 集群
......@@ -28,13 +28,13 @@
2.将 dlink-app.jar 上传到 **系统设置 > Flink 设置** 中的 **提交 FlinkSQL 的 Jar 文件路径** 的 hdfs 配置地址。
如何注册 Yarn Application 的集群配置，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)的集群配置管理。
如何注册 Yarn Application 的集群配置，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)的集群配置管理。
### Kubernetes Session 集群
根据 Flink 官网手动部署一个 Flink Kubernetes Session 集群，并暴露 **NodePort**， 注册到 **集群实例** 中。
如何注册 Kubernetes Session 集群，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)的集群实例管理。
如何注册 Kubernetes Session 集群，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)的集群实例管理。
### Kubernetes Application 集群
......@@ -42,10 +42,10 @@
2.将 dlink-app.jar 打包成完整的 Flink 镜像，在 **系统设置 > Flink 设置** 中的 **提交 FlinkSQL 的 Jar 文件路径** 的配置 dlink-app.jar 的 local 地址。
如何注册 Kubernetes Application 的集群配置，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)的集群配置管理。
如何注册 Kubernetes Application 的集群配置，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)的集群配置管理。
## 其他数据源环境配置
手动部署外部数据源，然后注册到 **数据源管理** 。
如何注册外部数据源，请参考[数据源管理](/zh-CN/administrator-guide/registerCenter/datasource_manage.md)。当前 Dinky 支持的数据源请参考功能扩展中的[扩展数据源](/zh-CN/extend/datasource.md)
\ No newline at end of file
如何注册外部数据源，请参考[数据源管理](/zh-CN/administrator_guide/register_center/datasource_manage.md)。当前 Dinky 支持的数据源请参考功能扩展中的[扩展数据源](/zh-CN/extend/datasource.md)
\ No newline at end of file
docs/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/flinksql_job_dev.md
View file @ 574c7403
......@@ -10,7 +10,7 @@
2.在左侧菜单栏，右键 **目录**
3.新建目录或作业，请参考作业运维中的 **[作业管理](/zh-CN/administrator-guide/Studio/job_devops/job_manage.md)**
3.新建目录或作业，请参考作业运维中的 **[作业管理](/zh-CN/administrator_guide/studio/job_devops/job_manage.md)**
4.在新建文件的对话框，填写作业信息
......@@ -48,15 +48,15 @@ from datagen_source;
新建作业如下图：
![](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/Studio/job_dev/flinksql_guide/flinksql_job_dev/job_dev.png)
![](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/flinksql_job_dev/job_dev.png)
6.在作业开发页面右侧 **执行配置**，填写配置信息
| 类型 | 配置项 | 备注 |
|:----:|:-------------|:-------------------------------------------------------------------------------------------------------------------------|
| 作业配置 | 执行模式 | 区别请参考:[作业托管概述](/zh-CN/administrator-guide/Studio/job_dev/job_hosting.md) |
| 作业配置 | 集群实例 | Standalone 和 Session 执行模式需要选择集群实例，请参考：[集群实例管理](/zh-CN/administrator-guide/registerCenter/cluster_manage?id=集群实例管理) |
| 作业配置 | 集群配置 | Per-Job 和 Application 执行模式需要选择集群配置，请参考：[集群配置管理](/zh-CN/administrator-guide/registerCenter/cluster_manage?id=集群配置管理) |
| 作业配置 | 执行模式 | 区别请参考:[作业托管概述](/zh-CN/administrator_guide/studio/job_dev/job_hosting.md) |
| 作业配置 | 集群实例 | Standalone 和 Session 执行模式需要选择集群实例，请参考：[集群实例管理](/zh-CN/administrator_guide/register_center/cluster_manage?id=集群实例管理) |
| 作业配置 | 集群配置 | Per-Job 和 Application 执行模式需要选择集群配置，请参考：[集群配置管理](/zh-CN/administrator_guide/register_center/cluster_manage?id=集群配置管理) |
| 作业配置 | FlinkSQL 环境 | 选择已创建的 FlinkSQLEnv，如果没有则不选 |
| 作业配置 | 任务并行度 | 指定作业级任务并行度，默认为 1 |
| 作业配置 | Insert 语句集 | 默认禁用，开启后将 SQL编辑器中编写的多个 Insert 语句合并为一个 JobGraph 进行提交 |
......@@ -68,6 +68,6 @@ from datagen_source;
作业配置如下图：
![job_config](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/Studio/job_dev/flinksql_guide/flinksql_job_dev/job_config.png)
![job_config](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/flinksql_job_dev/job_config.png)
**注意：** 请及时手动保存作业信息，以免丢失
\ No newline at end of file
docs/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/flinksql_job_submit.md
View file @ 574c7403
......@@ -28,10 +28,10 @@
作业启动异步提交如下图：
![async_submit](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/Studio/job_dev/flinksql_guide/flinksql_job_submit/async_submit.png)
![async_submit](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/flinksql_job_submit/async_submit.png)
作业启动发布上线如下图：
![online](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/Studio/job_dev/flinksql_guide/flinksql_job_submit/online.png)
![online](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator_guide/studio/job_dev/flinksql_guide/flinksql_job_submit/online.png)
有关发布上线的详细内容，请参考运维中心
docs/zh-CN/administrator_guide/studio/job_dev/job_hosting.md
View file @ 574c7403
......@@ -28,7 +28,7 @@ Dinky 将通过 JobManager 的 Rest 端口提交 FlinkSQL 作业至外部的 Fli
**适用于：** 作业资源共享，启动快，批作业、Flink OLAP 查询、资源占用小的流作业。
**注意：** 需要手动启动 Yarn Session 集群并注册到 Dinky 的集群实例，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)。
**注意：** 需要手动启动 Yarn Session 集群并注册到 Dinky 的集群实例，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)。
### Yarn Per-Job
......@@ -38,7 +38,7 @@ Dinky 将通过 Yarn 来创建 Flink Yarn Per-Job 集群。
**适用于：** 资源占用较多的批作业和流作业。
**注意：** 需要在 Dinky 的集群配置中注册相关的 Hadoop 和 Flink 配置，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)。
**注意：** 需要在 Dinky 的集群配置中注册相关的 Hadoop 和 Flink 配置，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)。
### Yarn Application
......@@ -48,7 +48,7 @@ Dinky 将通过 Yarn 来创建 Flink Yarn Application 集群。
**适用于：** 资源占用较多的批作业和流作业。
**注意：** 需要在 Dinky 的集群配置中注册相关的 Hadoop 和 Flink 配置，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)。
**注意：** 需要在 Dinky 的集群配置中注册相关的 Hadoop 和 Flink 配置，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)。
### Kubernetes Session
......@@ -56,7 +56,7 @@ Dinky 将通过暴露的 NodePort 端口提交 FlinkSQL 作业至外部的 Flink
**特点：** 作业资源隔离，启动快，动态扩容。
**注意：** 需要在 Dinky 的集群配置中注册相关的 Kubernetes 和 Flink 配置，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)。
**注意：** 需要在 Dinky 的集群配置中注册相关的 Kubernetes 和 Flink 配置，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)。
**适用于：** 作业资源隔离，启动快，动态扩容，批作业、Flink OLAP 查询、资源占用小的流作业。
......@@ -68,7 +68,7 @@ Dinky 将通过 dlink-app 镜像创建的 Flink Kubernetes Application 集群。
**适用于：** 作业资源隔离，启动慢，动态扩容，节约网络资源，资源占用较多的批作业和流作业。
**注意：** 需要在 Dinky 的集群配置中注册相关的 Kubernetes 和 Flink 配置，请参考[集群管理](/zh-CN/administrator-guide/registerCenter/cluster_manage.md)。
**注意：** 需要在 Dinky 的集群配置中注册相关的 Kubernetes 和 Flink 配置，请参考[集群管理](/zh-CN/administrator_guide/register_center/cluster_manage.md)。
## DB SQL
......@@ -76,4 +76,4 @@ Dinky 将把 sql 提交到对应的数据源执行。
**适用于：** 原生 SQL 查询、执行。
**注意：** 需要在数据源中心注册数据库，请参考[数据源管理](/zh-CN/administrator-guide/registerCenter/datasource_manage.md)
\ No newline at end of file
**注意：** 需要在数据源中心注册数据库，请参考[数据源管理](/zh-CN/administrator_guide/register_center/datasource_manage.md)
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment