创建XML配置文件

创建XML配置文件

安装openGauss前需要创建cluster_config.xml文件。cluster_config.xml文件包含部署openGauss的服务器信息、安装路径、IP地址以及端口号等。用于告知openGauss如何部署。用户需根据不同场景配置对应的XML文件。

下面以一主一备的方案为例，说明如何创建XML配置文件。

• 创建XML配置文件
  • 配置数据库名称及各项目录
  • 配置Host基本信息
  • 配置数据库主节点信息
  • 配置CM_SERVER（主、非主）信息
  • 示例
    • 单节点配置文件
    • 一主一备配置文件
    • 一主一备一级联配置文件
    • 一主二备配置文件
    • 一主三备配置文件
    • 一主四备配置文件
    • 一主四备配置文件（支持自定义利用FIRST、ANY设置同步备机）

配置数据库名称及各项目录

在script/gspylib/etc/conf/cluster_config_template.xml获取XML文件模板。以下配置内容为示例，可自行替换。每行信息均有注释进行说明。

<?xml version="1.0" encoding="UTF-8"?>
<ROOT>
  <!-- 整体信息 -->
  <CLUSTER>
  <!-- 数据库名称 -->
    <PARAM name="clusterName" value="Cluster_template" />  
  <!-- 数据库节点名称(hostname) -->
    <PARAM name="nodeNames" value="node1_hostname,node2_hostname" />
  <!-- 数据库安装目录-->
    <PARAM name="gaussdbAppPath" value="/opt/huawei/install/app" />
  <!-- 日志目录-->
    <PARAM name="gaussdbLogPath" value="/var/log/omm" />
  <!-- 临时文件目录-->
    <PARAM name="tmpMppdbPath" value="/opt/huawei/tmp" />
  <!--数据库工具目录-->
    <PARAM name="gaussdbToolPath" value="/opt/huawei/install/om" />
  <!--数据库core文件目录-->
    <PARAM name="corePath" value="/opt/huawei/corefile"/>
  <!-- 节点IP，与nodeNames一一对应 -->
    <PARAM name="backIp1s" value="192.168.0.1,192.168.0.2"/>
    <!-- 是否开启数据库节点自选主 -->
    <PARAM name="enable_dcf" value="on"/>
    <!-- 开启开关后对应的节点IP、PORT和角色信息 -->
    <PARAM name="dcf_config" value="[{&quot;stream_id&quot;:1,&quot;node_id&quot;:1,&quot;ip&quot;:&quot;8.92.1.85&quot;,&quot;port&quot;:16683,&quot;role&quot;:&quot;LEADER&quot;},{&quot;stream_id&quot;:1,&quot;node_id&quot;:2,&quot;ip&quot;:&quot;8.92.1.86&quot;,&quot;port&quot;:16683,&quot;role&quot;:&quot;FOLLOWER&quot;},{&quot;stream_id&quot;:1,&quot;node_id&quot;:3,&quot;ip&quot;:&quot;8.92.1.87&quot;,&quot;port&quot;:16683,&quot;role&quot;:&quot;FOLLOWER&quot;}]"/>
    <!-- 资源池化模式开关 -->
    <PARAM name="enable_dss" value="on"/>
    <!-- dss实例目录 -->
    <PARAM name="dss_home" value="/opt/huawei/install/data/dss"/>
    <!-- dss共享卷名 -->
    <PARAM name="ss_dss_vg_name" value="data"/>
    <!-- dss挂载卷组名和卷组信息，包含共享卷 -->
    <PARAM name="dss_vg_info" value="data:/dev/sdb,p0:/dev/sdc,p1:/dev/sdd"/>
    <!-- cm投票卷 -->
    <PARAM name="votingDiskPath" value="/dev/sde"/>
    <!-- cm共享卷 -->
    <PARAM name="shareDiskDir" value="/dev/sdf"/>
    <!-- dss开启ssl认证开关 -->
    <PARAM name="dss_ssl_enable" value="on"/>
    <!-- mes通信协议类型  -->
    <PARAM name="ss_interconnect_type" value="TCP"/>
    <!-- rdma绑定cpu序列  -->
    <PARAM name="ss_rdma_work_config" value="1 7"/>
    <!-- 是否开启uwal -->
    <PARAM name="enable_uwal" value="on"/>
    <!-- uwal文件大小 -->
    <PARAM name="uwal_disk_size" value="8589934592"/>
    <!-- uwal日志路径 -->
    <PARAM name="uwal_log_path" value="'/home/omm/data/log/omm/omm/pg_log'"/>
    <!-- uwal压缩开关 -->
    <PARAM name="uwal_rpc_compression_switch" value="false"/>
    <!-- uwal流控开关 -->
    <PARAM name="uwal_rpc_flowcontrol_switch" value="false"/>
    <!-- uwal流控值 -->
    <PARAM name="uwal_rpc_flowcontrol_value" value="128"/>
    <!-- uwal异步写开关 -->
    <PARAM name="uwal_async_append_switch" value="false"/>
    <!-- uwal挂载路径 -->
    <PARAM name="uwal_devices_path" value="'/home/omm/data/dn'"/>

    <!-- VIP信息  -->
    <PARAM name="floatIp1" value="10.10.10.100"/>
    <PARAM name="floatIp2" value="20.20.20.100"/>
    <PARAM name="floatIp3" value="30.30.30.100"/>
  
  </CLUSTER>

 须知：

• “/opt/huawei/install/om”存放互信等工具，为了避免权限问题，不要把实例数据目录放在此目录下。
• 安装目录和数据目录需为空或者不存在，否则可能导致安装失败。
• 在对数据库节点的实例进行具体配置时，需确保配置的目录之间不相互耦合。即各个配置目录不关联，删除其中任意一个目录，不会级联删除其它目录。如gaussdbAppPath为"/opt/huawei/install/app"，gaussdbLogPath为"/opt/huawei/install/app/omm"。当gaussdbAppPath目录被删除时，会级联删除gaussdbLogPath目录，从而引起其它问题。
• 若需要安装脚本自动创建安装用户时，各配置的目录需保证不与系统创建的默认用户目录耦合关联。
• 配置openGauss路径和实例路径时，路径中不能包含"|",";","&","$","<",">","`","\\","'","\"","{","}","(",")","[","]","~","*","?“特殊字符。
• 配置数据库节点名称时，请通过hostname命令获取数据库节点的主机名称，替换示例中的node1_hostname,node2_hostname。
• 配置dcf_config时，角色的配置有leader，follower，passive，logger，其中可投票的角色有leader，follower，logger，配置角色组网时，可投票的角色不能少于3个，因此dcf模式下至少需要三个节点。
• 资源池化中请谨慎配置所有包含磁盘信息的参数，安装时工具会低格所有参数中配置的磁盘，所有参数中的磁盘不能重复。
• 资源池化中的ip和dn的数据ip保持一致，dss的端口是db端口+10，dms的端口是db端口+20。

表 1 参数说明

实例类型	参数	说明
整体信息	clusterName	openGauss名称。
	nodeNames	openGauss中主机名称。
	backIp1s	主机在后端存储网络中的IP地址（内网IP）。所有openGauss主机使用后端存储网络通讯。
	gaussdbAppPath	openGauss程序安装目录。此目录应满足如下要求： 磁盘空间>1GB。 与数据库所需其它路径相互独立，没有包含关系。
	gaussdbLogPath	openGauss运行日志和操作日志存储目录。此目录应满足如下要求： 磁盘空间建议根据主机上的数据库节点数规划。数据库节点预留1GB空间的基础上，再适当预留冗余空间。 与openGauss所需其它路径相互独立，没有包含关系。 此路径可选。不指定的情况下，openGauss安装时会默认指定“$GAUSSLOG/安装用户名”作为日志目录。
	tmpMppdbPath	数据库临时文件存放目录。 若不配置tmpMppdbPath，默认存放在/opt/huawei/wisequery/安装用户名_mppdb目录下，其中"opt/huawei/wisequery"是默认指定的数据库系统工具目录。
	gaussdbToolPath	openGauss系统工具目录，主要用于存放互信工具等。此目录应满足如下要求： 磁盘空间>100MB。 固定目录，与数据库所需其它目录相互独立，没有包含关系。 此目录可选。不指定的情况下，openGauss安装时会默认指定“/opt/huawei/wisequery”作为数据库系统工具目录。
	corePath	openGauss core文件的指定目录。
	enable_dcf	是否开启DCF模式。
	dcf_config	开启DCF模式时配置，DCF启动节点信息。
	enable_dss	资源池化模式开关，取值范围on/off，默认为off，资源池化不支持dcf模式。
	dss_home	dss实例目录，enable_dss为on时必选。
	ss_dss_vg_name	dss共享卷名，enable_dss为on时必选。
	dss_vg_info	dss挂载卷组信息，包含一个共享卷组，其余为日志卷组，日志卷组的数量和dn的数量保持一致，集中式每个节点最多有一个dn。卷组形如“data:/dev/sdb”，卷组和卷组之间以“，”隔开，enable_dss为on时必选。日志卷组磁盘大小需要大于dn参数max_size_for_xlog_prune的值，
	votingDiskPath	cm的投票卷，enable_dss为on时必选。
	shareDiskDir	cm的共享卷，enable_dss为on时必选。
	dss_ssl_enable	dss开启ssl认证开关，取值范围on/off，默认为on。
	ss_interconnect_type	mes通信协议类型，默认值TCP，取值范围TCP/RDMA，默认为TCP。
	ss_rdma_work_config	rdma用户态poll占用起止cpu，ss_interconnect_type为RDMA时有效，形如"10 15"，中间以空格分隔。
	floatIp1、floatIp2、floatIp3	虚拟ip。