Browse Source

[Doc][Bug] Fix dead link caused by markdown cross-files anchor (#12357)

3.2.0-release
Eric Gao 2 years ago committed by GitHub
parent
commit
c50cc997a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 6
      docs/docs/en/contribute/join/pull-request.md
  2. 5
      docs/docs/en/guide/task/chunjun.md
  3. 5
      docs/docs/en/guide/task/conditions.md
  4. 22
      docs/docs/en/guide/task/datasync.md
  5. 5
      docs/docs/en/guide/task/datax.md
  6. 5
      docs/docs/en/guide/task/dependent.md
  7. 5
      docs/docs/en/guide/task/dinky.md
  8. 11
      docs/docs/en/guide/task/dms.md
  9. 5
      docs/docs/en/guide/task/dvc.md
  10. 5
      docs/docs/en/guide/task/emr.md
  11. 5
      docs/docs/en/guide/task/flink.md
  12. 5
      docs/docs/en/guide/task/hive-cli.md
  13. 5
      docs/docs/en/guide/task/http.md
  14. 19
      docs/docs/en/guide/task/java.md
  15. 5
      docs/docs/en/guide/task/jupyter.md
  16. 5
      docs/docs/en/guide/task/kubernetes.md
  17. 5
      docs/docs/en/guide/task/map-reduce.md
  18. 8
      docs/docs/en/guide/task/mlflow.md
  19. 5
      docs/docs/en/guide/task/openmldb.md
  20. 5
      docs/docs/en/guide/task/pigeon.md
  21. 5
      docs/docs/en/guide/task/python.md
  22. 5
      docs/docs/en/guide/task/pytorch.md
  23. 5
      docs/docs/en/guide/task/sagemaker.md
  24. 5
      docs/docs/en/guide/task/seatunnel.md
  25. 5
      docs/docs/en/guide/task/shell.md
  26. 5
      docs/docs/en/guide/task/spark.md
  27. 5
      docs/docs/en/guide/task/sql.md
  28. 5
      docs/docs/en/guide/task/stored-procedure.md
  29. 5
      docs/docs/en/guide/task/sub-process.md
  30. 5
      docs/docs/en/guide/task/switch.md
  31. 5
      docs/docs/en/guide/task/zeppelin.md
  32. 6
      docs/docs/zh/contribute/join/pull-request.md
  33. 5
      docs/docs/zh/guide/task/chunjun.md
  34. 5
      docs/docs/zh/guide/task/conditions.md
  35. 32
      docs/docs/zh/guide/task/datasync.md
  36. 5
      docs/docs/zh/guide/task/datax.md
  37. 5
      docs/docs/zh/guide/task/dependent.md
  38. 5
      docs/docs/zh/guide/task/dinky.md
  39. 11
      docs/docs/zh/guide/task/dms.md
  40. 5
      docs/docs/zh/guide/task/dvc.md
  41. 5
      docs/docs/zh/guide/task/emr.md
  42. 5
      docs/docs/zh/guide/task/flink.md
  43. 5
      docs/docs/zh/guide/task/hive-cli.md
  44. 5
      docs/docs/zh/guide/task/http.md
  45. 5
      docs/docs/zh/guide/task/java.md
  46. 5
      docs/docs/zh/guide/task/jupyter.md
  47. 5
      docs/docs/zh/guide/task/kubernetes.md
  48. 5
      docs/docs/zh/guide/task/map-reduce.md
  49. 8
      docs/docs/zh/guide/task/mlflow.md
  50. 5
      docs/docs/zh/guide/task/openmldb.md
  51. 5
      docs/docs/zh/guide/task/pigeon.md
  52. 5
      docs/docs/zh/guide/task/python.md
  53. 5
      docs/docs/zh/guide/task/pytorch.md
  54. 5
      docs/docs/zh/guide/task/sagemaker.md
  55. 5
      docs/docs/zh/guide/task/seatunnel.md
  56. 5
      docs/docs/zh/guide/task/shell.md
  57. 5
      docs/docs/zh/guide/task/spark.md
  58. 5
      docs/docs/zh/guide/task/sql.md
  59. 5
      docs/docs/zh/guide/task/stored-procedure.md
  60. 5
      docs/docs/zh/guide/task/sub-process.md
  61. 5
      docs/docs/zh/guide/task/switch.md
  62. 5
      docs/docs/zh/guide/task/zeppelin.md

6
docs/docs/en/contribute/join/pull-request.md

@ -63,8 +63,12 @@ Please refer to the commit message section.
### Pull Request Code Style ### Pull Request Code Style
[//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (DolphinScheduler uses `Spotless` to automatically fix code style and formatting errors,)
[//]: # (see [Development Environment Setup](../development-environment-setup.md#code-style) `Code Style` section for details.)
DolphinScheduler uses `Spotless` to automatically fix code style and formatting errors, DolphinScheduler uses `Spotless` to automatically fix code style and formatting errors,
see [Code Style](../development-environment-setup.md#code-style) for details. see [Development Environment Setup](../development-environment-setup.md) `Code Style` section for details.
### Question ### Question

5
docs/docs/en/guide/task/chunjun.md

@ -11,7 +11,10 @@ ChunJun task type for executing ChunJun programs. For ChunJun nodes, the worker
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters
| **Parameter** | **Description** | | **Parameter** | **Description** |
|-------------------|---------------------------------------------------------------------------------------------------------------------------| |-------------------|---------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/conditions.md

@ -9,7 +9,10 @@ Condition is a conditional node, that determines which downstream task should ru
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

22
docs/docs/en/guide/task/datasync.md

@ -30,23 +30,10 @@ The follow shows the DolphinScheduler DataSync task plugin features:
## Task Example ## Task Example
First, introduce some general parameters of DolphinScheduler: [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) `Default Task Parameters` section for default parameters.)
- **Node name**: The name of the task. Node names within the same workflow must be unique.
- **Run flag**: Indicating whether to schedule the task. If you do not need to execute the task, you can turn on the `Prohibition execution` switch. - Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
- **Description**: Describing the function of this node.
- **Task priority**: When the number of the worker threads is insufficient, the worker executes task according to the priority. When two tasks have the same priority, the worker will execute them in `first come first served` fashion.
- **Worker group**: Machines which execute the tasks. If you choose `default`, scheduler will send the task to a random worker.
- **Task group name**: Resource group of tasks. It will not take effect if not configured.
- **Environment name**: Environment to execute the task.
- **Number of failed retries**: The number of task retries for failures. You could select it by drop-down menu or fill it manually.
- **Failure retry interval**: Interval of task retries for failures. You could select it by drop-down menu or fill it manually.
- **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%. You could configure it 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. You could configure it by [task.resource.limit.state](../../architecture/configuration.md).
- **Timeout alarm**: Alarm for task timeout. When the task exceeds the "timeout threshold", an alarm email will send.
- **Delayed execution time**: The time that a task delays for execution in minutes.
- **Resources**: Resources which your task node uses.
- **Predecessor task**: The upstream task of the current task node.
Here are some specific parameters for the DataSync plugin: Here are some specific parameters for the DataSync plugin:
@ -75,3 +62,4 @@ resource.aws.secret.access.key=<YOUR AWS SECRET KEY>
# Defines AWS Region to use and is required # Defines AWS Region to use and is required
resource.aws.region=<AWS REGION> resource.aws.region=<AWS REGION>
``` ```

5
docs/docs/en/guide/task/datax.md

@ -11,7 +11,10 @@ DataX task type for executing DataX programs. For DataX nodes, the worker will e
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/dependent.md

@ -11,7 +11,10 @@ Dependent nodes are **dependency check nodes**. For example, process A depends o
## Task Parameter ## Task Parameter
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|------------------|---------------------------------------------| |------------------|---------------------------------------------|

5
docs/docs/en/guide/task/dinky.md

@ -12,7 +12,10 @@ it will call `Dinky API` to trigger dinky task. Click [here](http://www.dlink.to
## Task Parameter ## Task Parameter
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

11
docs/docs/en/guide/task/dms.md

@ -33,12 +33,10 @@ The task plugin picture is as follows
![dms](../../../../img/tasks/demo/dms_create_and_start.png) ![dms](../../../../img/tasks/demo/dms_create_and_start.png)
**Restart DMS task by interface** **Restart DMS task by interface**
![dms](../../../../img/tasks/demo/dms_restart.png) ![dms](../../../../img/tasks/demo/dms_restart.png)
**Create and start DMS task by JSON data** **Create and start DMS task by JSON data**
![dms](../../../../img/tasks/demo/dms_create_and_start_json.png) ![dms](../../../../img/tasks/demo/dms_create_and_start_json.png)
@ -47,10 +45,12 @@ The task plugin picture is as follows
![dms](../../../../img/tasks/demo/dms_restart_json.png) ![dms](../../../../img/tasks/demo/dms_restart_json.png)
### First, introduce some general parameters of DolphinScheduler ### First, introduce some general parameters of DolphinScheduler
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
### Here are some specific parameters for the DMS plugin ### Here are some specific parameters for the DMS plugin
@ -71,10 +71,10 @@ Parameters of restarting the task by interface
- **replicationTaskArn**:The ARN of the task. - **replicationTaskArn**:The ARN of the task.
## Environment to prepare ## Environment to prepare
Some AWS configuration is required, modify a field in file `common.properties` Some AWS configuration is required, modify a field in file `common.properties`
```yaml ```yaml
# The AWS access key. if resource.storage.type=S3 or use EMR-Task, This configuration is required # The AWS access key. if resource.storage.type=S3 or use EMR-Task, This configuration is required
resource.aws.access.key.id=<YOUR AWS ACCESS KEY> resource.aws.access.key.id=<YOUR AWS ACCESS KEY>
@ -83,3 +83,4 @@ resource.aws.secret.access.key=<YOUR AWS SECRET KEY>
# The AWS Region to use. if resource.storage.type=S3 or use EMR-Task, This configuration is required # The AWS Region to use. if resource.storage.type=S3 or use EMR-Task, This configuration is required
resource.aws.region=<AWS REGION> resource.aws.region=<AWS REGION>
``` ```

5
docs/docs/en/guide/task/dvc.md

@ -20,7 +20,10 @@ The plugin provides the following three functions:
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/emr.md

@ -15,7 +15,10 @@ Using [aws-java-sdk](https://aws.amazon.com/cn/sdk-for-java/) in the background
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/flink.md

@ -15,7 +15,10 @@ Flink task type, used to execute Flink programs. For Flink nodes:
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| |-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|

5
docs/docs/en/guide/task/hive-cli.md

@ -24,7 +24,10 @@ You could choose between these two based on your needs.
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|------------------------------|------------------------------------------------------------------------------------------------------| |------------------------------|------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/http.md

@ -11,7 +11,10 @@ This node is used to perform http type tasks such as the common POST and GET req
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---|--------------------|---|---|-------------------------|-----------------------------------------------------------------------------------------------| |----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---|--------------------|---|---|-------------------------|-----------------------------------------------------------------------------------------------|

19
docs/docs/en/guide/task/java.md

@ -10,25 +10,18 @@ This node is for executing java-type tasks and supports using files and jar pack
# Task Parameters # Task Parameters
[//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| Node Name | The name of the set task. The node name in a workflow definition is unique. |
| Run Flag | Indicates whether the node is scheduled properly and turns on the kill switch, if not needed. |
| Description | Describes the functionality of the node. |
| Task Priority | When the number of worker threads is insufficient, the worker executes tasks according to the priority. When the priority is the same, the worker executes tasks by order. |
| Worker Group | The group of machines who execute the tasks. If selecting `Default`, DolphinScheduler will randomly choose a worker machine to execute the task. |
| Environment Name | Configure the environment in which the task runs. |
| Number Of Failed Retries | Number of resubmitted tasks that failed. You can choose the number in the drop-down menu or fill it manually. |
| Failed Retry Interval | the interval between the failure and resubmission of a task. You can choose the number in the drop-down menu or fill it manually. |
| Delayed Execution Time | the amount of time a task is delayed, in units. |
| Timeout Alarm | Check timeout warning, timeout failure, when the task exceeds the“Timeout length”, send a warning message and the task execution fails. |
| Module Path | pick Java 9 + 's modularity feature, put all resources into-module-path, and require that the JDK version in your worker supports modularity. | | Module Path | pick Java 9 + 's modularity feature, put all resources into-module-path, and require that the JDK version in your worker supports modularity. |
| Main Parameter | Java program main method entry parameter. | | Main Parameter | Java program main method entry parameter. |
| Java VM Parameters | JVM startup parameters. | | Java VM Parameters | JVM startup parameters. |
| Script | You need to write Java code if you use the Java run type. The public class must exist in the code without writing a package statement. | | Script | You need to write Java code if you use the Java run type. The public class must exist in the code without writing a package statement. |
| Resources | External JAR packages or other resource files that are added to the classpath or module path and can be easily retrieved in your JAVA script. | | Resources | External JAR packages or other resource files that are added to the classpath or module path and can be easily retrieved in your JAVA script. |
| Custom parameter | A user-defined parameter that is part of HTTP and replaces `${ variable }` in the script . |
| Pre Tasks | Selects a pre-task for the current task and sets the pre-task as the upstream of the current task. |
## Example ## Example

5
docs/docs/en/guide/task/jupyter.md

@ -102,7 +102,10 @@ papermill==2.3.4
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|---------------------------|-------------------------------------------------------------------| |---------------------------|-------------------------------------------------------------------|

5
docs/docs/en/guide/task/kubernetes.md

@ -11,7 +11,10 @@ K8S task type used to execute a batch task. In this task, the worker submits the
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|------------------|------------------------------------------------------------------------------------------------------------------| |------------------|------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/map-reduce.md

@ -11,7 +11,10 @@ MapReduce(MR) task type used for executing MapReduce programs. For MapReduce nod
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
### General ### General

8
docs/docs/en/guide/task/mlflow.md

@ -28,7 +28,10 @@ The MLflow plugin currently supports and will support the following:
## Task Parameters and Example ## Task Parameters and Example
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
@ -100,6 +103,7 @@ You can now use this feature to run all MLFlow projects on Github (For example [
## Environment to Prepare ## Environment to Prepare
### Conda Environment ### Conda Environment
Please install [anaconda](https://docs.continuum.io/anaconda/install/) or [miniconda](https://docs.conda.io/en/latest/miniconda.html#installing) in advance. Please install [anaconda](https://docs.continuum.io/anaconda/install/) or [miniconda](https://docs.conda.io/en/latest/miniconda.html#installing) in advance.
**Method A:** **Method A:**
@ -113,7 +117,6 @@ Add the following content to the file:
export PATH=/opt/anaconda3/bin:$PATH export PATH=/opt/anaconda3/bin:$PATH
``` ```
**Method B:** **Method B:**
You need to enter the admin account to configure a conda environment variable. You need to enter the admin account to configure a conda environment variable.
@ -153,3 +156,4 @@ ml.mlflow.preset_repository=https://github.com/apache/dolphinscheduler-mlflow
# mlflow task plugin preset repository version # mlflow task plugin preset repository version
ml.mlflow.preset_repository_version="main" ml.mlflow.preset_repository_version="main"
``` ```

5
docs/docs/en/guide/task/openmldb.md

@ -14,7 +14,10 @@ OpenMLDB task plugin used to execute tasks on OpenMLDB cluster.
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|-------------------|--------------------------------------------------------------------------------------------------------------| |-------------------|--------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/pigeon.md

@ -11,7 +11,10 @@ Pigeon is a task used to trigger remote tasks, acquire logs or status by calling
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|------------------|---------------------------------------| |------------------|---------------------------------------|

5
docs/docs/en/guide/task/python.md

@ -12,7 +12,10 @@ it will generate a temporary python script, and executes the script by the Linux
## Task Parameter ## Task Parameter
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|-------------------|--------------------------------------------------------------------------------------------------------------| |-------------------|--------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/pytorch.md

@ -19,7 +19,10 @@ The task plugin picture is as follows
![pytorch](../../../../img/tasks/demo/pytorch_en.png) ![pytorch](../../../../img/tasks/demo/pytorch_en.png)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
#### Run time parameters #### Run time parameters

5
docs/docs/en/guide/task/sagemaker.md

@ -20,7 +20,10 @@ DolphinScheduler SageMaker task plugin features are as follows:
## Task Example ## Task Example
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
Here are some specific parameters for the SagaMaker plugin: Here are some specific parameters for the SagaMaker plugin:

5
docs/docs/en/guide/task/seatunnel.md

@ -12,7 +12,10 @@ Click [here](https://seatunnel.apache.org/) for more information about `Apache S
## Task Parameter ## Task Parameter
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
- Engine: Supports FLINK and SPARK - Engine: Supports FLINK and SPARK
- FLINK - FLINK
- Run model: supports `run` and `run-application` modes - Run model: supports `run` and `run-application` modes

5
docs/docs/en/guide/task/shell.md

@ -11,7 +11,10 @@ Shell task type, used to create a shell type task and execute a series of shell
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|------------------------|-----------------------------------------------------------------------------------------------------------| |------------------------|-----------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/spark.md

@ -15,7 +15,10 @@ Spark task type for executing Spark application. When executing the Spark task,
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| |----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/sql.md

@ -15,7 +15,10 @@ Refer to [datasource-setting](../howto/datasource-setting.md) `DataSource Center
## Task Parameter ## Task Parameter
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/stored-procedure.md

@ -10,7 +10,10 @@
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/sub-process.md

@ -11,7 +11,10 @@ The sub-process node is to execute an external workflow definition as a task nod
## Task Parameter ## Task Parameter
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/switch.md

@ -15,7 +15,10 @@ The switch is a conditional judgment node, decide the branch executes according
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/en/guide/task/zeppelin.md

@ -12,7 +12,10 @@ it will call `Zeppelin Client API` to trigger zeppelin notebook paragraph. Click
## Task Parameters ## Task Parameters
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md#default-task-parameters) for default parameters. [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- Please refer to [DolphinScheduler Task Parameters Appendix]&#40;appendix.md#default-task-parameters&#41; `Default Task Parameters` section for default parameters.)
- Please refer to [DolphinScheduler Task Parameters Appendix](appendix.md) `Default Task Parameters` section for default parameters.
| **Parameter** | **Description** | | **Parameter** | **Description** |
|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|

6
docs/docs/zh/contribute/join/pull-request.md

@ -65,8 +65,12 @@ waste time。
### Pull Request Code Style ### Pull Request Code Style
[//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (DolphinScheduler使用`Spotless`为您自动修复代码风格和格式问题,)
[//]: # (详情见[开发手册]&#40;../development-environment-setup.md#代码风格&#41;`代码风格`一栏。)
DolphinScheduler使用`Spotless`为您自动修复代码风格和格式问题, DolphinScheduler使用`Spotless`为您自动修复代码风格和格式问题,
详情见[代码风格](../development-environment-setup.md#代码风格)。 详情见[开发手册](../development-environment-setup.md)`代码风格`一栏
### 相关问题 ### 相关问题

5
docs/docs/zh/guide/task/chunjun.md

@ -11,7 +11,10 @@ ChunJun 任务类型,用于执行 ChunJun 程序。对于 ChunJun 节点,wor
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|------------------------------------------------------------| |----------|------------------------------------------------------------|

5
docs/docs/zh/guide/task/conditions.md

@ -9,7 +9,10 @@ Conditions 是一个条件节点,根据上游任务运行状态,判断应该
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|---------------------------------------------------------------------------------------------------------------------------------------| |----------|---------------------------------------------------------------------------------------------------------------------------------------|

32
docs/docs/zh/guide/task/datasync.md

@ -22,35 +22,19 @@ DolphinScheduler DataSync 组件的功能:
- 创建 AWS DataSync 任务并启动,持续获取状态,直至任务执行完成。 - 创建 AWS DataSync 任务并启动,持续获取状态,直至任务执行完成。
## 创建任务 ## 创建任务
- 点击项目管理-项目名称-工作流定义,点击“创建工作流”按钮,进入 DAG 编辑页面; - 点击项目管理-项目名称-工作流定义,点击“创建工作流”按钮,进入 DAG 编辑页面;
- 拖动工具栏的 <img src="../../../../img/tasks/icons/datasync.png" width="15"/> 任务节点到画板中。 - 拖动工具栏的 <img src="../../../../img/tasks/icons/datasync.png" width="15"/> 任务节点到画板中。
## 任务样例 ## 任务样例
首先介绍一些DS通用参数 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- **任务名称** :任务的名称,同一个工作流定义中的节点名称不能重复。
- **运行标志** :标识这个节点是否需要调度执行,如果不需要执行,可以打开禁止执行开关。 - 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
- **描述** :当前节点的功能描述。
- **任务优先级** :worker线程数不足时,根据优先级从高到低依次执行任务,优先级一样时根据先到先得原则执行。 ### 独有参数
- **Worker 分组** :设置分组后,任务会被分配给worker组的机器机执行。若选择Default,则会随机选择一个worker执行。
- **任务组名称** :任务资源组,未配置则不生效。
- **组内优先级** :一个任务组内此任务的优先级。
- **环境名称** :配置任务执行的环境。
- **失败重试次数** :任务失败重新提交的次数,可以在下拉菜单中选择或者手动填充。
- **失败重试间隔** :任务失败重新提交任务的时间间隔,可以在下拉菜单中选择或者手动填充。
- **CPU 配额** :为执行的任务分配指定的CPU时间配额,单位百分比,默认-1代表不限制,例如1个核心的CPU满载是100%,16个核心的是1600%。 [task.resource.limit.state](../../architecture/configuration.md)
- **最大内存** :为执行的任务分配指定的内存大小,超过会触发OOM被Kill同时不会进行自动重试,单位MB,默认-1代表不限制。这个功能由 [task.resource.limit.state](../../architecture/configuration.md) 控制。
- **超时告警** :勾选超时告警、超时失败,当任务超过"超时时长"后,会发送告警邮件并且任务执行失败.这个功能由 [task.resource.limit.state](../../architecture/configuration.md) 控制。
- **资源** :任务执行时所需资源文件。
- **前置任务** :设置当前任务的前置(上游)任务。
- **延时执行时间** :任务延迟执行的时间,以分为单位。
以上参数如无特殊需求,可以默认即可
- **name**: 任务名称 - **name**: 任务名称
- **destinationLocationArn**: 目标 AWS 存储资源位置的 Amazon Resource Name (ARN) ,可见 [AWS API](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-DestinationLocationArn) - **destinationLocationArn**: 目标 AWS 存储资源位置的 Amazon Resource Name (ARN) ,可见 [AWS API](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-DestinationLocationArn)
@ -61,13 +45,10 @@ DolphinScheduler DataSync 组件的功能:
- **json**: 创建 datasync 任务的JSON结构任务参数,可以支持options等参数,可见 [AWS CreateTask API] 的 Request Syntax (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html) - **json**: 创建 datasync 任务的JSON结构任务参数,可以支持options等参数,可见 [AWS CreateTask API] 的 Request Syntax (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html)
组件图示如下: 组件图示如下:
![datasync](../../../../img/tasks/demo/datasync_task01.png) ![datasync](../../../../img/tasks/demo/datasync_task01.png)
## 环境配置 ## 环境配置
需要进行AWS的一些配置,修改`common.properties`中的`xxxxx`为你的配置信息 需要进行AWS的一些配置,修改`common.properties`中的`xxxxx`为你的配置信息
@ -80,3 +61,4 @@ resource.aws.secret.access.key=<YOUR AWS SECRET KEY>
# Defines AWS Region to use and is required # Defines AWS Region to use and is required
resource.aws.region=<AWS REGION> resource.aws.region=<AWS REGION>
``` ```

5
docs/docs/zh/guide/task/datax.md

@ -11,7 +11,10 @@ DataX 任务类型,用于执行 DataX 程序。对于 DataX 节点,worker
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|-------------------------------------------------------------------------------------------------------| |----------|-------------------------------------------------------------------------------------------------------|

5
docs/docs/zh/guide/task/dependent.md

@ -11,7 +11,10 @@ Dependent 节点,就是**依赖检查节点**。比如 A 流程依赖昨天的
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
- 此任务除上述链接中的默认参数外无其他参数。 - 此任务除上述链接中的默认参数外无其他参数。
## 任务样例 ## 任务样例

5
docs/docs/zh/guide/task/dinky.md

@ -12,7 +12,10 @@
## Task Parameter ## Task Parameter
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|-------------|---------------------------------------------------------------------| |-------------|---------------------------------------------------------------------|

11
docs/docs/zh/guide/task/dms.md

@ -16,12 +16,10 @@ DMS任务组件帮助用户在DolphinScheduler中创建和启动DMS任务。
- 通过界面创建 - 通过界面创建
- 通过Json数据创建 - 通过Json数据创建
DolphinScheduler 在 启动DMS 任务后,会跟中DMS任务状态,直至DMS任务完成后才将任务设为成功状态。除了以下情况: DolphinScheduler 在 启动DMS 任务后,会跟中DMS任务状态,直至DMS任务完成后才将任务设为成功状态。除了以下情况:
不跟踪无结束时间的CDC任务,即 当迁移类型为 `full-load-and-cdc` 或者 `cdc` 时,且没有配置 `cdcStopPosition` 参数时,DolphinScheduler 在成功启动任务后,则会将任务状态设为 成功。 不跟踪无结束时间的CDC任务,即 当迁移类型为 `full-load-and-cdc` 或者 `cdc` 时,且没有配置 `cdcStopPosition` 参数时,DolphinScheduler 在成功启动任务后,则会将任务状态设为 成功。
## 创建任务 ## 创建任务
- 点击项目管理-项目名称-工作流定义,点击“创建工作流”按钮,进入 DAG 编辑页面; - 点击项目管理-项目名称-工作流定义,点击“创建工作流”按钮,进入 DAG 编辑页面;
@ -47,11 +45,12 @@ DolphinScheduler 在 启动DMS 任务后,会跟中DMS任务状态,直至DMS
![dms](../../../../img/tasks/demo/dms_restart_json.png) ![dms](../../../../img/tasks/demo/dms_restart_json.png)
### 首先介绍一些DS通用参数 ### 首先介绍一些DS通用参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
### DMS组件独有的参数 ### DMS组件独有的参数
@ -75,6 +74,7 @@ DolphinScheduler 在 启动DMS 任务后,会跟中DMS任务状态,直至DMS
## 环境配置 ## 环境配置
需要进行AWS的一些配置,修改`common.properties`中的以下配置信息 需要进行AWS的一些配置,修改`common.properties`中的以下配置信息
```yaml ```yaml
# The AWS access key. if resource.storage.type=S3 or use EMR-Task, This configuration is required # The AWS access key. if resource.storage.type=S3 or use EMR-Task, This configuration is required
resource.aws.access.key.id=<YOUR AWS ACCESS KEY> resource.aws.access.key.id=<YOUR AWS ACCESS KEY>
@ -83,3 +83,4 @@ resource.aws.secret.access.key=<YOUR AWS SECRET KEY>
# The AWS Region to use. if resource.storage.type=S3 or use EMR-Task, This configuration is required # The AWS Region to use. if resource.storage.type=S3 or use EMR-Task, This configuration is required
resource.aws.region=<AWS REGION> resource.aws.region=<AWS REGION>
``` ```

5
docs/docs/zh/guide/task/dvc.md

@ -17,7 +17,10 @@ DVC 组件用于在DS上使用DVC的数据版本管理功能,帮助用户简
## 任务样例 ## 任务样例
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|-------------------------------| |----------|-------------------------------|

5
docs/docs/zh/guide/task/emr.md

@ -10,7 +10,10 @@ Amazon EMR 任务类型,用于在AWS上操作EMR集群并执行计算任务。
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/zh/guide/task/flink.md

@ -15,7 +15,10 @@ Flink 任务类型,用于执行 Flink 程序。对于 Flink 节点:
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/zh/guide/task/hive-cli.md

@ -22,7 +22,10 @@
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|---------------|-----------------------------------------------------| |---------------|-----------------------------------------------------|

5
docs/docs/zh/guide/task/http.md

@ -12,7 +12,10 @@
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|-------------------------------------| |----------|-------------------------------------|

5
docs/docs/zh/guide/task/java.md

@ -12,7 +12,10 @@
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|---------------------------------------------------------------| |----------|---------------------------------------------------------------|

5
docs/docs/zh/guide/task/jupyter.md

@ -101,7 +101,10 @@ papermill==2.3.4
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|---------------------------|------------------------------------| |---------------------------|------------------------------------|

5
docs/docs/zh/guide/task/kubernetes.md

@ -11,7 +11,10 @@ kubernetes任务类型,用于在kubernetes上执行一个短时和批处理的
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|-----------------------------------------------------------------| |----------|-----------------------------------------------------------------|

5
docs/docs/zh/guide/task/map-reduce.md

@ -11,7 +11,10 @@ MapReduce(MR) 任务类型,用于执行 MapReduce 程序。对于 MapReduce
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
### JAVA/SCALA 程序 ### JAVA/SCALA 程序

8
docs/docs/zh/guide/task/mlflow.md

@ -27,7 +27,10 @@ MLflow 组件用于执行 MLflow 任务,目前包含Mlflow Projects,和MLflo
## 任务样例 ## 任务样例
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
以下是一些MLflow 组件的常用参数 以下是一些MLflow 组件的常用参数
@ -100,6 +103,7 @@ MLflow 组件用于执行 MLflow 任务,目前包含Mlflow Projects,和MLflo
配置文件:/dolphinscheduler/conf/env/dolphinscheduler_env.sh。 配置文件:/dolphinscheduler/conf/env/dolphinscheduler_env.sh。
在文件最后添加内容 在文件最后添加内容
``` ```
# 配置你的conda环境路径 # 配置你的conda环境路径
export PATH=/opt/anaconda3/bin:$PATH export PATH=/opt/anaconda3/bin:$PATH
@ -115,7 +119,6 @@ export PATH=/opt/anaconda3/bin:$PATH
![mlflow-set-conda-env](../../../../img/tasks/demo/mlflow-set-conda-env.png) ![mlflow-set-conda-env](../../../../img/tasks/demo/mlflow-set-conda-env.png)
### MLflow service 启动 ### MLflow service 启动
确保你已经安装MLflow,可以使用`pip install mlflow`进行安装。 确保你已经安装MLflow,可以使用`pip install mlflow`进行安装。
@ -134,7 +137,6 @@ mlflow server -h 0.0.0.0 -p 5000 --serve-artifacts --backend-store-uri sqlite://
![mlflow-server](../../../../img/tasks/demo/mlflow-server.png) ![mlflow-server](../../../../img/tasks/demo/mlflow-server.png)
### 内置算法仓库配置 ### 内置算法仓库配置
如果遇到github无法访问的情况,可以修改`commom.properties`配置文件的以下字段,将github地址替换能访问的地址。 如果遇到github无法访问的情况,可以修改`commom.properties`配置文件的以下字段,将github地址替换能访问的地址。

5
docs/docs/zh/guide/task/openmldb.md

@ -13,7 +13,10 @@ OpenMLDB任务组件可以连接OpenMLDB集群执行任务。
## 任务样例 ## 任务样例
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|-------------|--------------------------------------------------| |-------------|--------------------------------------------------|

5
docs/docs/zh/guide/task/pigeon.md

@ -8,7 +8,10 @@ Pigeon任务类型是通过调用远程websocket服务,实现远程任务的
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|-------------------| |----------|-------------------|

5
docs/docs/zh/guide/task/python.md

@ -12,7 +12,10 @@ Python 任务类型,用于创建 Python 类型的任务并执行一系列的 P
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|-----------------------------------| |----------|-----------------------------------|

5
docs/docs/zh/guide/task/pytorch.md

@ -21,7 +21,10 @@
### Pytorch参数 ### Pytorch参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
#### 运行参数 #### 运行参数

5
docs/docs/zh/guide/task/sagemaker.md

@ -18,7 +18,10 @@ DolphinScheduler SageMaker 组件的功能:
## 任务样例 ## 任务样例
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------------------|-------------------------------------------------------------------------------------------------------------------------------------| |----------------------|-------------------------------------------------------------------------------------------------------------------------------------|

5
docs/docs/zh/guide/task/seatunnel.md

@ -12,7 +12,10 @@
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
- 引擎:支持 FLINK 和 SPARK - 引擎:支持 FLINK 和 SPARK
- FLINK - FLINK
- 运行模型:支持 `run``run-application` 两种模式 - 运行模型:支持 `run``run-application` 两种模式

5
docs/docs/zh/guide/task/shell.md

@ -11,7 +11,10 @@ Shell 任务类型,用于创建 Shell 类型的任务并执行一系列的 She
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
- 除上述默认参数,此任务没有其他参数 - 除上述默认参数,此任务没有其他参数
## 任务样例 ## 任务样例

5
docs/docs/zh/guide/task/spark.md

@ -16,7 +16,10 @@ Spark 任务类型用于执行 Spark 应用。对于 Spark 节点,worker 支
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
- 程序类型:支持 Java、Scala、Python 和 SQL 四种语言。 - 程序类型:支持 Java、Scala、Python 和 SQL 四种语言。
- 主函数的 Class:Spark 程序的入口 Main class 的全路径。 - 主函数的 Class:Spark 程序的入口 Main class 的全路径。
- 主程序包:执行 Spark 程序的 jar 包(通过资源中心上传)。 - 主程序包:执行 Spark 程序的 jar 包(通过资源中心上传)。

5
docs/docs/zh/guide/task/sql.md

@ -15,7 +15,10 @@ SQL任务类型,用于连接数据库并执行相应SQL。
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
- 数据源:选择对应的数据源 - 数据源:选择对应的数据源
- sql类型:支持查询和非查询两种。 - sql类型:支持查询和非查询两种。
- 查询:支持 `DML select` 类型的命令,是有结果集返回的,可以指定邮件通知为表格、附件或表格附件三种模板; - 查询:支持 `DML select` 类型的命令,是有结果集返回的,可以指定邮件通知为表格、附件或表格附件三种模板;

5
docs/docs/zh/guide/task/stored-procedure.md

@ -19,7 +19,10 @@ END
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|---------------|--------------------------------------------------------------------------------------------------| |---------------|--------------------------------------------------------------------------------------------------|

5
docs/docs/zh/guide/task/sub-process.md

@ -12,7 +12,10 @@
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|----------------------------------------| |----------|----------------------------------------|

5
docs/docs/zh/guide/task/switch.md

@ -11,7 +11,10 @@ Switch 是一个条件判断节点,依据[全局变量](../parameter/global.md
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|----------|-------------------------------------------------------------------------| |----------|-------------------------------------------------------------------------|

5
docs/docs/zh/guide/task/zeppelin.md

@ -12,7 +12,10 @@
## 任务参数 ## 任务参数
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md#默认任务参数)。 [//]: # (TODO: use the commented anchor below once our website template supports this syntax)
[//]: # (- 默认参数说明请参考[DolphinScheduler任务参数附录]&#40;appendix.md#默认任务参数&#41;`默认任务参数`一栏。)
- 默认参数说明请参考[DolphinScheduler任务参数附录](appendix.md)`默认任务参数`一栏。
| **任务参数** | **描述** | | **任务参数** | **描述** |
|------------------------------------|---------------------------------------------------| |------------------------------------|---------------------------------------------------|

Loading…
Cancel
Save