Sfoglia il codice sorgente

[Feature][Doc] Add docs for zeppelin task plugin (#9866)

Eric Gao 2 anni fa
parent
commit
1f7884609a

+ 8 - 0
docs/configs/docsdev.js

@@ -166,6 +166,10 @@ export default {
                                 title: 'Amazon EMR',
                                 link: '/en-us/docs/dev/user_doc/guide/task/emr.html',
                             },
+                            {
+                                title: 'Apache Zeppelin',
+                                link: '/en-us/docs/dev/user_doc/guide/task/zeppelin.html',
+                            },
                         ],
                     },
                     {
@@ -492,6 +496,10 @@ export default {
                                 title: 'Amazon EMR',
                                 link: '/zh-cn/docs/dev/user_doc/guide/task/emr.html',
                             },
+                            {
+                                title: 'Apache Zeppelin',
+                                link: '/zh-cn/docs/dev/user_doc/guide/task/zeppelin.html',
+                            },
                         ],
                     },
                     {

+ 35 - 0
docs/docs/en/guide/task/zeppelin.md

@@ -0,0 +1,35 @@
+# Apache Zeppelin
+
+## Overview
+
+Use `Zeppelin Task` to create a zeppelin-type task and execute zeppelin notebook paragraphs. When the worker executes `Zeppelin Task`,
+it will call `Zeppelin Client API` to trigger zeppelin notebook paragraph. Click [here](https://zeppelin.apache.org/) for details about `Apache Zeppelin Notebook`. 
+
+## Create Task
+
+- Click Project Management-Project Name-Workflow Definition, and click the "Create Workflow" button to enter the DAG editing page.
+- Drag <img src="/img/tasks/icons/zeppelin.png" width="15"/> from the toolbar to the canvas.
+
+## Task Parameter
+
+- Node name: The node name in a workflow definition is unique.
+- Run flag: Identifies whether this node can be scheduled normally, if it does not need to be executed, you can turn on the prohibition switch.
+- Descriptive information: Describe the function of the node.
+- Task priority: When the number of worker threads is insufficient, execute in the order of priority from high to low, and tasks with the same priority will execute in a first-in first-out order.
+- Worker grouping: Assign tasks to the machines of the worker group to execute. If `Default` is selected, randomly select a worker machine for execution.
+- Number of failed retry attempts: The failure task resubmitting times. It supports drop-down and hand-filling.
+- Failed retry interval: The time interval for resubmitting the task after a failed task. It supports drop-down and hand-filling.
+- Timeout alarm: Check the timeout alarm and timeout failure. When the task exceeds the "timeout period", an alarm email will send and the task execution will fail.
+- Zeppelin Note ID: The unique note id for a zeppelin notebook note.
+- Zeppelin Paragraph ID: The unique paragraph id for a zeppelin notebook paragraph.
+
+## Task Example
+
+### Zeppelin Paragraph Task Example
+
+This example illustrates how to create a zeppelin paragraph task node.
+
+![demo-zeppelin-paragraph](/img/tasks/demo/zeppelin.png)
+
+![demo-get-zeppelin-id](/img/tasks/demo/zeppelin_id.png)
+

+ 36 - 0
docs/docs/zh/guide/task/zeppelin.md

@@ -0,0 +1,36 @@
+# Apache Zeppelin
+
+## Overview
+
+`Zeppelin`任务类型,用于创建并执行`Zeppelin`类型任务。worker 执行该任务的时候,会通过`Zeppelin Cient API`触发`Zeppelin Notebook段落`。
+点击[这里](https://zeppelin.apache.org/) 获取更多关于`Apache Zeppelin Notebook`的信息。
+
+## Create Task
+
+- 点击项目管理-项目名称-工作流定义,点击"创建工作流"按钮,进入DAG编辑页面。
+- 工具栏中拖动 <img src="/img/tasks/icons/zeppelin.png" width="15"/> 到画板中,即可完成创建。
+
+## Task Parameter
+
+- 任务名称:设置任务的名称。一个工作流定义中的节点名称是唯一的。
+- 运行标志:标识这个节点是否能正常调度,如果不需要执行,可以打开禁止执行开关。
+- 描述:描述该节点的功能。
+- 任务优先级:worker线程数不足时,根据优先级从高到低依次执行,优先级一样时根据先进先出原则执行。
+- Worker分组:任务分配给worker组的机器机执行,选择Default,会随机选择一台worker机执行。
+- 失败重试次数:任务失败重新提交的次数,支持下拉和手填。
+- 失败重试间隔:任务失败重新提交任务的时间间隔,支持下拉和手填。
+- 超时告警:勾选超时告警、超时失败,当任务超过"超时时长"后,会发送告警邮件并且任务执行失败.
+- 前置任务:选择当前任务的前置任务,会将被选择的前置任务设置为当前任务的上游。
+- Zeppelin Note ID:Zeppelin Note对应的唯一ID。
+- Zepplin Paragraph:Zeppelin Paragraph对应的唯一ID。
+
+## Task Example
+
+### Zeppelin Paragraph Task Example
+
+这个示例展示了如何创建Zeppelin Paragraph任务节点:
+
+![demo-zeppelin-paragraph](/img/tasks/demo/zeppelin.png)
+
+![demo-get-zeppelin-id](/img/tasks/demo/zeppelin_id.png)
+

BIN
docs/img/tasks/demo/zeppelin.png


BIN
docs/img/tasks/demo/zeppelin_id.png


BIN
docs/img/tasks/icons/zeppelin.png