H3C网闸插件部署指导-5W101

01-正文

1 概述

1.1 功能介绍

本文档主要介绍上下级穿网闸方案中的网闸插件的部署。

GAP：GAP（Generalized Application Plugin，通用应用插件）是为实现网络之间的单向数据摆渡，确保数据的安全性和隔离性实现的插件，在本手册内简称为“网闸插件”。

在网络部署中，上下级之间的隔离装置只能单向传输数据，为了实现下级环境数据传输到上级，需要使用网闸插件。

网闸插件包含Client和Server两个模块，其中下级环境上报数据至网闸插件Server端；上级环境从网闸插件Client端消费数据。

· 下级网闸插件（Server端）从下级环境获取数据、将数据打包成文件放到隔离装置共享目录；

· 上级网闸插件（Client端）从隔离装置共享目录获取文件，解包后发送到上级环境。

图1-1 上下级穿网闸方案

本文档中的所有截图均为举例，请以实际环境为准。

1.2 常用词

· 上下级：“上下级”部署方式在系统环境中指代不同级别的代理服务器的布置和连接，用于优化网络性能和管理网络流量。

¡ 上级代理服务器作为企业的门户，连接内部网络和外部互联网；

¡ 下级代理服务器对外部访问进行进一步处理，提高访问速度和安全性。

· RegionID、管理站ID、分级ID：都是指“系统/系统配置/分级管理（多域管理）”页面对应的ID列数值。

2 安装前的准备工作

网闸插件的安装依赖已部署Region组件的统一数字底盘。

统一数字底盘部署请参见《H3C 统一数字底盘部署指导》，例如E0721版本安装可参考文档网址：http://www.h3c.com/cn/home/qr/default.htm?id=1779 ，本文不做赘述且假设用户已完成统一数字底盘部署。

2.1 服务器配置需求

本章节介绍GAP（E0721）版本的服务器配置需求，其他版本的配置需求请参见对应版本说明书。

网闸插件支持单机部署和集群部署。

2.1.1 硬件配置需求

网闸插件所需消耗资源较少，每个节点需求基本相同。

表2-1 硬件配置需求

配置项	详细配置	备注
CPU	1核，2.0GHz主频及以上
内存	2GB
磁盘空间	10GB及以上	网闸插件需要至少10GB的磁盘空间，用于存放日志和中间传输临时文件

2.1.1 软件配置需求

· 网闸插件安装包的MD5值验证通过。

· 提供OpenJDK8及以上的插件运行环境。

网闸插件程序不会随操作系统重启而自动重启，重启操作系统后，需要手动启动程序。

2.2 客户端配置需求

网闸插件部署不涉及UI相关操作。用户不需要安装客户端软件。

网闸插件部署成功后，登录统一数字底盘进行上下级环境配置时需要使用浏览器。推荐使用的浏览器为Google Chrome 70及以上版本。

2.3 部署前提

· 提供上下级环境的IP地址，与具有管理员权限的用户名和密码。

¡ 上级和下级的版本部署时间需间隔15分钟以上，以确保上下级RegionID不会相同，以免影响分级管理（多域管理）的参数配置。

· 对于上下级环境，需要分别配置一个FTP服务器，并确保FTP服务器与上下级环境、网闸设备之间能够正常通信。获取FTP账户的详细信息，包括FTP服务器的IP地址、端口、用户名和密码，并确保该账户具有上传、下载和删除权限。

¡ FTP服务器需要自行配置和部署。网闸插件不包含FTP服务器功能。

¡ 推荐将网闸插件单独部署在一个独立服务器；如需将网闸插件与统一数字底盘部署在一起，则需要调整下级环境20200端口服务，具体操作请参见6.1 修改itom-server-hub-svc1服务对外端口。

请在部署网闸插件前，确认以上准备工作已完成。

2.4 注意事项

· 判断网闸通道是否正常，可以查看上级环境中“系统/系统配置/分级管理（多域管理）”列表对应数据状态列，上级状态为运行，下级状态为未知。

· 当一端无法正常连接时，中间临时文件会堆积在临时目录或FTP服务器上，会占用大量磁盘空间。因此，在使用过程中一定要注意通道的通断情况。

3 安装过程简介

表3-1 安装过程

步骤	具体操作	说明
确认Region组件已成功安装	确认环境中有“系统/系统配置/分级管理（多域管理）”菜单	Region组件正确安装是网闸插件对接成功的前提。
部署网闸插件	分别在服务器上部署网闸插件，并配置为Client端和Server端	具体方法请参见4.2 部署网闸插件。
配置上下级环境	在“系统/系统配置/分级管理（多域管理）”页面进行配置	具体方法请参见4.3 配置上下级环境。

4 部署网闸插件

4.1 检查Region组件是否成功安装

确认环境中有“系统/系统配置/分级管理（多域管理）”菜单，且上下级Region ID值不同。

4.2 部署网闸插件流程

4.2.1 上传网闸插件

· 推荐工作目录：/root/gap/目录。请注意检查空间、运行环境是否满足；可自定义目录。

· 获取FTP账户的详细信息，包括FTP服务器的IP地址、端口、用户名和密码，并确保该账户具有上传、下载和删除权限。

在上下级环境中，需分别上传至少一个网闸插件。

1. 上传至统一数字底盘

网闸插件支持上传至底盘所在服务器集群中任意一个节点，不区分Master，Worker节点。

(1) 提前修改下级环境中提供服务的端口号或关闭该服务。具体操作请参见6.1 修改itom-server-hub-svc1服务对外端口。

(2) 使用FTP工具或其他传输工具，上传网闸插件的软件包至统一数字底盘所在服务器节点。

(3) 将压缩包上传到工作目录后，使用“unzip 压缩文件名.zip -d 目标文件夹”命令解压即可。

2. 上传至独立服务器

(1) 使用FTP工具或其他传输工具，上传网闸插件的软件包至独立服务器。

(2) 将压缩包上传到工作目录后，使用“unzip 压缩文件名.zip -d 目标文件夹”命令解压即可。

4.2.2 网闸插件配置

(1) 请根据实际情况修改网闸插件的配置文件内容，并保存。配置文件信息及说明，请见4.2.2 网闸插件配置。

(2) 进入网闸插件的dist文件夹目录，执行启动命令“sh startup.sh”或停止命令“sh stop.sh”，即可使用或停止插件。

· 插件配置的临时文件目录也需要有文件读写权限。

· 临时文件目录程序不会自行创建，需要用户先手动创建，然后配置到配置文件中。

· 非root用户请将整个网闸插件目录读写权限授权给运行网闸插件账户，参考命令：sudo chmod +777 /root/gap

2. 上级环境配置（Server端）

上级环境配置文件存放路径：server/dist/conf。上级环境配置文件内容可参考，如图4-1所示。

图4-1 Server端配置参考

表4-1 Server端配置参数说明

名称	参数含义	取值范围	说明
path	临时文件目录	需手动创建，任意有效的路径，应当确保系统有足够的权限访问该目录	该目录用于存放接收下级推送数据转化生成的消息文件
suffix	临时文件后缀	任意有效的文件后缀名，如果不指定，则使用默认值	该参数通常不用调整
period	时间阈值	大于0的整数，默认值10	如果系统接收到的数据超过了该时间阈值，则会将当前的数据压缩成一个临时文件；以10为例，表示最多10秒压缩一个临时文件。
maxSize	大小阈值	大于0的整数，默认值30	如果系统接收到的数据超过了该大小阈值，则会将当前的数据压缩成一个临时文件；以30为例，表示最多30MB压缩一个临时文件。
ftp_enable	是否启用FTP连接配置	yes或no	如果需要将临时文件上传到FTP服务器，请将该参数设置为yes
ftp_protocol	FTP连接模式	true、false、空值	如果指定为true、false或空值时，将分别使用SFTP的Implicit、SFTP的Explicit或FTP连接模式来连接FTP服务器
ftp_ip/ftp_port/ftp_username/ftp_password	FTP服务器的IP地址、端口、用户名和密码	任意有效的IP地址、port、username和password	如果启用FTP连接配置，则必须提供FTP服务器的IP地址、端口、以及具有上传、下载和删除权限的用户名和密码
ftp_cwd	FTP服务器的工作目录	任意有效的目录	如果启用FTP连接配置，则必须提供FTP服务器的工作目录，以确保临时文件上传到FTP上的目录正确
Kafka_enable/kafkaProducerServers	Kafka连接配置	-	该参数已经废弃，不再需要配置

3. 下级环境配置（Client端）

下级环境配置文件存放路径：client/dist/conf。下级环境配置文件内容可参考，如图4-2所示。

图4-2 Client端配置参考

表4-2 Client端配置参数说明

名称	参数含义	取值范围	说明
path	临时文件目录	需手动创建，任意有效的路径，应当确保系统有足够的权限访问该目录	该目录用于存放接收下级推送数据转化生成的消息文件
suffix	临时文件后缀	任意有效的文件后缀名，如果不指定，则使用默认值	该参数通常不用调整
hub.ssl.key	与统一数字底盘的hub组件交互认证参数	-	该参数不支持修改
tomcat.default.port	插件对应的启动端口	任意有效的端口号	可以修改该参数，用于指定插件的启动端口，冲突后无法正常启动，配置前请确认无占用情况。
ftp_enable	是否启用FTP连接配置	yes或no	如果需要将临时文件上传到FTP服务器，请将该参数设置为yes
ftp_protocol	FTP连接模式	true、false、空值	如果指定为true、false或空值时，将分别使用SFTP的Implicit、SFTP的Explicit或FTP连接模式来连接FTP服务器
ftp_ip/ftp_port/ftp_username/ftp_password	FTP服务器的IP地址、端口、用户名和密码	任意有效的IP地址、port、username和password	如果启用FTP连接配置，则必须提供FTP服务器的IP地址、端口、以及具有上传、下载和删除权限的用户名和密码
ftp_cwd	FTP服务器的工作目录	任意有效的目录	如果启用FTP连接配置，则必须提供FTP服务器的工作目录，以确保临时文件上传到FTP上的目录正确
Kafka_enable/kafkaProducerServers	Kafka连接配置	-	该参数已经废弃，不再需要配置
hubServerIP	上级环境北向IP地址	上级环境北向IP地址	该参数用于配置网闸插件与上级环境的连接，确保数据的传输和通信正常进行。
port	上级环境itom-Server-hub-svc1对应的对外接口	20200（固定值）	PLAT 2.0 (E0713)及之后的版本，此项参数的默认值是20200，不支持修改
hubId	下级环境对应的管理站ID	随机生成的数值	可以在下级环境的“系统/系统配置/分级管理（多域管理）”列表中查看ID列的数值