From 402636f8c95250b63664cefdb4910f3bfe08a962 Mon Sep 17 00:00:00 2001 From: "qian.yao" Date: Tue, 24 Sep 2024 09:47:39 +0800 Subject: [PATCH] feat(ptk): add 1.7.2 release note --- .../v2.0/commands/ptk-template-create.md | 16 ++- .../en/docs-ptk/v2.0/reference/ref-config.md | 12 +- .../v2.0/reference/ref-support-mogdb.md | 1 + .../v2.0/commands/ptk-template-create.md | 14 ++- .../v2.0/guide/guide-install-cluster.md | 8 +- .../zh/docs-ptk/v2.0/reference/ref-config.md | 103 ++++++++++++------ .../v2.0/reference/ref-support-mogdb.md | 1 + .../v2.0/release-notes/release-17x.md | 8 ++ 8 files changed, 114 insertions(+), 49 deletions(-) diff --git a/product/en/docs-ptk/v2.0/commands/ptk-template-create.md b/product/en/docs-ptk/v2.0/commands/ptk-template-create.md index 5fea2257..ee03e9fb 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-template-create.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-template-create.md @@ -7,7 +7,7 @@ date: 2022-6-28 # ptk template create -`ptk template create` creates a configuration template in an interactive way. +`ptk template create` creates a configuration template in an interactive way. ## Syntax @@ -23,9 +23,15 @@ ptk template create [-o CONFIG.yaml] ## Option +### --tui + +* Description: Create a configuration file through terminal GUI +* Data type: bool +* Default value: false + ### -o, --output string -- Description: specifies the name of the output file. +- Description: specifies the name of the output file. - Data type: string - Default value: "config.2024-06-04T17_04_56.yaml" @@ -63,7 +69,7 @@ ptk template create [-o CONFIG.yaml] ### --log-format string -* Description: specifies the output format of a run log. The value can be **text** and **json**. +* Description: specifies the output format of a run log. The value can be **text** and **json**. * Data type: string * Default value: **text** @@ -81,7 +87,7 @@ ptk template create [-o CONFIG.yaml] ### --skip-fix-ssh -* Description: skips SSH connection fixing through interaction. +* Description: skips SSH connection fixing through interaction. * Data type: boolean * Default value: **false** @@ -92,4 +98,4 @@ v0.2 ## More Command -* [ptk template](./ptk-template.md) - Generates a configuration template. \ No newline at end of file +* [ptk template](./ptk-template.md) - Generates a configuration template. \ No newline at end of file diff --git a/product/en/docs-ptk/v2.0/reference/ref-config.md b/product/en/docs-ptk/v2.0/reference/ref-config.md index 4a972ab1..193ca20b 100644 --- a/product/en/docs-ptk/v2.0/reference/ref-config.md +++ b/product/en/docs-ptk/v2.0/reference/ref-config.md @@ -16,7 +16,7 @@ When installing a database cluster, a user-supplied configuration file describin PTK provides the ability to create profiles interactively, and the interactive process can be accessed by running the following command: ```shell -ptk template create +ptk template create --tui ``` You just need to follow the steps prompted by the terminal step by step to complete the configuration, and the config.yaml file will eventually be generated in the current folder. @@ -29,7 +29,7 @@ ptk template > config.yaml After running this command, the system will generate a config.yaml file, and you need to modify the values of the fields in the file according to your actual situation. -For non-interactive modification, sensitive fields such as user_password, db_password, ssh_option.password or ssh_option.passphrase must be encrypted using the encryption command provided by PTK. +For non-interactive modification, sensitive fields such as user_password, db_password, ssh_option.password or ssh_option.passphrase must be encrypted using the encryption command provided by PTK. ```shell ptk encrypt PASSWORD @@ -78,7 +78,7 @@ global: # MogDB HA component CM configuration information. If the CM component is not used, leave this field empty. cm_option: dir: /opt/mogdb/cm # CM installation directory - cm_server_port: 15300 # Listening port of the CM server + cm_server_port: 15300 # Listening port of the CM server db_service_vip: "" # Virtual IP address for the database to provide service. # Configuration information of database instance servers in a cluster db_servers: @@ -375,7 +375,7 @@ Appears in: - Global.extra_hba_conf -**Examples**: +**Examples**: - hba config @@ -545,7 +545,7 @@ Appears in: Configuration rule: {IP: vg_path, ...} -**Examples**: +**Examples**: - inst_vg_map example @@ -804,7 +804,7 @@ The field is left blank by default. The global port 26000 is reused. **Data type**: string -**Description**: +**Description**: **Range**: diff --git a/product/en/docs-ptk/v2.0/reference/ref-support-mogdb.md b/product/en/docs-ptk/v2.0/reference/ref-support-mogdb.md index d8611f12..969aae36 100644 --- a/product/en/docs-ptk/v2.0/reference/ref-support-mogdb.md +++ b/product/en/docs-ptk/v2.0/reference/ref-support-mogdb.md @@ -10,6 +10,7 @@ date: 2024-06-01 | MogDB version | PTK minimum version | | ------------- | ------------------- | +| 5.0.8 | 1.6.2+ | | 5.0.7 | 1.4.7+ | | 5.0.6 | 1.3.3+ | | 5.0.5 | 1.2.0+ | 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 7c35e3dc..a92d9e16 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-08-29T18:48:05+08:00 +date: 2024-09-24T08:50:06+08:00 --- # ptk template create @@ -18,16 +18,22 @@ ptk template create [flags] ## 示例 ```bash -ptk template create [-o config.yml] +ptk template create [-o config.yml] [--tui] ``` ## 选项 ### -o, --output string -* 说明: 指定输出文件名 +* 说明: 指定输出的文件名 * 数据类型: string -* 默认值: "config.2024-08-29T18_48_05.yaml" +* 默认值: "config..yaml" + +### --tui + +* 说明: 通过图形化界面创建配置文件 +* 数据类型: bool +* 默认值: false ## 从父命令继承的选项 diff --git a/product/zh/docs-ptk/v2.0/guide/guide-install-cluster.md b/product/zh/docs-ptk/v2.0/guide/guide-install-cluster.md index ba7c9254..439854ac 100644 --- a/product/zh/docs-ptk/v2.0/guide/guide-install-cluster.md +++ b/product/zh/docs-ptk/v2.0/guide/guide-install-cluster.md @@ -39,7 +39,13 @@ date: 2024-06-10 omm hard stack unlimited ``` -3. 在配置文件中的 `ssh_option` 配置为您创建的用户的登录信息 +3. 在配置文件中的 `ssh_option` 配置修改SSH登录的用户为 `omm` + +``` +ssh_option: + user: omm + ... +``` > 注：如果使用非超级用户进行集群管理，部分依赖超级权限的命令后续也无法使用，比如 `install-mogha` 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 2c3a9154..5007f962 100644 --- a/product/zh/docs-ptk/v2.0/reference/ref-config.md +++ b/product/zh/docs-ptk/v2.0/reference/ref-config.md @@ -12,13 +12,13 @@ PTK 的配置文件采用 [YAML格式](./yaml-grammar.md)。 在安装数据库集群时，需用户提供一个描述集群拓扑的配置文件来告诉 PTK 应该按照什么结构来部署集群。 -PTK 提供了交互式创建配置文件的功能，通过运行下面的指令可以进入交互流程: +PTK 提供了终端图形化创建配置文件的功能，通过运行下面的指令可以进入交互流程: ```shell -ptk template create +ptk template create --tui ``` -你只需要按照终端提示的步骤逐步完成配置，最终会在当前文件夹下生成 config.yaml 文件。 +你只需要按照终端提示的步骤逐步完成配置，最终会在当前文件夹下生成 config.xx.yaml 的配置文件。 另外，如果想要不使用交互式创建，直接生成一个默认配置的文件，可以运行命令: ```shell @@ -32,7 +32,8 @@ ptk template > config.yaml 必须使用 PTK 提供的加密命令进行加密后填写： ```shell -ptk encrypt PASSWORD +// 建议使用单引号包裹要加密的字符串，避免被转义 +ptk encrypt '' ``` --- @@ -54,8 +55,6 @@ global: db_servers: - host: # 数据库实例服务器 IP (仅支持 IPv4) - host: # 数据库实例服务器 IP (仅支持 IPv4) -# 集群内的CM服务部署机器列表 -cm_servers: [] ``` - 复杂配置示例 @@ -79,7 +78,6 @@ global: cm_option: dir: /opt/mogdb/cm # CM 安装目录 cm_server_port: 15300 # cm server 监听端口 - db_service_vip: "" # 数据库提供服务的虚拟IP # 集群内的数据库实例服务器配置信息 db_servers: - host: # 数据库实例服务器 IP (仅支持 IPv4) @@ -116,10 +114,8 @@ db_servers: cm_servers: - host: # CM Server 服务器 IP (仅支持 IPv4) port: 15300 # CM Server 监听端口 - role: "" - host: # CM Server 服务器 IP (仅支持 IPv4) port: 15300 # CM Server 监听端口 - role: "" ``` ### global @@ -344,7 +340,8 @@ method: sha256 # 指定当一个连接匹配这个记录时，要使用的认证 **类型**: string -**描述**: 连接类型，支持 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 +**描述**: 连接类型，支持 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 @@ -452,22 +449,6 @@ Appears in: **新增于**: v1.1.0 -### cm_voting_vg_path - -**类型**: string - -**描述**: CM 投票卷路径 - -**新增于**: v1.1.0 - -### cm_share_vg_path - -**类型**: string - -**描述**: CM 共享卷路径 - -**新增于**: v1.1.0 - ### inst_vg_map **类型**: map[string]string @@ -494,21 +475,61 @@ inst_vg_map: **新增于**: v1.1.0 -### inter_connect_type +### interconnect_type **类型**: string -**描述**: 内部 MES 通信协议类型
默认值: TCP
可选值: TCP/RDMA +**描述**: DSS 进程间通信方式
默认值: TCP
可选值: TCP/RDMA -**新增于**: v1.1.0 +**新增于**: v1.7.2 -### ss_guc_config +### interconnect_channel_num -**类型**: map[string]string +**类型**: int -**描述**: 资源池化 GUC 参数配置
可选值参考 [openGauss 文档](https://docs.opengauss.org/zh/docs/5.0.0/docs/DatabaseReference/%E8%B5%84%E6%BA%90%E6%B1%A0%E5%8C%96%E5%8F%82%E6%95%B0.html) +**描述**: DSS 进程间通信通道数量
默认值: 2
取值范围: [1, 32] -**新增于**: v1.1.0 +**新增于**: v1.7.2 + +### work_thread_count + +**类型**: int + +**描述**: 处理通信消息的线程数量
默认值: 2
取值范围: [2, 64] + +**新增于**: v1.7.2 + +### io_threads + +**类型**: int + +**描述**: DSS 进程中工作线程池的数目
默认值: 2
取值范围: [1, 8] + +**新增于**: v1.7.2 + +### work_threads + +**类型**: int + +**描述**: DSS 进程中每个线程池中的线程数
默认值: 16
取值范围: [16, 128] + +**新增于**: v1.7.2 + +### storage_mode + +**类型**: string + +**描述**: 存储类型
默认值: CLUSTER_RAID
取值范围: CLUSTER_RAID、RAID、DISK、DISK_LOCK + +**新增于**: v1.7.2 + +### max_session_nums + +**类型**: int + +**描述**: DSS 进程支持的最大会话连接数
默认值: 8192
取值范围: [16, 166320] + +**新增于**: v1.7.2 --- @@ -576,6 +597,22 @@ cm_agent_conf: **新增于**: v0.4 +### cm_voting_vg_path + +**类型**: string + +**描述**: CM 投票卷路径（资源池化场景使用） + +**新增于**: v1.7.2 + +### cm_share_vg_path + +**类型**: string + +**描述**: CM 共享卷路径（资源池化场景使用） + +**新增于**: v1.7.2 + --- ## CMServer diff --git a/product/zh/docs-ptk/v2.0/reference/ref-support-mogdb.md b/product/zh/docs-ptk/v2.0/reference/ref-support-mogdb.md index 2146258c..0da4f348 100644 --- a/product/zh/docs-ptk/v2.0/reference/ref-support-mogdb.md +++ b/product/zh/docs-ptk/v2.0/reference/ref-support-mogdb.md @@ -10,6 +10,7 @@ date: 2024-06-01 | MogDB版本 | PTK最低版本 | |-----------|---------| +| 5.0.8 | 1.6.2+ | | 5.0.7 | 1.4.7+ | | 5.0.6 | 1.3.3+ | | 5.0.5 | 1.2.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 index c0d6a18f..ffe2ad62 100644 --- a/product/zh/docs-ptk/v2.0/release-notes/release-17x.md +++ b/product/zh/docs-ptk/v2.0/release-notes/release-17x.md @@ -7,6 +7,14 @@ date: 2024-08-30 # 1.7 发布记录 +## 1.7.2 (2024-09-24) + +**Features** + +- **template:** create 子命令新增 `--tui` 参数，支持终端图形化创建配置文件 +- **install:** 部署CM集群时增加 ifconfig 权限检查和自动补齐 +- **internal:** 使用密码登录的SSH服务器支持通过密码执行sudo命令 + ## 1.7.1 (2024-09-04) **Bug Fixes** -- Gitee