You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by ti...@apache.org on 2022/04/26 09:43:51 UTC
[dolphinscheduler] branch dev updated: [Bug] [Website-9764]add script doc to the alert function (#9765)
This is an automated email from the ASF dual-hosted git repository.
tianqiyan 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 e3070d9fa3 [Bug] [Website-9764]add script doc to the alert function (#9765)
e3070d9fa3 is described below
commit e3070d9fa3fdccacb3d42380862c85a8b1320f8b
Author: Tq <ti...@gmail.com>
AuthorDate: Tue Apr 26 17:43:46 2022 +0800
[Bug] [Website-9764]add script doc to the alert function (#9765)
* add script doc to the alert function
* add script doc to the alert function modify docsdev.js
---
docs/configs/docsdev.js | 8 ++++++++
docs/docs/en/guide/alert/script.md | 17 +++++++++++++++++
docs/docs/zh/guide/alert/script.md | 17 +++++++++++++++++
docs/img/alert/script-plugin.png | Bin 0 -> 12752 bytes
4 files changed, 42 insertions(+)
diff --git a/docs/configs/docsdev.js b/docs/configs/docsdev.js
index 337eda71ec..1364b7dce7 100644
--- a/docs/configs/docsdev.js
+++ b/docs/configs/docsdev.js
@@ -241,6 +241,10 @@ export default {
title: 'Enterprise Webexteams',
link: '/en-us/docs/dev/user_doc/guide/alert/enterprise-webexteams.html',
},
+ {
+ title: 'Script',
+ link: '/en-us/docs/dev/user_doc/guide/alert/script.html',
+ },
],
},
{
@@ -559,6 +563,10 @@ export default {
title: 'Webexteams',
link: '/zh-cn/docs/dev/user_doc/guide/alert/enterprise-webexteams.html',
},
+ {
+ title: '脚本告警',
+ link: '/zh-cn/docs/dev/user_doc/guide/alert/script.html',
+ },
],
},
{
diff --git a/docs/docs/en/guide/alert/script.md b/docs/docs/en/guide/alert/script.md
new file mode 100644
index 0000000000..fb7a34b883
--- /dev/null
+++ b/docs/docs/en/guide/alert/script.md
@@ -0,0 +1,17 @@
+# DingTalk
+
+If you need to use `Shell script` for alerting, create an alert instance in the alert instance management and select the `Script` plugin.
+The following shows the `Script` configuration example:
+
+![dingtalk-plugin](/img/alert/script-plugin.png)
+
+## Parameter Configuration
+
+* User Params
+ > User defined parameters will pass to the script.
+* Script Path
+ > The file location path in the server.
+* Type
+ > Support `Shell` script.
+
+**_Notice:_** please consider the script file access privileges with the executing tenant.
\ No newline at end of file
diff --git a/docs/docs/zh/guide/alert/script.md b/docs/docs/zh/guide/alert/script.md
new file mode 100644
index 0000000000..41be752ed4
--- /dev/null
+++ b/docs/docs/zh/guide/alert/script.md
@@ -0,0 +1,17 @@
+# Script脚本
+
+如果您需要使用到`Shell`脚本进行告警,请在告警实例管理里创建告警实例,选择`Script`插件。`Script`的配置样例如下:
+
+![dingtalk-plugin](/img/alert/script-plugin.png)
+
+参数配置
+
+* 自定义参数
+ > 用户自定义的参数将被传入脚本执行
+* 脚本路径
+ > 脚本在服务器上的文件位置
+* 脚本类型
+ > 支持`Shell`脚本
+
+**_注意:_** 请注意脚本的读写权限与执行租户的关系
+
diff --git a/docs/img/alert/script-plugin.png b/docs/img/alert/script-plugin.png
new file mode 100644
index 0000000000..65f8396f9c
Binary files /dev/null and b/docs/img/alert/script-plugin.png differ