From c06b717f40177fee10b27c043ac1425d2e6729a5 Mon Sep 17 00:00:00 2001 From: "qian.yao" Date: Fri, 30 Aug 2024 17:34:47 +0800 Subject: [PATCH] feat(ptk): add v1.7.0 release --- product/en/docs-ptk/v2.0/toc.md | 7 +- .../zh/docs-ptk/v2.0/commands/ptk-cache.md | 2 +- .../v2.0/commands/ptk-candidate-cpu.md | 2 +- .../v2.0/commands/ptk-candidate-db.md | 2 +- .../v2.0/commands/ptk-candidate-os.md | 2 +- .../v2.0/commands/ptk-candidate-plugin.md | 2 +- .../docs-ptk/v2.0/commands/ptk-candidate.md | 2 +- .../zh/docs-ptk/v2.0/commands/ptk-checkos.md | 2 +- .../commands/ptk-cluster-add-kerberos-auth.md | 2 +- .../v2.0/commands/ptk-cluster-build.md | 2 +- .../v2.0/commands/ptk-cluster-createdb.md | 146 ++++++++++++++++++ .../commands/ptk-cluster-del-kerberos-auth.md | 2 +- .../v2.0/commands/ptk-cluster-demote.md | 2 +- .../v2.0/commands/ptk-cluster-failover.md | 2 +- .../commands/ptk-cluster-gen-cert-files.md | 2 +- .../v2.0/commands/ptk-cluster-inspect.md | 2 +- .../v2.0/commands/ptk-cluster-install-cm.md | 2 +- .../ptk-cluster-install-compat-tools.md | 106 +++++++++++++ .../ptk-cluster-install-kerberos-server.md | 2 +- .../commands/ptk-cluster-install-mogha.md | 4 +- .../commands/ptk-cluster-install-mogila.md | 112 ++++++++++++++ .../commands/ptk-cluster-install-plugin.md | 2 +- .../commands/ptk-cluster-is-in-upgrade.md | 2 +- .../v2.0/commands/ptk-cluster-list-plugins.md | 2 +- .../v2.0/commands/ptk-cluster-load-cm-vip.md | 2 +- .../commands/ptk-cluster-modify-comment.md | 2 +- .../v2.0/commands/ptk-cluster-promote.md | 2 +- .../v2.0/commands/ptk-cluster-refresh.md | 2 +- .../v2.0/commands/ptk-cluster-rename.md | 4 +- .../v2.0/commands/ptk-cluster-restart.md | 2 +- .../v2.0/commands/ptk-cluster-scale-in.md | 2 +- .../v2.0/commands/ptk-cluster-scale-out.md | 8 +- .../v2.0/commands/ptk-cluster-set-guc.md | 2 +- .../v2.0/commands/ptk-cluster-set-hba.md | 2 +- .../v2.0/commands/ptk-cluster-shell.md | 2 +- .../v2.0/commands/ptk-cluster-show-config.md | 2 +- .../v2.0/commands/ptk-cluster-show-guc.md | 2 +- .../v2.0/commands/ptk-cluster-show-hba.md | 2 +- .../v2.0/commands/ptk-cluster-start.md | 2 +- .../v2.0/commands/ptk-cluster-status.md | 2 +- .../v2.0/commands/ptk-cluster-stop.md | 2 +- .../v2.0/commands/ptk-cluster-switchover.md | 2 +- .../v2.0/commands/ptk-cluster-takeover.md | 38 +++-- .../v2.0/commands/ptk-cluster-throwout.md | 8 +- .../v2.0/commands/ptk-cluster-uninstall-cm.md | 2 +- .../ptk-cluster-uninstall-compat-tools.md | 106 +++++++++++++ .../ptk-cluster-uninstall-kerberos-server.md | 2 +- .../commands/ptk-cluster-uninstall-mogha.md | 2 +- .../commands/ptk-cluster-upgrade-commit.md | 2 +- .../commands/ptk-cluster-upgrade-rollback.md | 2 +- .../v2.0/commands/ptk-cluster-upgrade.md | 2 +- .../zh/docs-ptk/v2.0/commands/ptk-cluster.md | 12 +- .../zh/docs-ptk/v2.0/commands/ptk-collect.md | 2 +- .../v2.0/commands/ptk-completion-bash.md | 2 +- .../v2.0/commands/ptk-completion-fish.md | 2 +- .../commands/ptk-completion-powershell.md | 2 +- .../v2.0/commands/ptk-completion-zsh.md | 2 +- .../docs-ptk/v2.0/commands/ptk-completion.md | 2 +- product/zh/docs-ptk/v2.0/commands/ptk-demo.md | 10 +- .../zh/docs-ptk/v2.0/commands/ptk-download.md | 10 +- .../zh/docs-ptk/v2.0/commands/ptk-encrypt.md | 2 +- product/zh/docs-ptk/v2.0/commands/ptk-env.md | 2 +- product/zh/docs-ptk/v2.0/commands/ptk-exec.md | 2 +- .../docs-ptk/v2.0/commands/ptk-gen-om-xml.md | 2 +- .../zh/docs-ptk/v2.0/commands/ptk-gen-ptkc.md | 2 +- .../v2.0/commands/ptk-gen-static-config.md | 11 +- .../v2.0/commands/ptk-init-cluster.md | 4 +- .../zh/docs-ptk/v2.0/commands/ptk-install.md | 22 ++- product/zh/docs-ptk/v2.0/commands/ptk-ls.md | 2 +- .../zh/docs-ptk/v2.0/commands/ptk-manage.md | 10 +- .../docs-ptk/v2.0/commands/ptk-meta-dump.md | 2 +- .../docs-ptk/v2.0/commands/ptk-meta-home.md | 2 +- .../docs-ptk/v2.0/commands/ptk-meta-merge.md | 2 +- .../docs-ptk/v2.0/commands/ptk-meta-prune.md | 2 +- product/zh/docs-ptk/v2.0/commands/ptk-meta.md | 2 +- .../zh/docs-ptk/v2.0/commands/ptk-rec-guc.md | 2 +- .../v2.0/commands/ptk-self-upgrade.md | 2 +- product/zh/docs-ptk/v2.0/commands/ptk-self.md | 2 +- .../v2.0/commands/ptk-template-create.md | 4 +- .../v2.0/commands/ptk-template-mogha.md | 2 +- .../v2.0/commands/ptk-template-scale-out.md | 2 +- .../zh/docs-ptk/v2.0/commands/ptk-template.md | 2 +- .../docs-ptk/v2.0/commands/ptk-uninstall.md | 2 +- .../zh/docs-ptk/v2.0/commands/ptk-version.md | 2 +- ...-register.md => ptk-view-static-config.md} | 36 +++-- product/zh/docs-ptk/v2.0/commands/ptk.md | 10 +- .../zh/docs-ptk/v2.0/reference/ref-config.md | 4 +- .../v2.0/release-notes/release-17x.md | 31 ++++ product/zh/docs-ptk/v2.0/toc.md | 7 +- 89 files changed, 705 insertions(+), 137 deletions(-) create mode 100644 product/zh/docs-ptk/v2.0/commands/ptk-cluster-createdb.md create mode 100644 product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-compat-tools.md create mode 100644 product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-mogila.md create mode 100644 product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-compat-tools.md rename product/zh/docs-ptk/v2.0/commands/{ptk-register.md => ptk-view-static-config.md} (69%) create mode 100644 product/zh/docs-ptk/v2.0/release-notes/release-17x.md diff --git a/product/en/docs-ptk/v2.0/toc.md b/product/en/docs-ptk/v2.0/toc.md index 704bd170..5eaa349b 100644 --- a/product/en/docs-ptk/v2.0/toc.md +++ b/product/en/docs-ptk/v2.0/toc.md @@ -72,7 +72,7 @@ + [ptk completion fish](./commands/ptk-completion-fish.md) + [ptk completion zsh](./commands/ptk-completion-zsh.md) + [ptk completion bash](./commands/ptk-completion-bash.md) - + [ptk register](./commands/ptk-register.md) + + [ptk view-static-config](./commands/ptk-view-static-config.md) + [ptk init-cluster](./commands/ptk-init-cluster.md) + [ptk collect](./commands/ptk-collect.md) + [ptk rec-guc](./commands/ptk-rec-guc.md) @@ -92,6 +92,10 @@ + [ptk env](./commands/ptk-env.md) + [ptk gen-static-config](./commands/ptk-gen-static-config.md) + [ptk cluster](./commands/ptk-cluster.md) + + [ptk cluster createdb](./commands/ptk-cluster-createdb.md) + + [ptk cluster uninstall-compat-tools](./commands/ptk-cluster-uninstall-compat-tools.md) + + [ptk cluster install-compat-tools](./commands/ptk-cluster-install-compat-tools.md) + + [ptk cluster install-mogila](./commands/ptk-cluster-install-mogila.md) + [ptk cluster rename](./commands/ptk-cluster-rename.md) + [ptk cluster throwout](./commands/ptk-cluster-throwout.md) + [ptk cluster takeover](./commands/ptk-cluster-takeover.md) @@ -150,6 +154,7 @@ + [Troubleshooting](./debug.md) + [FAQ](./faq.md) + Release Notes + + [v1.7](./release-notes/release-17x.md) + [v1.6](./release-notes/release-16x.md) + [v1.5](./release-notes/release-15x.md) + [v1.4](./release-notes/release-14x.md) diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cache.md b/product/zh/docs-ptk/v2.0/commands/ptk-cache.md index 27aaedeb..41e70975 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cache.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cache.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cache.md summary: dist/docs/commands/ptk-cache.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cache diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-candidate-cpu.md b/product/zh/docs-ptk/v2.0/commands/ptk-candidate-cpu.md index 80333f7e..110eb431 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-candidate-cpu.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-candidate-cpu.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-candidate-cpu.md summary: dist/docs/commands/ptk-candidate-cpu.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk candidate cpu diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-candidate-db.md b/product/zh/docs-ptk/v2.0/commands/ptk-candidate-db.md index b32de00f..38f7d428 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-candidate-db.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-candidate-db.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-candidate-db.md summary: dist/docs/commands/ptk-candidate-db.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk candidate db diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-candidate-os.md b/product/zh/docs-ptk/v2.0/commands/ptk-candidate-os.md index 0290e4a1..09aa5307 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-candidate-os.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-candidate-os.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-candidate-os.md summary: dist/docs/commands/ptk-candidate-os.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk candidate os diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-candidate-plugin.md b/product/zh/docs-ptk/v2.0/commands/ptk-candidate-plugin.md index 9ba22f80..bdde6006 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-candidate-plugin.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-candidate-plugin.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-candidate-plugin.md summary: dist/docs/commands/ptk-candidate-plugin.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk candidate plugin diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-candidate.md b/product/zh/docs-ptk/v2.0/commands/ptk-candidate.md index 96c5be01..2bd73ddb 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-candidate.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-candidate.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-candidate.md summary: dist/docs/commands/ptk-candidate.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk candidate diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-checkos.md b/product/zh/docs-ptk/v2.0/commands/ptk-checkos.md index bd9eb501..f005ea6d 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-checkos.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-checkos.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-checkos.md summary: dist/docs/commands/ptk-checkos.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk checkos diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-add-kerberos-auth.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-add-kerberos-auth.md index 6ab81247..17677ac4 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-add-kerberos-auth.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-add-kerberos-auth.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-add-kerberos-auth.md summary: dist/docs/commands/ptk-cluster-add-kerberos-auth.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster add-kerberos-auth diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-build.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-build.md index 664e70e6..791cfa2f 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-build.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-build.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-build.md summary: dist/docs/commands/ptk-cluster-build.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster build diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-createdb.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-createdb.md new file mode 100644 index 00000000..892c031b --- /dev/null +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-createdb.md @@ -0,0 +1,146 @@ +--- +title: dist/docs/commands/ptk-cluster-createdb.md +summary: dist/docs/commands/ptk-cluster-createdb.md +author: ptk +date: 2024-08-29T18:48:05+08:00 +--- + +# ptk cluster createdb + +创建Database + +## 语法 + +```bash +ptk cluster createdb [flags] +``` + +## 示例 + +```bash +# 创建数据库 +ptk cluster -n createdb --dbname +[--owner ] [--encoding ] [--lc-collate ] +[--lc-type ] [--compatibility ] +[--tablespace ] [--connlimit ] +``` + +## 选项 + +### --compatibility string + +* 说明: 数据库兼容性 +* 数据类型: string +* 默认值: "A" + +### --connlimit int + +* 说明: CONNECTION LIMIT of database +* 数据类型: int +* 默认值: 0 + +### --dbname string + +* 说明: Database名称 +* 数据类型: string +* 默认值: "" + +### --encoding string + +* 说明: ENCODING of database +* 数据类型: string +* 默认值: "" + +### --lc-collate string + +* 说明: LC_COLLATE of database +* 数据类型: string +* 默认值: "" + +### --lc-type string + +* 说明: LC_TYPE of database +* 数据类型: string +* 默认值: "" + +### --owner string + +* 说明: OWNER of database +* 数据类型: string +* 默认值: "" + +### --tablespace string + +* 说明: TABLESPACE of database +* 数据类型: string +* 默认值: "" + +## 从父命令继承的选项 + +### --disable-color + +* 说明: 禁用彩色日志 +* 数据类型: bool +* 默认值: false + +### --disable-debug-log + +* 说明: 不生成调试日志文件 +* 数据类型: bool +* 默认值: false + +### --disable-progressbar + +* 说明: 全局不显示进度条 +* 数据类型: bool +* 默认值: false + +### -h, --help + +* 说明: 打印帮助信息 +* 数据类型: bool +* 默认值: false + +### --log-file string + +* 说明: 指定运行日志文件路径 +* 数据类型: string +* 默认值: "" + +### --log-format string + +* 说明: 指定运行日志的输出格式, 可选项: [text, json] +* 数据类型: string +* 默认值: "text" + +### --log-level string + +* 说明: 指定运行日志级别, 可选项: [debug, info, warning, error, panic] +* 数据类型: string +* 默认值: "info" + +### -n, --name string + +* 说明: 集群名称 +* 数据类型: string +* 默认值: "" + +### --silence + +* 说明: 不打印日志到标准输出 +* 数据类型: bool +* 默认值: false + +### --skip-fix-ssh + +* 说明: 无需通过交互修复 ssh 连接 +* 数据类型: bool +* 默认值: false + +## 开始支持的版本 + +v1.7 + +## 另请参阅 + +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-del-kerberos-auth.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-del-kerberos-auth.md index fab66d30..05b2ce35 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-del-kerberos-auth.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-del-kerberos-auth.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-del-kerberos-auth.md summary: dist/docs/commands/ptk-cluster-del-kerberos-auth.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster del-kerberos-auth diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-demote.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-demote.md index 283f4724..42a04b14 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-demote.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-demote.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-demote.md summary: dist/docs/commands/ptk-cluster-demote.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster demote diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-failover.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-failover.md index aa84079a..a66e68e3 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-failover.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-failover.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-failover.md summary: dist/docs/commands/ptk-cluster-failover.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster failover diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-gen-cert-files.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-gen-cert-files.md index 973866ae..c4d3b67f 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-gen-cert-files.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-gen-cert-files.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-gen-cert-files.md summary: dist/docs/commands/ptk-cluster-gen-cert-files.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster gen-cert-files diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-inspect.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-inspect.md index 60a9e548..46d2de4d 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-inspect.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-inspect.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-inspect.md summary: dist/docs/commands/ptk-cluster-inspect.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster inspect diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-cm.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-cm.md index b9f56103..6fa27acb 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-cm.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-cm.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-install-cm.md summary: dist/docs/commands/ptk-cluster-install-cm.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster install-cm diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-compat-tools.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-compat-tools.md new file mode 100644 index 00000000..7852687d --- /dev/null +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-compat-tools.md @@ -0,0 +1,106 @@ +--- +title: dist/docs/commands/ptk-cluster-install-compat-tools.md +summary: dist/docs/commands/ptk-cluster-install-compat-tools.md +author: ptk +date: 2024-08-29T18:48:05+08:00 +--- + +# ptk cluster install-compat-tools + +安装compat-tools + +## 语法 + +```bash +ptk cluster install-compat-tools [flags] +``` + +## 示例 + +```bash +ptk cluster -n install-compat-tools -d --dir +``` + +## 选项 + +### -d, --dbname string + +* 说明: 指定要安装compat-tools的数据库 +* 数据类型: string +* 默认值: "" + +### --dir string + +* 说明: 指定compat-tools的本地目录 +* 数据类型: string +* 默认值: "" + +## 从父命令继承的选项 + +### --disable-color + +* 说明: 禁用彩色日志 +* 数据类型: bool +* 默认值: false + +### --disable-debug-log + +* 说明: 不生成调试日志文件 +* 数据类型: bool +* 默认值: false + +### --disable-progressbar + +* 说明: 全局不显示进度条 +* 数据类型: bool +* 默认值: false + +### -h, --help + +* 说明: 打印帮助信息 +* 数据类型: bool +* 默认值: false + +### --log-file string + +* 说明: 指定运行日志文件路径 +* 数据类型: string +* 默认值: "" + +### --log-format string + +* 说明: 指定运行日志的输出格式, 可选项: [text, json] +* 数据类型: string +* 默认值: "text" + +### --log-level string + +* 说明: 指定运行日志级别, 可选项: [debug, info, warning, error, panic] +* 数据类型: string +* 默认值: "info" + +### -n, --name string + +* 说明: 集群名称 +* 数据类型: string +* 默认值: "" + +### --silence + +* 说明: 不打印日志到标准输出 +* 数据类型: bool +* 默认值: false + +### --skip-fix-ssh + +* 说明: 无需通过交互修复 ssh 连接 +* 数据类型: bool +* 默认值: false + +## 开始支持的版本 + +v1.7 + +## 另请参阅 + +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-kerberos-server.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-kerberos-server.md index 5ba8c196..d68146ca 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-kerberos-server.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-kerberos-server.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-install-kerberos-server.md summary: dist/docs/commands/ptk-cluster-install-kerberos-server.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster install-kerberos-server diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-mogha.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-mogha.md index 24511a0a..c003e57e 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-mogha.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-mogha.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-install-mogha.md summary: dist/docs/commands/ptk-cluster-install-mogha.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster install-mogha @@ -45,7 +45,7 @@ ptk cluster -n install-mogha -c node.conf [-y] [-p install-mogila -d --dir +``` + +## 选项 + +### --db-user string + +* 说明: 为mogila创建一个数据库用户 +* 数据类型: string +* 默认值: "" + +### -d, --dbname string + +* 说明: 指定要安装mogila的数据库 +* 数据类型: string +* 默认值: "" + +### --dir string + +* 说明: 指定mogila的本地目录 +* 数据类型: string +* 默认值: "" + +## 从父命令继承的选项 + +### --disable-color + +* 说明: 禁用彩色日志 +* 数据类型: bool +* 默认值: false + +### --disable-debug-log + +* 说明: 不生成调试日志文件 +* 数据类型: bool +* 默认值: false + +### --disable-progressbar + +* 说明: 全局不显示进度条 +* 数据类型: bool +* 默认值: false + +### -h, --help + +* 说明: 打印帮助信息 +* 数据类型: bool +* 默认值: false + +### --log-file string + +* 说明: 指定运行日志文件路径 +* 数据类型: string +* 默认值: "" + +### --log-format string + +* 说明: 指定运行日志的输出格式, 可选项: [text, json] +* 数据类型: string +* 默认值: "text" + +### --log-level string + +* 说明: 指定运行日志级别, 可选项: [debug, info, warning, error, panic] +* 数据类型: string +* 默认值: "info" + +### -n, --name string + +* 说明: 集群名称 +* 数据类型: string +* 默认值: "" + +### --silence + +* 说明: 不打印日志到标准输出 +* 数据类型: bool +* 默认值: false + +### --skip-fix-ssh + +* 说明: 无需通过交互修复 ssh 连接 +* 数据类型: bool +* 默认值: false + +## 开始支持的版本 + +v1.7 + +## 另请参阅 + +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-plugin.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-plugin.md index a07c9731..0c97d3c5 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-plugin.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-install-plugin.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-install-plugin.md summary: dist/docs/commands/ptk-cluster-install-plugin.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster install-plugin diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-is-in-upgrade.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-is-in-upgrade.md index 2930a284..9e0bf362 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-is-in-upgrade.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-is-in-upgrade.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-is-in-upgrade.md summary: dist/docs/commands/ptk-cluster-is-in-upgrade.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster is-in-upgrade diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-list-plugins.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-list-plugins.md index 69fb4b7e..b72de276 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-list-plugins.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-list-plugins.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-list-plugins.md summary: dist/docs/commands/ptk-cluster-list-plugins.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster list-plugins diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-load-cm-vip.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-load-cm-vip.md index 2f30460e..05fad07a 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-load-cm-vip.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-load-cm-vip.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-load-cm-vip.md summary: dist/docs/commands/ptk-cluster-load-cm-vip.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster load-cm-vip diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-modify-comment.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-modify-comment.md index f6a81e53..1dac13bd 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-modify-comment.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-modify-comment.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-modify-comment.md summary: dist/docs/commands/ptk-cluster-modify-comment.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster modify-comment diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-promote.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-promote.md index 584deefa..f2082738 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-promote.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-promote.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-promote.md summary: dist/docs/commands/ptk-cluster-promote.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster promote diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-refresh.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-refresh.md index ecaaec56..d0d948ef 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-refresh.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-refresh.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-refresh.md summary: dist/docs/commands/ptk-cluster-refresh.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster refresh diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-rename.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-rename.md index 3f4e7d1c..bacc2af5 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-rename.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-rename.md @@ -2,12 +2,12 @@ title: dist/docs/commands/ptk-cluster-rename.md summary: dist/docs/commands/ptk-cluster-rename.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster rename -Rename cluster +重命名集群 ## 语法 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-restart.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-restart.md index dfa56ec2..c4832bbb 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-restart.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-restart.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-restart.md summary: dist/docs/commands/ptk-cluster-restart.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster restart diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-scale-in.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-scale-in.md index a5022b73..90bc8bde 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-scale-in.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-scale-in.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-scale-in.md summary: dist/docs/commands/ptk-cluster-scale-in.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster scale-in diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-scale-out.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-scale-out.md index 633cdac2..d3154cd8 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-scale-out.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-scale-out.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-scale-out.md summary: dist/docs/commands/ptk-cluster-scale-out.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster scale-out @@ -69,6 +69,12 @@ ptk cluster -n scale-out -c scale-out.yaml --build-from * 数据类型: bool * 默认值: false +### --skip-check-hostname + +* 说明: 跳过检查hostname +* 数据类型: bool +* 默认值: false + ### --skip-check-os * 说明: 跳过系统检查 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-set-guc.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-set-guc.md index 803bd63b..b2718a4d 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-set-guc.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-set-guc.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-set-guc.md summary: dist/docs/commands/ptk-cluster-set-guc.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster set-guc diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-set-hba.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-set-hba.md index fbaf6950..bd33dd65 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-set-hba.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-set-hba.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-set-hba.md summary: dist/docs/commands/ptk-cluster-set-hba.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster set-hba diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-shell.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-shell.md index 6859c1c2..e681d336 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-shell.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-shell.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-shell.md summary: dist/docs/commands/ptk-cluster-shell.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster shell diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-config.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-config.md index 04459942..97a7a86e 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-config.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-config.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-show-config.md summary: dist/docs/commands/ptk-cluster-show-config.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster show-config diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-guc.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-guc.md index 758046ad..b4481288 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-guc.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-guc.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-show-guc.md summary: dist/docs/commands/ptk-cluster-show-guc.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster show-guc diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-hba.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-hba.md index 4168d37c..2a99c115 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-hba.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-show-hba.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-show-hba.md summary: dist/docs/commands/ptk-cluster-show-hba.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster show-hba diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-start.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-start.md index 2d85dcd1..d50a23f3 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-start.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-start.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-start.md summary: dist/docs/commands/ptk-cluster-start.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster start diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-status.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-status.md index c308153f..2daf786f 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-status.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-status.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-status.md summary: dist/docs/commands/ptk-cluster-status.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster status diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-stop.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-stop.md index 7a0df405..8e594c2a 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-stop.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-stop.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-stop.md summary: dist/docs/commands/ptk-cluster-stop.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster stop diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-switchover.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-switchover.md index 2e983f35..d985254f 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-switchover.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-switchover.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-switchover.md summary: dist/docs/commands/ptk-cluster-switchover.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster switchover diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-takeover.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-takeover.md index d5ffd7b2..2a1cf2ed 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-takeover.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-takeover.md @@ -2,12 +2,12 @@ title: dist/docs/commands/ptk-cluster-takeover.md summary: dist/docs/commands/ptk-cluster-takeover.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster takeover -Takeover a new server to ptk metadata +添加一个新的实例到PTK的元数据 ## 语法 @@ -18,18 +18,18 @@ ptk cluster takeover [flags] ## 示例 ```bash -ptk cluster -n takeover [-H|--host ][-U|--user ] +ptk cluster -n takeover [-H|--host ][--db-user ][--ssh-user ] [-i|--identity ] [--appdir ] [--datadir ] [--logdir ] [--tmpdir ] [--tooldir ] # For example: -ptk cluster -n takeover -H -U +ptk cluster -n takeover -H --db-user ``` ## 选项 ### --appdir string -* 说明: App dir of db server +* 说明: 数据库实例的应用目录 * 数据类型: string * 默认值: "" @@ -41,49 +41,55 @@ ptk cluster -n takeover -H -U ### --datadir string -* 说明: Data dir of db server +* 说明: 数据目录 * 数据类型: string * 默认值: "" ### --db-port int -* 说明: DB port of db server +* 说明: 数据库实例端口 * 数据类型: int * 默认值: 0 +### --db-user string + +* 说明: 运行数据库的操作系统用户 +* 数据类型: string +* 默认值: "" + ### -H, --host string -* 说明: Specify the host of the takeover node +* 说明: 数据库实例 IP * 数据类型: string * 默认值: "" ### -i, --identity string -* 说明: SSH private key path +* 说明: SSH私钥路径 * 数据类型: string * 默认值: "" ### --logdir string -* 说明: Log dir of db server +* 说明: 日志目录 * 数据类型: string * 默认值: "" -### --tmpdir string +### --ssh-user string -* 说明: Tmp dir of db server +* 说明: SSH login user * 数据类型: string * 默认值: "" -### --tooldir string +### --tmpdir string -* 说明: Tool dir of db server +* 说明: Tmp dir of db server * 数据类型: string * 默认值: "" -### -U, --username string +### --tooldir string -* 说明: Specify the user to takeover the node +* 说明: Tool dir of db server * 数据类型: string * 默认值: "" diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-throwout.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-throwout.md index 7fa76ba2..b9a5ed28 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-throwout.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-throwout.md @@ -2,12 +2,12 @@ title: dist/docs/commands/ptk-cluster-throwout.md summary: dist/docs/commands/ptk-cluster-throwout.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster throwout -Remove a server from ptk metadata +从PTK的元数据中移除实例 ## 语法 @@ -19,10 +19,10 @@ ptk cluster throwout [flags] ```bash -# By host ip +# 使用机器 IP ptk cluster -n throwout -H -# By instance id +# 使用实例 ID ptk cluster -n throwout -i ``` diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-cm.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-cm.md index 0b673885..2b7fce6a 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-cm.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-cm.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-uninstall-cm.md summary: dist/docs/commands/ptk-cluster-uninstall-cm.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster uninstall-cm diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-compat-tools.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-compat-tools.md new file mode 100644 index 00000000..02f97482 --- /dev/null +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-compat-tools.md @@ -0,0 +1,106 @@ +--- +title: dist/docs/commands/ptk-cluster-uninstall-compat-tools.md +summary: dist/docs/commands/ptk-cluster-uninstall-compat-tools.md +author: ptk +date: 2024-08-29T18:48:05+08:00 +--- + +# ptk cluster uninstall-compat-tools + +Uninstall compat-tools + +## 语法 + +```bash +ptk cluster uninstall-compat-tools [flags] +``` + +## 示例 + +```bash +ptk cluster -n uninstall-compat-tools -d --dir +``` + +## 选项 + +### -d, --dbname string + +* 说明: 指定要卸载compat-tools的数据库 +* 数据类型: string +* 默认值: "" + +### --dir string + +* 说明: 指定compat-tools的本地目录 +* 数据类型: string +* 默认值: "" + +## 从父命令继承的选项 + +### --disable-color + +* 说明: 禁用彩色日志 +* 数据类型: bool +* 默认值: false + +### --disable-debug-log + +* 说明: 不生成调试日志文件 +* 数据类型: bool +* 默认值: false + +### --disable-progressbar + +* 说明: 全局不显示进度条 +* 数据类型: bool +* 默认值: false + +### -h, --help + +* 说明: 打印帮助信息 +* 数据类型: bool +* 默认值: false + +### --log-file string + +* 说明: 指定运行日志文件路径 +* 数据类型: string +* 默认值: "" + +### --log-format string + +* 说明: 指定运行日志的输出格式, 可选项: [text, json] +* 数据类型: string +* 默认值: "text" + +### --log-level string + +* 说明: 指定运行日志级别, 可选项: [debug, info, warning, error, panic] +* 数据类型: string +* 默认值: "info" + +### -n, --name string + +* 说明: 集群名称 +* 数据类型: string +* 默认值: "" + +### --silence + +* 说明: 不打印日志到标准输出 +* 数据类型: bool +* 默认值: false + +### --skip-fix-ssh + +* 说明: 无需通过交互修复 ssh 连接 +* 数据类型: bool +* 默认值: false + +## 开始支持的版本 + +v1.7 + +## 另请参阅 + +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-kerberos-server.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-kerberos-server.md index cc8a76fc..a94ca82e 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-kerberos-server.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-kerberos-server.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-uninstall-kerberos-server.md summary: dist/docs/commands/ptk-cluster-uninstall-kerberos-server.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster uninstall-kerberos-server diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-mogha.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-mogha.md index 59e98f3e..c30ebb05 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-mogha.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-uninstall-mogha.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-uninstall-mogha.md summary: dist/docs/commands/ptk-cluster-uninstall-mogha.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster uninstall-mogha diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade-commit.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade-commit.md index 84b469cf..9652dda8 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade-commit.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade-commit.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-upgrade-commit.md summary: dist/docs/commands/ptk-cluster-upgrade-commit.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster upgrade-commit diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade-rollback.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade-rollback.md index 34745337..8da16de0 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade-rollback.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade-rollback.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-upgrade-rollback.md summary: dist/docs/commands/ptk-cluster-upgrade-rollback.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster upgrade-rollback diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade.md index 6b12354d..414df22e 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster-upgrade.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster-upgrade.md summary: dist/docs/commands/ptk-cluster-upgrade.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster upgrade diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-cluster.md b/product/zh/docs-ptk/v2.0/commands/ptk-cluster.md index 5130d4ab..50a1768f 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-cluster.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-cluster.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-cluster.md summary: dist/docs/commands/ptk-cluster.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk cluster @@ -88,14 +88,17 @@ v0.1 * [ptk](./ptk.md) - Provisioning Toolkit for MogDB * [ptk cluster add-kerberos-auth](./ptk-cluster-add-kerberos-auth.md) - 添加 kerberos 认证 * [ptk cluster build](./ptk-cluster-build.md) - 重建数据库数据 +* [ptk cluster createdb](./ptk-cluster-createdb.md) - 创建Database * [ptk cluster del-kerberos-auth](./ptk-cluster-del-kerberos-auth.md) - 删除 kerberos 认证 * [ptk cluster demote](./ptk-cluster-demote.md) - 将数据库角色从 Primary 降级为 Standby，或从 Standby 降级为 Cascade Standby * [ptk cluster failover](./ptk-cluster-failover.md) - 提升一个备库为主库 * [ptk cluster gen-cert-files](./ptk-cluster-gen-cert-files.md) - 生成ssl证书文件 * [ptk cluster inspect](./ptk-cluster-inspect.md) - 返回关于集群的内部信息 * [ptk cluster install-cm](./ptk-cluster-install-cm.md) - 安装 CM 组件 +* [ptk cluster install-compat-tools](./ptk-cluster-install-compat-tools.md) - 安装compat-tools * [ptk cluster install-kerberos-server](./ptk-cluster-install-kerberos-server.md) - 安装 kerberos 服务器 * [ptk cluster install-mogha](./ptk-cluster-install-mogha.md) - 为 MogDB 安装 MogHA +* [ptk cluster install-mogila](./ptk-cluster-install-mogila.md) - 安装mogila示例数据 * [ptk cluster install-plugin](./ptk-cluster-install-plugin.md) - 安装 MogDB 插件 * [ptk cluster is-in-upgrade](./ptk-cluster-is-in-upgrade.md) - 查看集群是否处于升级过程中 * [ptk cluster list-plugins](./ptk-cluster-list-plugins.md) - 列出集群中的插件 @@ -103,7 +106,7 @@ v0.1 * [ptk cluster modify-comment](./ptk-cluster-modify-comment.md) - 修改指定集群的备注 * [ptk cluster promote](./ptk-cluster-promote.md) - 将一个数据库实例从备库提升为主库, 或从级联备库提升为备库 * [ptk cluster refresh](./ptk-cluster-refresh.md) - 更新集群配置 -* [ptk cluster rename](./ptk-cluster-rename.md) - Rename cluster +* [ptk cluster rename](./ptk-cluster-rename.md) - 重命名集群 * [ptk cluster restart](./ptk-cluster-restart.md) - 重启数据库实例或集群 * [ptk cluster scale-in](./ptk-cluster-scale-in.md) - 对一个MogDB集群进行缩容 * [ptk cluster scale-out](./ptk-cluster-scale-out.md) - 对一个MogDB集群进行扩容 @@ -117,9 +120,10 @@ v0.1 * [ptk cluster status](./ptk-cluster-status.md) - 显示集群或实例的状态信息 * [ptk cluster stop](./ptk-cluster-stop.md) - 停止数据库实例或集群 * [ptk cluster switchover](./ptk-cluster-switchover.md) - 主备切换，升级备库为主库，降主库为备库 -* [ptk cluster takeover](./ptk-cluster-takeover.md) - Takeover a new server to ptk metadata -* [ptk cluster throwout](./ptk-cluster-throwout.md) - Remove a server from ptk metadata +* [ptk cluster takeover](./ptk-cluster-takeover.md) - 添加一个新的实例到PTK的元数据 +* [ptk cluster throwout](./ptk-cluster-throwout.md) - 从PTK的元数据中移除实例 * [ptk cluster uninstall-cm](./ptk-cluster-uninstall-cm.md) - 卸载 CM 组件 +* [ptk cluster uninstall-compat-tools](./ptk-cluster-uninstall-compat-tools.md) - Uninstall compat-tools * [ptk cluster uninstall-kerberos-server](./ptk-cluster-uninstall-kerberos-server.md) - 卸载 kerberos 服务 * [ptk cluster uninstall-mogha](./ptk-cluster-uninstall-mogha.md) - 卸载 MogHA * [ptk cluster upgrade](./ptk-cluster-upgrade.md) - 升级集群的数据库版本 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-collect.md b/product/zh/docs-ptk/v2.0/commands/ptk-collect.md index 56afadc9..b865cf2e 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-collect.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-collect.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-collect.md summary: dist/docs/commands/ptk-collect.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk collect diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-completion-bash.md b/product/zh/docs-ptk/v2.0/commands/ptk-completion-bash.md index 2c25c2fa..9fbdff70 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-completion-bash.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-completion-bash.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-completion-bash.md summary: dist/docs/commands/ptk-completion-bash.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk completion bash diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-completion-fish.md b/product/zh/docs-ptk/v2.0/commands/ptk-completion-fish.md index f23d22ee..863eb465 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-completion-fish.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-completion-fish.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-completion-fish.md summary: dist/docs/commands/ptk-completion-fish.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk completion fish diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-completion-powershell.md b/product/zh/docs-ptk/v2.0/commands/ptk-completion-powershell.md index 451c6282..4ce1e710 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-completion-powershell.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-completion-powershell.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-completion-powershell.md summary: dist/docs/commands/ptk-completion-powershell.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk completion powershell diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-completion-zsh.md b/product/zh/docs-ptk/v2.0/commands/ptk-completion-zsh.md index 9727f34d..d4b9ae48 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-completion-zsh.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-completion-zsh.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-completion-zsh.md summary: dist/docs/commands/ptk-completion-zsh.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk completion zsh diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-completion.md b/product/zh/docs-ptk/v2.0/commands/ptk-completion.md index 0010606b..4525a978 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-completion.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-completion.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-completion.md summary: dist/docs/commands/ptk-completion.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk completion diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-demo.md b/product/zh/docs-ptk/v2.0/commands/ptk-demo.md index 3092b472..6bd8eae3 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-demo.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-demo.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-demo.md summary: dist/docs/commands/ptk-demo.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk demo @@ -19,11 +19,17 @@ ptk demo [flags] ```bash ptk demo -ptk demo -p +ptk demo -p --base-dir ``` ## 选项 +### --base-dir string + +* 说明: 指定安装数据库的目录 +* 数据类型: string +* 默认值: "" + ### --compat-tools-dir string * 说明: 指定 compat-tools 插件目录 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-download.md b/product/zh/docs-ptk/v2.0/commands/ptk-download.md index eefc9e40..be0b9c77 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-download.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-download.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-download.md summary: dist/docs/commands/ptk-download.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk download @@ -33,11 +33,11 @@ ptk download --db-version 5.0.5 ### -V, --db-version string -* 说明: Specify db version. -Type 'ptk candidate db' to show supported version -This flag only support MogDB +* 说明: 指定数据库版本 +可通过输入 'ptk candidate db' 命令查看支持的版本列表 +这个参数仅支持MogDB * 数据类型: string -* 默认值: "5.0.7" +* 默认值: "5.0.8" ### --dest-dir string diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-encrypt.md b/product/zh/docs-ptk/v2.0/commands/ptk-encrypt.md index 5e0d1788..7f97945b 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-encrypt.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-encrypt.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-encrypt.md summary: dist/docs/commands/ptk-encrypt.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk encrypt diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-env.md b/product/zh/docs-ptk/v2.0/commands/ptk-env.md index 7e82b22d..1b551c81 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-env.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-env.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-env.md summary: dist/docs/commands/ptk-env.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk env diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-exec.md b/product/zh/docs-ptk/v2.0/commands/ptk-exec.md index 89dc221f..dff44c4b 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-exec.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-exec.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-exec.md summary: dist/docs/commands/ptk-exec.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk exec diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-gen-om-xml.md b/product/zh/docs-ptk/v2.0/commands/ptk-gen-om-xml.md index b2dc28a5..e15abc0d 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-gen-om-xml.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-gen-om-xml.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-gen-om-xml.md summary: dist/docs/commands/ptk-gen-om-xml.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk gen-om-xml diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-gen-ptkc.md b/product/zh/docs-ptk/v2.0/commands/ptk-gen-ptkc.md index f191dd1e..7a8c1a30 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-gen-ptkc.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-gen-ptkc.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-gen-ptkc.md summary: dist/docs/commands/ptk-gen-ptkc.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk gen-ptkc diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-gen-static-config.md b/product/zh/docs-ptk/v2.0/commands/ptk-gen-static-config.md index 0becd632..91b67114 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-gen-static-config.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-gen-static-config.md @@ -2,12 +2,12 @@ title: dist/docs/commands/ptk-gen-static-config.md summary: dist/docs/commands/ptk-gen-static-config.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk gen-static-config -使用指定的 YAML 配置生成一份新的集群静态文件并分发到数据节点 +指定集群来创建静态文件并分发到实例节点 ## 语法 @@ -18,15 +18,14 @@ ptk gen-static-config [flags] ## 示例 ```bash -ptk gen-static-config -f -ptk distribute -f +ptk gen-static-config -n ``` ## 选项 -### -f, --file string +### -n, --clustername string -* 说明: 指定集群配置文件 +* 说明: 指定集群名称 * 数据类型: string * 默认值: "" diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-init-cluster.md b/product/zh/docs-ptk/v2.0/commands/ptk-init-cluster.md index 2eb0d8e6..b4cc4f86 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-init-cluster.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-init-cluster.md @@ -2,12 +2,12 @@ title: dist/docs/commands/ptk-init-cluster.md summary: dist/docs/commands/ptk-init-cluster.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk init-cluster -Generate a new empty cluster +创建一个空集群 ## 语法 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-install.md b/product/zh/docs-ptk/v2.0/commands/ptk-install.md index bfd49cf1..0bec8c74 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-install.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-install.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-install.md summary: dist/docs/commands/ptk-install.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk install @@ -64,13 +64,19 @@ ptk install -f -p -y --skip-check-os --comment ' * 数据类型: string * 默认值: "" +### --db-conf-file string + +* 说明: 指定自定义数据库参数配置文件，格式和 postgresql.conf 一致 +* 数据类型: string +* 默认值: "" + ### --db-version string * 说明: Specify the database package version if use online package Type 'ptk candidate db' to show available version This flag only support MogDB * 数据类型: string -* 默认值: "5.0.7" +* 默认值: "5.0.8" ### --default-guc @@ -140,13 +146,19 @@ This flag only support MogDB ### --skip-check-distro -* 说明: 跳过系统发行版检查，直接安装 +* 说明: 跳过检查系统发行版 +* 数据类型: bool +* 默认值: false + +### --skip-check-hostname + +* 说明: 跳过检查hostname * 数据类型: bool * 默认值: false ### --skip-check-os -* 说明: 跳过系统环境检查，直接安装 +* 说明: 跳过系统检查 * 数据类型: bool * 默认值: false @@ -176,7 +188,7 @@ This flag only support MogDB ### --skip-load-vip -* 说明: Skip load vip after deploying CM +* 说明: 安装CM后无需加载VIP * 数据类型: bool * 默认值: false diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-ls.md b/product/zh/docs-ptk/v2.0/commands/ptk-ls.md index 315775df..2f1132de 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-ls.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-ls.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-ls.md summary: dist/docs/commands/ptk-ls.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk ls diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-manage.md b/product/zh/docs-ptk/v2.0/commands/ptk-manage.md index dc5ea6e6..ce1b55a4 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-manage.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-manage.md @@ -2,12 +2,12 @@ title: dist/docs/commands/ptk-manage.md summary: dist/docs/commands/ptk-manage.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk manage -Manage an exist cluster +纳管一个存在的集群 ## 语法 @@ -35,6 +35,12 @@ ptk manage --clustername -H -U * 数据类型: string * 默认值: "" +### --ssh-port int + +* 说明: 指定SSH端口 +* 数据类型: int +* 默认值: 22 + ### -U, --username string * 说明: 运行数据库的操作系统用户 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-meta-dump.md b/product/zh/docs-ptk/v2.0/commands/ptk-meta-dump.md index 0f577060..e04c4953 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-meta-dump.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-meta-dump.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-meta-dump.md summary: dist/docs/commands/ptk-meta-dump.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk meta dump diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-meta-home.md b/product/zh/docs-ptk/v2.0/commands/ptk-meta-home.md index 365ebd4f..c5a68ada 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-meta-home.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-meta-home.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-meta-home.md summary: dist/docs/commands/ptk-meta-home.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk meta home diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-meta-merge.md b/product/zh/docs-ptk/v2.0/commands/ptk-meta-merge.md index 4cf79564..acfdf039 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-meta-merge.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-meta-merge.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-meta-merge.md summary: dist/docs/commands/ptk-meta-merge.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk meta merge diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-meta-prune.md b/product/zh/docs-ptk/v2.0/commands/ptk-meta-prune.md index 92e3a0cd..c9bad05b 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-meta-prune.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-meta-prune.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-meta-prune.md summary: dist/docs/commands/ptk-meta-prune.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk meta prune diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-meta.md b/product/zh/docs-ptk/v2.0/commands/ptk-meta.md index c5b8d9e0..6ff0e81b 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-meta.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-meta.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-meta.md summary: dist/docs/commands/ptk-meta.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk meta diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-rec-guc.md b/product/zh/docs-ptk/v2.0/commands/ptk-rec-guc.md index d282e7ab..2df61e4d 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-rec-guc.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-rec-guc.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-rec-guc.md summary: dist/docs/commands/ptk-rec-guc.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk rec-guc diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-self-upgrade.md b/product/zh/docs-ptk/v2.0/commands/ptk-self-upgrade.md index 171360f5..82adf06e 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-self-upgrade.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-self-upgrade.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-self-upgrade.md summary: dist/docs/commands/ptk-self-upgrade.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk self upgrade diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-self.md b/product/zh/docs-ptk/v2.0/commands/ptk-self.md index cb927c78..e415f262 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-self.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-self.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-self.md summary: dist/docs/commands/ptk-self.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk self diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-template-create.md b/product/zh/docs-ptk/v2.0/commands/ptk-template-create.md index 1849621c..7c35e3dc 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-template-create.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-template-create.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-template-create.md summary: dist/docs/commands/ptk-template-create.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk template create @@ -27,7 +27,7 @@ ptk template create [-o config.yml] * 说明: 指定输出文件名 * 数据类型: string -* 默认值: "config.2024-06-04T17_04_56.yaml" +* 默认值: "config.2024-08-29T18_48_05.yaml" ## 从父命令继承的选项 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-template-mogha.md b/product/zh/docs-ptk/v2.0/commands/ptk-template-mogha.md index b7a3d511..e0ede8a8 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-template-mogha.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-template-mogha.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-template-mogha.md summary: dist/docs/commands/ptk-template-mogha.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk template mogha diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-template-scale-out.md b/product/zh/docs-ptk/v2.0/commands/ptk-template-scale-out.md index 429ae908..2a92f9b7 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-template-scale-out.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-template-scale-out.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-template-scale-out.md summary: dist/docs/commands/ptk-template-scale-out.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk template scale-out diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-template.md b/product/zh/docs-ptk/v2.0/commands/ptk-template.md index c2eafc5f..cb611014 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-template.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-template.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-template.md summary: dist/docs/commands/ptk-template.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk template diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-uninstall.md b/product/zh/docs-ptk/v2.0/commands/ptk-uninstall.md index 07e26391..57465264 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-uninstall.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-uninstall.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-uninstall.md summary: dist/docs/commands/ptk-uninstall.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk uninstall diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-version.md b/product/zh/docs-ptk/v2.0/commands/ptk-version.md index e3bbd42c..eb56dcdd 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-version.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-version.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-version.md summary: dist/docs/commands/ptk-version.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk version diff --git a/product/zh/docs-ptk/v2.0/commands/ptk-register.md b/product/zh/docs-ptk/v2.0/commands/ptk-view-static-config.md similarity index 69% rename from product/zh/docs-ptk/v2.0/commands/ptk-register.md rename to product/zh/docs-ptk/v2.0/commands/ptk-view-static-config.md index e4035321..bd91caf0 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk-register.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk-view-static-config.md @@ -1,22 +1,40 @@ --- -title: dist/docs/commands/ptk-register.md -summary: dist/docs/commands/ptk-register.md +title: dist/docs/commands/ptk-view-static-config.md +summary: dist/docs/commands/ptk-view-static-config.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- -# ptk register +# ptk view-static-config -> ! 该命令已经废弃，将在未来版本中删除 - -注册一些内部类型以满足特定需求 +显示解析后的静态文件内容 ## 语法 ```bash -ptk register [flags] +ptk view-static-config [flags] ``` +## 示例 + +```bash +ptk view-static-config -f [--raw] +``` + +## 选项 + +### --file string + +* 说明: 指定本地静态文件 +* 数据类型: string +* 默认值: "" + +### --raw + +* 说明: 显示静态文件的原始内容 +* 数据类型: bool +* 默认值: false + ## 从父命令继承的选项 ### --disable-color @@ -75,7 +93,7 @@ ptk register [flags] ## 开始支持的版本 -v0.4 +v1.7 ## 另请参阅 diff --git a/product/zh/docs-ptk/v2.0/commands/ptk.md b/product/zh/docs-ptk/v2.0/commands/ptk.md index 613c9442..a33ced0d 100644 --- a/product/zh/docs-ptk/v2.0/commands/ptk.md +++ b/product/zh/docs-ptk/v2.0/commands/ptk.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk.md summary: dist/docs/commands/ptk.md author: ptk -date: 2024-06-04T17:04:56+08:00 +date: 2024-08-29T18:48:05+08:00 --- # ptk @@ -96,15 +96,15 @@ ptk [flags] [args...] * [ptk exec](./ptk-exec.md) - 执行 shell 命令或脚本 * [ptk gen-om-xml](./ptk-gen-om-xml.md) - 生成 gs_om 的 XML 配置文件 * [ptk gen-ptkc](./ptk-gen-ptkc.md) - 生成 ptkc 二进制文件 -* [ptk gen-static-config](./ptk-gen-static-config.md) - 使用指定的 YAML 配置生成一份新的集群静态文件并分发到数据节点 -* [ptk init-cluster](./ptk-init-cluster.md) - Generate a new empty cluster +* [ptk gen-static-config](./ptk-gen-static-config.md) - 指定集群来创建静态文件并分发到实例节点 +* [ptk init-cluster](./ptk-init-cluster.md) - 创建一个空集群 * [ptk install](./ptk-install.md) - 安装 MogDB 或 Uqbar 数据库集群 * [ptk ls](./ptk-ls.md) - 列出所有 MogDB 集群列表 -* [ptk manage](./ptk-manage.md) - Manage an exist cluster +* [ptk manage](./ptk-manage.md) - 纳管一个存在的集群 * [ptk meta](./ptk-meta.md) - 管理 PTK 元数据 * [ptk rec-guc](./ptk-rec-guc.md) - 显示优化参数列表 -* [ptk register](./ptk-register.md) - 注册一些内部类型以满足特定需求 * [ptk self](./ptk-self.md) - 关于 ptk 的自操作 * [ptk template](./ptk-template.md) - 生成配置模板 * [ptk uninstall](./ptk-uninstall.md) - 卸载数据库集群 * [ptk version](./ptk-version.md) - 打印 PTK 版本 +* [ptk view-static-config](./ptk-view-static-config.md) - 显示解析后的静态文件内容 diff --git a/product/zh/docs-ptk/v2.0/reference/ref-config.md b/product/zh/docs-ptk/v2.0/reference/ref-config.md index 0de39908..2c3a9154 100644 --- a/product/zh/docs-ptk/v2.0/reference/ref-config.md +++ b/product/zh/docs-ptk/v2.0/reference/ref-config.md @@ -6,7 +6,7 @@ date: 2024-06-01 # 配置文件 -PTK 的拓扑配置文件采用 [YAML格式](../appendix/yaml-grammar.md)。 +PTK 的配置文件采用 [YAML格式](./yaml-grammar.md)。 该文件介绍了拓扑配置文件的所有参数。 @@ -344,7 +344,7 @@ method: sha256 # 指定当一个连接匹配这个记录时，要使用的认证 **类型**: string -**描述**: 连接类型，支持 local/host/hostssl/hostnossl
具体含义请参考 MogDB 文档: [client-access-authentication](https://docs.mogdb.io/zh/mogdb/v5.0/1-client-access-authentication#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E5%8F%82%E8%80%83)
默认值: host +**描述**: 连接类型，支持 local/host/hostssl/hostnossl
具体含义请参考 [MogDB 文档](https://docs.mogdb.io/zh/mogdb/v5.0/1-client-access-authentication#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E5%8F%82%E8%80%83)
默认值: host **新增于**: v1.5.0 diff --git a/product/zh/docs-ptk/v2.0/release-notes/release-17x.md b/product/zh/docs-ptk/v2.0/release-notes/release-17x.md new file mode 100644 index 00000000..c2ce3569 --- /dev/null +++ b/product/zh/docs-ptk/v2.0/release-notes/release-17x.md @@ -0,0 +1,31 @@ +--- +title: v1.6发布记录 +summary: v1.5发布记录 +author: Yao Qian +date: 2024-07-16 +--- + +# 1.7 发布记录 + +## 1.7.0 (2024-08-30) + +**Features** + +- **cluster:** 新增 `install-mogila` 命令，支持安装 [mogila 示例库](https://gitee.com/enmotech/mogila) +- **cluster:** 新增 `install-compat-tools` 命令，支持安装 [compat-tools 兼容工具](https://gitee.com/enmotech/compat-tools) +- **cluster:** 新增 `createdb` 命令，支持通过PTK创建数据库 +- 新增 `view-static-config` 命令，支持查看静态文件内容 +- **install:** 安装命令新增 `--db-conf-file` 参数，支持用户将定制的数据库参数通过文件传入 +- **upgrade:** 升级前增加当前集群和目标安装包的CPU架构一致性检查 +- **checkos:** unicode 检查项增加 `en_US.UTF-8` 字符集必要性检查 +- **takeover:** 废弃 `--user` 参数，新增 `--db-user` 和 `--ssh-user` 参数 +- **manage:** 新增 `--ssh-port` 参数 +- **scaleout:** 扩容的新节点仅修改和服务器相关的必要参数，尽可能的继承其他节点现有配置 +- **gen-static-config:** 废弃 `-f` 参数，新增 `-n` 参数，仅允许操作 PTK 管理的集群 +- 优化 .ptk_mogdb_env 文件中 PATH 变量，将系统默认的目录显式填入，确保系统工具可被检索到 + +**Bug Fixes** + +- **upgrade:** 修复针对打过补丁的数据库升级时执行SQL报只读错误的问题 +- **upgrade:** 修复升级前PTK元数据老旧导致升级失败的问题 +- **scaleout:** 修复扩容时偶现的备库build时报错hba信息不存在的问题 diff --git a/product/zh/docs-ptk/v2.0/toc.md b/product/zh/docs-ptk/v2.0/toc.md index 4115b2b5..0b8adfc0 100644 --- a/product/zh/docs-ptk/v2.0/toc.md +++ b/product/zh/docs-ptk/v2.0/toc.md @@ -71,7 +71,7 @@ + [ptk completion fish](./commands/ptk-completion-fish.md) + [ptk completion zsh](./commands/ptk-completion-zsh.md) + [ptk completion bash](./commands/ptk-completion-bash.md) - + [ptk register](./commands/ptk-register.md) + + [ptk view-static-config](./commands/ptk-view-static-config.md) + [ptk init-cluster](./commands/ptk-init-cluster.md) + [ptk collect](./commands/ptk-collect.md) + [ptk rec-guc](./commands/ptk-rec-guc.md) @@ -91,6 +91,10 @@ + [ptk env](./commands/ptk-env.md) + [ptk gen-static-config](./commands/ptk-gen-static-config.md) + [ptk cluster](./commands/ptk-cluster.md) + + [ptk cluster createdb](./commands/ptk-cluster-createdb.md) + + [ptk cluster uninstall-compat-tools](./commands/ptk-cluster-uninstall-compat-tools.md) + + [ptk cluster install-compat-tools](./commands/ptk-cluster-install-compat-tools.md) + + [ptk cluster install-mogila](./commands/ptk-cluster-install-mogila.md) + [ptk cluster rename](./commands/ptk-cluster-rename.md) + [ptk cluster throwout](./commands/ptk-cluster-throwout.md) + [ptk cluster takeover](./commands/ptk-cluster-takeover.md) @@ -149,6 +153,7 @@ + [故障排查](./debug.md) + [FAQ](./faq.md) + 发布记录 + + [v1.7](./release-notes/release-17x.md) + [v1.6](./release-notes/release-16x.md) + [v1.5](./release-notes/release-15x.md) + [v1.4](./release-notes/release-14x.md) -- Gitee