diff --git a/docs/apidoc/en/create_periodic_task.md b/docs/apidoc/en/create_periodic_task.md index b371aa86f0..fddff3938c 100644 --- a/docs/apidoc/en/create_periodic_task.md +++ b/docs/apidoc/en/create_periodic_task.md @@ -284,7 +284,7 @@ constant value |-----------|----------|-----------| | start_event | dict | start node | | end_event | dict | end node | -| activities | dict | task node（atoms or subprocess）info | +| activities | dict | task node（standard plugins or subprocess）info | | gateways | dict | gateways（parallel gateway、exclusive gateway、exclusive gateway）info | | flows | dict | sequenceFlow（the line between nodes）info | | constants | dict | global variables, details are described below | @@ -304,5 +304,5 @@ KEY, the format is like ${key} | desc | string | description | | source_type | string | source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters | | custom_type | string | custom type, which is not empty when source_type is custom, the value is input ,or textarea, or datetime, or int | -| source_tag | string | source tag and atom info, which is not empty when source_type is component_inputs or component_outputs | +| source_tag | string | source tag and standard plugin info, which is not empty when source_type is component_inputs or component_outputs | | source_info | dict | source info about task node ID | diff --git a/docs/apidoc/en/create_task.md b/docs/apidoc/en/create_task.md index 63e5709cb3..100bb35403 100644 --- a/docs/apidoc/en/create_task.md +++ b/docs/apidoc/en/create_task.md @@ -229,7 +229,7 @@ constant value, the type of value should be same with data from API[get_template |-----------|----------|-----------| | start_event | dict | start node | | end_event | dict | end node | -| activities | dict | task node（atoms or subprocess）info | +| activities | dict | task node（standard plugins or subprocess）info | | gateways | dict | gateways（parallel gateway、exclusive gateway、exclusive gateway）info | | flows | dict | sequenceFlow（the line between nodes）info | | constants | dict | global variables, details are described below | @@ -249,5 +249,5 @@ KEY, the format is like ${key} | desc | string | description | | source_type | string | source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters | | custom_type | string | custom type, which is not empty when source_type is custom, the value is input ,or textarea, or datetime, or int | -| source_tag | string | source tag and atom info, which is not empty when source_type is component_inputs or component_outputs | +| source_tag | string | source tag and standard plugin info, which is not empty when source_type is component_inputs or component_outputs | | source_info | dict | source info about task node ID | diff --git a/docs/apidoc/en/get_periodic_task_info.md b/docs/apidoc/en/get_periodic_task_info.md index c9215689b9..56604887f3 100644 --- a/docs/apidoc/en/get_periodic_task_info.md +++ b/docs/apidoc/en/get_periodic_task_info.md @@ -259,7 +259,7 @@ Query periodic task detail |-----------|----------|-----------| | start_event | dict | start node | | end_event | dict | end node | -| activities | dict | task node（atoms or subprocess）info | +| activities | dict | task node（standard plugins or subprocess）info | | gateways | dict | gateways（parallel gateway、exclusive gateway、exclusive gateway）info | | flows | dict | sequenceFlow（the line between nodes）info | | constants | dict | global variables, details are described below | @@ -279,5 +279,5 @@ KEY, the format is like ${key} | desc | string | description | | source_type | string | source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters | | custom_type | string | custom type, which is not empty when source_type is custom, the value is input ,or textarea, or datetime, or int | -| source_tag | string | source tag and atom info, which is not empty when source_type is component_inputs or component_outputs | +| source_tag | string | source tag and standard plugin info, which is not empty when source_type is component_inputs or component_outputs | | source_info | dict | source info about task node ID | diff --git a/docs/apidoc/en/get_task_detail.md b/docs/apidoc/en/get_task_detail.md index 415bbdd97c..4f728400e2 100644 --- a/docs/apidoc/en/get_task_detail.md +++ b/docs/apidoc/en/get_task_detail.md @@ -314,7 +314,7 @@ KEY, the format is like ${key} | desc | string | description | | source_type | string | source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters | | custom_type | string | custom type, which is not empty when source_type is custom, the value is input ,or textarea, or datetime, or int | -| source_tag | string | source tag and atom info, which is not empty when source_type is component_inputs or component_outputs | +| source_tag | string | source tag and standard plugin info, which is not empty when source_type is component_inputs or component_outputs | | source_info | dict | source info about task node ID | @@ -332,7 +332,7 @@ KEY, the format is like ${key} |-----------|----------|-----------| | start_event | dict | start node | | end_event | dict | end node | -| activities | dict | task node（atoms or subprocess）info | +| activities | dict | task node（standard plugins or subprocess）info | | gateways | dict | gateways（parallel gateway、exclusive gateway、exclusive gateway）info | | flows | dict | sequenceFlow（the line between nodes）info | | constants | dict | global variables, details are described below | diff --git a/docs/apidoc/en/get_template_info.md b/docs/apidoc/en/get_template_info.md index 6aca5a08f1..f5f5b11d3a 100644 --- a/docs/apidoc/en/get_template_info.md +++ b/docs/apidoc/en/get_template_info.md @@ -226,7 +226,7 @@ Query individual flow template details of the business |-----------|----------|-----------| | start_event | dict | start node | | end_event | dict | end node | -| activities | dict | task node（atoms or subprocess）info | +| activities | dict | task node（standard plugins or subprocess）info | | gateways | dict | gateways（parallel gateway、exclusive gateway、exclusive gateway）info | | flows | dict | sequenceFlow（the line between nodes）info | | constants | dict | global variables, details are described below | @@ -246,5 +246,5 @@ KEY, the format is like ${key} | desc | string | description | | source_type | string | source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters | | custom_type | string | custom type, which is not empty when source_type is custom, the value is input ,or textarea, or datetime, or int | -| source_tag | string | source tag and atom info, which is not empty when source_type is component_inputs or component_outputs | +| source_tag | string | source tag and standard plugin info, which is not empty when source_type is component_inputs or component_outputs | | source_info | dict | source info about task node ID | diff --git a/docs/apidoc/en/modify_constants_for_periodic_task.md b/docs/apidoc/en/modify_constants_for_periodic_task.md index 15f27df70e..4090ecc03b 100644 --- a/docs/apidoc/en/modify_constants_for_periodic_task.md +++ b/docs/apidoc/en/modify_constants_for_periodic_task.md @@ -90,5 +90,5 @@ KEY, the format is like ${key} | desc | string | description | | source_type | string | source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters | | custom_type | string | custom type, which is not empty when source_type is custom, the value is input ,or textarea, or datetime, or int | -| source_tag | string | source tag and atom info, which is not empty when source_type is component_inputs or component_outputs | +| source_tag | string | source tag and standard plugin info, which is not empty when source_type is component_inputs or component_outputs | | source_info | dict | source info about task node ID | diff --git a/docs/apidoc/zh_hans/create_periodic_task.md b/docs/apidoc/zh_hans/create_periodic_task.md index 45adf970ab..00c44c526c 100644 --- a/docs/apidoc/zh_hans/create_periodic_task.md +++ b/docs/apidoc/zh_hans/create_periodic_task.md @@ -243,7 +243,7 @@ | ------------ | ---------- | ------------------------------ | | start_event | dict | 开始节点信息 | | end_event | dict | 结束节点信息 | -| activities | dict | 任务节点（原子和子流程）信息 | +| activities | dict | 任务节点（标准插件和子流程）信息 | | gateways | dict | 网关节点（并行网关、分支网关和汇聚网关）信息 | | flows | dict | 顺序流（节点连线）信息 | | constants | dict | 全局变量信息，详情见下面 | @@ -261,7 +261,7 @@ | name | string | 变量名字 | | index | int | 变量在模板中的显示顺序 | | desc | string | 变量说明 | -| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选 | +| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选 | | custom_type | string | source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数| -| source_tag | string | source_type=component_inputs/component_outputs 时有效，变量的来源原子 | +| source_tag | string | source_type=component_inputs/component_outputs 时有效，变量的来源标准插件 | | source_info | dict | source_type=component_inputs/component_outputs 时有效，变量的来源节点信息 | diff --git a/docs/apidoc/zh_hans/create_task.md b/docs/apidoc/zh_hans/create_task.md index 247000a5b0..572621dfea 100644 --- a/docs/apidoc/zh_hans/create_task.md +++ b/docs/apidoc/zh_hans/create_task.md @@ -229,7 +229,7 @@ |-----------|----------|-----------| | start_event | dict | 开始节点信息 | | end_event | dict | 结束节点信息 | -| activities | dict | 任务节点（原子和子流程）信息 | +| activities | dict | 任务节点（标准插件和子流程）信息 | | gateways | dict | 网关节点（并行网关、分支网关和汇聚网关）信息 | | flows | dict | 顺序流（节点连线）信息 | | constants | dict | 全局变量信息，详情见下面 | @@ -247,7 +247,7 @@ | name | string | 变量名字 | | index | int | 变量在模板中的显示顺序 | | desc | string | 变量说明 | -| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选 | +| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选 | | custom_type | string | source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数| -| source_tag | string | source_type=component_inputs/component_outputs 时有效，变量的来源原子 | +| source_tag | string | source_type=component_inputs/component_outputs 时有效，变量的来源标准插件 | | source_info | dict | source_type=component_inputs/component_outputs 时有效，变量的来源节点信息 | diff --git a/docs/apidoc/zh_hans/get_periodic_task_info.md b/docs/apidoc/zh_hans/get_periodic_task_info.md index 4a4d67e4fa..09c9efd22e 100644 --- a/docs/apidoc/zh_hans/get_periodic_task_info.md +++ b/docs/apidoc/zh_hans/get_periodic_task_info.md @@ -256,7 +256,7 @@ | ------------ | ---------- | ------------------------------ | | start_event | dict | 开始节点信息 | | end_event | dict | 结束节点信息 | -| activities | dict | 任务节点（原子和子流程）信息 | +| activities | dict | 任务节点（标准插件和子流程）信息 | | gateways | dict | 网关节点（并行网关、分支网关和汇聚网关）信息 | | flows | dict | 顺序流（节点连线）信息 | | constants | dict | 全局变量信息，详情见下面 | @@ -274,7 +274,7 @@ | name | string | 变量名字 | | index | int | 变量在模板中的显示顺序 | | desc | string | 变量说明 | -| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选 | +| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选 | | custom_type | string | source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数| -| source_tag | string | source_type=component_inputs/component_outputs 时有效，变量的来源原子 | +| source_tag | string | source_type=component_inputs/component_outputs 时有效，变量的来源标准插件 | | source_info | dict | source_type=component_inputs/component_outputs 时有效，变量的来源节点信息 | diff --git a/docs/apidoc/zh_hans/get_task_detail.md b/docs/apidoc/zh_hans/get_task_detail.md index 26f5c2f5c7..099618b8e4 100644 --- a/docs/apidoc/zh_hans/get_task_detail.md +++ b/docs/apidoc/zh_hans/get_task_detail.md @@ -331,7 +331,7 @@ |-----------|----------|-----------| | start_event | dict | 开始节点信息 | | end_event | dict | 结束节点信息 | -| activities | dict | 任务节点（原子和子流程）信息 | +| activities | dict | 任务节点（标准插件和子流程）信息 | | gateways | dict | 网关节点（并行网关、分支网关和汇聚网关）信息 | | flows | dict | 顺序流（节点连线）信息 | | constants | dict | 全局变量信息，详情见下面 | diff --git a/docs/apidoc/zh_hans/get_template_info.md b/docs/apidoc/zh_hans/get_template_info.md index 4fe43e6423..71b84be657 100644 --- a/docs/apidoc/zh_hans/get_template_info.md +++ b/docs/apidoc/zh_hans/get_template_info.md @@ -226,7 +226,7 @@ |-----------|----------|-----------| | start_event | dict | 开始节点信息 | | end_event | dict | 结束节点信息 | -| activities | dict | 任务节点（原子和子流程）信息 | +| activities | dict | 任务节点（标准插件和子流程）信息 | | gateways | dict | 网关节点（并行网关、分支网关和汇聚网关）信息 | | flows | dict | 顺序流（节点连线）信息 | | constants | dict | 全局变量信息，详情见下面 | @@ -244,7 +244,7 @@ | name | string | 变量名字 | | index | int | 变量在模板中的显示顺序 | | desc | string | 变量说明 | -| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选 | +| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选 | | custom_type | string | source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数| -| source_tag | string | source_type=component_inputs或component_outputs 时有效，变量的来源原子 | +| source_tag | string | source_type=component_inputs或component_outputs 时有效，变量的来源标准插件 | | source_info | dict | source_type=component_inputs或component_outputs 时有效，变量的来源节点信息 | diff --git a/docs/apidoc/zh_hans/modify_constants_for_periodic_task.md b/docs/apidoc/zh_hans/modify_constants_for_periodic_task.md index 6bbce84a43..f530435751 100644 --- a/docs/apidoc/zh_hans/modify_constants_for_periodic_task.md +++ b/docs/apidoc/zh_hans/modify_constants_for_periodic_task.md @@ -87,7 +87,7 @@ | name | string | 变量名字 | | index | int | 变量在模板中的显示顺序 | | desc | string | 变量说明 | -| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选 | +| source_type | string | 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选 | | custom_type | string | source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数| -| source_tag | string | source_type=component_inputs/component_outputs 时有效，变量的来源原子 | +| source_tag | string | source_type=component_inputs/component_outputs 时有效，变量的来源标准插件 | | source_info | dict | source_type=component_inputs/component_outputs 时有效，变量的来源节点信息 | diff --git a/docs/install/dev_deploy.md b/docs/install/dev_deploy.md index 1988260a45..f956ee9c03 100644 --- a/docs/install/dev_deploy.md +++ b/docs/install/dev_deploy.md @@ -78,13 +78,13 @@ python manage.py createcachetable django_cache ## 打包并收集前端静态资源 1）安装依赖包 -进入 pipeline/blueflow/，执行以下命令安装 +进入 frontend/desktop/，执行以下命令安装 ```bash npm install ``` 2）本地打包 -在 pipeline/blueflow/ 目录下，继续执行以下命令打包前端静态资源 +在 frontend/desktop/ 目录下，继续执行以下命令打包前端静态资源 ```bash npm run build -- --STATIC_ENV=dev ``` @@ -98,8 +98,8 @@ python manage.py collectstatic --noinput 前端资源文件需要单独拷贝收集，执行如下命令 ```bash rm -rf static/dev static/images -mv pipeline/blueflow/static/dev static/ -mv pipeline/blueflow/static/images static/ +mv frontend/desktop/static/dev static/ +mv frontend/desktop/static/images static/ ``` diff --git a/docs/install/dev_web.md b/docs/install/dev_web.md index b43df34125..b0921e2e77 100644 --- a/docs/install/dev_web.md +++ b/docs/install/dev_web.md @@ -4,22 +4,22 @@ 标准运维前端是用 vue 框架开发的，在本地开发时需要先安装 node.js，直接去官网下载软件并安装即可，地址为：https://nodejs.org/en/。 ## 安装依赖包 -进入 pipeline/blueflow/，执行以下命令安装。 +进入 frontend/desktop/，执行以下命令安装。 ```bash npm install ``` ## 修改配置文件 -把 pipeline/blueflow/ 中的所有文件中的 {BK_PAAS_HOST} 换成你部署的蓝鲸社区版地址，如果你的应用 ID 修改过，请把所有文件中的 bk_sops 改成你的新应用 ID。 +把 frontend/desktop/ 中的所有文件中的 {BK_PAAS_HOST} 换成你部署的蓝鲸社区版地址，如果你的应用 ID 修改过，请把所有文件中的 bk_sops 改成你的新应用 ID。 ## 启动前端工程 -进入 bk_sops/src/pipeline/blueflow/，执行以下命令运行前端工程。默认启动的是 9000 端口，然后通过 http://dev.{BK_PAAS_HOST}:9000/ 访问前端应用，此时后端请求会自动转发到你启动的 django 工程，即 8000 端口。 +进入 bk_sops/src/frontend/desktop/，执行以下命令运行前端工程。默认启动的是 9000 端口，然后通过 http://dev.{BK_PAAS_HOST}:9000/ 访问前端应用，此时后端请求会自动转发到你启动的 django 工程，即 8000 端口。 ```bash npm run dev ``` ## 开发后打包 -前端开发完成后，正式发布前需要先打包。还是在 pipeline/blueflow/ 目录下，执行如下命令打包，会自动在当前目录下生成 static/dist/ 目录，即打包好的前端资源。 +前端开发完成后，正式发布前需要先打包。还是在 frontend/desktop/ 目录下，执行如下命令打包，会自动在当前目录下生成 static/dist/ 目录，即打包好的前端资源。 ```bash npm run build -- --SITE_URL="/o/bk_sops" --STATIC_ENV="open/prod" @@ -29,6 +29,6 @@ npm run build -- --SITE_URL="/o/bk_sops" --STATIC_ENV="open/prod" 前端打包后，需要在工程目录下运行如下命令收集静态资源到 static 下。 ```bash rm -rf static/open static/images -mv pipeline/blueflow/static/open static/ -mv pipeline/blueflow/static/images static/ +mv frontend/desktop/static/open static/ +mv frontend/desktop/static/images static/ ``` \ No newline at end of file diff --git a/docs/install/source_code_deploy.md b/docs/install/source_code_deploy.md index 5d1f2fc451..273cef4356 100644 --- a/docs/install/source_code_deploy.md +++ b/docs/install/source_code_deploy.md @@ -6,13 +6,13 @@ ## 打包并收集前端静态资源 1）安装依赖包 -进入 pipeline/blueflow/，执行以下命令安装 +进入 frontend/desktop/，执行以下命令安装 ```bash npm install ``` 2）本地打包 -在 pipeline/blueflow/ 目录下，继续执行以下命令打包前端静态资源 +在 frontend/desktop/ 目录下，继续执行以下命令打包前端静态资源 ```bash npm run build -- --STATIC_ENV=dev ``` @@ -33,7 +33,7 @@ python manage.py collectstatic --noinput ## 开通 API 白名单 -手动在你部署的蓝鲸社区版的中控机执行如下命令，开通标准运维访问蓝鲸PaaS平台API网关的白名单，以便标准运维原子可以正常调用 API。 +手动在你部署的蓝鲸社区版的中控机执行如下命令，开通标准运维访问蓝鲸PaaS平台API网关的白名单，以便标准插件可以正常调用 API。 ```bash source /data/install/utils.fc add_app_token bk-sops-ce "$(_app_token bk-sops-ce)" "标准运维定制版" diff --git a/docs/install/upload_pack_deploy.md b/docs/install/upload_pack_deploy.md index d931dd3983..79cdfca90a 100644 --- a/docs/install/upload_pack_deploy.md +++ b/docs/install/upload_pack_deploy.md @@ -10,13 +10,13 @@ ## 打包并收集前端静态资源 1）安装依赖包 -进入 pipeline/blueflow/，执行以下命令安装 +进入 frontend/desktop/，执行以下命令安装 ```bash npm install ``` 2）本地打包 -在 pipeline/blueflow/ 目录下，继续执行以下命令打包前端静态资源 +在 frontend/desktop/ 目录下，继续执行以下命令打包前端静态资源 ```bash npm run build -- --STATIC_ENV=dev ``` diff --git a/docs/overview/architecture.md b/docs/overview/architecture.md index 4d95b1396a..968ad8141a 100644 --- a/docs/overview/architecture.md +++ b/docs/overview/architecture.md @@ -5,10 +5,10 @@ 这是标准运维的逻辑架构图，可以分为四层： - API 网关层 -主要负责通过API网关和第三方平台进行交互，标准运维原子的实际执行就是通过这一层把请求分发给依赖的系统。 +主要负责通过API网关和第三方平台进行交互，标准运维插件的实际执行就是通过这一层把请求分发给依赖的系统。 - 流程引擎层 -负责解析上层的任务实例，映射节点原子对应的服务，并通过底层的蓝鲸API网关调用其他系统的API（如配置平台的创建集群，作业平台的快速执行脚本等），流程引擎还包括了具体的任务执行引擎和流程控制、上下文管理等模块。 +负责解析上层的任务实例，映射节点插件对应的服务，并通过底层的蓝鲸API网关调用其他系统的API（如配置平台的创建集群，作业平台的快速执行脚本等），流程引擎还包括了具体的任务执行引擎和流程控制、上下文管理等模块。 - 任务管理层 -主要对应标准运维的任务编排和任务控制功能，任务编排包含基础单元原子框架和原子展示层，任务控制包括创建任务实例的模板校验和参数校验，以及任务实例执行时给用户提供的操作接口如暂停、继续、撤销任务等。 +主要对应标准运维的任务编排和任务控制功能，任务编排包含基础单元插件框架和插件展示层，任务控制包括创建任务实例的模板校验和参数校验，以及任务实例执行时给用户提供的操作接口如暂停、继续、撤销任务等。 - 接入层 包含权限控制、API接口和数据统计等。 \ No newline at end of file diff --git a/docs/overview/code_structure.md b/docs/overview/code_structure.md index 0e99f7b5d7..c915c049af 100644 --- a/docs/overview/code_structure.md +++ b/docs/overview/code_structure.md @@ -6,21 +6,15 @@ - framework - 蓝鲸基于 django 框架的二次封装架构，主要提供 saas 运营在蓝鲸 paas 上的基础配置和服务。 + 蓝鲸基于 django 框架的二次封装架构，主要提供 SaaS 运营在蓝鲸 PaaS 上的基础配置和服务。 - conf：工程各部署环境配置，如本地环境、测试环境、正式环境。 + config：工程各部署环境配置，如本地环境、测试环境、正式环境，以及路由配置。 - common：主要是一些公共函数。 + blueapps：新版开发框架核心模块，包括蓝鲸统一登录、鉴权、中间件和公共函数。 - blueapps：也是一些公共函数，单独作为一个模块主要是为了向后兼容新版开发框架。 + packages：蓝鲸 API Gateway SDK，包括配置平台、作业平台等提供的API。 - bk_api：蓝鲸 paas 提供的 API。 - - blueking：蓝鲸 API Gateway SDK，包括配置平台、作业平台等提供的API。 - - account：蓝鲸统一登录和鉴权。 - -- pipeline +- pipeline、pipeline_web、pipeline_plugins 自研的流程引擎框架，主要包含任务流程编排页面和任务流程执行服务。 @@ -38,11 +32,15 @@ validators：数据校验，如环状结构检测和数据合法性校验。 - components：原子框架和原子定义。 + component_framework：插件框架和插件定义。 variables：全局变量定义。 contrib：扩展功能，如数据统计和前端 API。 + + pipeline_web：前端数据适配层，支持前端画布生成的流程数据。 + + pipeline_plugins：标准运维官方插件库和全局自定义变量。 - gcloud @@ -68,9 +66,9 @@ 前端资源，包括 webpack 配置和静态资源。 - pipeline.blueflow：主要包括流程编排 pipeline/blueflow 模块，该模块是基于 vue 实现的。 + frontend：主要包括流程编排 desktop 模块，该模块是基于 vue 实现的。 - static：原子 components 和变量 variables 的前端定义文件，都放在各自模块的 static 目录下。 + static：插件 components 和变量 variables 的前端定义文件，都放在各自模块的 static 目录下。 templates：包含首页和 django admin 需要的页面。 diff --git a/docs/overview/usecase.md b/docs/overview/usecase.md index 07f23293ca..6ec76f1ccd 100644 --- a/docs/overview/usecase.md +++ b/docs/overview/usecase.md @@ -1,4 +1,4 @@ # 使用场景 -标准运维主要用于运维场景，如业务发布、变更、开区、扩缩容、故障处理等执行类操作；通过接入自定义原子，对接企业内其他系统，如单据系统、 +标准运维主要用于运维场景，如业务发布、变更、开区、扩缩容、故障处理等执行类操作；通过接入自定义插件，对接企业内其他系统，如单据系统、 版本管理系统等，也能应用到监控告警、配置管理、开发工具、企业IT、办公应用等场景。 \ No newline at end of file diff --git a/docs/resource/img/code_structure.png b/docs/resource/img/code_structure.png index 41583be737..cb91be68cc 100644 Binary files a/docs/resource/img/code_structure.png and b/docs/resource/img/code_structure.png differ diff --git a/docs/wiki/faq.md b/docs/wiki/faq.md index 9225a67358..11fd6717ff 100644 --- a/docs/wiki/faq.md +++ b/docs/wiki/faq.md @@ -1,8 +1,8 @@ -### 标准运维原子支持用户接入企业内IT系统吗？ -> 支持，接入方式请参考“附录3：原子开发”。 +### 标准运维插件支持用户接入企业内IT系统吗？ +> 支持，接入方式请参考“附录3：标准插件开发”。 ### 标准运维点击开始执行任务后报错：taskflow[id=1] get status error: node(nodee37e20…c7fb131) does not exist, may have not by executed，并且在任务列表中查看任务状态是“未知”，可能是什么原因？ > 标准运维执行引擎依赖于蓝鲸的RabbitMQ服务和App启动的celery进程，请登录服务器确认服务已启动并正常运行，可以查看App的celery.log日志文件帮助定位问题原因。 -### 标准运维能执行任务，但是原子节点报错：Trackback…TypeError:int() argument must be a string or a number,not ‘NoneType’，可能是什么原因？ -> 标准运维任务流程的执行状态和原子输入、输出等信息缓存依赖Redis服务，所以首次部署请务必按照“标准运维部署文档”，配置Redis环境变量后重新部署。 +### 标准运维能执行任务，但是插件节点报错：Trackback…TypeError:int() argument must be a string or a number,not ‘NoneType’，可能是什么原因？ +> 标准运维任务流程的执行状态和插件输入、输出等信息缓存依赖Redis服务，所以首次部署请务必按照“标准运维部署文档”，配置Redis环境变量后重新部署。 diff --git a/docs/wiki/home.md b/docs/wiki/home.md index 10a7180534..4b928385c7 100644 --- a/docs/wiki/home.md +++ b/docs/wiki/home.md @@ -2,7 +2,7 @@ # 标准运维，一套成熟稳定的流程编排调度引擎！ ## 导读 ->标准运维是腾讯蓝鲸体系中的一款SaaS产品，它助力运维实现跨系统的调度自动化。通过一套成熟稳定的流程编排调度引擎，基于蓝鲸PaaS平台的API网关服务对接企业内部各个系统API的能力，把在多系统间切换的工作模式整合到一个流程中，不仅可以将腾讯蓝鲸智云体系内的服务（如：配置平台、作业平台、通知服务等）进行整合，而且提供了自定义原子开发能力，让用户可以将自己企业内独有的系统接入并整合，实现一键自动化调度。 +>标准运维是腾讯蓝鲸体系中的一款SaaS产品，它助力运维实现跨系统的调度自动化。通过一套成熟稳定的流程编排调度引擎，基于蓝鲸PaaS平台的API网关服务对接企业内部各个系统API的能力，把在多系统间切换的工作模式整合到一个流程中，不仅可以将腾讯蓝鲸智云体系内的服务（如：配置平台、作业平台、通知服务等）进行整合，而且提供了自定义插件开发能力，让用户可以将自己企业内独有的系统接入并整合，实现一键自动化调度。 ![](https://github.com/Tencent/bk-sops/blob/master/docs/wiki/img/wiki_product.png) ## 功能特性 diff --git a/docs/wiki/version-guideline.md b/docs/wiki/version-guideline.md index 4044a2acc0..073c3a53c3 100644 --- a/docs/wiki/version-guideline.md +++ b/docs/wiki/version-guideline.md @@ -6,7 +6,7 @@ * 第一段: 3代表整个标准运维的大版本，目前是3。只有在标准运维进行大的版本调整时才会变更。 * 第二段： - 1代表一个版本迭代周期，该周期内包含大的结构调整或者依赖的蓝鲸原子平台需要升级。当迭代周期向前演进时会进行调整。 + 1代表一个版本迭代周期，该周期内包含大的结构调整或者依赖的蓝鲸插件平台需要升级。当迭代周期向前演进时会进行调整。 * 第三段： 32代表当前的迭代周期，包含了一个特性、多个bugfix等内容。随着开发节奏不定期进行调整。一般为1~3周的周期。 * pre-release-type： diff --git a/scripts/i18n/django_i18n.sh b/scripts/i18n/django_i18n.sh index a75a89c99c..ad696a873a 100755 --- a/scripts/i18n/django_i18n.sh +++ b/scripts/i18n/django_i18n.sh @@ -4,16 +4,19 @@ WORK_PATH=`pwd` # check_vue_i18n_utils # 所有的 vue 文件都需要添加 import '@/utils/i18n.js'，排除不能和项目代码耦合的独立组件 IpSelector # $1 参数表示当前目录 -for item in `find $WORK_PATH/pipeline/blueflow/src/ -name "*.vue" ! -path "*IpSelector*"`;do +for item in `find $WORK_PATH/frontend/desktop/src/ -name "*.vue" ! -path "*IpSelector*"`;do echo $item grep "i18n.js" $item || exit 1 done mkdir -p ~/Temp/gcloud_open/ mv -f $WORK_PATH/static/ ~/Temp/gcloud_open/ -rm -rf $WORK_PATH/pipeline/blueflow/static/ +rm -rf $WORK_PATH/frontend/desktop/static/ pybabel extract -F babel.cfg --copyright-holder=blueking . -o django.pot || exit 1 +# first time +# pybabel init -i django.pot -D django -d locale -l en --no-wrap +# pybabel init -i django.pot -D django -d locale -l zh_hans --no-wrap pybabel update -i django.pot -d locale -D django --no-wrap || exit 1 django-admin makemessages -d djangojs -e vue,js -i '*node_modules*' --no-wrap || exit 1 diff --git a/scripts/publish/build.sh b/scripts/publish/build.sh index 83a24d5e1c..dc7c47fb4c 100644 --- a/scripts/publish/build.sh +++ b/scripts/publish/build.sh @@ -2,7 +2,7 @@ APP_CODE="bk_sops" rm -rf $APP_CODE mkdir -p $APP_CODE/src $APP_CODE/pkgs || exit 1 -rsync -av --exclude="$APP_CODE" --exclude=".*" --exclude="*.tar.gz" --exclude="pipeline/blueflow/node_modules/" ./ $APP_CODE/src/ || exit 1 +rsync -av --exclude="$APP_CODE" --exclude=".*" --exclude="*.tar.gz" --exclude="frontend/desktop/node_modules/" ./ $APP_CODE/src/ || exit 1 cp app.yml $APP_CODE/ || exit 1 echo "libraries:" >> $APP_CODE/app.yml grep -e "^[^#].*$" requirements.txt | awk '{split($1,b,"==");printf "- name: "b[1]"\n version: "b[2]"\n"}' >> $APP_CODE/app.yml