v2.0
- 关于PTK
- 快速入门
- 使用指南
- 使用参考
- 配置文件示例
- 命令介绍
- ptk
- ptk completion
- ptk view-static-config
- ptk init-cluster
- ptk collect
- ptk rec-guc
- ptk cache
- ptk gen-ptkc
- ptk manage
- ptk demo
- ptk meta
- ptk version
- ptk self
- ptk gen-om-xml
- ptk env
- ptk gen-static-config
- ptk cluster
- ptk cluster createdb
- ptk cluster uninstall-compat-tools
- ptk cluster install-compat-tools
- ptk cluster install-mogila
- ptk cluster rename
- ptk cluster throwout
- ptk cluster takeover
- ptk cluster uninstall-cm
- ptk cluster install-cm
- ptk cluster gen-cert-files
- ptk cluster load-cm-vip
- ptk cluster del-kerberos-auth
- ptk cluster add-kerberos-auth
- ptk cluster uninstall-kerberos-server
- ptk cluster install-kerberos-server
- ptk cluster is-in-upgrade
- ptk cluster upgrade-rollback
- ptk cluster upgrade-commit
- ptk cluster upgrade
- ptk cluster demote
- ptk cluster promote
- ptk cluster refresh
- ptk cluster shell
- ptk cluster modify-comment
- ptk cluster show-config
- ptk cluster set-guc
- ptk cluster show-guc
- ptk cluster set-hba
- ptk cluster show-hba
- ptk cluster scale-out
- ptk cluster scale-in
- ptk cluster uninstall-mogha
- ptk cluster install-mogha
- ptk cluster list-plugins
- ptk cluster install-plugin
- ptk cluster inspect
- ptk cluster failover
- ptk cluster switchover
- ptk cluster build
- ptk cluster status
- ptk cluster restart
- ptk cluster stop
- ptk cluster start
- ptk uninstall
- ptk ls
- ptk install
- ptk exec
- ptk template
- ptk encrypt
- ptk checkos
- ptk download
- ptk candidate
- 故障排查
- FAQ
- 发布记录
- 社区
- 附录:YAML语法
环境变量
PTK 在运行时会读取一些特定的环境变量值来影响运行逻辑。
可以通过 ptk env
命令来查看 PTK 支持的所有环境变量以及对应生效的值。
如果想查看具体某个环境变量的值,可以通过 ptk env <KEY>
来查看,例如:
- 查看 PTK 元数据目录
ptk env PTK_HOME
支持的环境变量列表
PTK 会在运行期间读取下表中的环境变量,您可以通过 export
对环境变量进行修改来改变 PTK 的行为
环境变量名 | 含义 | 说明 |
---|---|---|
PTK_HOME |
PTK 存储元数据的根目录,默认为 $HOME/.ptk |
|
PTK_DATA_DIR |
PTK 存储集群元数据的目录,默认为 $PTK_HOME/data |
|
PTK_SSH_CONNECT_TIMEOUT |
执行器在和目标服务器建立 ssh 链接时建链超时时间,默认为 1 分钟 | 单位支持 h(时)/m(分)/s(秒),例如 "2m20s" |
PTK_CMD_EXECUTE_TIMEOUT |
执行器在执行 shell 命令时等待返回的超时时间,默认为 10 分钟 | 单位支持 h(时)/m(分)/s(秒),例如 "2m20s" |
PTK_LOG_PATH |
执行日志输出的文件路径,也可以通过命令行参数 --log-file 指定,设置了该环境变量的话,在 PTK 执行期间除了在终端输出外,额外会写入到日志文件中。PTK 内部自己在运行期间默认也会记录一个日志文件在 $PTK_HOME/log 目录下,这个不受该环境变量控制。 |
|
PTK_NO_CHECK_VERSION |
PTK 默认会在每次命令运行的同时联网检查是否有新版本的 PTK 发布,您可以通过设置该环境变量为 true ,则可以禁止 PTK 版本检查 |
|
PTK_NOT_LIMIT_CM_NODES |
PTK 在部署 MogDB 数据库并且同时部署 CM 集群时,会检查CM的节点个数,当CM个数大于3节点时,默认强制限定只能部署奇数个 CM server 节点,以满足多数派选举要求,所以当部署4节点集群时,会要求用户选择一个节点不部署CM server。用户可以设置该参数为 true ,来关闭该限制。当然,也可以在安装时通过命令行参数 --not-limit-cm-nodes 来实现同样的效果 |
|
PTK_ENABLE_TIMEOUT_WHEN_BUILD_DB |
PTK 在对备库进行 build 重建操作时,默认不设置执行命令的超时时间(PTK_CMD_EXECUTE_TIMEOUT 不生效),这样是为了某些大数据量场景下,单次build的时间成本很高,如果超时退出会导致需要重新构建。如果设置了该参数则可以使 PTK_CMD_EXECUTE_TIMEOUT 生效 |