Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
howeye committed Dec 23, 2019
1 parent bda3c85 commit d346550
Show file tree
Hide file tree
Showing 10 changed files with 46 additions and 26 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,9 @@ If you desire immediate response, please kindly raise issues to us or scan the b
![](images/en_US/ch1/ContractUs.png)

## License
**Linkis is under the Apache 2.0 license. See the [LICENSE](/LICENSE) file for details.**
**Linkis is under the Apache 2.0 license. See the [LICENSE](/LICENSE) file for details.**

## Tips
Because the front-end code of Qualitis is FES, a front-end framework developed by WeBank, but the FES framework is not currently open source, so the front-end code of Qualitis is not open source for the time being. We will promote Qualitis's front-end open source as soon as possible. We are very sorry about this.

You can download the source code and unzip web/app/src/main/resources/static/static.zip to get the compiled front-end code, or use it directly by downloading the release.
19 changes: 10 additions & 9 deletions docs/en_US/ch1/QuickDeploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Hadoop (2.7.2)
Hive (1.2.1)
Zookeeper (3.4.9)
Linkis (0.9.1), Spark engine required.[How to install Linkis?](https://github.com/WeBankFinTech/Linkis)
DataSphereStudio (0.6.0) Optional. If you want to use workflow, it it required. [How to install DataSphereStudio?](https://github.com/WeBankFinTech/DataSphereStudio)
DataSphereStudio (0.6.0) Optional. If you want to use workflow, it it required. [How to install DataSphereStudio?](https://github.com/WeBankFinTech/DataSphereStudio)

## 2. Download
[Download](https://github.com/WeBankFinTech/Qualitis/releases)
Expand Down Expand Up @@ -54,10 +54,6 @@ task.persistence.address=
## zookeeper address
zk.address=
## HiveServer2 username and password
hive.username=
hive.password=
```

### 4.4 Start Service
Expand All @@ -79,9 +75,7 @@ Click on "Configuration" -> "Cluster Configuration" to add cluster.
![系统配置](../../../images/en_US/ch1/NewCluster.png)
Type in the configuration information below:
Cluster name(The name of Hadoop cluster)
Cluster type
HiveMetaStore address
HiveServer2 address
Cluster type
Linkis address
Linkis Token(How to get Linkis Token:[Linkis Access Guide](Linkis Access Guide.md))

Expand All @@ -90,7 +84,14 @@ Here is an example:

---

Tips:
Tips:

Qualitis will save the abnormal data in the database. The saved database name can be configured in the system settings, as shown in the following figure:
![](../../../images/en_US/ch1/AbnormalDataSavedDatabaseConfiguration.png)
As shown in the figure, Qualitis provides $ {USERNAME} as an expression for user name replacement. The abnormal data ran by different users are stored in their respective databases.

---

Workflow is default supported.
You need to install [DataSphereStudio](https://github.com/WeBankFinTech/DataSphereStudio) to use workflow.
Enabling workflow does not affect the normal use of Qualitis.
Expand Down
8 changes: 6 additions & 2 deletions docs/zh_CN/ch1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Qualitis基于Spring Boot,依赖于Linkis进行数据计算,提供数据质
[用户手册](用户手册.md)
[架构设计文档](架构设计文档.md)
<br/>
**更多文档,请[点我访问](https://github.com/WeBankFinTech/Qualitis/wiki)**

## Architecture
![](../../../images/zh_CN/ch1/总体架构设计.png)
Expand Down Expand Up @@ -74,4 +73,9 @@ Qualitis基于Spring Boot,依赖于Linkis进行数据计算,提供数据质
![](../../../images/en_US/ch1/ContractUs.png)

## License
**Linkis is under the Apache 2.0 license. See the [LICENSE](/LICENSE) file for details.**
**Linkis is under the Apache 2.0 license. See the [LICENSE](/LICENSE) file for details.**

## Tips
由于Qualitis的前端代码是采用WeBank自研的前端框架FES,但是FES框架目前没有开源,所以Qualitis的前端代码暂不开源。我们会尽快推进Qualitis的前端开源。对此我们感到非常抱歉。

你可以通过源码下载,并解压web/app/src/main/resources/static/static.zip来获取编译后的前端代码,或者通过下载release直接使用。
17 changes: 13 additions & 4 deletions docs/zh_CN/ch1/升级指南.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@
下载0.6.0版本代码,并解压。

执行以下数据库脚本:
```
mysql -u {USERNAME} -p {PASSWORD} -h {IP} --default-character-set=utf8
source conf/database/update/update_0.5.0-0.6.0.sql
```
```
mysql -u {USERNAME} -p {PASSWORD} -h {IP} --default-character-set=utf8
source conf/database/update/update_0.5.0-0.6.0.sql
```

## 0.6.0 升级 0.7.0
下载0.6.0版本代码,并解压。

执行以下数据库脚本:
```
mysql -u {USERNAME} -p {PASSWORD} -h {IP} --default-character-set=utf8
source conf/database/update/update_0.6.0-0.7.0.sql
```
19 changes: 10 additions & 9 deletions docs/zh_CN/ch1/快速搭建手册.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Hadoop (2.7.2)
Hive (1.2.1)
Zookeeper (3.4.9)
Linkis(0.9.1), 必装Spark引擎。[如何安装Linkis](https://github.com/WeBankFinTech/Linkis)
DataSphereStudio (0.6.0) 可选. 如果你想使用工作流,必装DataSphereStudio [如何安装DataSphereStudio?](https://github.com/WeBankFinTech/DataSphereStudio)
DataSphereStudio (0.6.0) 可选. 如果你想使用工作流,必装DataSphereStudio [如何安装DataSphereStudio?](https://github.com/WeBankFinTech/DataSphereStudio)

## 二、安装包下载
[下载](https://github.com/WeBankFinTech/Qualitis/releases)
Expand Down Expand Up @@ -54,10 +54,6 @@ task.persistence.address=
## Zookeeper地址
zk.address=
## HiveServer2 连接用户名密码
hive.username=
hive.password=
```

### 4.4 启动系统
Expand All @@ -79,9 +75,7 @@ sh bin/start.sh
![系统配置](../../../images/zh_CN/ch1/系统配置.png)
填入以下配置信息:
集群名称(Hadoop集群名称)
集群类型
HiveMetaStore地址
HiveServer2地址
集群类型
Linkis地址
Linkis Token(Linkis Token配置方式请查看文档:[接入Linkis文档](接入Linkis文档.md))

Expand All @@ -90,7 +84,14 @@ Linkis Token(Linkis Token配置方式请查看文档:[接入Linkis文档](接

---

Tips:
Tips:

Qualitis会将异常数据保存在数据库当中,保存的数据库名称可以在系统设置中配置,如下图所示:
![](../../../images/zh_CN/ch1/异常数据数据库配置.png)
如图所示,Qualitis提供${USERNAME}来作为用户名替换的表达式,不同的用户跑出来的异常数据,保存在各自的数据库中。

---

工作流已默认开启,工作流需要安装[DataSphereStudio](https://github.com/WeBankFinTech/DataSphereStudio)
开启工作流不影响Qualitis正常使用。
如需关闭,可修改配置文件
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/ch1/接入Linkis文档.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ QUALITIS-AUTH=*

### 加入MySQL依赖包
```
cd $LINKIS_HOME/linkis-ujes-spark-enginemanager/lib
cd $SPARK_HOME/jars
```
并加入mysql依赖包

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/en_US/ch1/ClusterConfigurationDemo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/zh_CN/ch1/异常数据数据库配置.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/zh_CN/ch1/规则配置样例.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d346550

Please sign in to comment.