From 5af3ab7c3c225f954cde1021b72c629689516246 Mon Sep 17 00:00:00 2001 From: "qian.yao" Date: Thu, 6 Jun 2024 09:50:23 +0800 Subject: [PATCH] feat(ptk): add v1.5.0 release note --- product/en/docs-mogdb/v3.0/_index.md | 2 +- product/en/docs-ptk/v1.1/toc.md | 5 + .../zh/docs-ptk/v1.1/commands/ptk-cache.md | 6 +- .../v1.1/commands/ptk-candidate-cpu.md | 4 +- .../v1.1/commands/ptk-candidate-db.md | 4 +- .../v1.1/commands/ptk-candidate-os.md | 4 +- .../v1.1/commands/ptk-candidate-plugin.md | 7 +- .../docs-ptk/v1.1/commands/ptk-candidate.md | 10 +- .../zh/docs-ptk/v1.1/commands/ptk-checkos.md | 10 +- .../commands/ptk-cluster-add-kerberos-auth.md | 4 +- .../v1.1/commands/ptk-cluster-build.md | 12 +- .../commands/ptk-cluster-del-kerberos-auth.md | 4 +- .../v1.1/commands/ptk-cluster-demote.md | 9 +- .../v1.1/commands/ptk-cluster-failover.md | 4 +- .../commands/ptk-cluster-gen-cert-files.md | 4 +- .../v1.1/commands/ptk-cluster-inspect.md | 4 +- .../v1.1/commands/ptk-cluster-install-cm.md | 4 +- .../ptk-cluster-install-kerberos-server.md | 4 +- .../commands/ptk-cluster-install-mogha.md | 4 +- .../commands/ptk-cluster-install-plugin.md | 10 +- .../commands/ptk-cluster-is-in-upgrade.md | 4 +- .../v1.1/commands/ptk-cluster-list-plugins.md | 4 +- .../v1.1/commands/ptk-cluster-load-cm-vip.md | 4 +- .../commands/ptk-cluster-modify-comment.md | 4 +- .../v1.1/commands/ptk-cluster-promote.md | 4 +- .../v1.1/commands/ptk-cluster-refresh.md | 8 +- .../v1.1/commands/ptk-cluster-rename.md | 103 ++++++++++++ .../v1.1/commands/ptk-cluster-restart.md | 10 +- .../v1.1/commands/ptk-cluster-scale-in.md | 10 +- .../v1.1/commands/ptk-cluster-scale-out.md | 6 +- .../v1.1/commands/ptk-cluster-set-guc.md | 4 +- .../v1.1/commands/ptk-cluster-set-hba.md | 4 +- .../v1.1/commands/ptk-cluster-shell.md | 4 +- .../v1.1/commands/ptk-cluster-show-config.md | 4 +- .../v1.1/commands/ptk-cluster-show-guc.md | 4 +- .../v1.1/commands/ptk-cluster-show-hba.md | 8 +- .../v1.1/commands/ptk-cluster-start.md | 10 +- .../v1.1/commands/ptk-cluster-status.md | 10 +- .../v1.1/commands/ptk-cluster-stop.md | 10 +- .../v1.1/commands/ptk-cluster-switchover.md | 4 +- .../v1.1/commands/ptk-cluster-takeover.md | 158 ++++++++++++++++++ .../v1.1/commands/ptk-cluster-throwout.md | 118 +++++++++++++ .../v1.1/commands/ptk-cluster-uninstall-cm.md | 4 +- .../ptk-cluster-uninstall-kerberos-server.md | 4 +- .../commands/ptk-cluster-uninstall-mogha.md | 4 +- .../commands/ptk-cluster-upgrade-commit.md | 4 +- .../commands/ptk-cluster-upgrade-rollback.md | 4 +- .../v1.1/commands/ptk-cluster-upgrade.md | 19 +-- .../zh/docs-ptk/v1.1/commands/ptk-cluster.md | 77 +++++---- .../zh/docs-ptk/v1.1/commands/ptk-collect.md | 2 +- .../v1.1/commands/ptk-completion-bash.md | 2 +- .../v1.1/commands/ptk-completion-fish.md | 2 +- .../commands/ptk-completion-powershell.md | 2 +- .../v1.1/commands/ptk-completion-zsh.md | 2 +- .../docs-ptk/v1.1/commands/ptk-completion.md | 2 +- product/zh/docs-ptk/v1.1/commands/ptk-demo.md | 2 +- .../zh/docs-ptk/v1.1/commands/ptk-download.md | 9 +- .../zh/docs-ptk/v1.1/commands/ptk-encrypt.md | 2 +- product/zh/docs-ptk/v1.1/commands/ptk-env.md | 2 +- product/zh/docs-ptk/v1.1/commands/ptk-exec.md | 2 +- .../docs-ptk/v1.1/commands/ptk-gen-om-xml.md | 6 +- .../zh/docs-ptk/v1.1/commands/ptk-gen-ptkc.md | 2 +- .../v1.1/commands/ptk-gen-static-config.md | 2 +- .../v1.1/commands/ptk-init-cluster.md | 94 +++++++++++ .../zh/docs-ptk/v1.1/commands/ptk-install.md | 15 +- product/zh/docs-ptk/v1.1/commands/ptk-ls.md | 2 +- .../zh/docs-ptk/v1.1/commands/ptk-manage.md | 4 +- .../docs-ptk/v1.1/commands/ptk-meta-dump.md | 8 +- .../docs-ptk/v1.1/commands/ptk-meta-home.md | 4 +- .../docs-ptk/v1.1/commands/ptk-meta-merge.md | 4 +- .../docs-ptk/v1.1/commands/ptk-meta-prune.md | 4 +- product/zh/docs-ptk/v1.1/commands/ptk-meta.md | 10 +- .../zh/docs-ptk/v1.1/commands/ptk-rec-guc.md | 6 +- .../zh/docs-ptk/v1.1/commands/ptk-register.md | 2 +- .../v1.1/commands/ptk-self-upgrade.md | 12 +- product/zh/docs-ptk/v1.1/commands/ptk-self.md | 4 +- .../v1.1/commands/ptk-template-create.md | 6 +- .../v1.1/commands/ptk-template-mogha.md | 4 +- .../v1.1/commands/ptk-template-scale-out.md | 4 +- .../zh/docs-ptk/v1.1/commands/ptk-template.md | 20 +-- .../docs-ptk/v1.1/commands/ptk-uninstall.md | 6 +- .../zh/docs-ptk/v1.1/commands/ptk-version.md | 2 +- product/zh/docs-ptk/v1.1/commands/ptk.md | 51 +++--- product/zh/docs-ptk/v1.1/config.md | 113 +++++++++++-- product/zh/docs-ptk/v1.1/release-15x.md | 38 +++++ product/zh/docs-ptk/v1.1/release.md | 4 +- product/zh/docs-ptk/v1.1/toc.md | 5 + 87 files changed, 902 insertions(+), 285 deletions(-) create mode 100644 product/zh/docs-ptk/v1.1/commands/ptk-cluster-rename.md create mode 100644 product/zh/docs-ptk/v1.1/commands/ptk-cluster-takeover.md create mode 100644 product/zh/docs-ptk/v1.1/commands/ptk-cluster-throwout.md create mode 100644 product/zh/docs-ptk/v1.1/commands/ptk-init-cluster.md create mode 100644 product/zh/docs-ptk/v1.1/release-15x.md diff --git a/product/en/docs-mogdb/v3.0/_index.md b/product/en/docs-mogdb/v3.0/_index.md index 85e29b1b..659e40bc 100644 --- a/product/en/docs-mogdb/v3.0/_index.md +++ b/product/en/docs-mogdb/v3.0/_index.md @@ -73,7 +73,7 @@ date: 2022-08-07 -[PTK - Provisioning Toolkit](../../docs-ptk/v1.1/overview.md) +[PTK - Provisioning Toolkit](https://docs.mogdb.io/en/ptk/latest/overview) [MTK - Database Migration Toolkit](../../docs-mtk/v2.0/overview.md) diff --git a/product/en/docs-ptk/v1.1/toc.md b/product/en/docs-ptk/v1.1/toc.md index 64cfd42b..4e77b088 100644 --- a/product/en/docs-ptk/v1.1/toc.md +++ b/product/en/docs-ptk/v1.1/toc.md @@ -33,6 +33,7 @@ + [ptk completion zsh](./commands/ptk-completion-zsh.md) + [ptk completion bash](./commands/ptk-completion-bash.md) + [ptk register](./commands/ptk-register.md) + + [ptk init-cluster](./commands/ptk-init-cluster.md) + [ptk collect](./commands/ptk-collect.md) + [ptk rec-guc](./commands/ptk-rec-guc.md) + [ptk cache](./commands/ptk-cache.md) @@ -51,6 +52,9 @@ + [ptk env](./commands/ptk-env.md) + [ptk gen-static-config](./commands/ptk-gen-static-config.md) + [ptk cluster](./commands/ptk-cluster.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) + [ptk cluster uninstall-cm](./commands/ptk-cluster-uninstall-cm.md) + [ptk cluster install-cm](./commands/ptk-cluster-install-cm.md) + [ptk cluster gen-cert-files](./commands/ptk-cluster-gen-cert-files.md) @@ -106,6 +110,7 @@ + [Troubleshooting](./debug.md) + [FAQ](./faq.md) + [Release Note](./release.md) + + [v1.5](./release-15x.md) + [v1.4](./release-14x.md) + [v1.3](./release-13x.md) + [v1.2](./release-12x.md) diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cache.md b/product/zh/docs-ptk/v1.1/commands/ptk-cache.md index 200c0bd6..27aaedeb 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cache.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cache @@ -18,10 +18,10 @@ ptk cache [flags] ## 示例 ```bash -# Print cache file list +# 打印缓存文件列表 ptk cache -# Clear all cache files +# 清楚所有缓存文件 ptk cache --clear ``` diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-candidate-cpu.md b/product/zh/docs-ptk/v1.1/commands/ptk-candidate-cpu.md index 08ec5dfd..80333f7e 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-candidate-cpu.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk candidate cpu @@ -83,4 +83,4 @@ v0.4 ## 另请参阅 -* [ptk candidate](./ptk-candidate.md) - Print software version list which PTK supported +* [ptk candidate](./ptk-candidate.md) - 打印 PTK 支持的软件版本列表 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-candidate-db.md b/product/zh/docs-ptk/v1.1/commands/ptk-candidate-db.md index ac4f66f4..b32de00f 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-candidate-db.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk candidate db @@ -83,4 +83,4 @@ v0.2 ## 另请参阅 -* [ptk candidate](./ptk-candidate.md) - Print software version list which PTK supported +* [ptk candidate](./ptk-candidate.md) - 打印 PTK 支持的软件版本列表 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-candidate-os.md b/product/zh/docs-ptk/v1.1/commands/ptk-candidate-os.md index 81f66661..0290e4a1 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-candidate-os.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk candidate os @@ -97,4 +97,4 @@ v0.2 ## 另请参阅 -* [ptk candidate](./ptk-candidate.md) - Print software version list which PTK supported +* [ptk candidate](./ptk-candidate.md) - 打印 PTK 支持的软件版本列表 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-candidate-plugin.md b/product/zh/docs-ptk/v1.1/commands/ptk-candidate-plugin.md index d12c2bb8..9ba22f80 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-candidate-plugin.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk candidate plugin @@ -25,7 +25,8 @@ ptk candidate plugin [-t] ### --db-version string -* 说明: 查询固定版本的插件 +* 说明: Query plugins of a fixed version +This flag only support MogDB * 数据类型: string * 默认值: "" @@ -97,4 +98,4 @@ v1.0.0 ## 另请参阅 -* [ptk candidate](./ptk-candidate.md) - Print software version list which PTK supported +* [ptk candidate](./ptk-candidate.md) - 打印 PTK 支持的软件版本列表 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-candidate.md b/product/zh/docs-ptk/v1.1/commands/ptk-candidate.md index a1b922bc..96c5be01 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-candidate.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk candidate @@ -78,7 +78,7 @@ v0.2 ## 另请参阅 * [ptk](./ptk.md) - Provisioning Toolkit for MogDB -* [ptk candidate cpu](./ptk-candidate-cpu.md) - List supported CPU models name -* [ptk candidate db](./ptk-candidate-db.md) - List supported db server versions -* [ptk candidate os](./ptk-candidate-os.md) - List supported OS versions -* [ptk candidate plugin](./ptk-candidate-plugin.md) - List plugins supported by MogDB +* [ptk candidate cpu](./ptk-candidate-cpu.md) - 列出支持的 CPU 列表 +* [ptk candidate db](./ptk-candidate-db.md) - 列出支持的数据库版本 +* [ptk candidate os](./ptk-candidate-os.md) - 列出支持安装 MogDB 的操作系统 +* [ptk candidate plugin](./ptk-candidate-plugin.md) - 列出 MogDB 支持的插件 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-checkos.md b/product/zh/docs-ptk/v1.1/commands/ptk-checkos.md index 59db8c90..bd9eb501 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-checkos.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk checkos @@ -44,16 +44,16 @@ ptk checkos [flags] ## 示例 ```bash -# Check local host +# 检查当前主机 ptk checkos -# Check fixed items in detail mode +# 检查特定的项目，并展示详细信息 ptk checkos -i A1,A2,A3 --detail -# Check cluster with config.yaml, and just show abnormal detail +# 通过指定 config.yaml 来检查集群的机器，并且仅显示 abormal 的详细信息 ptk checkos -f config.yaml --only-abnormal-detail -# Check cluster with config.yaml and generate warning-level fix commands +# 通过指定 config.yaml 来检查集群的机器，同时在生成修复命令时包含 warning 级别的修复命令 ptk checkos -f config.yaml --gen-warning-fix ``` diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-add-kerberos-auth.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-add-kerberos-auth.md index 5e08a14a..6ab81247 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-add-kerberos-auth.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster add-kerberos-auth @@ -115,4 +115,4 @@ v1.0.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-build.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-build.md index 15605c47..664e70e6 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-build.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster build @@ -18,14 +18,14 @@ ptk cluster build [flags] ## 示例 ```bash -# Rebuild db with ip +# 通过 IP 重建指定实例 ptk cluster -n build -H -# Rebuild db with instance id +# 通过 ID 重建指定实例 ptk cluster -n build -i -# Rebuild db from sepcified upstream instance ip -# The upstream instance can be any instance in the cluster +# 指定从集群内哪个实例来重建目标实例的数据 +# 数据源实例可以是集群中的任何实例 ptk cluster -n build -H --build-from ``` @@ -117,4 +117,4 @@ v0.6 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-del-kerberos-auth.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-del-kerberos-auth.md index 86dff7a9..fab66d30 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-del-kerberos-auth.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster del-kerberos-auth @@ -103,4 +103,4 @@ v1.0.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-demote.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-demote.md index 78383d9f..283f4724 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-demote.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster demote @@ -21,9 +21,8 @@ ptk cluster demote [flags] ptk cluster -n demote -H ptk cluster -n demote -i -# If the specified instance is a standby database, -# the '--upstream' parameter must also be used to specify the upstream standby's IP -# when it is downgraded to cascade_standby +# 如果指定的实例原本是个备库，其降级后会成为级联备 +# 那么还必须通过 '--upstream' 参数指定上游备库的 IP ptk cluster -n demote --upstream ``` @@ -115,4 +114,4 @@ v0.7 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-failover.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-failover.md index 04666845..aa84079a 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-failover.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster failover @@ -104,4 +104,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-gen-cert-files.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-gen-cert-files.md index f9aae4e3..973866ae 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-gen-cert-files.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster gen-cert-files @@ -89,4 +89,4 @@ v1.3.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-inspect.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-inspect.md index e8e07686..60a9e548 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-inspect.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster inspect @@ -89,4 +89,4 @@ v0.8 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-cm.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-cm.md index c9e35997..b9f56103 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-cm.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster install-cm @@ -153,4 +153,4 @@ v1.4.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-kerberos-server.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-kerberos-server.md index 614d404e..5ba8c196 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-kerberos-server.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster install-kerberos-server @@ -116,4 +116,4 @@ v1.0.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-mogha.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-mogha.md index 9634b76c..24511a0a 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-mogha.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster install-mogha @@ -151,4 +151,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-plugin.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-plugin.md index 2fbe37ce..a07c9731 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-install-plugin.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster install-plugin @@ -18,13 +18,13 @@ ptk cluster install-plugin [flags] ## 示例 ```bash -# By default, all plugins of the same version as the cluster will be downloaded from the network +# 默认情况下，将从网络下载与集群相同版本的所有插件 ptk cluster -n install-plugin [--override] -# If you want to install a specific plugin, you can specify plugin name with '-P' +# 如果你想安装一个特定的插件，你可以通过 '-P' 指定插件名。 ptk cluster -p install-plugin -P postgis -P wal2json -# If your host can not access internet, you can install from local plugin package +# 如果你的主机不能访问互联网，您可以从本地的插件包 ptk cluster -p install-plugin -p ``` @@ -128,4 +128,4 @@ v0.3 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-is-in-upgrade.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-is-in-upgrade.md index 1e9acf0f..2930a284 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-is-in-upgrade.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster is-in-upgrade @@ -79,4 +79,4 @@ ptk cluster is-in-upgrade [flags] ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-list-plugins.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-list-plugins.md index 486cf1f9..69fb4b7e 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-list-plugins.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster list-plugins @@ -97,4 +97,4 @@ v1.0.1 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-load-cm-vip.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-load-cm-vip.md index 1bf6515d..2f30460e 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-load-cm-vip.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster load-cm-vip @@ -103,4 +103,4 @@ v1.2.1 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-modify-comment.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-modify-comment.md index 1aabb57f..f6a81e53 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-modify-comment.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster modify-comment @@ -97,4 +97,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-promote.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-promote.md index 2b2b594e..584deefa 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-promote.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster promote @@ -105,4 +105,4 @@ v0.7 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-refresh.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-refresh.md index 94acd42a..ecaaec56 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-refresh.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster refresh @@ -23,10 +23,10 @@ ptk cluster refresh [flags] ## 示例 ```bash -# just refresh cluster_static_config +# 仅刷新 cluster_static_config 文件 ptk cluster -n refresh -# replace old ip with new ip +# 替换IP ptk cluster -n refresh --replace-ip oldIP=newIP ``` @@ -106,4 +106,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-rename.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-rename.md new file mode 100644 index 00000000..3f4e7d1c --- /dev/null +++ b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-rename.md @@ -0,0 +1,103 @@ +--- +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 +--- + +# ptk cluster rename + +Rename cluster + +## 语法 + +```bash +ptk cluster rename [flags] +``` + +## 示例 + +```bash +ptk cluster -n rename [-N|--new ] + +# You can rename cluster +ptk cluster -n rename -N +``` + +## 选项 + +### -N, --cluster-name string + +* 说明: 集群名称 +* 数据类型: 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.5.0 + +## 另请参阅 + +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-restart.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-restart.md index 05f362af..dfa56ec2 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-restart.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster restart @@ -18,14 +18,14 @@ ptk cluster restart [flags] ## 示例 ```bash -# Restart all instances of specified cluster +# 重启指定集群的所有实例 ptk cluster -n restart -# Restart fixed db instance of specified cluster +# 重启集群内特定的实例 ptk cluster -n restart -H ptk cluster -n restart -i -# [!DANGER] Restart all clusters +# [!危险] 重启 PTK 管理的所有集群 ptk cluster restart --all ``` @@ -136,4 +136,4 @@ v0.1 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-scale-in.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-scale-in.md index 4b0b2c39..a5022b73 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-scale-in.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster scale-in @@ -20,13 +20,13 @@ ptk cluster scale-in [flags] ```bash ptk cluster -n scale-in -H -H [-y] -# Scale in db instance but do not delete os user +# 缩容指定的数据库实例，但不删除操作系统用户 ptk cluster -n scale-in -H --skip-clear-user -# Scale in db instance but do not delte db data +# 缩容指定的数据库实例，但不删除数据库的数据 ptk cluster -n scale-in -H --skip-clear-db -# if target db instance is not accessible, you can kick out of cluster forcely +# 如果目标数据库实例不可访问，可以强制踢出集群 ptk cluster -n scale-in -H --force ``` @@ -136,4 +136,4 @@ v0.3 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-scale-out.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-scale-out.md index 4ad2ce2c..633cdac2 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-scale-out.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster scale-out @@ -20,7 +20,7 @@ ptk cluster scale-out [flags] ```bash ptk cluster -n scale-out -c scale-out.yaml -# You can also specify the new db instance rebuild data from a existing instance with '--build-from' +# 你也可以使用 '--build-from' 来指定新的数据库实例从哪个现有实例中重建数据。 ptk cluster -n scale-out -c scale-out.yaml --build-from ``` @@ -161,4 +161,4 @@ v0.3 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-set-guc.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-set-guc.md index 684abf32..803bd63b 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-set-guc.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster set-guc @@ -110,4 +110,4 @@ v1.2.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-set-hba.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-set-hba.md index 361cf3b4..fbaf6950 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-set-hba.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster set-hba @@ -110,4 +110,4 @@ v1.2.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-shell.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-shell.md index 3e2d554d..6859c1c2 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-shell.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster shell @@ -115,4 +115,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-config.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-config.md index 72551470..04459942 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-config.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster show-config @@ -89,4 +89,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-guc.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-guc.md index 0d784164..758046ad 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-guc.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster show-guc @@ -97,4 +97,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-hba.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-hba.md index a62c4773..4168d37c 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-show-hba.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster show-hba @@ -18,10 +18,10 @@ ptk cluster show-hba [flags] ## 示例 ```bash -# If not specified any instance, it will print hba content of primary database +# 如果没有指定任何实例的话，默认将打印主库的 hba 内容 ptk cluster -n show-hba -# You can also specify a fixed instance +# 你也可以查看一个固定的实例的 hba 内容 ptk cluster -n show-hba -H ptk cluster -n show-hba -i ``` @@ -109,4 +109,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-start.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-start.md index 2b803e48..2d85dcd1 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-start.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster start @@ -18,14 +18,14 @@ ptk cluster start [flags] ## 示例 ```bash -# Start all instances of specified cluster +# 启动指定集群的所有实例 ptk cluster -n start -# Start fixed db instance of specified cluster +# 启动指定集群的特定实例 ptk cluster -n start -H ptk cluster -n start -i -# [!DANGER] Start all clusters +# [!危险] 启动 PTK 管理的所有集群 ptk cluster start --all ``` @@ -136,4 +136,4 @@ v0.1 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-status.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-status.md index 373adda3..c308153f 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-status.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster status @@ -18,14 +18,14 @@ ptk cluster status [flags] ## 示例 ```bash -# Print specified cluster's status +# 打印指定集群的状态 ptk cluster -n status -# Print status of fixed db instance of specified cluster +# 打印指定集群中某个实例的状态 ptk cluster -n status -H ptk cluster -n status -i -# Print status of all clusters +# 打印所有集群的状态 ptk cluster status --all ``` @@ -129,4 +129,4 @@ v0.1 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-stop.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-stop.md index 91bd4faf..7a0df405 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-stop.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster stop @@ -18,14 +18,14 @@ ptk cluster stop [flags] ## 示例 ```bash -# Stop all instances of specified cluster +# 停止指定集群的所有实例 ptk cluster -n stop -# Stop fixed db instance of specified cluster +# 停止指定集群的特定实例 ptk cluster -n stop -H ptk cluster -n stop -i -# [!DANGER] Stop all clusters +# [!危险] 停止 PTK 管理的所有集群 ptk cluster stop --all ``` @@ -129,4 +129,4 @@ v0.1 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-switchover.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-switchover.md index 8e1f237f..2e983f35 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-switchover.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster switchover @@ -110,4 +110,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-takeover.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-takeover.md new file mode 100644 index 00000000..d5ffd7b2 --- /dev/null +++ b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-takeover.md @@ -0,0 +1,158 @@ +--- +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 +--- + +# ptk cluster takeover + +Takeover a new server to ptk metadata + +## 语法 + +```bash +ptk cluster takeover [flags] +``` + +## 示例 + +```bash +ptk cluster -n takeover [-H|--host ][-U|--user ] +[-i|--identity ] [--appdir ] [--datadir ] [--logdir ] [--tmpdir ] [--tooldir ] + +# For example: +ptk cluster -n takeover -H -U +``` + +## 选项 + +### --appdir string + +* 说明: App dir of db server +* 数据类型: string +* 默认值: "" + +### -y, --assumeyes + +* 说明: 自动对所有提问回复 Yes +* 数据类型: bool +* 默认值: false + +### --datadir string + +* 说明: Data dir of db server +* 数据类型: string +* 默认值: "" + +### --db-port int + +* 说明: DB port of db server +* 数据类型: int +* 默认值: 0 + +### -H, --host string + +* 说明: Specify the host of the takeover node +* 数据类型: string +* 默认值: "" + +### -i, --identity string + +* 说明: SSH private key path +* 数据类型: string +* 默认值: "" + +### --logdir string + +* 说明: Log dir of db server +* 数据类型: string +* 默认值: "" + +### --tmpdir string + +* 说明: Tmp dir of db server +* 数据类型: string +* 默认值: "" + +### --tooldir string + +* 说明: Tool dir of db server +* 数据类型: string +* 默认值: "" + +### -U, --username string + +* 说明: Specify the user to takeover the node +* 数据类型: 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.5.0 + +## 另请参阅 + +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-throwout.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-throwout.md new file mode 100644 index 00000000..7fa76ba2 --- /dev/null +++ b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-throwout.md @@ -0,0 +1,118 @@ +--- +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 +--- + +# ptk cluster throwout + +Remove a server from ptk metadata + +## 语法 + +```bash +ptk cluster throwout [flags] +``` + +## 示例 + +```bash + +# By host ip +ptk cluster -n throwout -H + +# By instance id +ptk cluster -n throwout -i + +``` + +## 选项 + +### -H, --host stringArray + +* 说明: 数据库实例 IP +* 数据类型: stringArray +* 默认值: [] + +### -i, --id ints + +* 说明: 数据库实例 ID +* 数据类型: ints +* 默认值: [] + +### -y, --yes + +* 说明: 对所有问题自动确认 +* 数据类型: bool +* 默认值: false + +## 从父命令继承的选项 + +### --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.5.0 + +## 另请参阅 + +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-cm.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-cm.md index a7ed7228..0b673885 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-cm.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster uninstall-cm @@ -89,4 +89,4 @@ v1.4.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-kerberos-server.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-kerberos-server.md index 9702b2ae..cc8a76fc 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-kerberos-server.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster uninstall-kerberos-server @@ -104,4 +104,4 @@ v1.0.0 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-mogha.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-mogha.md index 0c41be5c..59e98f3e 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-uninstall-mogha.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster uninstall-mogha @@ -89,4 +89,4 @@ v0.4 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade-commit.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade-commit.md index 6287efc3..84b469cf 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade-commit.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster upgrade-commit @@ -89,4 +89,4 @@ v0.7 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade-rollback.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade-rollback.md index b95d66db..34745337 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade-rollback.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster upgrade-rollback @@ -110,4 +110,4 @@ v0.7 ## 另请参阅 -* [ptk cluster](./ptk-cluster.md) - Manage clusters +* [ptk cluster](./ptk-cluster.md) - 管理集群 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade.md b/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade.md index d4ddccd4..6b12354d 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-cluster-upgrade.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk cluster upgrade @@ -18,17 +18,16 @@ ptk cluster upgrade [flags] ## 示例 ```bash -# Use the local installation package to upgrade +# 使用本地安装包进行升级 ptk cluster -n upgrade -p -# Specifies the db version to upgrade (require network) -# When the ptk version is 1.2.0 or newer, it supports the direct upgrade of the database which contains plugins, -# and ptk will download the plugin installation package of the new version from the network +# 指定目标数据库版本升级(需要网络) +# 当 ptk 版本为 1.2.0 或更高版本时，它支持直接升级包含插件的数据库， +# ptk 会从网络上下载新版本对应的插件安装包 ptk cluster -n upgrade -t 5.0.6 -# If current database contains plugins and no network available, -# you can download plugin installation packages to a fixed directory, -# and specified with '--plugin-dir' +# 如果当前数据库包含插件并且无法访问互联网, +# 你可以下载插件安装包到一个固定的目录，然后通过 '--plugin-dir' 指定存放目录 ptk cluster -n upgrade -p --plugin-dir ``` @@ -56,7 +55,7 @@ ptk cluster -n upgrade -p --plugin-dir [-o output.xml] -# Generate xml from existing cluster +# 通过已经存在的集群生成 xml ptk gen-om-xml -n [-o output.xml] ``` diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-gen-ptkc.md b/product/zh/docs-ptk/v1.1/commands/ptk-gen-ptkc.md index 8dac6ef5..f191dd1e 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-gen-ptkc.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk gen-ptkc diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-gen-static-config.md b/product/zh/docs-ptk/v1.1/commands/ptk-gen-static-config.md index 234fe14b..0becd632 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-gen-static-config.md +++ b/product/zh/docs-ptk/v1.1/commands/ptk-gen-static-config.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-gen-static-config.md summary: dist/docs/commands/ptk-gen-static-config.md author: ptk -date: 2024-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk gen-static-config diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-init-cluster.md b/product/zh/docs-ptk/v1.1/commands/ptk-init-cluster.md new file mode 100644 index 00000000..2eb0d8e6 --- /dev/null +++ b/product/zh/docs-ptk/v1.1/commands/ptk-init-cluster.md @@ -0,0 +1,94 @@ +--- +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 +--- + +# ptk init-cluster + +Generate a new empty cluster + +## 语法 + +```bash +ptk init-cluster [flags] +``` + +## 示例 + +```bash +ptk init-cluster [--name|-n CLUSTER_NAME] +``` + +## 选项 + +### -n, --name string + +* 说明: 集群名称 +* 数据类型: 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" + +### --silence + +* 说明: 不打印日志到标准输出 +* 数据类型: bool +* 默认值: false + +### --skip-fix-ssh + +* 说明: 无需通过交互修复 ssh 连接 +* 数据类型: bool +* 默认值: false + +## 开始支持的版本 + +v1.5.0 + +## 另请参阅 + +* [ptk](./ptk.md) - Provisioning Toolkit for MogDB diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-install.md b/product/zh/docs-ptk/v1.1/commands/ptk-install.md index 74d70dae..bfd49cf1 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-install.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk install @@ -66,10 +66,11 @@ ptk install -f -p -y --skip-check-os --comment ' ### --db-version string -* 说明: 指定数据库安装包的版本(仅限在线安装) -可通过 'ptk candidate db' 查看支持的 MogDB Server 版本列表 +* 说明: 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.6" +* 默认值: "5.0.7" ### --default-guc @@ -173,6 +174,12 @@ ptk install -f -p -y --skip-check-os --comment ' * 数据类型: bool * 默认值: false +### --skip-load-vip + +* 说明: Skip load vip after deploying CM +* 数据类型: bool +* 默认值: false + ### --skip-rollback * 说明: 安装失败时，不进行回滚操作 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-ls.md b/product/zh/docs-ptk/v1.1/commands/ptk-ls.md index ca10babe..315775df 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-ls.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk ls diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-manage.md b/product/zh/docs-ptk/v1.1/commands/ptk-manage.md index 51fa4a41..dc5ea6e6 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-manage.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk manage -纳管一个已存在的集群(需 $GAUSSHOME/bin/cluster_static_config 文件存在) +Manage an exist cluster ## 语法 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-meta-dump.md b/product/zh/docs-ptk/v1.1/commands/ptk-meta-dump.md index 63a02e36..0f577060 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-meta-dump.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk meta dump @@ -18,10 +18,10 @@ ptk meta dump [flags] ## 示例 ```bash -# Dump one cluster metadata +# 转储一个集群的元数据 ptk meta dump -n [-o OUTPUT_DIR] -# Dump all cluster metadata +# 转储所有集群的元数据 ptk meta dump --all [-o OUTPUT_DIR] ``` @@ -107,4 +107,4 @@ v0.8 ## 另请参阅 -* [ptk meta](./ptk-meta.md) - Manage ptk metadata +* [ptk meta](./ptk-meta.md) - 管理 PTK 元数据 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-meta-home.md b/product/zh/docs-ptk/v1.1/commands/ptk-meta-home.md index 56ef7e16..365ebd4f 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-meta-home.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk meta home @@ -83,4 +83,4 @@ v0.4 ## 另请参阅 -* [ptk meta](./ptk-meta.md) - Manage ptk metadata +* [ptk meta](./ptk-meta.md) - 管理 PTK 元数据 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-meta-merge.md b/product/zh/docs-ptk/v1.1/commands/ptk-meta-merge.md index 8a7c6f3e..4cf79564 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-meta-merge.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk meta merge @@ -91,4 +91,4 @@ v0.8 ## 另请参阅 -* [ptk meta](./ptk-meta.md) - Manage ptk metadata +* [ptk meta](./ptk-meta.md) - 管理 PTK 元数据 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-meta-prune.md b/product/zh/docs-ptk/v1.1/commands/ptk-meta-prune.md index 93164444..92e3a0cd 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-meta-prune.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk meta prune @@ -103,4 +103,4 @@ v0.6 ## 另请参阅 -* [ptk meta](./ptk-meta.md) - Manage ptk metadata +* [ptk meta](./ptk-meta.md) - 管理 PTK 元数据 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-meta.md b/product/zh/docs-ptk/v1.1/commands/ptk-meta.md index 7f7b7b31..c5b8d9e0 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-meta.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk meta @@ -78,7 +78,7 @@ v0.4 ## 另请参阅 * [ptk](./ptk.md) - Provisioning Toolkit for MogDB -* [ptk meta dump](./ptk-meta-dump.md) - Dump cluster metadata -* [ptk meta home](./ptk-meta-home.md) - Print home dir of metadata -* [ptk meta merge](./ptk-meta-merge.md) - Merge cluster metadata -* [ptk meta prune](./ptk-meta-prune.md) - Remove outdated cluster metadata +* [ptk meta dump](./ptk-meta-dump.md) - 导出集群元数据 +* [ptk meta home](./ptk-meta-home.md) - 打印元数据的根目录 +* [ptk meta merge](./ptk-meta-merge.md) - 合并集群元数据 +* [ptk meta prune](./ptk-meta-prune.md) - 清理过期的集群元数据 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-rec-guc.md b/product/zh/docs-ptk/v1.1/commands/ptk-rec-guc.md index 0df39e4a..d282e7ab 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-rec-guc.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk rec-guc @@ -18,11 +18,11 @@ ptk rec-guc version1 [version2] [flags] ## 示例 ```bash -# Print fixed db version's optimising guc list +# 打印指定数据库版本的优化参数列表 # such as 5.0.5 ptk rec-guc 5.0.5 -# Compare differeces between two versions +# 比较两个版本之间的差异 ptk rec-guc 3.0.5 5.0.5 ``` diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-register.md b/product/zh/docs-ptk/v1.1/commands/ptk-register.md index 4262ca2a..a03beaee 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-register.md +++ b/product/zh/docs-ptk/v1.1/commands/ptk-register.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk-register.md summary: dist/docs/commands/ptk-register.md author: ptk -date: 2024-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk register diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-self-upgrade.md b/product/zh/docs-ptk/v1.1/commands/ptk-self-upgrade.md index 2534ca14..171360f5 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-self-upgrade.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk self upgrade @@ -18,14 +18,14 @@ ptk self upgrade [flags] ## 示例 ```bash -# upgrade online (require network) +# 在线自升级(需要网络) ptk self upgrade -# upgrade to fixed version (require network), -# such as target version is 1.2.0 +# 升级到固定版本(需要网络)， +# 比如目标版本是1.2.0 ptk self upgrade -V 1.2.0 -# upgrade with local ptk installation package +# 使用本地 ptk 安装包自升级 ptk self upgrade -p ``` @@ -105,4 +105,4 @@ v0.2 ## 另请参阅 -* [ptk self](./ptk-self.md) - Self operations about ptk +* [ptk self](./ptk-self.md) - 关于 ptk 的自操作 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-self.md b/product/zh/docs-ptk/v1.1/commands/ptk-self.md index 11efc7e3..cb927c78 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-self.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk self @@ -68,4 +68,4 @@ date: 2024-04-09T09:59:28+08:00 ## 另请参阅 * [ptk](./ptk.md) - Provisioning Toolkit for MogDB -* [ptk self upgrade](./ptk-self-upgrade.md) - Download and install updates to ptk +* [ptk self upgrade](./ptk-self-upgrade.md) - 下载并自动安装 PTK diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-template-create.md b/product/zh/docs-ptk/v1.1/commands/ptk-template-create.md index 77490a06..1849621c 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-template-create.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk template create @@ -27,7 +27,7 @@ ptk template create [-o config.yml] * 说明: 指定输出文件名 * 数据类型: string -* 默认值: "config.2024-04-09T09_59_28.yaml" +* 默认值: "config.2024-06-04T17_04_56.yaml" ## 从父命令继承的选项 @@ -91,4 +91,4 @@ v0.2 ## 另请参阅 -* [ptk template](./ptk-template.md) - Generate template of configuration +* [ptk template](./ptk-template.md) - 生成配置模板 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-template-mogha.md b/product/zh/docs-ptk/v1.1/commands/ptk-template-mogha.md index f4b83345..b7a3d511 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-template-mogha.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk template mogha @@ -103,4 +103,4 @@ v0.4 ## 另请参阅 -* [ptk template](./ptk-template.md) - Generate template of configuration +* [ptk template](./ptk-template.md) - 生成配置模板 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-template-scale-out.md b/product/zh/docs-ptk/v1.1/commands/ptk-template-scale-out.md index 3c99007e..429ae908 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-template-scale-out.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk template scale-out @@ -91,4 +91,4 @@ v0.4 ## 另请参阅 -* [ptk template](./ptk-template.md) - Generate template of configuration +* [ptk template](./ptk-template.md) - 生成配置模板 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-template.md b/product/zh/docs-ptk/v1.1/commands/ptk-template.md index c7223fab..c2eafc5f 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-template.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk template @@ -18,13 +18,13 @@ ptk template [flags] ## 示例 ```bash -# Generate local single instance configuration +# 生成本地单实例配置模板 ptk template -l > config.yml -# Generate multi-instance configuration +# 生成多实例集群的配置模板 ptk template > config.yml -# Customize the values of some config fields +# 自定义部分配置字段的值 ptk template -n -u -g -d -p > config.yml ``` @@ -34,7 +34,7 @@ ptk template -n -u -g -d -p < * 说明: 指定数据库要安装的基目录 * 数据类型: string -* 默认值: "/Users/vimiix/mogdb" +* 默认值: "/home/kylin/mogdb" ### -n, --cluster-name string @@ -46,7 +46,7 @@ ptk template -n -u -g -d -p < * 说明: 指定系统用户组 * 数据类型: string -* 默认值: "staff" +* 默认值: "kylin" ### -l, --local @@ -64,7 +64,7 @@ ptk template -n -u -g -d -p < * 说明: 指定系统用户名 * 数据类型: string -* 默认值: "vimiix" +* 默认值: "kylin" ## 从父命令继承的选项 @@ -129,6 +129,6 @@ v0.2 ## 另请参阅 * [ptk](./ptk.md) - Provisioning Toolkit for MogDB -* [ptk template create](./ptk-template-create.md) - Create config file by interaction -* [ptk template mogha](./ptk-template-mogha.md) - Generate mogha config -* [ptk template scale-out](./ptk-template-scale-out.md) - Generate scale-out config +* [ptk template create](./ptk-template-create.md) - 交互式创建配置文件 +* [ptk template mogha](./ptk-template-mogha.md) - 生成 MogHA 配置 +* [ptk template scale-out](./ptk-template-scale-out.md) - 生成扩容配置 diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-uninstall.md b/product/zh/docs-ptk/v1.1/commands/ptk-uninstall.md index 298b9004..07e26391 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-uninstall.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk uninstall @@ -18,10 +18,10 @@ ptk uninstall [flags] ## 示例 ```bash -# uninstall by cluster name +# 按集群名称卸载 ptk uninstall -n -# Avoid interactions and submit expectations on the command line +# 如果要避免交互，可在命令行提前提交交互问题的答案 ptk uninstall -n --skip-confirm --remove-data y --remove-user y ``` diff --git a/product/zh/docs-ptk/v1.1/commands/ptk-version.md b/product/zh/docs-ptk/v1.1/commands/ptk-version.md index 3c05fbd6..e3bbd42c 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk-version.md +++ b/product/zh/docs-ptk/v1.1/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-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk version diff --git a/product/zh/docs-ptk/v1.1/commands/ptk.md b/product/zh/docs-ptk/v1.1/commands/ptk.md index 63b94072..613c9442 100644 --- a/product/zh/docs-ptk/v1.1/commands/ptk.md +++ b/product/zh/docs-ptk/v1.1/commands/ptk.md @@ -2,7 +2,7 @@ title: dist/docs/commands/ptk.md summary: dist/docs/commands/ptk.md author: ptk -date: 2024-04-09T09:59:28+08:00 +date: 2024-06-04T17:04:56+08:00 --- # ptk @@ -11,8 +11,7 @@ Provisioning Toolkit for MogDB ## 说明 -ptk is a command-line management tool that can help you to -deploy or manage MogDB clusters. +PTK 是一款部署和管理MogDB数据库集群的命令行工具 ## 语法 @@ -84,28 +83,28 @@ ptk [flags] [args...] ## 另请参阅 -* [ptk cache](./ptk-cache.md) - List the cache files -* [ptk candidate](./ptk-candidate.md) - Print software version list which PTK supported -* [ptk checkos](./ptk-checkos.md) - Check cluster servers os dependencies -* [ptk cluster](./ptk-cluster.md) - Manage clusters -* [ptk collect](./ptk-collect.md) - Collect system and cluster information for analysis +* [ptk cache](./ptk-cache.md) - 列出缓存文件 +* [ptk candidate](./ptk-candidate.md) - 打印 PTK 支持的软件版本列表 +* [ptk checkos](./ptk-checkos.md) - 检查集群服务器系统依赖是否满足安装数据库需求 +* [ptk cluster](./ptk-cluster.md) - 管理集群 +* [ptk collect](./ptk-collect.md) - 收集系统和集群信息用于分析 * [ptk completion](./ptk-completion.md) - Generate the autocompletion script for the specified shell -* [ptk demo](./ptk-demo.md) - Install MogDB demo quickly -* [ptk download](./ptk-download.md) - Download MogDB package online -* [ptk encrypt](./ptk-encrypt.md) - Provides a convenient way to encrypt your text/password -* [ptk env](./ptk-env.md) - Print ptk loaded environment values -* [ptk exec](./ptk-exec.md) - Execute shell command or script -* [ptk gen-om-xml](./ptk-gen-om-xml.md) - Generate an XML file for gs_om -* [ptk gen-ptkc](./ptk-gen-ptkc.md) - Generate ptkc binary -* [ptk gen-static-config](./ptk-gen-static-config.md) - Generate and distribute a new cluster_static_config with specified YAML config -* [ptk install](./ptk-install.md) - Install a MogDB or Uqbar database cluster -* [ptk ls](./ptk-ls.md) - List MogDB clusters +* [ptk demo](./ptk-demo.md) - 快速部署本地示例 MogDB +* [ptk download](./ptk-download.md) - 在线下载 MogDB 安装包 +* [ptk encrypt](./ptk-encrypt.md) - 提供一个便捷的方式来加密您的文本或密码 +* [ptk env](./ptk-env.md) - 打印 PTK 加载的环境变量值 +* [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 install](./ptk-install.md) - 安装 MogDB 或 Uqbar 数据库集群 +* [ptk ls](./ptk-ls.md) - 列出所有 MogDB 集群列表 * [ptk manage](./ptk-manage.md) - Manage an exist cluster -(File $GAUSSHOME/bin/cluster_static_config is required) -* [ptk meta](./ptk-meta.md) - Manage ptk metadata -* [ptk rec-guc](./ptk-rec-guc.md) - Display the list of optimising guc parameters -* [ptk register](./ptk-register.md) - Register some internal types to fulfill specific requirements -* [ptk self](./ptk-self.md) - Self operations about ptk -* [ptk template](./ptk-template.md) - Generate template of configuration -* [ptk uninstall](./ptk-uninstall.md) - Uninstall a database cluster -* [ptk version](./ptk-version.md) - Print version of ptk +* [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 版本 diff --git a/product/zh/docs-ptk/v1.1/config.md b/product/zh/docs-ptk/v1.1/config.md index 0b8c0a35..aab15516 100644 --- a/product/zh/docs-ptk/v1.1/config.md +++ b/product/zh/docs-ptk/v1.1/config.md @@ -9,9 +9,9 @@ date: 2024-04-09T09:59:28+08:00 PTK 的配置文件采用 [YAML格式](./yaml-grammar.md)。 -该文件包含介绍了安装集群所需的所有配置参数。 +该文件介绍了拓扑配置文件的所有参数。 -在安装数据库集群时，需用户提供一个描述集群拓扑的配置文件，该配置文件在 PTK 的大多数子命令中都会使用到。 +在安装数据库集群时，需用户提供一个描述集群拓扑的配置文件来告诉 PTK 应该按照什么结构来部署集群。 PTK 提供了交互式创建配置文件的功能，通过运行下面的指令可以进入交互流程: @@ -26,11 +26,11 @@ ptk template create ptk template > config.yaml ``` -运行后可以生成一个 config.yaml 的文件，需用户根据自己的实际情况配置里面的参数。 +运行后可以生成一个 config.yaml 的文件，需用户根据自己的实际情况修改文件里面的字段值。 -在非交互式修改配置时，配置中的系统用户密码 (user_password)，数据库密码 (db_password)，SSH密码 (ssh_option.password) 或密钥口令 (ssh_option.passphrase) 等敏感字段， +在非交互式修改时，配置文件中的系统用户密码 (user_password)，数据库密码 (db_password)，SSH密码 (ssh_option.password) 或密钥口令 (ssh_option.passphrase) 等敏感字段， -建议使用 PTK 提供的加密命令进行加密后填写： +必须使用 PTK 提供的加密命令进行加密后填写： ```shell ptk encrypt PASSWORD @@ -53,8 +53,8 @@ global: db_password: pTk6MTIxOGMxOTk8QT1CPT4+PXlnYW1DdHpXb2hCX3c3UW0wWXVkNlZwMGRCakpxRXd1WWdwQ0xDUWVrb0U= # 数据库的初始用户密码，若配置文件中未填写，会在安装时通过交互式要求输入 # 集群内的数据库实例服务器配置信息 db_servers: - - host: 10.1.1.100 # 数据库实例服务器 IP (仅支持 IPv4) - - host: 10.1.1.101 # 数据库实例服务器 IP (仅支持 IPv4) + - host: # 数据库实例服务器 IP (仅支持 IPv4) + - host: # 数据库实例服务器 IP (仅支持 IPv4) # 集群内的CM服务部署机器列表 cm_servers: [] ``` @@ -69,6 +69,13 @@ global: group: omm # 运行数据库的操作系统用户组 db_password: pTk6MTIxOGMxOTk8QT1CPT4+PXlnYW1DdHpXb2hCX3c3UW0wWXVkNlZwMGRCakpxRXd1WWdwQ0xDUWVrb0U= # 数据库的初始用户密码，若配置文件中未填写，会在安装时通过交互式要求输入 base_dir: /opt/mogdb # 数据库安装的基础目录，一般建议指定到配置文件中 ssh 用户可访问的目录下的路径，让PTK自动创建。 + # 额外新增 HBA 条目列表 + extra_hba_conf: + - type: host # 连接类型，支持 local/host/hostssl/hostnossl + database: all # 指定这条记录所匹配的数据库名称 + user: all # 指定这条记录匹配哪些数据库用户名 + address: # 必填，指定这个记录匹配的客户端机器地址。 + method: sha256 # 指定当一个连接匹配这个记录时，要使用的认证方法。 # MogDB 高可用组件 CM 配置信息，若不使用 CM 组件，则无需填写该字段 cm_option: dir: /opt/mogdb/cm # CM 安装目录 @@ -76,7 +83,7 @@ global: db_service_vip: "" # 数据库提供服务的虚拟IP # 集群内的数据库实例服务器配置信息 db_servers: - - host: 10.1.1.100 # 数据库实例服务器 IP (仅支持 IPv4) + - host: # 数据库实例服务器 IP (仅支持 IPv4) db_port: 27000 # 数据库端口 role: primary # 数据库实例角色，若不填，PTK 会随机选择一个实例作为主库，其余自动为备库 az_name: BJ # Available Zone (可用区) 名称 @@ -88,7 +95,7 @@ db_servers: password: pTk6LIBsPVplOpmxQToCPT9+PXlnYW1DdHpXb2hCX3c3UW0wWXVkNlZwMGRCakpxRXd1WWdwQ0xDUWVrb0U= # SSH 登录用户密码 conn_timeout: 5m0s # SSH 登录连接超时时间，支持单位 m(分),s(秒) exec_timeout: 5m0s # SSH 执行单条命令时的超时时间，支持单位 m(分),s(秒) - - host: 10.1.1.101 # 数据库实例服务器 IP (仅支持 IPv4) + - host: # 数据库实例服务器 IP (仅支持 IPv4) db_port: 27000 # 数据库端口 role: standby # 数据库实例角色，若不填，PTK 会随机选择一个实例作为主库，其余自动为备库 az_name: BJ # Available Zone (可用区) 名称 @@ -100,18 +107,18 @@ db_servers: key_file: ~/.ssh/id_rsa # SSH 登录密钥文件路径 conn_timeout: 5m0s # SSH 登录连接超时时间，支持单位 m(分),s(秒) exec_timeout: 5m0s # SSH 执行单条命令时的超时时间，支持单位 m(分),s(秒) - - host: 10.1.1.102 # 数据库实例服务器 IP (仅支持 IPv4) + - host: # 数据库实例服务器 IP (仅支持 IPv4) db_port: 27000 # 数据库端口 role: cascade_standby # 数据库实例角色，若不填，PTK 会随机选择一个实例作为主库，其余自动为备库 - upstream_host: 10.1.1.101 # 当实例角色为 cascade_standby 时，该字段表示要跟随的上游备库 IP + upstream_host: # 当实例角色为 cascade_standby 时，该字段表示要跟随的上游备库 IP az_name: SH # Available Zone (可用区) 名称 az_priority: 2 # 可用区使用的优先级，数值越小优先级越高, 最小为 1 # 集群内的CM服务部署机器列表 cm_servers: - - host: 10.1.1.100 # CM Server 服务器 IP (仅支持 IPv4) + - host: # CM Server 服务器 IP (仅支持 IPv4) port: 15300 # CM Server 监听端口 role: "" - - host: 10.1.1.101 # CM Server 服务器 IP (仅支持 IPv4) + - host: # CM Server 服务器 IP (仅支持 IPv4) port: 15300 # CM Server 监听端口 role: "" ``` @@ -280,6 +287,14 @@ gs_initdb_opts: **新增于**: v0.3 +### extra_hba_conf + +**类型**: []HBAConf + +**描述**: 额外新增 HBA 条目列表 + +**新增于**: v1.5 + ### cm_option **类型**: CMOption @@ -306,6 +321,76 @@ gs_initdb_opts: --- +## HBAConf + +HBAConf HBA 条目配置 + +Appears in: + +- Global.extra_hba_conf + +**示例**: + +- hba config 示例 + +```yaml +type: host # 连接类型，支持 local/host/hostssl/hostnossl +database: all # 指定这条记录所匹配的数据库名称 +user: all # 指定这条记录匹配哪些数据库用户名 +address: # 必填，指定这个记录匹配的客户端机器地址。 +method: sha256 # 指定当一个连接匹配这个记录时，要使用的认证方法。 +``` + +### type + +**类型**: 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 + +**新增于**: v1.5.0 + +### database + +**类型**: string + +**描述**: 指定这条记录所匹配的数据库名称
默认值: all + +**新增于**: v1.5.0 + +### user + +**类型**: string + +**描述**: 指定这条记录匹配哪些数据库用户名
默认值: all + +**新增于**: v1.5.0 + +### address + +**类型**: string + +**描述**: 必填，指定这个记录匹配的客户端机器地址。
如果只设置一个IPv4或IPv6地址，未配置 CIDR 掩码，则默认针对 IPv4 使用 32 的 CIDR 掩码，针对 IPv6 使用 128 的 CIDR 掩码 + +**新增于**: v1.5.0 + +### method + +**类型**: string + +**描述**: 指定当一个连接匹配这个记录时，要使用的认证方法。
默认值: sha256 + +**新增于**: v1.5.0 + +### option + +**类型**: string + +**描述**: 在 method 域的后面，可以是形如 name=value 的域，它们指定认证方法的选项 + +**新增于**: v1.5.0 + +--- + ## DSSOption Appears in: @@ -707,7 +792,7 @@ Appears in: **示例**: ```yaml -host: 10.1.1.100 +host: port: 22 user: root key_file: ~/.ssh/id_rsa diff --git a/product/zh/docs-ptk/v1.1/release-15x.md b/product/zh/docs-ptk/v1.1/release-15x.md new file mode 100644 index 00000000..c42f9e84 --- /dev/null +++ b/product/zh/docs-ptk/v1.1/release-15x.md @@ -0,0 +1,38 @@ +--- +title: v1.5发布记录 +summary: v1.5发布记录 +author: Yao Qian +date: 2024-06-04 +--- + +# 1.5 发布记录 + +## 1.5.0 (2024-06-06) + +**Features** + +- **takeover:** 支持对现有集群接管一个已经运行中的实际同属一个集群的节点（仅新增PTK的元数据） +- **throwout:** 支持对现有集群放弃管理一个节点（仅删除PTK的元数据） +- **rename:** 支持对现有集群重命名集群名 +- **init-cluster:** 支持创建空集群 +- **manage:** 支持纳管没有 cluster_static_config 文件的集群 +- **install:** 支持直接从内核安装包安装数据库 +- **upgrade:** 支持部署了CM的数据库集群版本升级（CM版本不升级） +- **upgrade:** 默认升级模式由 replace 改为 cover 覆盖方式 +- **config:** 配置文件 global 域新增 extra_hba_conf 字段，支持配置额外的 hba 条目 +- **status:** 支持显示 CM 组件的版本号 +- **install:** 如果安装 CM 组件，强制检查已存在用户可打开文件数目 +- **metadata:** 新增 history 文件记录执行历史命令 + +**Bug Fixes** + +- **status:** 查询vip状态时，若cm_resource.json不存在，则不显示 +- **upgrade:** 修复带插件升级时，在非 postgres 库安装插件未识别的问题 +- **checkos:** 修复资源池化场景磁盘检查命令 +- **checkos:** 修复已存在用户 ulimit 参数未检查的问题 +- **checkos:** 修复内存检查的修复命令导致脚本执行报错的问题 +- **checkos:** 修复存在重复 IP 字符串的多网卡场景获取网卡错误问题 +- **demote:** 修复降级备节点时未正确修改 upstream 的问题 +- **prune:** 修复无法 Ctrl C 中断的问题 +- **status,switchover:** 修复级联备未刷新元数据的 upstream 问题 +- 修复和优化其他若干内部问题 diff --git a/product/zh/docs-ptk/v1.1/release.md b/product/zh/docs-ptk/v1.1/release.md index 331bb540..4339809c 100644 --- a/product/zh/docs-ptk/v1.1/release.md +++ b/product/zh/docs-ptk/v1.1/release.md @@ -11,6 +11,7 @@ date: 2023-11-14 ## PTK 发布记录 +- [v1.5 版本发布记录](./release-15x.md) - [v1.4 版本发布记录](./release-14x.md) - [v1.3 版本发布记录](./release-13x.md) - [v1.2 版本发布记录](./release-12x.md) @@ -22,10 +23,11 @@ date: 2023-11-14 | MogDB版本 | PTK最低版本 | |-----------|---------| +| 5.0.7 | 1.4.7+ | | 5.0.6 | 1.3.3+ | | 5.0.5 | 1.2.0+ | | 5.0.4 | 1.1.3+ | -| 5.0.3 | 1.0.10+ | +| 5.0.3 | 1.0.10+ | | 5.0.2 | 1.0.9+ | | 5.0.1 | 1.0.4+ | | 5.0.0 | 1.0.0+ | diff --git a/product/zh/docs-ptk/v1.1/toc.md b/product/zh/docs-ptk/v1.1/toc.md index 3ea9064a..8ed6653b 100644 --- a/product/zh/docs-ptk/v1.1/toc.md +++ b/product/zh/docs-ptk/v1.1/toc.md @@ -33,6 +33,7 @@ + [ptk completion zsh](./commands/ptk-completion-zsh.md) + [ptk completion bash](./commands/ptk-completion-bash.md) + [ptk register](./commands/ptk-register.md) + + [ptk init-cluster](./commands/ptk-init-cluster.md) + [ptk collect](./commands/ptk-collect.md) + [ptk rec-guc](./commands/ptk-rec-guc.md) + [ptk cache](./commands/ptk-cache.md) @@ -51,6 +52,9 @@ + [ptk env](./commands/ptk-env.md) + [ptk gen-static-config](./commands/ptk-gen-static-config.md) + [ptk cluster](./commands/ptk-cluster.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) + [ptk cluster uninstall-cm](./commands/ptk-cluster-uninstall-cm.md) + [ptk cluster install-cm](./commands/ptk-cluster-install-cm.md) + [ptk cluster gen-cert-files](./commands/ptk-cluster-gen-cert-files.md) @@ -106,6 +110,7 @@ + [故障排查](./debug.md) + [常见问题](./faq.md) + [发布记录](./release.md) + + [v1.5](./release-15x.md) + [v1.4](./release-14x.md) + [v1.3](./release-13x.md) + [v1.2](./release-12x.md) -- Gitee