Merge pull request #7 from JackChen0810/main

Documentation for installing QualitisAppConn and compiling DSS

Author: wushengyeyouya

zh_CN/Images/安装部署/QualitisAppConn部署/dss-qualitis.png

@@ -0,0 +1,74 @@
+# QualitisAppConn安装文档
+
+本文主要介绍在DSS(DataSphere Studio)1.0中QualitisAppConn的部署、配置以及使用。
+
+
+
+## 1.部署QualitisAppConn的准备工作
+
+您在部署QualitisAppConn之前，必须要先将Qualitis部署启动并保证基本功能可用。
+
+
+
+## 2.QualitisAppConn插件的下载和编译
+
+我们提供了QualitisAppConn的物料包，如果您已经下载了，您可以跳过此步骤。如果您想自己编译QualitisAppConn，具体编译步骤如下:
+1. clone DataSphere Studio的代码
+2. 单独编译qualitis-appconn
+```bash 
+cd {DSS_CODE_HOME}/dss-appconn/appconns/dss-qualitis-appconn
+mvn clean install
+```
+
+## 3.QualitisAppConn插件的部署和配置
+
+
+1. 从步骤2中的target目录获取qualitis-appconn.zip物料包
+2. 放置到如下目录并进行解压
+```bash 
+cd {DSS_HOME}/dss/dss-appconns
+unzip qualitis-appconn.zip
+```
+3.配置QualitisAppConn的相关信息
+``` bash 
+cd {DSS_INSTALL_HOME}/dss/bin
+sh install-appconn.sh
+脚本是交互式的安装方案，您需要输入字符串qualitis以及qualitis服务的ip和端口，即可以完成安装
+```
+4.重启dss服务，完成插件的更新
+
+## 4.QualitisAppConn的使用
+您可以进入DSS的前端首页,然后进入Qualitis应用的首页,如图
+
+![Qualitis嵌入DSS](../Images/安装部署/QualitisAppConn部署/dss-qualitis.png)
+
+您也可以通过使用工作流的可视化节点来使用Qualitis的可视化能力，如图
+
+![工作流使用可视化节点](../Images/安装部署/QualitisAppConn部署/workflow-qualitis.png)
+
+
+
+## 5.QualitisAppConn插件的工作原理
+本小节是安装的延伸，是对QualitisAppConn工作原理的简单讲解。
+
+1.使用QualitisAppConn的微服务
+
+DSS中有以下的微服务会通过QualitisAppConn与Qualitis进行交互，完成指定的功能。
+
+| 微服务名      | 使用AppConn完成的功能   | 备注                                   |
+|-----------------|----------------|----------------------------------------|
+| dss-framework-project-server       | 使用qualitis-appconn完成工程以及组织的统一    | 必须                                   |
+| dss-workflow-server     | 使用第三级规范完成节点的创建、编辑和导入导出等| 必须                                   |
+| appconn-engine | 使用第三级规范，完成qualitis节点的执行 |                    必须                |
+
+2. Qualitis集成进入dss需要在以下数据库表中设置相应的内容
+
+| 表名      | 表作用   | 备注                                   |
+|-----------------|----------------|----------------------------------------|
+| dss_application       | 应用表,主要是插入qualitis应用的基本信息    | 必须                                   |
+| dss_menu     | 菜单表，存储对外展示的内容，如图标、名称等 | 必须                                   |
+| dss_onestop_menu_application | menu和application的关联表，用于联合查找 |                    必须                |
+| dss_appconn      | appconn的基本信息，用于加载appconn  | 必须                                   |
+| dss_appconn_instance  | qualitis实例的信息，包括qualitis自身的url信息   | 必须         |
+| dss_workflow_node  | Qualitis作为工作流节点需要插入的信息   | 如果想使用数据质量检测，则必须   |
+

zh_CN/Images/安装部署/QualitisAppConn部署/workflow-qualitis.png

@@ -0,0 +1,41 @@
+## 1.编译整体的DSS：
+
+   从git获取项目代码后，使用maven打包项目安装包。  
+
+   (1) 您可以在最顶层的pom.xml文件，修改Linkis、Java、Scala、Maven等软件的版本，以适配您公司的大数据环境，具体如下：
+
+```xml
+  <properties>
+          <dss.version>1.0.0</dss.version>
+          <linkis.version>1.0.2</linkis.version>
+          <scala.version>2.11.12</scala.version>
+          <jdk.compile.version>1.8</jdk.compile.version>
+          <maven.version>3.3.3</maven.version>
+  </properties>
+
+```
+
+   (2) **如果您是本地第一次使用，必须在最外层工程pom.xml所在目录先执行以下命令**：
+
+```bash
+    mvn -N  install
+```
+
+   (3) 在最外层工程pom.xml所在目录执行以下命令
+    
+```bash
+    mvn clean install
+```
+
+  
+
+  (4) 获取安装包，在工程的assembly->target目录下：
+
+```
+    wedatasphere-dss-x.x.x-dist.tar.gz
+```
+
+
+
+
+