diff --git a/product/zh/docs-mogdb/v2.1/reference-guide/tool-reference/tools-used-in-the-internal-system/gs_install_plugin.md b/product/zh/docs-mogdb/v2.1/reference-guide/tool-reference/tools-used-in-the-internal-system/gs_install_plugin.md index 18c56c5195ccaf4e977aad8999ae9963976503f0..43548f7c194584d13247022b2ec9133c0f7c662e 100644 --- a/product/zh/docs-mogdb/v2.1/reference-guide/tool-reference/tools-used-in-the-internal-system/gs_install_plugin.md +++ b/product/zh/docs-mogdb/v2.1/reference-guide/tool-reference/tools-used-in-the-internal-system/gs_install_plugin.md @@ -9,13 +9,29 @@ date: 2021-11-29 ## 背景信息 -MogDB提供了gs_install_plugin工具用于安装插件，目前支持安装的插件包括pg_repack、pg_trgm、dblink、wal2json、orafce、pg_bulkload、pg_prewarm。本工具适用于一主多备部署的MogDB。 +MogDB提供了 gs_install_plugin 工具用于安装插件，目前支持安装的插件包括 pg_repack、pg_trgm、dblink、wal2json、orafce、pg_bulkload、pg_prewarm。本工具适用于一主多备部署的 MogDB。   ## 前提条件 -已完成MogDB一主多备部署。 +已完成 MogDB 一主多备部署。 + +> **发布补丁说明**: +> +> 2.1 版本中本工具存在已知的 bug, 会导致因识别不到插件包而安装失败的问题。 +> 请您在使用本工具前，先按照如下操作来进行补丁修复，然后再进行后续插件的安装（适用于 2.1.x）： +> +> - 可访问外网时： +> +> 1. 切换到安装数据库的用户下（例如: omm）: `su - omm` +> 2. 执行在线修复： `cd $GPHOME && curl https://cdn-mogdb.enmotech.com/mogdb-media/2.1.1/om_plugin_install_v2.1.1.patch | patch -p1` +> +> - 无法访问外网时： +> +> 1. 请先在有网络的服务器下载补丁文件 [om_plugin_install_v2.1.1.patch](https://cdn-mogdb.enmotech.com/mogdb-media/2.1.1/om_plugin_install_v2.1.1.patch)，然后将补丁文件拷贝到需要修复的服务器上； +> 2. 切换到安装数据库的用户下（例如: omm）： `su - omm` +> 3. 执行 `cd $GPHOME && patch -p1 < [此处替换Patch文件路径]`   @@ -35,7 +51,7 @@ gs_install_plugin [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json] [--p - -X - 必填参数，后跟clusterconfig.xml配置文件的路径 + 必填参数，后跟 clusterconfig.xml 配置文件的路径 - --all @@ -43,43 +59,43 @@ gs_install_plugin [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json] [--p - --plugins - 可安装多个插件，如：--plugins dblink pg_repack wal2json + 可安装多个插件，如：`--plugins dblink pg_repack wal2json` - --dblink - 只安装dblink + 只安装 dblink - --pg_trgm - 只安装pg_trgm + 只安装 pg_trgm - --wal2json - 只安装wal2json + 只安装 wal2json - --pg_repack - 只安装pg_repack + 只安装 pg_repack - --orafce - 只安装orafce + 只安装 orafce - --pg_bulkload - 只安装pg_bulkload + 只安装 pg_bulkload   ## 安装示例 -1. 进入数据库安装目录下的script文件夹： +1. 进入数据库安装目录下的 script 文件夹： ```bash cd /opt/software/mogdb/script/ ``` -2. 创建static文件夹： +2. 创建 static 文件夹： ```bash mkdir -p static @@ -87,7 +103,7 @@ gs_install_plugin [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json] [--p > 注意：文件夹名称请勿更改。 -3. 访问[MogDB官网下载页面](https://www.mogdb.io/downloads/mogdb)，根据您的操作系统及CPU架构下载对应版本的插件，并将插件放入static文件夹下。 +3. 访问[MogDB官网下载页面](https://www.mogdb.io/downloads/mogdb)，根据您的操作系统及 CPU 架构下载对应版本的插件，并将插件放入 static 文件夹下。 4. 权限设置 @@ -96,7 +112,7 @@ gs_install_plugin [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json] [--p chown -R omm:dbgrp /opt/software/mogdb/script ``` -5. 配置clusterconfig.xml配置文件，这里以一主一备配置文件作为示例，`backIp1s`为节点ip，`dataNode1`为数据目录，该程序默认获取到的数据目录为第一个节点的数据目录位置。 +5. 配置 clusterconfig.xml 配置文件，这里以一主一备配置文件作为示例，`backIp1s` 为节点ip，`dataNode1` 为数据目录，该程序默认获取到的数据目录为第一个节点的数据目录位置。 ```xml @@ -142,7 +158,7 @@ gs_install_plugin [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json] [--p ``` -6. 切换到omm用户 +6. 切换到 omm 用户 ``` su - omm @@ -152,7 +168,6 @@ gs_install_plugin [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json] [--p ```bash /opt/software/mogdb/script/gs_install_plugin -X /opt/software/mogdb/clusterconfig.xml --all - # 安装成功时回显如下： SUCCESS: dblink. SUCCESS: pg_trgm. diff --git a/product/zh/docs-mogdb/v2.1/reference-guide/tool-reference/tools-used-in-the-internal-system/gs_install_plugin_local.md b/product/zh/docs-mogdb/v2.1/reference-guide/tool-reference/tools-used-in-the-internal-system/gs_install_plugin_local.md index 291a1ec400a480c2c73e0f68bf713d815e999478..3fcd2161464824f941dd2cf6af945519810d421e 100644 --- a/product/zh/docs-mogdb/v2.1/reference-guide/tool-reference/tools-used-in-the-internal-system/gs_install_plugin_local.md +++ b/product/zh/docs-mogdb/v2.1/reference-guide/tool-reference/tools-used-in-the-internal-system/gs_install_plugin_local.md @@ -9,13 +9,29 @@ date: 2022-01-18 ## 背景信息 -MogDB提供了gs_install_plugin_local工具用于安装插件，目前支持安装的插件包括pg_repack、pg_trgm、dblink、wal2json、orafce、pg_bulkload、pg_prewarm。本工具适用于单机部署的MogDB。 +MogDB提供了 gs_install_plugin_local 工具用于安装插件，目前支持安装的插件包括 pg_repack、pg_trgm、dblink、wal2json、orafce、pg_bulkload、pg_prewarm。本工具适用于单机部署的 MogDB。   ## 前提条件 -已完成MogDB单机部署。 +已完成 MogDB 单机部署。 + +> **发布补丁说明**: +> +> 2.1 版本中本工具存在已知的 bug, 会导致因识别不到插件包而安装失败的问题。 +> 请您在使用本工具前，先按照如下操作来进行补丁修复，然后再进行后续插件的安装（适用于 2.1.x）： +> +> - 可访问外网时： +> +> 1. 切换到安装数据库的用户下（例如: omm）: `su - omm` +> 2. 执行在线修复： `cd $GPHOME && curl https://cdn-mogdb.enmotech.com/mogdb-media/2.1.1/om_plugin_install_v2.1.1.patch | patch -p1` +> +> - 无法访问外网时： +> +> 1. 请先在有网络的服务器下载补丁文件 [om_plugin_install_v2.1.1.patch](https://cdn-mogdb.enmotech.com/mogdb-media/2.1.1/om_plugin_install_v2.1.1.patch)，然后将补丁文件拷贝到需要修复的服务器上； +> 2. 切换到安装数据库的用户下（例如: omm）： `su - omm` +> 3. 执行 `cd $GPHOME && patch -p1 < [此处替换Patch文件路径]`   @@ -35,7 +51,7 @@ gs_install_plugin_local [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json - -X - 必填参数，后跟clusterconfig.xml配置文件的路径 + 必填参数，后跟 clusterconfig.xml 配置文件的路径 - --all @@ -43,43 +59,43 @@ gs_install_plugin_local [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json - --plugins - 可安装多个插件，如：--plugins dblink pg_repack wal2json + 可安装多个插件，如：`--plugins dblink pg_repack wal2json` - --dblink - 只安装dblink + 只安装 dblink - --pg_trgm - 只安装pg_trgm + 只安装 pg_trgm - --wal2json - 只安装wal2json + 只安装 wal2json - --pg_repack - 只安装pg_repack + 只安装 pg_repack - --orafce - 只安装orafce + 只安装 orafce - --pg_bulkload - 只安装pg_bulkload + 只安装 pg_bulkload   ## 安装示例 -1. 进入数据库安装目录下的script文件夹： +1. 进入数据库安装目录下的 script 文件夹： ```bash cd /opt/software/mogdb/script/ ``` -2. 创建static文件夹： +2. 创建 static 文件夹： ```bash mkdir -p static @@ -87,7 +103,7 @@ gs_install_plugin_local [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json > 注意：文件夹名称请勿更改。 -3. 访问[MogDB官网下载页面](https://www.mogdb.io/downloads/mogdb)，根据您的操作系统及CPU架构下载对应版本的插件，并将插件放入static文件夹下。 +3. 访问[MogDB官网下载页面](https://www.mogdb.io/downloads/mogdb)，根据您的操作系统及 CPU 架构下载对应版本的插件，并将插件放入 static 文件夹下。 4. 权限设置 @@ -96,7 +112,7 @@ gs_install_plugin_local [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json chown -R omm:dbgrp /opt/software/mogdb/script ``` -5. 配置clusterconfig.xml配置文件，这里以单节点配置文件作为示例，`backIp1s`为节点ip，`dataNode1`为数据目录，该程序默认获取到的数据目录为第一个节点的数据目录位置。 +5. 配置 clusterconfig.xml 配置文件，这里以单节点配置文件作为示例，`backIp1s` 为节点ip，`dataNode1` 为数据目录，该程序默认获取到的数据目录为第一个节点的数据目录位置。 ```xml @@ -132,7 +148,7 @@ gs_install_plugin_local [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json -6. 切换到omm用户 +6. 切换到 omm 用户 ``` su - omm @@ -142,7 +158,6 @@ gs_install_plugin_local [-h] [-X XML] [--all] [--dblink] [--pg_trgm] [--wal2json ```bash /opt/software/mogdb/script/gs_install_plugin_local -X /opt/software/mogdb/clusterconfig.xml --all - # 安装成功时回显如下： SUCCESS: dblink. SUCCESS: pg_trgm.