背景信息

目前GaussDB 200配置文件（“postgresql.conf”、“pg_hba.conf”）中的参数默认值都是单机的配置模式。应用程序可以通过调用gs_guc来设置适合自己的参数。

• “gs_guc-current.log”

  这个文件记录gs_guc产生的日志。

  默认路径：$GAUSSLOG/bin/gs_guc。

• “gs_guc-年-月-日_HHMMSS.log”

  当“gs_guc-current.log”文件大小满16M后，会根据当前时刻生成一个备份文件。

• “server.key.cipher”，“server.key.rand”

  使用gs_guc encrypt命令加密用户密码时，如果指定的-M的值为server，则会生成这两个文件。其中“server.key.cipher”存储用户密码的密文，“server.key.rand”存储的是加密因子。

• “client.key.cipher”，“client.key.rand”

  使用gs_guc encrypt命令加密用户密码时，如果指定的-M的值为client，则会生成这两个文件。其中“client.key.cipher”存储用户密码的密文，“client.key.rand”存储的是加密因子。

  说明：

  “client.key.cipher”和“client.key.rand”是不指定-U选项时生成的密文文件和加密因子文件。如果通过-U指定了用户名，则会生成以用户名开头的文件。以指定-U test为例，生成的文件名为:“test.key.cipher、test.key.rand”。

语法

• -Z为coordinator、datanode或者gtm
  • 检查配置文件中参数（仅支持CN和DN）

    gs_guc check -Z NODE-TYPE [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -c "parameter"

  • 检查逻辑集群的配置文件中参数（逻辑集群仅支持DN）

    gs_guc check -Z datanode [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -c "parameter" --lcname=LCNAME

  • 修改配置文件中参数

    gs_guc set -Z NODE-TYPE [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -c "parameter = value"

  • 修改逻辑集群的配置文件中参数（逻辑集群仅支持DN）

    gs_guc set -Z datanode [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -c "parameter = value" --lcname=LCNAME

  • 同时修改CN和DN配置文件中参数（postgresql.conf）

    gs_guc set -Z coordinator -Z datanode [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -c "parameter = value"

  • 将已设置的参数值修改为默认值

    gs_guc [ set | reload ] -Z NODE-TYPE [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -c "parameter"

  • 将逻辑集群中已设置的参数值修改为默认值

    gs_guc [ set | reload ] -Z datanode [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -c "parameter" --lcname=LCNAME

  • 修改配置文件中参数，同时发送信号量到postgresql.conf或者gtm.conf

    gs_guc reload -Z NODE-TYPE [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -c parameter=value

  • 修改客户端认证策略，同时发送信号量到pg_hba.conf

    gs_guc [ set | reload ] -Z NODE-TYPE [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -h "HOSTTYPE DATABASE USERNAME IPADDR-WITH-IPMASK AUTHMEHOD authentication-options option" 

    说明：

    authmehod-options支持以下选项：

    trust：不验密，禁止远程主机使用trust方式访问集群

    reject：拒绝访问

    md5、sha256、cert：客户端证书认证

    gss：kerberos认证

  • 注释已经设置的客户端认证策略， 同时发送信号量到pg_hba.conf

    gs_guc [ set | reload ] -Z NODE-TYPE [-N NODE-NAME] [-I INSTANCE-NAME | -D DATADIR] -h "HOSTTYPE DATABASE USERNAME IPADDR-WITH-IPMASK AUTHMEHOD" 

    说明：

    如果需要注释已经设置的认证策略，请使用-h "HOSTTYPE DATABASE USERNAME IPADDR-WITH-IPMASK AUTHMEHOD"，不需要指定authmehod-options。

  • 显示帮助信息

    gs_guc -? | --help

  • 显示版本号信息

    gs_guc -V | --version

• -Z为cmserver或者cmagent
  • 仅修改配置文件中参数（cmserver.conf/cmagent.conf）

    gs_guc set -Z NODE-TYPE -N all -I all -c "parameter = value"

    gs_guc set -Z NODE-TYPE -c "parameter = value"

• 生成加密密文文件和加密因子文件
  • 生成加密密码文件

    gs_guc encrypt [-M keymode] -K password [-U username] -D DATADIR

    说明：

    -K是用户指定的密码，gs_guc会对该密码进行长度（8<=len<=16）和密码复杂度要求，如果不满足，将会报错。

    -M是加密类型，当前仅支持server、client和source。默认值为server。

  • 生成OBS加密密码文件

    gs_guc generate [-o prefix] -S cipherkey -D DATADIR

    说明：

    -o是输出的OBS类型的cipher和rand文件前缀名称，默认输出文件名前缀为obsserver。其内容仅支持数字、字母和下划线。

    -S是用户指定的密码。当其值为default时，会随机生成一段字符串作为密码，该密码长度为13。

说明：

• gs_guc工具不支持参数值中包含'#'的设置。可以使用vi工具通过手工修改配置文件来设置。
• 如果已经在环境变量中设置PGDATA，则可以省略-D参数。否则提示设置参数失败。
• 环境变量PGDATA设置方法：先将参数PGDATA设置为${BIGDATA_DATA_HOME}/mppdb，然后在执行“export PGDATA”使设置生效。
• authpolicy包含一串认证参数：HOSTTYPE DATABASE USERNAME IPADDR IPMASK，或者HOSTTYPE DATABASE USERNAME IPADDR-WITH-IPMASK，或者HOSTTYPE DATABASE USERNAME HOSTNAME。
• 如果设置GUC参数时使用-c "parameter"，则会将已设置的GUC参数值设置成该参数的内核默认值（注意log_directory和audit_directory不会被设置为内核参数默认值，而是设为$GAUSSLOG/pg_audit/instance_name）。因GUC参数间存在依赖关系，因此请慎用该功能。
• 设置-c参数时，无论节点类型是datanode或coordinator，参数都可以省略双引号。
• 如果value中含有特殊字符（如$），请转义后使用。
• 如果同一个配置参数在配置文件里面出现多行，且有两行或多于两行同时生效（即没有用"#"注释掉），那么只有最后一个配置参数会被设置，而前面的都会被忽略。
• 通过reload模式设置或修改集群节点配置文件（postgresql.conf）的参数，生效存在短暂延迟，有可能导致配置后集群各实例参数极短时间不一致。
• check操作仅支持CN和DN；reload操作支持CN、DN和GTM；CM仅支持set操作且在使用过程中-N和-I的参数值只能全部为all或者全部为NULL。