-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #116 from WeBankFinTech/1.0.0
modify visualis doc
- Loading branch information
Showing
9 changed files
with
177 additions
and
263 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,49 @@ | ||
| > Visualis AppConn Install | ||
| > Visualis AppConn Installation | ||
| ## 1. Introduction | ||
| Visualis is a data visualization system based on the secondary development of the open source project DaVinci. In order to connect with DSS, visualis has implemented the relevant specifications for DSS appconn access. For the app conn access specification, please refer to [dss appconn Access Specification] (). Visualis is connected to DSS as a data visualization node, which needs to meet the three-level specifications, namely: | ||
| * In order to realize secret free interworking with DSS, SSO specification is implemented | ||
| * In order to connect with DSS project, the organization structure specification is realized | ||
| * In order to realize the interworking with DSS workflow development, the application development specification is implemented | ||
|
|
||
| Appconn is a JVM process running inside its DSS and linkis. For each third-party application accessed, there is a unique appconn instance, which is similar to a proxy client of a third-party application in the DSS. If the DSS needs to use interaction with the third-party system, it can call the relevant appconn to request the third-party application in the appconn to realize the interaction, You can directly understand the role of appconn through the following figure. | ||
|  | ||
| ## 1. AppConn installation | ||
| The third-party component AppConn of DSS1.1.0 is maintained by the third-party component itself, so in order to successfully install visualis and support the DSS workflow, you need to pull the visualis1.0.0 code, compile and package the AppConn code. | ||
| ```shell | ||
| # Enter the visualis source code project | ||
| cd visualis | ||
|
|
||
| In order to use the relevant functions of visualis in DSS workflow, you need to install the corresponding appconn to develop visualis visual reports in DSS workflow. | ||
| # Enter the visualis-appconn module | ||
| cd visualis-appconn | ||
|
|
||
| ## 2. One click installation package installation | ||
| If the service is deployed using [dss one click Install bucket] (), you can directly use the scripting tool provided in the software package. After one click deployment, you can find the script tool in the installation directory of DSS. Its directory structure and instructions are as follows. | ||
| mvn clean package -DskipTests=ture | ||
| ``` | ||
| The visualis.zip package as shown below is the package of visualis-appconn. | ||
|  | ||
| If you use [DSS one-click installation of the whole family bucket](https://github.com/WeBankFinTech/DataSphereStudio-Doc/blob/1.1.0/zh_CN/%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2/DSS%26Linkis%E4%B8%80%E9%94%AE%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A3%E5%8D%95%E6%9C%BA%E7%89%88.md) to deploy the service, you can directly use the script tool provided in its software package. After the one-click family bucket deployment is complete, you can find the script tool in the dss installation directory. Its directory structure and usage instructions are as follows. | ||
| ```shell | ||
| # Enter the bin directory of DSS installation | ||
| >> cd dss/bin | ||
| # Go to the bin directory of the dss installation | ||
| > cd dss/bin | ||
|
|
||
| # Where appconn-install.sh is the appconn installation script tool | ||
| # Where appconn-install.sh is the AppConn installation script tool | ||
| >> ls | ||
| >> appconn-install.sh checkEnv.sh excecuteSQL.sh install.sh | ||
| ``` | ||
| In order to install smoothly, we first need to deploy and start the visualis service. For the installation and deployment of visualis, please refer to [visualis installation and deployment document] (). When using appconn to install the script tool, the steps are as follows: | ||
| >> appconn-install.sh appconn-refresh.sh checkEnv.sh executeSQL.sh install.sh start-default-appconn.sh | ||
| ```` | ||
| In order to install smoothly, the Visualis service needs to be deployed first, and then the zip package of visualis appconn needs to be placed in the specified appconn directory and decompressed. For the installation and deployment of Visualis, please refer to [Visualis Installation and Deployment Documentation](./Visualis_deploy_doc_cn.md). The steps for placing the visualis appconn zip package and the AppConn installation script tool are as follows: | ||
| ```shell | ||
| >> sh appconn-install.sh | ||
| # Put visualis appconn in the dss-appconns directory | ||
| rz -ybe ${DSS_INSTALL_HOME}/dss/dss-appconns | ||
| # Choose to install visualis appconn | ||
| >> 1 | ||
| # Unzip the Visualis AppConn package | ||
| unzip visualis.zip | ||
| # Enter the server IP for visualis deployment | ||
| >> 127.0.0.1 | ||
| cd {DSS_INSTALL_HOME}/dss/bin | ||
| # Enter the port number for the visualis service | ||
| >> 8008 | ||
| > sh appconn-install.sh | ||
| # After executing the appconn installation script tool, the configuration information of the relevant third-party appconn will be inserted | ||
| ``` | ||
|
|
||
| ## 3. Independent installation | ||
| If the DSS and linkis services are deployed independently, you need to add additional visualis to use them. You can choose to install appconn independently. Download DSS and install the whole family bucket with one click. After decompression, find appconn install in dss/bin SH script. Place the script in the bin directory of the DSS path after installation (you need to ensure that the appconn package of the DSS compiled and installed by the source code is also intact). | ||
| ```shell | ||
| # Copy the unzipped one click installation script tool for whole bucket appconn installation to the installed DSS bin directory | ||
| >> cp appconn-install.sh /appconn/Install/DSSInstall/bin/ | ||
|
|
||
| # Execute the script | ||
| >> sh appconn-install.sh | ||
|
|
||
| # Similar to step 2 | ||
| ... | ||
|
|
||
| ``` | ||
| **Additional attention is required. Since linkis-gateway supports multi-active service request forwarding, it will be matched and forwarded by name. In actual use, if you need to use the front-end interface to request services, you need to ask Configure the corresponding label in the DSS1.0.1 to make the request forwarding successfully. Since the Visualis AppConn of DSS1.0.1 requests the Visualis service, the label is not added yet, which will cause the request to be intercepted. Therefore, in the DSS1.0.1 version, you need to manually modify the url of the dss_appconn_instance table field, so that Visualis AppConn requests go through the server-side request path to support the interaction between DSS workflows and Visualis services (we will fix this problem in the next version). The relevant table modification records are referenced as follows:** | ||
|  | ||
| # Enter the Visualis name | ||
| >> visualis | ||
| # Enter the Visualis frontend IP address | ||
| >> 127.0.0.1 | ||
| Of course, if you need a more flexible installation method, you can execute the relevant SQL of visualis appconn separately. The tables involved are as follows. Please refer to the following table. If you need to pay attention to the need during installation, due to the limited space, the relevant SQL of DSS insert table can be found in the one click bucket under the DSS appconn lib package SQL. The SQL script has some variables that need to be inserted after replacement. | ||
| # After entering the front-end port of the Visualis service | ||
| >> 8088 | ||
| |Table name|effect|remarks| | ||
| |-----|-----|-----| | ||
| |dss_application|DSS quick store configuration|The project front-end access address of visualis needs to be configured| | ||
| |dss_menu|DSS quick store|Configure the classification information of the app store| | ||
| |dss_onestop_menu_application|Applied menu table|Configure the menu to which the visualis application belongs| | ||
| |dss_appconn|DSS appconn configuration table|Related configuration information of appconn| | ||
| |dss_appconn_instance|Appconn instance information table|Configure information about each appconn instance| | ||
| |dss_workflow_node|Workflow node configuration table|Configure relevant node configurations to be added to DSS workflow| | ||
| |dss_workflow_node_to_ui|Configuration table required for each node of Workflow|Configure the configuration items required by each node in the DSS| | ||
| # After executing the AppConn installation script tool, the configuration information of the relevant third-party AppConn will be inserted | ||
| ```` | ||
| DSS service needs to be restarted after modification. | ||
| If you use the domain name to access the DSS service, you need to refer to Section 5 of the [visualis installation and deployment document](./Visualis_deploy_doc_cn.md). |
Oops, something went wrong.