Merge pull request #118 from WeBankFinTech/1.0.0

jinyangrao · web-flow · commit b20c14282365 · 2022-07-07T09:43:44.000+08:00
1.0.0
diff --git a/README-CH.md b/README-CH.md
@@ -7,20 +7,20 @@
 
 ## 简介
 
-&nbsp;&nbsp;&nbsp;&nbsp;Visualis是一个基于宜信的开源项目[Davinci](https://github.com/edp963/davinci)开发的数据可视化BI工具。现已被集成到数据应用开发门户[DataSphere Studio](https://github.com/WeBankFinTech/DataSphereStudio)中，此次发布的版本Visualis1.0.0-rc1版本支持Linkis1.1.1和DSS1.0.1版本。
+&nbsp;&nbsp;&nbsp;&nbsp;Visualis是一个基于宜信的开源项目[Davinci](https://github.com/edp963/davinci)开发的数据可视化BI工具。现已被集成到数据应用开发门户[DataSphere Studio](https://github.com/WeBankFinTech/DataSphereStudio)中，此次发布的版本Visualis1.0.0版本支持Linkis1.1.1和DSS1.1.0版本。
 
 &nbsp;&nbsp;&nbsp;&nbsp;Visualis支持拖拽式报表定义、图表联动、钻取、全局筛选、多维分析、实时查询等数据开发探索的分析模式，并做了水印、数据质量校验等金融级增强。
 
 ## 功能特性
 
-&nbsp;&nbsp;&nbsp;&nbsp;基于达芬奇项目, Visualis与DataSphere Studio 1.0.1集成，实现了以下特性：
+&nbsp;&nbsp;&nbsp;&nbsp;基于达芬奇项目, Visualis与DataSphere Studio 1.1.0集成，实现了以下特性：
 * 图表水印
 * 数据质量校验
 * 图表展示优化
 * 对接Linkis计算中间件
 * Scriptis结果集一键可视化
 * 外部应用参数支持
-* Widget/Dashboard/Display集成为DataSphere Studio的工作流节点
+* View/Widget/Dashboard/Display集成为DataSphere Studio的工作流节点
 
 &nbsp;&nbsp;&nbsp;&nbsp;Visualis同时支持以下Davinci v0.3版本的原生功能：
 * **数据源**
@@ -91,6 +91,9 @@
 
 [虚拟视图设计文档](visualis_docs/zh_CN/Visualis_visual_doc_cn.md)
 
+## 升级文档
+[升级文档](visualis_docs/zh_CN/visualis_update_cn.md)
+
 ## 交流贡献
 
 ![communication](images/communication.png)
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ English | [中文](README-CH.md)
 
 ## Introduction
 
-&nbsp;&nbsp;&nbsp;&nbsp;Visualis is an open source project based on Yixin [davinci](https://github.com/edp963/davinci) Developed data visualization Bi tool. It has been integrated into the data application development portal [datasphere studio](https://github.com/WeBankFinTech/DataSphereStudio) In this release, visualis1.0.0-rc1 supports linkis1.1.1 and dss1.0.1.  
+&nbsp;&nbsp;&nbsp;&nbsp;Visualis is an open source project based on Yixin [davinci](https://github.com/edp963/davinci) Developed data visualization Bi tool. It has been integrated into the data application development portal [datasphere studio](https://github.com/WeBankFinTech/DataSphereStudio) In this release, visualis1.0.0 supports linkis1.1.1 and dss1.1.0.  
 &nbsp;&nbsp;&nbsp;&nbsp;Visualis provides data development/exploration functionalities including drag & drop style report definition, diagram correlation analysis, data drilling, global filtering, multi-dimensional analysis and real-time query, with the enhancement of report watermark and data quality management.
 
 ## Features
@@ -19,7 +19,7 @@ Based on Davinci project, Visualis achieves below features with DataSphere Studi
 * Linkis adaption for big-data queries
 * One-click visualization from Scriptis
 * External application parameters support
-* Dashboard/Display as an appjoint of DataSphere Studio workflow
+* View/Widget/Dashboard/Display as an appjoint of DataSphere Studio workflow
 
 Visualis also supports most of the original features of Davinci v0.3.
 * Data Source Support
@@ -86,6 +86,9 @@ For more details: [Visualis User Manul Doc](./visualis_docs/en_US/Visualis_user_
 
 [Virtual View Design Documentation](visualis_docs/en_US/Visualis_visual_doc_en.md)
 
+## Upgrade documentation
+[Upgrade Documentation](visualis_docs/en_US/visualis_update_en.md)
+
 ## Communication
 
 ![communication](images/communication.png)
diff --git a/visualis_docs/en_US/visualis_update_en.md b/visualis_docs/en_US/visualis_update_en.md
@@ -0,0 +1,59 @@
+Visualis 1.0.0-rc1 upgrading to 1.0.0 using documentation
+
+---
+
+
+
+## 1. The upgrade steps are mainly divided into:
+
+- Service stop
+- Execute database upgrade script
+- Replace the visualis deployment directory with a new version package
+- Add and modify configuration files
+- Service startup
+
+#### 1. Service stop
+
+Enter the deployment directory of Visualis, and execute the command under the directory to stop the services of Visualis:
+```shell
+cd ${VISUALIS_INSTALL_PATH}
+sh bin/stop-visualis-server.sh
+```
+
+#### 2. Execute database upgrade SQL script
+
+After linking the visualis database, execute the following SQL:
+```sql
+alter table linkis_user rename to visualis_user;
+```
+
+#### 3. Replace the visualis deployment directory with a new version package
+
+- Back up the deployment directory of the old version of visualis. Take this directory as an example: 
+```shell
+mv /appcom/Install/VisualisInstall/lib /appcom/Install/VisualisInstall/lib-bak
+```
+- Refer to [visualis installation and deployment document](./visualis_deploy_doc_cn.md). After compiling and packaging, replace lib.
+
+
+
+#### 4. Modify configuration
+
+- Visualis1.0.0-rc1 version is compatible with cookies in order to be compatible with dss1.0.1 and linkis1.1.1. You need to delete the following parameters and use the linkers configured by default in the code: linkis_user_session_ticket_id_v1 value.
+
+```properties
+#Delete the following configuration
+wds. linkis. session. ticket. key=bdp-user-ticket-id
+wds. dss. visualis. ticketid=bdp-user-ticket-id
+
+```
+- After the configuration modification is completed, you need to reinstall visualis appconn on the DSS side. To install visualis1.0.0 appconn, refer to [visualis appconn installation](./visualis_appconn_install_cn.md).
+
+
+
+
+#### 5. Service startup
+&nbsp;&nbsp;&nbsp;&nbsp;Now you can start the new version of Visualis services. Execute the command to start the services:
+```shell
+sh bin/start-visualis-server. sh
+```
diff --git a/visualis_docs/zh_CN/visualis_update_cn.md b/visualis_docs/zh_CN/visualis_update_cn.md
@@ -0,0 +1,59 @@
+Visualis 1.0.0-rc1 upgrading to 1.0.0 using documentation
+
+---
+
+
+
+## 1. The upgrade steps are mainly divided into:
+
+- Service stop
+- Execute database upgrade script
+- Replace the visualis deployment directory with a new version package
+- Add and modify configuration files
+- Service startup
+
+#### 1. Service stop
+
+Enter the deployment directory of Visualis, and execute the command under the directory to stop the services of Visualis:
+```shell
+cd ${VISUALIS_INSTALL_PATH}
+sh bin/stop-visualis-server.sh
+```
+
+#### 2. Execute database upgrade SQL script
+
+After linking the visualis database, execute the following SQL:
+```sql
+alter table linkis_user rename to visualis_user;
+```
+
+#### 3. Replace the visualis deployment directory with a new version package
+
+- Back up the deployment directory of the old version of visualis. Take this directory as an example: 
+```shell
+mv /appcom/Install/VisualisInstall/lib /appcom/Install/VisualisInstall/lib-bak
+```
+- Refer to [visualis installation and deployment document](./visualis_deploy_doc_cn.md). After compiling and packaging, replace lib.
+
+
+
+#### 4. Modify configuration
+
+- Visualis1.0.0-rc1 version is compatible with cookies in order to be compatible with dss1.0.1 and linkis1.1.1. You need to delete the following parameters and use the linkers configured by default in the code: linkis_user_session_ticket_id_v1 value.
+
+```properties
+#Delete the following configuration
+wds. linkis. session. ticket. key=bdp-user-ticket-id
+wds. dss. visualis. ticketid=bdp-user-ticket-id
+
+```
+- After the configuration modification is completed, you need to reinstall visualis appconn on the DSS side. To install visualis1.0.0 appconn, refer to [visualis appconn installation](./visualis_appconn_install_cn.md).
+
+
+
+
+#### 5. Service startup
+&nbsp;&nbsp;&nbsp;&nbsp;Now you can start the new version of Visualis services. Execute the command to start the services:
+```shell
+sh bin/start-visualis-server. sh
+```
