Skip to content

Commit

Permalink
Update deploy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jefftlin committed Aug 4, 2023
1 parent ecd2d35 commit 0d8d453
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 25 deletions.
45 changes: 34 additions & 11 deletions docs/en_US/ch1/exchangis_deploy_en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Exchangis installation is mainly divided into the following four steps ：

| Dependent components | Must be installed | Install through train |
|------------------------------------------------------------------------------| ------ | --------------- |
| MySQL (5.5+) | yes | [How to install mysql](https://www.runoob.com/mysql/mysql-install.html) |
| JDK (1.8.0_141) | yes | [How to install JDK](https://www.runoob.com/java/java-environment-setup.html) |
| Hadoop(3.3.4，Other versions of Hadoop need to compile Linkis by themselves.) | yes | [Hadoop stand-alone deployment](https://linkis.apache.org/zh-CN/docs/latest/deployment/quick-deploy) ；[Hadoop distributed deployment](https://linkis.apache.org/zh-CN/docs/latest/deployment/quick-deploy) |
| Hive(2.3.3，Other versions of Hive need to compile Linkis by themselves.) | yes | [Hive quick installation](https://linkis.apache.org/zh-CN/docs/latest/deployment/quick-deploy) |
| JDK (1.8.0_141) | yes | [How to install JDK](https://www.oracle.com/java/technologies/downloads/) |
| MySQL (5.5+) | yes | [How to install mysql](https://www.mysql.com/downloads/) |
| Hadoop(3.3.4，Other versions of Hadoop need to compile Linkis by themselves.) | yes | [Hadoop deployment](https://www.apache.org/dyn/closer.cgi/hadoop/common/hadoop-3.3.4/hadoop-3.3.4.tar.gz) |
| Hive(2.3.3，Other versions of Hive need to compile Linkis by themselves.) | yes | [Hive quick installation](https://www.apache.org/dyn/closer.cgi/hive/) |
| SQOOP (1.4.6) | yes | [How to install Sqoop](https://sqoop.apache.org/docs/1.4.6/SqoopUserGuide.html) |
| DSS1.1.2 | yes | [How to install DSS](https://github.com/WeBankFinTech/Exchangis/blob/dev-1.0.0/docs/zh_CN/ch1/exchangis_appconn_deploy_cn.md) |
| Linkis1.4.0 | yes | [How to install Linkis](https://linkis.apache.org/zh-CN/docs/latest/deployment/quick-deploy) |
| Nginx | yes | [How to install Nginx](http://nginx.org/en/linux_packages.html) |
| DSS1.1.2 | yes | [How to install DSS](https://github.com/WeBankFinTech/DataSphereStudio-Doc/tree/main/zh_CN/%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2) |
| Linkis1.4.0 | yes | [How to install Linkis](https://linkis.apache.org/zh-CN/docs/1.4.0/deployment/deploy-quick) |
| Nginx | yes | [How to install Nginx](http://nginx.org/) |

Underlying component checking

Expand Down Expand Up @@ -55,7 +55,7 @@ INSERT INTO `linkis_ps_dm_datasource_env` (`env_name`, `env_desc`, `datasource_t
INSERT INTO `linkis_ps_dm_datasource_env` (`env_name`, `env_desc`, `datasource_type_id`, `parameter`, `create_time`, `create_user`, `modify_time`, `modify_user`) VALUES ('开发环境UAT', '开发环境UAT', 4, '{"uris":"thrift://${HIVE_METADATA_IP}:${HIVE_METADATA_PORT}", "hadoopConf":{"hive.metastore.execute.setugi":"true"}}', now(), NULL, now(), NULL);
```

If the hive data source needs kerberos authentication when deployed, you need to specify a parameter keyTab in the parameter field of the Linkis_ps_dm_datasource_env table, and the way to obtain its value can be seen: [Setting and authenticating hive data source in linkis](https://linkis.apache.org/zh-CN/docs/1.4.0/deployment/start-metadatasource).
If the hive data source needs kerberos authentication when deployed, you need to specify a parameter keyTab in the parameter field of the Linkis_ps_dm_datasource_env table, and the way to obtain its value can be seen: [Setting and authenticating hive data source in linkis](https://linkis.apache.org/zh-CN/docs/latest/auth/token).

#### 1.4 Underlying component checking

Expand All @@ -67,7 +67,7 @@ Please ensure that DSS1.1.2 and Linkis1.4.0 are basically available. HiveQL scri

#### 2.1.1 Download binary package

Download the latest installation package from the Released release of Exchangis [click to jump to the release interface](https://github.com/WeBankFinTech/Exchangis/releases/tag/release-1.0.0).
Download the latest installation package from the Released release of Exchangis [click to jump to the release interface](https://github.com/WeBankFinTech/Exchangis/releases/tag/release-1.1.2).

#### 2.1.2 Compile and package

Expand All @@ -94,6 +94,8 @@ Download the latest installation package from the Released release of Exchangis
|-- db：Database initialization SQL directory
|-- exchangis-extds
|-- packages：Exchangis installation package directory
|-- exchangis-extds：exchangis datasource library
|-- lib：library
|-- sbin：Script storage directory
```

Expand Down Expand Up @@ -159,7 +161,28 @@ DATABASE=

Enter `y` to start installing Exchange IS service, or `n` to not install it.

#### 2.5.3 Start service
#### 2.5.3 Change the path of the configuration file and log file

In the 'env.properties' file in the sbin directory, set the configuration file path and log file path

```yaml
EXCHANGIS_CONF_PATH="/appcom/config/exchangis-config/background"
EXCHANGIS_LOG_PATH="/appcom/logs/exchangis/background"
MODULE_DEFAULT_PREFIX="dss-exchangis-main-"
MODULE_DEFAULT_SUFFIX="-dev"
```

EXCHANGIS_CONF_PATH indicates the configuration file path, and EXCHANGIS_LOG_PATH indicates the log file path. If the preceding configurations are used, perform the following operations:

```yaml
cd {EXCHANGIS_DEPLOY_PATH}
cp -r config /appcom/config/exchangis-config/background
mkdir -p /appcom/logs/exchangis/background
```

When the service is started, the configuration file in the corresponding path is used and logs are written to the corresponding path

#### 2.5.4 Start service

Execute the following command to start Exchangis Server:

Expand All @@ -175,7 +198,7 @@ Execute the following command to start Exchangis Server:

After executing the startup script, the following prompt will appear, eureka address will also be typed in the console when starting the service:

![企业微信截图_16532930262583](https://user-images.githubusercontent.com/27387830/169773764-1c5ed6fb-35e9-48cb-bac8-6fa7f738368a.png)
![企业微信截图_16532930262583](../../../images/zh_CN/ch1/register_eureka.png)

### 2.6 Check whether the service started successfully.

Expand Down
30 changes: 16 additions & 14 deletions docs/zh_CN/ch1/exchangis_deploy_cn.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Exchangis 的安装，主要分为以下四步：

| 依赖的组件 | 是否必装 | 安装直通车 |
|---------------------------------------| ------ | --------------- |
| MySQL (5.5+) | 必装 | [如何安装mysql](https://www.runoob.com/mysql/mysql-install.html) |
| JDK (1.8.0_141) | 必装 | [如何安装JDK](https://www.runoob.com/java/java-environment-setup.html) |
| Hadoop(3.3.4，Hadoop 其他版本需自行编译 Linkis) | 必装 | [Hadoop单机部署](https://linkis.apache.org/zh-CN/docs/latest/deployment/quick-deploy) ；[Hadoop分布式部署](https://linkis.apache.org/zh-CN/docs/latest/deployment/quick-deploy) |
| Hive(2.3.3，Hive 其他版本需自行编译 Linkis) | 必装 | [Hive快速安装](https://linkis.apache.org/zh-CN/docs/latest/deployment/quick-deploy) |
| JDK (1.8.0_141) | 必装 | [如何安装JDK](https://www.oracle.com/java/technologies/downloads/) |
| MySQL (5.5+) | 必装 | [如何安装mysql](https://www.runoob.com/mysql/mysql-install.html) |
| Hadoop(3.3.4，Hadoop 其他版本需自行编译 Linkis) | 必装 | [Hadoop部署](https://www.apache.org/dyn/closer.cgi/hadoop/common/hadoop-3.3.4/hadoop-3.3.4.tar.gz) |
| Hive(2.3.3，Hive 其他版本需自行编译 Linkis) | 必装 | [Hive快速安装](https://www.apache.org/dyn/closer.cgi/hive/) |
| SQOOP (1.4.6) | 必装 | [如何安装Sqoop](https://sqoop.apache.org/docs/1.4.6/SqoopUserGuide.html) |
| DSS1.1.2 | 必装 | [如何安装DSS](https://github.com/WeBankFinTech/DataSphereStudio-Doc/tree/main/zh_CN/%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2) |
| Linkis1.4.0 | 必装 | [如何安装Linkis](https://linkis.apache.org/zh-CN/docs/latest/deployment/quick-deploy) |
| Nginx | 必装 | [如何安装 Nginx](http://nginx.org/en/linux_packages.html) |
| Linkis1.4.0 | 必装 | [如何安装Linkis](https://linkis.apache.org/zh-CN/docs/1.4.0/deployment/deploy-quick) |
| Nginx | 必装 | [如何安装 Nginx](http://nginx.org/) |

底层依赖组件检查

Expand Down Expand Up @@ -58,7 +58,7 @@ INSERT INTO `linkis_ps_dm_datasource_env` (`env_name`, `env_desc`, `datasource_t
INSERT INTO `linkis_ps_dm_datasource_env` (`env_name`, `env_desc`, `datasource_type_id`, `parameter`, `create_time`, `create_user`, `modify_time`, `modify_user`) VALUES ('开发环境UAT', '开发环境UAT', 4, '{"uris":"thrift://${HIVE_METADATA_IP}:${HIVE_METADATA_PORT}", "hadoopConf":{"hive.metastore.execute.setugi":"true"}}', now(), NULL, now(), NULL);
```

如果hive数据源在部署时设置了需要进行kerberos方式认证，则需要在linkis_ps_dm_datasource_env表的parameter字段指定一个参数keyTab，其值的获取方式可见：[在Linkis中设置并认证hive数据源](https://linkis.apache.org/zh-CN/docs/1.4.0/deployment/start-metadatasource)
如果hive数据源在部署时设置了需要进行kerberos方式认证，则需要在linkis_ps_dm_datasource_env表的parameter字段指定一个参数keyTab，其值的获取方式可见：[在Linkis中设置并认证hive数据源](https://linkis.apache.org/zh-CN/docs/latest/auth/token)

#### 1.4 底层依赖组件检查

Expand Down Expand Up @@ -96,8 +96,9 @@ INSERT INTO `linkis_ps_dm_datasource_env` (`env_name`, `env_desc`, `datasource_t
```html
|-- config：一键安装部署参数配置目录
|-- db：数据库表初始化 SQL 目录
|-- exchangis-extds
|-- packages：Exchangis 安装包目录
|-- exchangis-extds：数据源扩展库
|-- lib：库
|-- sbin：脚本存放目录
```

Expand Down Expand Up @@ -163,16 +164,17 @@ DATABASE={dbName}

```yaml
EXCHANGIS_CONF_PATH="/appcom/config/exchangis-config/background"
EXCHANGIS_LOG_PATH="/appcom/logs/exchangis-log"
MODULE_DEFAULT_PREFIX="exchangis-server"
MODULE_DEFAULT_SUFFIX=""
EXCHANGIS_LOG_PATH="/appcom/logs/exchangis/background"
MODULE_DEFAULT_PREFIX="dss-exchangis-main-"
MODULE_DEFAULT_SUFFIX="-dev"
```

EXCHANGIS_CONF_PATH为配置文件路径，EXCHANGIS_LOG_PATH为日志文件路径，若为以上配置，则作如下操作：

```shell
cp config/* /appcom/config/exchangis-config/background
mkdir -p /appcom/logs/exchangis-log
cd {EXCHANGIS_DEPLOY_PATH}
cp -r config /appcom/config/exchangis-config/background
mkdir -p /appcom/logs/exchangis/background
```

则在服务启动时，将会使用对应路径下的配置文件，以及将日志写到对应的路径下
Expand All @@ -193,7 +195,7 @@ mkdir -p /appcom/logs/exchangis-log

执行完成启动脚本后，会出现以下提示，eureka地址也会在启动服务时在控制台打出：

![企业微信截图_16532930262583](https://user-images.githubusercontent.com/27387830/173892397-7cc7e988-0222-4f64-92ed-2cc58669770e.png)
![企业微信截图_16532930262583](../../../images/zh_CN/ch1/register_eureka.png)

### 2.6 查看服务是否启动成功

Expand Down
Binary file added images/zh_CN/ch1/register_eureka.png
View file
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 0d8d453

Please sign in to comment.