Merge pull request #28 from zqburde/fix

Add project and workflow doc.

Author: zqburde

zh_CN/设计文档/project/DSS工程模块设计文档.md

@@ -0,0 +1,96 @@
+# DSS 工程设计
+
+
+
+在实际的开发生产中，工程往往被用来管理开发一类数据应用，工程可以是一个实际的一类数据应用，包括工作流，单任务等，每个工作空间下的工程互相隔离。
+
+
+
+## 1、架构设计
+
+- DSS本身可以创建和管理工程。包括创建、查看、修改、删除等功能。同时DSS提供工程集成规范完成与外部组件的对接操作。
+- DSS的工程通过工程集成规范，与外部系统的工程（或同级别的实体）进行同步创建和互相绑定。
+- 外部系统通过工程集成规范，获取用户在DSS对应的工程，完成对底层实体的统一管理。
+- 外部系统通过工程集成规范，获取用户在DSS拥有的工程权限，进一步限制原生工程的操作权限。
+
+![project](images\project.png)
+
+
+
+### 2.1.1、工程创建
+
+简要流程说明：创建DSS工程 》创建第三方应用工程 》保存工程与用户权限关系
+
+流程图：
+
+![创建工程流程图](images/project-create.png)
+
+### 2.1.2、工程编辑
+
+简要流程说明： 编辑用户权限关系 》编辑第三方工程信息 》编辑DSS工程基本信息
+
+
+
+流程图：
+
+![创建工程流程图](images/project-edit.png)
+
+### 2.1.3、工程删除
+
+简要流程说明：判断是否有删除权限 》删除第三方应用工程 》删除DSS工程
+
+### 
+
+## 3、数据库表结构设计
+
+```
+--dss工程基础信息表
+dss_project:
+ id                      
+ name                    
+ source                  
+ description             
+ user_id                 
+ username                
+ workspace_id            
+ create_time             
+ create_by               
+ update_time             
+ update_by               
+ org_id                  
+ visibility              
+ is_transfer             
+ initial_org_id          
+ isArchive               
+ pic                     
+ star_num                
+ product                 
+ application_area        
+ business                
+ is_personal             
+ create_by_str           
+ update_by_str           
+ dev_process             
+ orchestrator_mod        
+ visible
+ 
+ --dss工程与用户权限关系表
+ dss_project_user:
+  id                 
+  project_id         
+  username           
+  workspace_id       
+  priv  
+  last_update_time 
+  
+ --第三方应用工程与dss工程关系表
+ dss_appconn_project_relation:  
+  id                           
+  project_id                   
+  appconn_instance_id          
+  appconn_instance_project_id
+
+```
+
+
+

zh_CN/设计文档/project/images/project-create.png

@@ -0,0 +1,19 @@
+## 工作流发布设计
+
+## 一、概述
+
+在实际的生产应用中，开发中心负责对业务相关的工作流做调试，当调试完成之后，会把工作流发布到调度系统做定时批量调度作业，实现业务自动化。
+
+### 二、工作流发布架构设计
+
+工作流的发布是一个相对复杂的过程，其中涉及到工作流的导入、导出以及发布等功能。
+
+##### 1、发布流程调用链路图：
+
+![img](images/workflow-publish.png)
+
+##### 2、重要步骤说明
+
+- 导出：从开发中心(dev)导出，包括工作流和第三方节点导出。通过bml服务将生成的工作流json文件压缩成zip包上传到bml文件服务中心。
+- 导入：导入到生产中心(prod)。下载保存在bml文件服务中心的的zip文件，并对json文件进行解析，获取工作流编排信息，并保存到数据库。
+- 发布：将导入获取到的dss工作流编排信息转换成调度系统可用的工作流编排信息，压缩成zip包，发布到wtss调度系统。

zh_CN/设计文档/project/images/project-edit.png

@@ -0,0 +1,60 @@
+## DSS工作流(workflow)架构设计
+
+工作流(workflow)：指“业务过程的部分或整体在计算机应用环境下的自动化”。是对工作流程及其各操作步骤之间业务规则的抽象、概括描述。通过使用工作流可以给数据开发工作带来极大的便利。
+
+### 一、工作流架构
+
+![工作流](images/workflow.png)
+
+
+
+### 二、二级模块介绍
+
+##### dss-workflow-server
+
+工作流核心模块，包括工作流CRUD功能，工作流发布功能，工作流appconn节点的CRUD功能，工作流cs服务功能，以及PPC对外提供服务功能。
+
+| 核心service     | 核心功能 |
+| ------------------- | -------- |
+| DSSFlowService      | 包含了工作流及子工作流CRUD，以及工作流版本管理等方法        |
+| WorkflowNodeService | 包含工作流节点CRUD、copy、import、export等方法       |
+| PublishService    | 提供工作流发布相关功能 |
+| DSSWorkflowReceiver  | PRC任务调用接收器 |
+| DSSWorkflowChooser | PRC任务调用选择器 |
+
+##### dss-flow-execution-server
+
+工作流执行模块，包含工作流执行的相关功能，包括工作流的实时执行、选中执行、失败重跑、工作流kill等功能。
+
+##### dss-workflow-sdk
+
+工作流工具包模块，对外提供工作流资源文件解析功能。
+
+| 核心类           | 核心功能                                     |
+| ---------------- | -------------------------------------------- |
+| FlowToJsonParser | 用于将一个flow解析为DSS可以使用的DSSJsonFlow |
+| json2flow        | 用于将工作流json解析为需要的工作流对象       |
+
+##### dss-workflow-common
+
+工作流基础公共模块，将公共实体类抽象出来，保存在此模块当中。
+
+##### dss-linkis-node-execution
+
+dss调用linkis执行节点模块，实现了linkis提供的任务执行相关接口。
+
+| 核心类                  | 核心功能                                                     |
+| ----------------------- | ------------------------------------------------------------ |
+| LinkisNodeExecution     | 包含任务运行、任务状态、任务结果、任务取消、任务日志等核心方法 |
+| LinkisExecutionListener | 监听任务执行情况                                             |
+| DefaultRetryHandler     | 提供重试机制                                                 |
+
+##### dss-workflow-conversion-standard
+
+工作流转换规范模块，定义了将DSS的工作流转换为其他外部应用可以使用的工作流的规范。
+
+| 核心类                                | 核心功能       |
+| ------------------------------------- | -------------- |
+| ProjectConversionIntegrationStandard  | 工程转换规范   |
+| WorkflowConversionIntegrationStandard | 工作流转换规范 |
+