Merge pull request #31 from wushengyeyouya/1.1.0

Add some docs for DSS1.1.0

Author: zqburde

README-ZH.md

@@ -48,7 +48,7 @@ DataSphereStudio
 
        请参照 [编译指引](zh_CN/开发文档/DSS编译文档.md) 来编译 DSS 源码。
 
-       请参考 [安装部署文档](zh_CN/安装部署/DSS单机部署文档.md) 来部署 DSS。
+       请参考 [安装部署文档](zh_CN/安装部署/DSS&Linkis一键部署文档单机版.md) 来部署 DSS。
 
 ## Demo试用环境
 

zh_CN/README.md

@@ -7,7 +7,7 @@ DataSphere Studio（简称 DSS）是微众银行自研的数据应用开发管
 ## 文档列表
 
 * [安装部署](安装部署)
-    * [DSS 单机部署文档](安装部署/DSS单机部署文档.md)
+    * [DSS 单机部署文档](安装部署/DSS&Linkis一键部署文档单机版.md)
     * [ExchangisAppConn 插件安装文档](安装部署/ExchangisAppConn插件安装文档.md)
     * [QualitisAppConn 插件安装文档](安装部署/QualitisAppConn插件安装文档.md)
     * [SchedulisAppConn 插件安装文档](安装部署/SchedulisAppConn插件安装文档.md)

zh_CN/SUMMARY.md

@@ -1,17 +1,40 @@
 * [安装部署](安装部署)
-    * [DSS 单机部署文档](安装部署/DSS单机部署文档.md)
-    * [ExchangisAppConn 插件安装文档](安装部署/ExchangisAppConn插件安装文档.md)
-    * [QualitisAppConn 插件安装文档](安装部署/QualitisAppConn插件安装文档.md)
+    * [DSS & Linkis 一键部署文档单机版.md](安装部署/DSS&Linkis一键部署文档单机版.md)
+    * [DolphinScheduler 插件安装文档](安装部署/DolphinScheduler插件安装文档.md)
     * [SchedulisAppConn 插件安装文档](安装部署/SchedulisAppConn插件安装文档.md)
-    * [VisualisAppConn 插件安装文档](安装部署/VisualisAppConn插件安装文档.md)
+    * [DSS1.0.1 到 1.1.0 升级文档](安装部署/DSS1.0.1到1.1.0升级文档.md)
 * [使用文档](使用文档)
-    * [DSS 用户手册](使用文档/DSS用户手册.md)
-    * [DataApiService 使用文档](使用文档/DataApiService使用文档.md)
+    * [DSS 快速使用文档](使用文档/DSS用户手册.md)
+    * [DSS 用户手册汇总版](用户手册/用户使用文档.md)
+        * [DSS 如何新增用户](用户手册/DSS新增用户方式.md)
+        * [超级管理员使用介绍](用户手册/超级管理员功能.md)
+        * [工作空间管理使用介绍](用户手册/)
+        * [Scriptis 数据开发探索使用介绍](用户手册/Scriptis使用文档.md)
+        * [DSS 工作流使用介绍](用户手册/工作流使用文档.md)
+        * [数据服务使用介绍](用户手册/数据服务使用手册.md)
+        * [Linkis 管理台使用介绍](https://linkis.apache.org/zh-CN/docs/latest/user_guide/console_manual)
+        * [调度中心使用介绍](用户手册/调度中心使用文档.md)
+    * [DSS 接口汇总](使用文档/DSS接口汇总.md)
+    * [DSS 用户登录认证体系](使用文档/用户登录认证体系.md)
+    * DSS 插件使用文档
+        * [如何使用 ExchangisAppConn ？]()
+        * [如何使用 StreamisAppConn ？]()
+        * [如何使用 QualitisAppConn ？]()
+        * [如何使用 VisualisAppConn ？]()
+        * [如何使用 ProphecisAppConn ？]()
     * Scriptis
         * [如何使用 SparkSQL？](使用文档/Scriptis/Scriptis_User_Tests3_SparkSQL.md)
         * [如何使用 Hive QL？](使用文档/Scriptis/Scriptis_User_Tests2_Hive.md)
         * [如何使用 Spark Scala？](使用文档/Scriptis/Scriptis_User_Tests1_Scala.md)
 * [开发文档](开发文档)
     * [DSS 后台编译文档](开发文档/DSS编译文档.md)
     * [DSS 前端编译文档](开发文档/前端编译文档.md)
-    * [第三方系统接入 DSS 开发指南](开发文档/第三方系统接入DSS开发指南.md)
+    * [第三方系统接入 DSS 开发指南](开发文档/第三方系统接入DSS开发指南.md)
+* [设计文档](设计文档)
+    * [AppConn 设计文档](设计文档/appconn/appconn.md)
+    * [DSS Workspace 设计文档](设计文档/Workspace/README.md)
+    * [DSS Project 设计文档](设计文档/project/DSS工程模块设计文档.md)
+    * [DSS Orchestrator 设计文档](设计文档/Orchestrator/README.md)
+    * [DSS 工作流微模块设计文档](设计文档/workflow/DSS工作流架构设计.md)
+    * [DSS 工作流执行设计文档](设计文档/FlowExecution/README.md)
+    * [DSS 工作流发布到调度系统设计文档](设计文档/publish/工作流发布设计文档.md)

zh_CN/使用文档/DSS新增用户方式.md

@@ -0,0 +1,129 @@
+# DataSphere Studio 用户登录认证体系
+
+> DSS 默认只提供了管理员账号，用户登录鉴权依托于 Linkis 的 LDAP 用户登录认证体系。
+> 本文将详细介绍 Linkis 目前已经支持的用户登录认证方式。
+
+## 一、基本介绍
+
+1. DSS 超级管理员的用户名为部署用户名，如部署用户为 hadoop，则管理员的用户名和密码为 hadoop/hadoop，具体用户可在 [DSS单机部署文档](../安装部署/DSS&Linkis一键部署文档单机版.md) 查看。
+
+2. DSS的用户登录鉴权，依托于 Linkis 的用户登录认证体系。除管理员以外，Linkis 还支持以下用户登录认证方式： 
+  
+  - Token 登录方式
+  - 代理用户模式
+  - 接入SSO单点登录  
+
+## 二、Token登录方式
+
+该方式是给第三方系统访问 Linkis 和 DSS 使用的。
+
+第三方系统调用 Linkis 和 DSS 后台接口时，只需通过 token 模式即可直接跳过登录。
+
+在 `linkis/linkis-gateway/conf/linkis.properties` 指定如下参数：
+
+```properties
+    # 打开token模式
+    wds.linkis.gateway.conf.enable.token.auth=true
+    # 指定token配置文件
+    wds.linkis.gateway.conf.token.auth.config=token.properties
+```
+
+在 `linkis/linkis-gateway/conf` 目录下，创建 `token.properties` 文件，内容如下：
+
+```properties
+    # 格式如下：
+    ${TOKEN_NAME}=${USER1},${USER2}
+    # 例如：
+    AZKABAN=*
+```
+
+TOKEN_NAME 指分配给第三方系统的 tokenId，后面的 value 为可跳过登录的用户，如果完全信任该系统的所有请求，可直接等于*，表示全部授权。
+
+第三方系统在请求 DSS 和 Linkis，在 request 的 header 或 cookie 中，写入如下两个参数即可：
+
+```json
+    {
+      "Token-Code": "${TOKEN_NAME}",
+      "Token-User": "${USER}"
+    }
+```
+
+## 三、代理用户模式
+
+该方式允许登录用户和实际使用 DSS 的用户不同，主要作用：控制用户登录时必须为实名用户，但是实际使用大数据平台时，是非实名用户。
+
+在 `linkis/linkis-gateway/conf/linkis.properties` 指定如下参数：
+
+```properties
+    # 打开代理模式
+    wds.linkis.gateway.conf.enable.proxy.user=true
+    # 指定代理配置文件
+    wds.linkis.gateway.conf.proxy.user.config=proxy.properties
+```
+
+在 `linkis/linkis-gateway/conf` 目录下，创建 `proxy.properties` 文件，内容如下：
+
+```properties
+    # 格式如下：
+    ${LOGIN_USER}=${PROXY_USER}
+    # 例如：
+    enjoyyin=hadoop
+```
+
+如果现有的代理模式不能满足您的需求，您也可以手动修改：`com.webank.wedatasphere.linkis.gateway.security.ProxyUserUtils`。
+
+## 四、接入SSO单点登录
+
+接入您公司的 SSO 单点登录体系要复杂一些。
+
+首先，您需要打开 SSO 单点验证功能，请在 `linkis/linkis-gateway/conf/linkis.properties` 指定如下参数：
+
+```properties
+    wds.linkis.gateway.conf.enable.sso=true
+```
+
+然后，您需要实现SSOInterceptor接口：
+
+```scala
+trait SSOInterceptor {
+
+  /**
+    * 如果打开SSO单点登录功能，当前端跳转SSO登录页面登录成功后，会重新跳回到DSS首页，这时DSS前端再次请求gateway，
+    *     gateway会通过调用该方法获取已SSO登录的用户，然后将用户写入cookie，保证后续请求可直接放行。
+    * 您需实现该方法，通过Request返回用户名。
+    * @param gatewayContext
+    * @return
+    */
+  def getUser(gatewayContext: GatewayContext): String
+
+  /**
+    * 通过DSS首页Url，用户生成一个可重定向的SSO登录页面URL。
+    * 要求：需带上requestUrl，以便SSO登录成功后能跳转回来
+    * @param requestUrl DSS首页URL
+    * @return 例如：https://${sso_host}:${sso_port}/cas/login?redirectUrl=${requestUrl}
+    */
+  def redirectTo(requestUrl: URI): String
+
+  /**
+    * 用户退出登录时，gateway会调用此接口，以保证gateway清除cookie后，SSO单点登录也会把登录信息清除掉
+    * @param gatewayContext
+    */
+  def logout(gatewayContext: GatewayContext): Unit
+
+}
+```
+
+将您的 SSO 实现类，打成 jar 包，放入 `linkis/linkis-gateway/lib` 目录。
+
+Linkis 提供了两种加载您 SSO 实现类的方式：
+
+将 SSO 实现类声明为 Spring bean，这种方式要求您只需在类名上面加上 `@Component` 注解即可。
+
+在 `linkis/linkis-gateway/conf/linkis.properties` 指定如下参数：
+
+```properties
+    #请指定为您的SSO实现类
+    wds.linkis.gateway.conf.sso.interceptor=com.webank.wedatasphere.linkis.gateway.security.sso.SSOInterceptor
+```
+
+重启 linkis-gateway，SSO 单点登录即可生效。

zh_CN/使用文档/用户登录认证体系.md

@@ -115,10 +115,10 @@
 
 ### <a id = "1">四、修改配置</a>
 
-- 用户需要对xx/dss_linkis/conf目录下的config.sh和db.sh进行修改
+- 用户需要对 `xx/dss_linkis/conf` 目录下的 `config.sh` 和 `db.sh` 进行修改。
 
 
-- 打开config.sh，按需修改相关配置参数，参数说明如下：
+- 打开 `config.sh`，按需修改相关配置参数，参数说明如下：
 
 ```properties
 #################### 一键安装部署的基本配置 ####################
@@ -285,7 +285,9 @@ EXECUTION_LOG_PATH=/appcom/tmp/dss
 ############## other default configuration 其他默认配置信息 ############## 
 ```
 
-- 修改数据库配置。请确保配置的数据库，安装机器可以正常访问，否则将会出现DDL和DML导入失败的错误，打开db.sh，按需修改相关配置参数，参数说明如下：
+请注意：DSS 推荐使用 LDAP 进行用户登录鉴权，如您想接入公司的 LDAP，还需在上面的 `config.sh` 中填写 LDAP 的配置参数。 [如何安装 LDAP？](https://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-ldap-quickstart.html)
+
+- 修改数据库配置。请确保配置的数据库，安装机器可以正常访问，否则将会出现 DDL 和 DML 导入失败的错误，打开 `db.sh`，按需修改相关配置参数，参数说明如下：
 
 ```properties
 ### 配置DSS数据库