# og_pkt

**Repository Path**: chenyingzi/og_pkt

## Basic Information

- **Project Name**: og_pkt
- **Description**: openGauss 集群部署 xml 模板生成工具
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/chenyingzi/og_pkt
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-19
- **Last Updated**: 2023-11-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# og_pkt
## 使用帮助

```shell
python.exe .\og_pkt.py

Usage: og_pkt [options]
Options:
-m, --master  <count>   Number of master nodes, only set to 1
-s, --standby <count>   Number of standby nodes
-S, --cascade <count>   Number of cascade standby nodes
-C, --cm_enable         Enable the cluster manager
-c, --comment_enable    Enable the comment in the xml file
-D, --deploy <path>     Deployment path
-d, --data <path>       Data path
-n, --cluster <name>    Cluster name
-X, --xmlfile <name>    XML file name
-l, --local             Quick to generate Single node deployment
```

## 使用示例
### 单主部署

```shell
python.exe .\og_pkt.py -l -D /opengauss/og_deploy -d /opengauss/og_data -X local.xml -c
```

```xml
<?xml version="1.0" ?>
<ROOT>
  <!--openGauss 总体部署信息：1主 0备 0级联，禁用CMServer-->
  <CLUSTER>
    <!--集群名称-->
    <PARAM name="clusterName" value="og_cluster"/>
    <!--逗号分隔的集群节点主机名列表（hostname）-->
    <PARAM name="nodeNames" value="h101"/>
    <!--数据库软件安装路径（切勿预先创建此路径）-->
    <PARAM name="gaussdbAppPath" value="/opengauss/og_deploy/install/app"/>
    <!--数据库运行日志存放路径-->
    <PARAM name="gaussdbLogPath" value="/opengauss/og_deploy/log/omm"/>
    <!--临时文件存放路径-->
    <PARAM name="tmpMppdbPath" value="/opengauss/og_deploy/tmp"/>
    <!--om 工具部署路径-->
    <PARAM name="gaussdbToolPath" value="/opengauss/og_deploy/install/om"/>
    <!--核心文件的部署路径-->
    <PARAM name="corePath" value="/opengauss/og_deploy/corefile"/>
    <!--逗号分隔的集群节点IP列表，必须与 nodeNames 的值一一对应-->
    <PARAM name="backIp1s" value="192.168.3.101"/>
  </CLUSTER>
  <!--集群中每个节点上的部署信息-->
  <DEVICELIST>
    <!--节点 1 上的部署信息-->
    <DEVICE sn="h101">
      <!--节点 1 的主机名称-->
      <PARAM name="name" value="h101"/>
      <!--节点 1 所在的 AreaZone 及 AreaZone 优先级-->
      <PARAM name="azName" value="AZ1"/>
      <PARAM name="azPriority" value="1"/>
      <!--节点 1 的 IP，如果服务器只有一个网卡可用，将backIP1和sshIP1配置成同一个IP-->
      <PARAM name="backIp1" value="192.168.3.101"/>
      <PARAM name="sshIp1" value="192.168.3.101"/>
      <!--datanote 信息-->
      <PARAM name="dataNum" value="1"/>
      <PARAM name="dataPortBase" value="15400"/>
      <PARAM name="dataNode1" value="/opengauss/og_data/dn"/>
      <PARAM name="dataNode1_syncNum" value="0"/>
    </DEVICE>
  </DEVICELIST>
</ROOT>
```

### 一主一备

```shell
python.exe .\og_pkt.py -s 1 -X 1master_1standby.xml -c
```

```xml
<?xml version="1.0" ?>
<ROOT>
  <!--openGauss 总体部署信息：1主 1备 0级联，禁用CMServer-->
  <CLUSTER>
    <!--集群名称-->
    <PARAM name="clusterName" value="og_cluster"/>
    <!--逗号分隔的集群节点主机名列表（hostname）-->
    <PARAM name="nodeNames" value="h101,h102"/>
    <!--数据库软件安装路径（切勿预先创建此路径）-->
    <PARAM name="gaussdbAppPath" value="/og_deploy/install/app"/>
    <!--数据库运行日志存放路径-->
    <PARAM name="gaussdbLogPath" value="/og_deploy/log/omm"/>
    <!--临时文件存放路径-->
    <PARAM name="tmpMppdbPath" value="/og_deploy/tmp"/>
    <!--om 工具部署路径-->
    <PARAM name="gaussdbToolPath" value="/og_deploy/install/om"/>
    <!--核心文件的部署路径-->
    <PARAM name="corePath" value="/og_deploy/corefile"/>
    <!--逗号分隔的集群节点IP列表，必须与 nodeNames 的值一一对应-->
    <PARAM name="backIp1s" value="192.168.3.101,192.168.3.102"/>
  </CLUSTER>
  <!--集群中每个节点上的部署信息-->
  <DEVICELIST>
    <!--节点 1 上的部署信息-->
    <DEVICE sn="h101">
      <!--节点 1 的主机名称-->
      <PARAM name="name" value="h101"/>
      <!--节点 1 所在的 AreaZone 及 AreaZone 优先级-->
      <PARAM name="azName" value="AZ1"/>
      <PARAM name="azPriority" value="1"/>
      <!--节点 1 的 IP，如果服务器只有一个网卡可用，将backIP1和sshIP1配置成同一个IP-->
      <PARAM name="backIp1" value="192.168.3.101"/>
      <PARAM name="sshIp1" value="192.168.3.101"/>
      <!--datanote 信息-->
      <PARAM name="dataNum" value="1"/>
      <PARAM name="dataPortBase" value="15400"/>
      <PARAM name="dataNode1" value="/og_data/dn,h102,/og_data/dn"/>
      <PARAM name="dataNode1_syncNum" value="0"/>
    </DEVICE>
    <!--节点 2 上的部署信息-->
    <DEVICE sn="h102">
      <!--节点 2 的主机名称-->
      <PARAM name="name" value="h102"/>
      <!--节点 2 所在的 AreaZone 及 AreaZone 优先级-->
      <PARAM name="azName" value="AZ1"/>
      <PARAM name="azPriority" value="1"/>
      <!--节点 2 的 IP，如果服务器只有一个网卡可用，将backIP1和sshIP1配置成同一个IP-->
      <PARAM name="backIp1" value="192.168.3.102"/>
      <PARAM name="sshIp1" value="192.168.3.102"/>
    </DEVICE>
  </DEVICELIST>
</ROOT>
```

### 一主一备一级联

```shell
python.exe .\og_pkt.py -s 1 -S 1 -X 1master_1standby_1cascade.xml -c
```

```xml
<?xml version="1.0" ?>
<ROOT>
  <!--openGauss 总体部署信息：1主 1备 1级联，禁用CMServer-->
  <CLUSTER>
    <!--集群名称-->
    <PARAM name="clusterName" value="og_cluster"/>
    <!--逗号分隔的集群节点主机名列表（hostname）-->
    <PARAM name="nodeNames" value="h101,h102,h103"/>
    <!--数据库软件安装路径（切勿预先创建此路径）-->
    <PARAM name="gaussdbAppPath" value="/og_deploy/install/app"/>
    <!--数据库运行日志存放路径-->
    <PARAM name="gaussdbLogPath" value="/og_deploy/log/omm"/>
    <!--临时文件存放路径-->
    <PARAM name="tmpMppdbPath" value="/og_deploy/tmp"/>
    <!--om 工具部署路径-->
    <PARAM name="gaussdbToolPath" value="/og_deploy/install/om"/>
    <!--核心文件的部署路径-->
    <PARAM name="corePath" value="/og_deploy/corefile"/>
    <!--逗号分隔的集群节点IP列表，必须与 nodeNames 的值一一对应-->
    <PARAM name="backIp1s" value="192.168.3.101,192.168.3.102,192.168.3.103"/>
  </CLUSTER>
  <!--集群中每个节点上的部署信息-->
  <DEVICELIST>
    <!--节点 1 上的部署信息-->
    <DEVICE sn="h101">
      <!--节点 1 的主机名称-->
      <PARAM name="name" value="h101"/>
      <!--节点 1 所在的 AreaZone 及 AreaZone 优先级-->
      <PARAM name="azName" value="AZ1"/>
      <PARAM name="azPriority" value="1"/>
      <!--节点 1 的 IP，如果服务器只有一个网卡可用，将backIP1和sshIP1配置成同一个IP-->
      <PARAM name="backIp1" value="192.168.3.101"/>
      <PARAM name="sshIp1" value="192.168.3.101"/>
      <!--datanote 信息-->
      <PARAM name="dataNum" value="1"/>
      <PARAM name="dataPortBase" value="15400"/>
      <PARAM name="dataNode1" value="/og_data/dn,h102,/og_data/dn,h103,/og_data/dn"/>
      <PARAM name="dataNode1_syncNum" value="0"/>
    </DEVICE>
    <!--节点 2 上的部署信息-->
    <DEVICE sn="h102">
      <!--节点 2 的主机名称-->
      <PARAM name="name" value="h102"/>
      <!--节点 2 所在的 AreaZone 及 AreaZone 优先级-->
      <PARAM name="azName" value="AZ1"/>
      <PARAM name="azPriority" value="1"/>
      <!--节点 2 的 IP，如果服务器只有一个网卡可用，将backIP1和sshIP1配置成同一个IP-->
      <PARAM name="backIp1" value="192.168.3.102"/>
      <PARAM name="sshIp1" value="192.168.3.102"/>
    </DEVICE>
    <!--节点 3 上的部署信息-->
    <DEVICE sn="h103">
      <!--节点 3 的主机名称-->
      <PARAM name="name" value="h103"/>
      <!--节点 3 所在的 AreaZone 及 AreaZone 优先级-->
      <PARAM name="azName" value="AZ1"/>
      <PARAM name="azPriority" value="1"/>
      <!--节点 3 的 IP，如果服务器只有一个网卡可用，将backIP1和sshIP1配置成同一个IP-->
      <PARAM name="backIp1" value="192.168.3.103"/>
      <PARAM name="sshIp1" value="192.168.3.103"/>
      <!--级联备节点-->
      <PARAM name="cascadeRole" value="on"/>
    </DEVICE>
  </DEVICELIST>
</ROOT>

```