Merge pull request #32 from HmhWz/1.1.0

add dss-debug doc

Author: zqburde

zh_CN/Images/安装部署/DSS调试/img.png

@@ -11,6 +11,7 @@
 进入到dss的部署目录，在目录下执行命令停止dss的所有服务：
 ```shell
 cd ${DSS_DEPLOY_PATH}
+
 sh sbin/dss-stop-all.sh
 ```
 #### 2. 执行数据库升级sql脚本
@@ -29,7 +30,26 @@ source ${your_path}/from_v101_to_v110.sql
 
 #### 3. dss部署目录替换为新版本包
 
-首先备份dss旧版本的部署目录，以该目录为例：/appcom/Install/DSSInstall
+**(重要：最好先备份好dss旧版本的数据库)**
+
+- 通过mysqldump命令备份如下有结构变化的表：
+
+dss_appconn、dss_appconn_instance、dss_workflow_node、dss_onestop_user_favorites、dss_component_role、dss_onestop_menu_application
+
+
+
+这些表只是修改了表名，也可以备份下：
+
+dss_dictionary
+dss_role 
+dss_admin_dept
+dss_download_audit 
+dss_flow_relation
+dss_flow_edit_lock 
+dss_onestop_menu 
+dss_menu_role
+
+- 备份dss旧版本的部署目录，以该目录为例：/appcom/Install/DSSInstall
 ```shell
 mv /appcom/Install/DSSInstall /appcom/Install/DSSInstall-bak
 ```
@@ -67,17 +87,12 @@ cp -r conf/dss-guide-server.properties /appcom/Install/DSSInstall/conf/
 
 配置修改：
 
-1.在dss.properties配置文件中加入：
-```properties
-###dolphinscheduler系统admin用户的token，若无需安装dolphinscheduler-appconn则无需配置该项
-wds.dss.appconn.ds.admin.token=
-```
 1.在配置文件dss-framework-project-server.properties中加入：
 ```properties
-###或appconn没有实现所欲开发规范（节点更新、删除、拷贝、导入、导出操作），需要加入到该配置忽略检查
+###若appconn没有实现所有开发规范（节点更新、删除、拷贝、导入、导出操作），需要加入到该配置忽略检查
 wds.dss.appconn.checker.development.ignore.list=workflow,sendemail
-###或appconn没有实现所有工程规范（增删改查），需要加入到该配置忽略检查
-wds.dss.appconn.checker.project.ignore.list=mlss
+###若appconn没有实现所有工程规范（增删改查），需要加入到该配置忽略检查
+wds.dss.appconn.checker.project.ignore.list=
 ```
 
 #### 5. 服务启动

zh_CN/Images/安装部署/DSS调试/img_1.png

@@ -0,0 +1,82 @@
+---
+title: 调试指引
+sidebar_position: 2
+---
+
+# 调试相关
+
+> 没有任何程序员能够一气呵成的写出没有任何Bug的代码，所以很多程序员有相当一部分时间是花费在Debug上的，程序调试是每个程序员必须面对的工作，下面就指导大家如何进行dss远程调试(基于DSS1.1.0版本)。
+
+## step 1 准备DSS源码并编译
+
+```plain
+git clone https://github.com/WeBankFinTech/DataSphereStudio.git
+cd DataSphereStudio
+#如果需要 可以切换到对应的分支上
+#git checkout dev-xxx
+mvn -N install 
+mvn clean Install
+```
+
+## step 2 在服务器上部署好DSS服务
+若尚未部署DSS可参考部署文档：[DSS单机部署文档](./DSS单机部署文档.md)
+
+## step 3 打开调试端口
+
+首先需要明确需要调试的包所在的服务，根据需要调试的代码位置,确定其所属的服务。
+
+进入dss部署目录下的该目录：${DSS_HOME}/sbin/ext，修改需要调试的对应服务的启动脚本文件，开启远程调用端口：（以workflow-server服务为例）
+
+```properties
+cd ${DSS_HOME}
+
+vim sbin/ext/dss-workflow-server
+```
+在脚本中找到 DEBUG_PORT 关键字，然后输入需要打开的端口号（要从本地能够连通）：
+
+![img.png](../Images/安装部署/DSS调试/img.png)
+
+接着需要重启对应服务使之生效：
+
+```
+sh sbin/dss-daemon.sh restart workflow-server
+```
+注：如果不确定服务名称，可以在 ${DSS_HOME}/sbin/common.sh 脚本内查询，
+只需要输入服务的关键字即可启动对应服务：
+
+![img_1.png](../Images/安装部署/DSS调试/img_1.png)
+
+
+## step 4 IDEA编译器配置远程调试
+如下图所示打开窗口并配置远程调试的端口,服务,以及模块：  
+
+![img_2.png](../Images/安装部署/DSS调试/img_2.png)
+
+## step 5. 开始调试
+
+在idea右上角点击调试按钮，即可可以开始调试：
+
+![img_3.png](../Images/安装部署/DSS调试/img_3.png)
+
+## step 6. 替换jar包
+
+本地修改了代码后，可以打包好对应模块的jar包，然后替换服务器上对应lib的jar。重启服务即可。
+
+```properties
+cd ${DSS_HOME}
+
+## 往服务器上传jar包
+rz -bye
+
+##将上传的jar包拷贝替换原来jar包
+cp ${your_jar_name} lib/${jar_path}
+```
+
+注：若不清楚该jar在哪些服务的lib中存在，可通过如下命令搜索该jar的所有位置：
+```properties
+cd ${DSS_HOME}
+###搜索lib目录下的所有dss-orchestrator-common-*.jar包
+find lib/ -name "*dss-orchestrator-common*"
+```
+
+![img_4.png](../Images/安装部署/DSS调试/img_4.png)

zh_CN/Images/安装部署/DSS调试/img_2.png

@@ -23,6 +23,21 @@ sh bin/appconn-install.sh
 >> 8085
 ```
 
+#### 配置 "前往调度中心" 按钮 的 url
+
+修改 `${DSS_HOME}/conf/dss-workflow-server.properties` 配置：
+
+```properties
+#该路径对应的是dolphinscheduler运维中心的页面
+wds.dss.workflow.schedulerCenter.url="http://${schedulis_ip}:${schedulis_port}"
+```
+
+然后重启下 workflow 使配置生效：
+
+```shell script
+sh sbin/dss-daemon.sh restart workflow-server
+```
+
 
 ### 三、Schedulis JobType 插件安装
 
@@ -38,12 +53,10 @@ sh bin/appconn-install.sh
 
 | 表名      | 表作用   | 备注                                   |
 |-----------------|----------------|----------------------------------------|
-| dss_application       | 应用表,主要是插入 schedulis 应用的基本信息 | 必须                                   |
-| dss_menu     | 菜单表，存储对外展示的内容，如图标、名称等 | 必须                                   |
-| dss_onestop_menu_application | menu 和 application 的关联表，用于联合查找 |                    必须                |
+| dss_workspace_menu     | 菜单表，存储对外展示的内容，如图标、名称等 | 必须                                   |
+| dss_workspace_menu_appconn | menu 和 application 的关联表，用于联合查找 |                    必须                |
 | dss_appconn      | appconn 的基本信息，用于加载 appconn  | 必须                                   |
 | dss_appconn_instance  | AppConn 的实例的信息，包括自身的url信息 | 必须         |
-| dss_workflow_node  | schedulis 作为工作流节点需要插入的信息 | 如果使用可视化节点，则必须         |
 
 - Schedulis 作为调度框架，实现了一级规范和二级规范，需要使用 Schedulis AppConn 的微服务如下表。