This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
The following commit(s) were added to refs/heads/dev by this push:
new a14b96b091 [doc] Modify Shell task file (#10634)
a14b96b091 is described below
commit a14b96b09143ab52a54683def740295a873bb5ad
Author: sneh-wha <[email protected]>
AuthorDate: Mon Jun 27 14:52:09 2022 +0530
[doc] Modify Shell task file (#10634)
---
docs/docs/en/guide/task/shell.md | 50 ++++++++++++++++++----------------------
1 file changed, 23 insertions(+), 27 deletions(-)
diff --git a/docs/docs/en/guide/task/shell.md b/docs/docs/en/guide/task/shell.md
index 3119cfae13..6aba4358e0 100644
--- a/docs/docs/en/guide/task/shell.md
+++ b/docs/docs/en/guide/task/shell.md
@@ -2,49 +2,45 @@
## Overview
-Shell task used to create a shell task type and execute a series of shell
scripts. When the worker run the shell task, a temporary shell script is
generated, and use the Linux user with the same name as the tenant executes the
script.
+Shell task type, used to create a shell type task and execute a series of
shell scripts. When the worker executes this task, a temporary shell script is
generated and executed using the linux user with the same name as the tenant.
## Create Task
-- Click `Project -> Management-Project -> Name-Workflow Definition`, and click
the `Create Workflow` button to enter the DAG editing page.
+- Click `Project Management -> Project Name -> Workflow Definition`, and click
the `Create Workflow` button to enter the DAG editing page.
- Drag from the toolbar <img src="../../../../img/tasks/icons/shell.png"
width="15"/> to the canvas.
-## Task Parameter
-
-- Node name: The node name in a workflow definition is unique.
-- Run flag: Identifies whether this node schedules normally, if it does not
need to execute, select the `prohibition execution`.
-- 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.
-- Environment Name: Configure the environment name in which run the script.
-- Times of failed retry attempts: The number of times the task failed to
resubmit. You can select from drop-down or fill-in a number.
-- Failed retry interval: The time interval for resubmitting the task after a
failed task. You can select from drop-down or fill-in a number.
-- Cpu quota: Assign the specified CPU time quota to the task executed. Takes a
percentage value. Default -1 means unlimited. For example, the full CPU load of
one core is 100%,and that of 16 cores is 1600%. This function is controlled by
[task.resource.limit.state](../../architecture/configuration.md)
-- Max memory：Assign the specified max memory to the task executed. Exceeding
this limit will trigger oom to be killed and will not automatically retry.
Takes an MB value. Default -1 means unlimited. This function is controlled by
[task.resource.limit.state](../../architecture/configuration.md)
-- Timeout alarm: Check the timeout alarm and timeout failure. When the task
runs exceed the "timeout", an alarm email will send and the task execution will
fail.
-- Script: Shell program developed by users.
-- Resource: Refers to the list of resource files that called in the script,
and upload or create files by the Resource Center file management.
-- Custom parameters: It is a user-defined local parameter of Shell, and will
replace the content with `${variable}` in the script.
-- Predecessor task: Selecting a predecessor task for the current task, will
set the selected predecessor task as upstream of the current task.
+| **Parameter** | **Description** |
+| ------- | ---------- |
+| Node Name | Set the name of the task. Node names within a workflow
definition are unique. |
+| Run flag | Indicates whether the node can be scheduled normally. If it is
not necessary to execute, you can turn on the prohibiting execution switch. |
+| Description | Describes the function of this node. |
+| Task priority | When the number of worker threads is insufficient, they are
executed in order from high to low according to the priority, and they are
executed according to the first-in, first-out principle when the priority is
the same. |
+| Worker group | The task is assigned to the machines in the worker group for
execution. If Default is selected, a worker machine will be randomly selected
for execution. |
+| Task group name | The group in Resources, if not configured, it will not be
used. |
+| Environment Name | Configure the environment in which to run the script. |
+| Number of failed retries | The number of times the task is resubmitted after
failure. It supports drop-down and manual filling. |
+| Failure Retry Interval | The time interval for resubmitting the task if the
task fails. It supports drop-down and manual filling. |
+| Timeout alarm | Check Timeout Alarm and Timeout Failure. When the task
exceeds the "timeout duration", an alarm email will be sent and the task
execution will fail. |
+| Script | A SHELL program developed by the user. |
+| Resource | Refers to the list of resource files that need to be called in
the script, and the files uploaded or created in Resource Center - File
Management.|
+| User-defined parameter | It is a user-defined parameter of Shell, which will
replace the content with `${variable}` in the script. |
+| Predecessor task | Selecting the predecessor task of the current task will
set the selected predecessor task as the upstream of the current task. |
## Task Example
-### Simply Print
+### Print a Line
-We make an example simulate from a common task which runs by one command. The
example is to print one line in the log file, as shown in the following figure:
-"This is a demo of shell task".
+This example shows how to simulate simple tasks with just one or more simple
lines of command. In this example, we will see how to print a line in a log
file.
-### Custom Parameters
+### Use custom parameters
-This example simulates a custom parameter task. We use parameters for reusing
existing tasks as template or coping with the dynamic task. In this case,
-we declare a custom parameter named "param_key", with the value "param_val".
Then we use `echo` to print the parameter "${param_key}" we just declared.
-After running this example, we would see "param_val" print in the log.
+This example simulates a custom parameter task. In order to reuse existing
tasks more conveniently, or when faced with dynamic requirements, we will use
variables to ensure the reusability of scripts. In this example, we first
define the parameter "param_key" in the custom script and set its value to
"param_val". Then the echo command is declared in the "script", and the
parameter "param_key" is printed out. When we save and run the task, we will
see in the log that the value "param_val" [...]
-## Attention
+## Note
The shell task type resolves whether the task log contains
```application_xxx_xxx``` to determine whether is the yarn task. If so, the
corresponding application
will be use to judge the running state of the current shell node. At this
time, if stops the operation of the workflow, the corresponding
```application_id```
