11# 可视化编排插件
22
3- ModelBox提供了在线可视化编排的工具——Editor, 在开发时,可使用此工具,提升开发效率 。
3+ ModelBox提供了在线可视化编排的工具——Editor。 在开发时,可使用此工具进行创建项目、创建功能单元、编排图、调试等来提升开发效率 。
44
55## 编排插件是什么
66
@@ -10,30 +10,33 @@ ModelBox提供了在线可视化编排的工具——Editor,在开发时,可
1010
1111![ editor-feature alt rect_w_500] ( ../assets/images/figure/server/editor-feature.png )
1212
13- 1 . 安装ModelBox server服务。
14131 . 配置ModelBox Server。
15- 1 . 配置启用编排插件。
16- 1 . 浏览器访问Editor界面。
17- 1 . 业务进行编排操作。
18- 1 . 下发编排任务。
14+ 2 . 配置启用编排插件。
15+ 3 . 浏览器访问Editor界面。
16+ 4 . 业务进行编排操作。
17+ 5 . 下发编排任务。
1918
2019编排插件集成在ModelBox Server中,默认情况下,编排插件未启用。可以参考下方[ 编排插件配置] ( #编排插件配置 ) 章节来启用编排插件并加载Editor界面。
2120
2221## 编排插件配置
2322
24- ModelBox Server安装完成后,编排插件会通过插件的形式由ModelBox Server加载,并在网页浏览器上提供在线可视化编排插件。
23+ ### 配置ModelBox Server
24+
25+ [ ModelBox Server安装] ( ../environment/container-usage.md ) 完成后,编排插件会通过插件的形式由ModelBox Server加载,并在网页浏览器上提供在线可视化编排插件。
2526
2627对应插件路径为` "/usr/local/lib/modelbox-plugin-editor.so" ` (#由于不同操作系统目录结构存在差异,此路径也可能为 ` "/usr/local/lib64/modelbox-plugin-editor.so" ` ,下文涉及系统lib库路径的地方均存在系统路径差异)。
2728
2829编排插件的配置文件路径为` $HOME/modelbox-service/conf/modelbox.conf ` ,其配置项目如下:
2930
30- | 配置项目 | 配置说明 |
31- | ---------------------- | --------------------------------------------------------------------------- |
32- | editor.enable | 是否启用Editor工具 |
33- | editor.ip | Editor工具监听IP,默认为127.0.0.1。不指定的情况下,和server.ip一致 |
34- | editor.port | Editor工具监听端口,默认为1104,不指定情况下,和server.port一致 |
35- | editor.root | Editor前端UI路径,默认为/usr/local/share/modelbox/www |
36- | editor.demo_root | Editor demo路径,默认为/usr/local/share/modelbox/demo |
31+ | 配置项目 | 配置说明 |
32+ | ---------------- | ------------------------------------------------------------------ |
33+ | editor.enable | 是否启用Editor工具 |
34+ | editor.ip | Editor工具监听IP,默认为127.0.0.1。不指定的情况下,和server.ip一致 |
35+ | editor.port | Editor工具监听端口,默认为1104,不指定情况下,和server.port一致 |
36+ | editor.root | Editor前端UI路径,默认为/usr/local/share/modelbox/www |
37+ | editor.demo_root | Editor demo路径,默认为/usr/local/share/modelbox/demo |
38+
39+ ### 配置启用编排插件
3740
3841通过如下命令,可开启基于Web的可视化编辑工具——Editor:
3942
@@ -45,100 +48,100 @@ modelbox-tool develop -s
4548
4649** 如果访问被拒绝,可以尝试检查并修改ACL配置** ,并重启ModelBox服务生效,详见** 访问控制列表** 章节。
4750
48- * ** Editor配置**
51+ ## Editor配置
4952
5053 若需要定制化编排服务启动参数,可以修改配置文件,具体修改流程如下:
5154
52- 1 . 打开` $HOME/modelbox-service/conf/modelbox.conf ` ,修改其中的配置项:
55+ 1 . 打开` $HOME/modelbox-service/conf/modelbox.conf ` ,修改其中的配置项:
56+
57+ ``` shell
58+ [server]
59+ ip = " 0.0.0.0"
60+ port = " 1104"
61+ flow_path = " $HOME /modelbox-service/graph"
62+
63+ [plugin]
64+ files = [
65+ " /usr/local/lib/modelbox-plugin.so" ,
66+ " /usr/local/lib/modelbox-plugin-editor.so"
67+ ]
68+
69+ [control]
70+ enable = true
71+ listen = " $HOME /modelbox-service/run/modelbox.sock"
72+
73+ [acl]
74+ allow = [
75+ " 127.0.0.1/8" ,
76+ # ADD CLIENT HOST HERE
77+ " 192.168.59.145"
78+ ]
79+
80+ [editor]
81+ enable = true
82+ # ip = "127.0.0.1"
83+ # port = "1104"
84+ root = " /usr/local/share/modelbox/www"
85+ demo_root = " /usr/local/share/modelbox/demo"
86+
87+ [log]
88+ # log level, DEBUG, INFO, NOTICE, WARN, ERROR, FATAL, OFF
89+ level = " INFO"
90+
91+ # log archive number
92+ num = 32
93+
94+ # log file path
95+ path = " $HOME /modelbox-service/log/modelbox.log"
96+ ```
97+
98+ 1 . 重启ModelBox Server服务使配置生效。
99+
100+ ``` shell
101+ $HOME /modelbox-service/modelbox restart
102+ ```
103+
104+ 或者
105+
106+ ``` shell
107+ $HOME /modelbox-service/modelbox-manager restart
108+ ```
109+
110+ ## 访问控制列表
111+
112+ 访问控制列表ACL(Access Control List)是由一条或多条规则组成的集合,里面配置了允许访问Editor的IP地址。
113+ 可以通过修改配置文件,来修改ACL列表,具体流程如下:
114+
115+ 1 . 打开` $HOME/modelbox/modelbox.conf ` ,修改其中的配置项:
116+ 假设打开编排UI的机器的IP地址为10.11.12.13
53117
54118 ``` shell
55- [server]
56- ip = " 0.0.0.0"
57- port = " 1104"
58- flow_path = " $HOME /modelbox-service/graph"
59-
60- [plugin]
61- files = [
62- " /usr/local/lib/modelbox-plugin.so" ,
63- " /usr/local/lib/modelbox-plugin-editor.so"
64- ]
65-
66- [control]
67- enable = true
68- listen = " $HOME /modelbox-service/run/modelbox.sock"
69-
70119 [acl]
71120 allow = [
72- " 127.0.0.1/8" ,
73- # ADD CLIENT HOST HERE
74- " 192.168.59.145"
121+ " 10.11.12.13" ,
75122 ]
76-
77- [editor]
78- enable = true
79- # ip = "127.0.0.1"
80- # port = "1104"
81- root = " /usr/local/share/modelbox/www"
82- demo_root = " /usr/local/share/modelbox/demo"
83-
84- [log]
85- # log level, DEBUG, INFO, NOTICE, WARN, ERROR, FATAL, OFF
86- level = " INFO"
87-
88- # log archive number
89- num = 32
90-
91- # log file path
92- path = " $HOME /modelbox-service/log/modelbox.log"
93123 ```
94124
95- 1. 重启ModelBox Server服务使配置生效。
96-
97- ` ` ` shell
98- $HOME /modelbox-service/modelbox restart
99- ` ` `
100-
101- 或者
102-
103- ` ` ` shell
104- $HOME /modelbox-service/modelbox-manager restart
105- ` ` `
106-
107- * ** 访问控制列表**
125+ 如果没有配置任何访问白名单,则允许所有人皆可访问。
108126
109- 访问控制列表ACL(Access Control List)是由一条或多条规则组成的集合,里面配置了允许访问Editor的IP地址。
110- 可以通过修改配置文件,来修改ACL列表,具体流程如下:
127+ ` ` ` shell
128+ # [acl]
129+ # allow = [
130+ # "10.11.12.13",
131+ # ]
132+ ` ` `
111133
112- 1. 打开` $HOME /modelbox/modelbox.conf` ,修改其中的配置项:
113- 假设打开编排UI的机器的IP地址为10.11.12.13
134+ 1. 重启ModelBox Server服务使配置生效。
114135
115- ` ` ` shell
116- [acl]
117- allow = [
118- " 10.11.12.13" ,
119- ]
120- ` ` `
121-
122- 如果没有配置任何访问白名单,则允许所有人皆可访问。
123-
124- ` ` ` shell
125- # [acl]
126- # allow = [
127- # "10.11.12.13",
128- # ]
129- ` ` `
130-
131- 1. 重启ModelBox Server服务使配置生效。
132-
133- # # 访问编排服务
136+ # # 浏览器访问Editor界面
134137
135138服务启动成功后,可使用浏览器访问服务,输入对应的网址即可,如:` http://[host]:1104/editor/` ,成功后,将显示如下界面:
136139
137140! [editor-ui alt rect_w_1000](../assets/images/figure/server/editor-first.png)
138141
139142在主页中,分别可以链接到** 示例展示** ,** 任务编排** ,** 任务管理** 。右上角可以可查看** 帮助文档** 以及** API** 。
140143
141- * ** 示例展示**
144+ # ## 示例展示
142145
143146 ! [editor-demo alt rect_w_1000](../assets/images/figure/server/editor-demo.png)
144147
@@ -168,7 +171,25 @@ modelbox-tool develop -s
168171
169172 1. 对应网址的端口号以Docker启动脚本中的 ` EDITOR_MAP_PORT` 为准,默认端口号为1104。
170173
171- # # 任务编排页面
174+ # ## 任务管理页面
175+
176+ ! [editor-management alt rect_w_1000](../assets/images/figure/server/editor-management.png)
177+
178+ 如果编排任务被下发,那么所有正在运行的任务都会显示在任务管理页面中。
179+
180+ 该页面除了可以查看运行中的任务状态,还可以对任务进行Http调试。
181+
182+ 调试功能有:` api调试` 与` Base64编码`
183+
184+ api调试:
185+
186+ 选择模板, 修改Request中的Header和Body部分,发送请求之后得到的Reponse将显示在页面上。
187+
188+ Base64编码:
189+
190+ 选择需要转成base64格式的文件,即可在页面右侧得到base64代码。
191+
192+ # ## 任务编排页面
172193
173194! [editor-main alt rect_w_1000](../assets/images/figure/server/editor-main.png)
174195
@@ -180,9 +201,41 @@ modelbox-tool develop -s
180201当图编排完成之后,可以通过` 图属性` 设置相关属性。最后,点击` 项目` 下面的` 保存` 即可将项目信息保存至后端。
181202如果需要运行项目,就点击工具栏上的` 运行` 按钮即可。
182203
183- # ## 项目
204+ # ### 功能单元列表
205+
206+ 功能单元列表中,陈列了后端内置以及自制的功能单元。用户可以采用拖拽的方式,将所需要使用的功能单元,拖拽至编排界面。随后进行相对应的图编排以及属性配置等操作。
207+
208+ ! [editor-attribute alt rect_w_1000](../assets/images/figure/server/editor-attribute.png)
209+
210+ 点击已放入编排界面的功能单元,可以通过在右侧弹出的属性面板进行配置。
184211
185- ` 项目` 下拉菜单在工具栏的左侧的第一个位置,其有四个功能,分别为:
212+ 将鼠标悬浮至目标功能单元,在输出端口上方会显示一个白色的圆圈。点击白色的圆圈并连接至其它圆圈,即可完成功能单元的连接。
213+
214+ 所有的更改,都将反馈至下方的文本编辑区域。
215+
216+ # ### 工具栏
217+
218+ ! [editor-tool-bar alt rect_w_1000](../assets/images/figure/server/editor-tool-bar.png)
219+
220+ 工具栏分为左中右三个区域。
221+
222+ 1. 左侧区域
223+
224+ 该区域包括了图的显示工具(回退,重做,放大,缩小,重置缩放,自适应,切换布局)以及运行按钮。
225+
226+ 1. 中部区域
227+
228+ 该区域显示了项目名称,路径,当前处于编排界面的图名称以及编辑状态。
229+
230+ 1. 右侧区域
231+
232+ 该区域包括了项目的相关功能,功能单元的相关功能,图属性,按键说明以及下载图。
233+
234+ # ### 项目
235+
236+ ! [editor-project](../assets/images/figure/server/editor-project.png)
237+
238+ ` 项目` 下拉菜单在工具栏的左侧的第一个位置,其有八个功能,分别为:
186239
1872401. 新建项目
188241
@@ -192,48 +245,48 @@ modelbox-tool develop -s
192245
1932461. 打开项目
194247
195- 输入项目路径,点击 ` 确认` 即可打开项目。
248+ 输入项目路径,或通过单击文件夹名称来选择项目,最后点击 ` 确认` 即可打开项目。
196249
197250 ! [editor-open-project](../assets/images/figure/server/editor-open-project.png)
198251
199- 1. 保存
252+ 1. IDE打开工程
200253
201- 将更改的内容保存至后端 。
254+ 点击 ` 批处理 ` 即可下载脚本。直接运行脚本,可自动配置并打开远程连接至目标容器 。
202255
203- 1. 关闭
256+ ! [editor-ide](../assets/images/figure/server/editor-ide.png)
204257
205- 将会清空保存在浏览器中的项目数据。
258+ 1. 关闭项目
206259
207- # ## 功能单元
260+ 将会清空保存在浏览器中的项目数据,并停止当前项目正在运行的编排服务。
208261
209- 1. 新建单元
262+ 1. 新建图
210263
211- ! [editor-open-flowunit](../assets/images/figure/server/editor-create-flowunit.png)
264+ 输入新图名称之后,将新建图。如果需要保存当前图文件,需要 ` 保存图 ` 将图文件保存至后台。
212265
213- 依次选择功能单元类型,名称,处理类型。
266+ 1. 选择图
267+
268+ 可以选择当前项目中已保存至后台的图文件,点击确认之后,将从后台拉取至编排界面。
214269
215- 端口可通过选择 ` 输入 \输 出 ` , ` 端口名称 ` , ` 处理类型 ` ,点击 ` 添加 ` 来增加功能单元的端口。
270+ 1. 保存图
216271
217- 再选择功能类型。功能类型相关的介绍可以参考[功能单元开发](../use-modelbox/standard-mode/flowunit/flowunit.md) 。
272+ 将当前编排界面的图文件保存至后台 。
218273
219- 1. 刷新单元
274+ 1. 同步图
220275
221- 如果在后端对功能单元进行了更改,可用该功能直接加载更新后的功能
276+ 将后台的图文件覆盖当前编排界面的图文件。
222277
223- # # 任务管理页面
278+ # ### 功能单元
224279
225- ! [editor-management alt rect_w_1000](../assets/images/figure/server/editor-management.png)
226-
227- 该页面除了可以查看运行中的任务状态,还可以对任务进行调试。
280+ 1. 新建单元
228281
229- 调试功能有: ` api调试 ` 与 ` 转base64 `
282+ ! [editor-open-flowunit](../assets/images/figure/server/editor-create-flowunit.png)
230283
231- * api调试
284+ 依次选择功能单元类型,名称,处理类型。
232285
233- 选择相关模板, 修改Request中的Header和Body部分,发送请求之后得到的Reponse将显示在页面上 。
286+ 端口可通过选择 ` 输入 \输 出 ` , ` 端口名称 ` , ` 处理类型 ` ,点击 ` 添加 ` 来增加功能单元的端口 。
234287
235- 也可以不加载模板,直接进行调试 。
288+ 再选择功能类型。功能类型相关的介绍可以参考[功能单元开发](../use-modelbox/standard-mode/flowunit/flowunit.md) 。
236289
237- * 转base64
290+ 1. 刷新单元
238291
239- 选择需要转成base64格式的文件,即可在页面右侧得到base64代码。
292+ 如果在后端对功能单元直接进行了更改,可用该功能直接加载更新后的功能单元
0 commit comments