From 989e929c3852abf5accdcfb54e9a164fbcfa8401 Mon Sep 17 00:00:00 2001 From: ethan-liu Date: Wed, 26 Apr 2023 20:04:43 +0800 Subject: [PATCH] add JM_INSTANCE_NAME --- guide/custom-node.md | 83 ++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 41 deletions(-) diff --git a/guide/custom-node.md b/guide/custom-node.md index a570c2f..0f74c6e 100644 --- a/guide/custom-node.md +++ b/guide/custom-node.md @@ -39,24 +39,24 @@ 节点定义版本 dsl 说明： -| 关键字 | 说明 | -| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ref | 归属人或归属组织的唯一标识/节点定义在归属内的唯一标识，必填，如：jianmu/hub_publish。若为官方节点定义，则可省略归属人或归属组织的唯一标识，如：hub_publish | -| version | 节点定义的版本，必填 | -| description | 节点定义的版本描述，需要添加换行符时，必须用引号将描述内容括起来，如：`"1.xxx\n2.xxx"`，选填 | -| resultFile | 输出参数转换成 json 的文件路径，若定义了输出参数 outputParameters，则必填 | -| inputParameters | 输入参数列表 | -| inputParameters.ref | 参数唯一标识，会在容器内转译成'JIANMU\_'开头并大写的环境变量。如：hub_url 在容器内可通过 JIANMU_HUB_URL 环境变量调用，必填 | -| inputParameters.name | 参数名称，必填 | +| 关键字 | 说明 | +| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ref | 归属人或归属组织的唯一标识/节点定义在归属内的唯一标识，必填，如：jianmu/hub_publish。若为官方节点定义，则可省略归属人或归属组织的唯一标识，如：hub_publish | +| version | 节点定义的版本，必填 | +| description | 节点定义的版本描述，需要添加换行符时，必须用引号将描述内容括起来，如：`"1.xxx\n2.xxx"`，选填 | +| resultFile | 输出参数转换成 json 的文件路径，若定义了输出参数 outputParameters，则必填 | +| inputParameters | 输入参数列表 | +| inputParameters.ref | 参数唯一标识，会在容器内转译成'JIANMU\_'开头并大写的环境变量。如：hub_url 在容器内可通过 JIANMU_HUB_URL 环境变量调用，必填 | +| inputParameters.name | 参数名称，必填 | | inputParameters.type | 参数类型，支持 STRING、SECRET、NUMBER、BOOL 等类型，必填。STRING/NUMBER/BOOL: 若参数类型为 STRING/NUMBER/BOOL，可直接填写值或引用其他参数(事件、全局、其他任务的输出等参数)。SECRET: 若参数类型为 SECRET，需要调用平台密钥，具体用法详见密钥管理章节 | -| inputParameters.required | 参数是否必填，默认为 false。
required 为 false 或默认时，参数默认值 value 必填；required 为 true 时，不能有参数默认值 value | -| inputParameters.value | 参数默认值，若没有指定参数值，将会使用此默认值，若 required 为 false 或默认时，则必填 | -| inputParameters.description | 参数描述，选填 | -| outputParameters | 输出参数，需要定义 **required**，格式同输入参数；
需要在"resultFile"指定的文件路径内填写对应的 json 数据，key 为输出参数的唯一标识（ref）值，格式同输入参数 | -| spec | 镜像相关信息，节点定义类型为 docker 时，必填 | -| spec.image | 指定该节点定义使用的容器镜像，执行时，平台将会从 dockerhub 拉取指定镜像，必填 | -| spec.cmd | list 格式，指定容器运行时的 command 内容，选填 | -| spec.entrypoint | list 格式，指定容器运行时的 entrypoint 内容，选填 | +| inputParameters.required | 参数是否必填，默认为 false。
required 为 false 或默认时，参数默认值 value 必填；required 为 true 时，不能有参数默认值 value | +| inputParameters.value | 参数默认值，若没有指定参数值，将会使用此默认值，若 required 为 false 或默认时，则必填 | +| inputParameters.description | 参数描述，选填 | +| outputParameters | 输出参数，需要定义 **required**，格式同输入参数；
需要在"resultFile"指定的文件路径内填写对应的 json 数据，key 为输出参数的唯一标识（ref）值，格式同输入参数 | +| spec | 镜像相关信息，节点定义类型为 docker 时，必填 | +| spec.image | 指定该节点定义使用的容器镜像，执行时，平台将会从 dockerhub 拉取指定镜像，必填 | +| spec.cmd | list 格式，指定容器运行时的 command 内容，选填 | +| spec.entrypoint | list 格式，指定容器运行时的 entrypoint 内容，选填 | 节点定义版本示例: @@ -186,35 +186,36 @@ pipeline: ### 3. 内置输入参数 -| 关键字 | 说明 | -|-----------------------------------|-------------------------------------------------------------------------------------------------| -| share_dir | 共享目录，容器中可通过 JM_SHARE_DIR 使用 | -| trigger_id | 触发器ID，容器中可通过 JM_TRIGGER_ID 使用，`v2.3.0`版本开始支持 | -| worker_id | 执行器ID，容器中可通过 JM_WORKER_ID 使用，`v2.3.1`版本开始支持 | -| worker_type | 执行器类型，容器中可通过 JM_WORKER_TYPE 使用，`v2.3.1`版本开始支持 | -| project_id | 项目ID，容器中可通过 JM_PROJECT_ID 使用，`v2.3.1`版本开始支持 | -| instance_id | 执行记录(实例)ID，容器中可通过 JM_INSTANCE_ID 使用，`v2.3.1`版本开始支持 | -| instance_trigger_type | 执行记录触发类型，容器中可通过 JM_INSTANCE_TRIGGER_TYPE 使用，`v2.3.1`版本开始支持,取值范围为: CRON-定时触发 MANUAL-手动触发 WEBHOOK-webhook触发 | -| instance_workflow_ref | 执行记录触发定义的引用，容器中可通过 JM_INSTANCE_WORKFLOW_REF 使用，`v2.3.1`版本开始支持 | -| instance_workflow_version | 执行记录触发定义的版本，容器中可通过 JM_INSTANCE_WORKFLOW_VERSION 使用，`v2.3.1`版本开始支持 | -| instance_create_time | 执行记录创建时间，容器中可通过 JM_INSTANCE_CREATE_TIME 使用，`v2.3.1`版本开始支持 | -| instance_start_time | 执行记录创建开始时间，容器中可通过 JM_INSTANCE_START_TIME 使用，`v2.3.1`版本开始支持 | -| instance_suspended_time | 执行记录创建挂起时间，容器中可通过 JM_INSTANCE_SUSPENDED_TIME 使用，`v2.3.1`版本开始支持 | -| instance_serial_no | 执行记录内部序号，容器中可通过 JM_INSTANCE_SERIAL_NO 使用，`v2.3.1`版本开始支持 | -| instance_run_mode | 执行记录运行模式，容器中可通过 JM_INSTANCE_RUN_MODE 使用，`v2.3.1`版本开始支持 | -| instance_status | 执行记录当前状态，容器中可通过 JM_INSTANCE_STATUS 使用，`v2.3.1`版本开始支持 | -| def_key | 执行记录定义key，容器中可通过 JM_DEF_KEY 使用，`v2.3.1`版本开始支持 | -| web_request_id | 节点执行失败时间重试唯一标识ID，容器中可通过 JM_WEB_REQUEST_ID 使用，`v2.3.1`版本开始支持 | +| 关键字 | 说明 | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| share_dir | 共享目录，容器中可通过 JM_SHARE_DIR 使用 | +| trigger_id | 触发器ID，容器中可通过 JM_TRIGGER_ID 使用，`v2.3.0`版本开始支持 | +| worker_id | 执行器ID，容器中可通过 JM_WORKER_ID 使用，`v2.3.1`版本开始支持 | +| worker_type | 执行器类型，容器中可通过 JM_WORKER_TYPE 使用，`v2.3.1`版本开始支持 | +| project_id | 项目ID，容器中可通过 JM_PROJECT_ID 使用，`v2.3.1`版本开始支持 | +| instance_id | 执行记录(实例)ID，容器中可通过 JM_INSTANCE_ID 使用，`v2.3.1`版本开始支持 | +| instance_name | 执行记录(实例)Name，容器中可通过 JM_INSTANCE_NAME 使用，`v2.7.2`版本开始支持 | +| instance_trigger_type | 执行记录触发类型，容器中可通过 JM_INSTANCE_TRIGGER_TYPE 使用，`v2.3.1`版本开始支持,取值范围为: CRON-定时触发 MANUAL-手动触发 WEBHOOK-webhook触发 | +| instance_workflow_ref | 执行记录触发定义的引用，容器中可通过 JM_INSTANCE_WORKFLOW_REF 使用，`v2.3.1`版本开始支持 | +| instance_workflow_version | 执行记录触发定义的版本，容器中可通过 JM_INSTANCE_WORKFLOW_VERSION 使用，`v2.3.1`版本开始支持 | +| instance_create_time | 执行记录创建时间，容器中可通过 JM_INSTANCE_CREATE_TIME 使用，`v2.3.1`版本开始支持 | +| instance_start_time | 执行记录创建开始时间，容器中可通过 JM_INSTANCE_START_TIME 使用，`v2.3.1`版本开始支持 | +| instance_suspended_time | 执行记录创建挂起时间，容器中可通过 JM_INSTANCE_SUSPENDED_TIME 使用，`v2.3.1`版本开始支持 | +| instance_serial_no | 执行记录内部序号，容器中可通过 JM_INSTANCE_SERIAL_NO 使用，`v2.3.1`版本开始支持 | +| instance_run_mode | 执行记录运行模式，容器中可通过 JM_INSTANCE_RUN_MODE 使用，`v2.3.1`版本开始支持 | +| instance_status | 执行记录当前状态，容器中可通过 JM_INSTANCE_STATUS 使用，`v2.3.1`版本开始支持 | +| def_key | 执行记录定义key，容器中可通过 JM_DEF_KEY 使用，`v2.3.1`版本开始支持 | +| web_request_id | 节点执行失败时间重试唯一标识ID，容器中可通过 JM_WEB_REQUEST_ID 使用，`v2.3.1`版本开始支持 | ### 4. 内置输出参数 > 版本说明：`v2.2.0`开始支持 -| 关键字 | 说明 | -| -------------------------------- | ---------------------------------------------------------------------------------------------- | -| inner.execution_status | 节点任务执行状态，可在下游节点通过`${xxx.inner.execution_status}`调用，取值范围为：
EXECUTION_SUCCEEDED: 执行成功
EXECUTION_FAILED: 执行失败
DISPATCH_FAILED: 分发失败 | -| inner.start_time | 节点任务开始时间，可在下游节点通过`${xxx.inner.start_time}`调用 | -| inner.end_time | 节点任务结束时间，可在下游节点通过`${xxx.inner.end_time}`调用 | +| 关键字 | 说明 | +| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| inner.execution_status | 节点任务执行状态，可在下游节点通过`${xxx.inner.execution_status}`调用，取值范围为：
EXECUTION_SUCCEEDED: 执行成功
EXECUTION_FAILED: 执行失败
DISPATCH_FAILED: 分发失败 | +| inner.start_time | 节点任务开始时间，可在下游节点通过`${xxx.inner.start_time}`调用 | +| inner.end_time | 节点任务结束时间，可在下游节点通过`${xxx.inner.end_time}`调用 | -- Gitee