Skip to content

Commit

Permalink
feat(docs): update docs about nodeset
Browse files Browse the repository at this point in the history 
Signed-off-by: setcy <[email protected]>
  • Loading branch information
@setcy @true1064
setcy authored and true1064 committed Sep 14, 2023
1 parent 5b9f169 commit 4c75f2a
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 3 deletions.
8 changes: 8 additions & 0 deletions docs-zh/source/deploy/metrics/metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ master模块上报的监控指标主要是关于集群内节点的健康状态
| cfs_master_vol_total_GB{volName="xx"} | 指定卷的容量带下 |
| cfs_master_vol_usage_ratio{volName="xx"} | 指定卷的使用率 |
| cfs_master_vol_used_GB{volName="xx"} | 指定卷已用容量 |
| cfs_master_nodeset_data_total_GB{nodeset="xx"} | 指定nodeset上的所有数据节点总空间之和 |
| cfs_master_nodeset_data_usage_ratio{nodeset="xx"} | 指定nodeset上的已使用数据空间比率 |
| cfs_master_nodeset_data_used_GB{nodeset="xx"} | 指定nodeset上的所有数据节点的可用空间之和 |
| cfs_master_nodeset_dp_replica_count{nodeset="xx"} | 指定nodeset上的数据分片数量 |
| cfs_master_nodeset_meta_total_GB{nodeset="xx"} | 指定nodeset上的所有元数据节点总空间之和 |
| cfs_master_nodeset_meta_usage_ratio{nodeset="xx"} | 指定nodeset上的已使用元数据空间比率 |
| cfs_master_nodeset_meta_used_GB{nodeset="xx"} | 指定nodeset上的所有元数据节点的可用空间之和 |
| cfs_master_nodeset_mp_replica_count{nodeset="xx"} | 指定nodeset上的元数据分片数量 |

## MetaNode

Expand Down
25 changes: 23 additions & 2 deletions docs-zh/source/tools/cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
在 `cubefs/cli` 目录下，执行命令 `./cfs-cli --help` 或 `./cfs-cli -h`
，可获取CLI的帮助文档。

CLI主要分为10类管理命令：
CLI主要分为11类管理命令：

| 命令 | 描述 |
|-----------------------|------------|
Expand All @@ -33,7 +33,8 @@ CLI主要分为10类管理命令：
| cfs-cli completion | 生成自动补全命令脚本 |
| cfs-cli volume, vol | 卷管理 |
| cfs-cli user | 用户管理 |
|cfs-cli quota | 目录配额管理 |
| cfs-cli nodeset | nodeset管理 |
| cfs-cli quota | 目录配额管理 |
### 集群管理

``` bash
Expand Down Expand Up @@ -207,6 +208,26 @@ Flags：
-y, --yes #跳过所有问题并设置回答为"yes"
```

### nodeset管理
``` bash
./cfs-cli nodeset info [NODESET ID] #获取nodeset [NODESET ID]的信息
```

``` bash
./cfs-cli nodeset list #列出所有nodeset
Flags:
-h, --help help for list
--zone-name string List nodeSets in the specified zone
```

``` bash
./cfs-cli nodeset update [NODESET ID] [flags] #更新nodeset [NODESET ID]的信息
Flags:
--dataNodeSelector string Set the node select policy(datanode) for specify nodeset
-h, --help help for update
--metaNodeSelector string Set the node select policy(metanode) for specify nodeset
```
### 纠删码子系统管理
Expand Down
8 changes: 8 additions & 0 deletions docs/source/deploy/metrics/metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ The monitoring metrics reported by the `Master` module mainly include the health
| cfs_master_vol_total_GB{volName="xx"} | Capacity of the specified volume |
| cfs_master_vol_usage_ratio{volName="xx"} | Usage rate of the specified volume |
| cfs_master_vol_used_GB{volName="xx"} | Used capacity of the specified volume |
| cfs_master_nodeset_data_total_GB{nodeset="xx"} | The sum of the total space of all data nodes on the specified nodeset |
| cfs_master_nodeset_data_usage_ratio{nodeset="xx"} | The used data space ratio on the specified nodeset |
| cfs_master_nodeset_data_used_GB{nodeset="xx"} | The sum of available space of all data nodes on the specified nodeset |
| cfs_master_nodeset_dp_replica_count{nodeset="xx"} | The number of data partition replicas on the specified nodeset |
| cfs_master_nodeset_meta_total_GB{nodeset="xx"} | The sum of the total space of all meta nodes on the specified nodeset |
| cfs_master_nodeset_meta_usage_ratio{nodeset="xx"} | The used meta space ratio on the specified nodeset |
| cfs_master_nodeset_meta_used_GB{nodeset="xx"} | The sum of available space of all meta nodes on the specified nodeset |
| cfs_master_nodeset_mp_replica_count{nodeset="xx"} | The number of meta partition replicas on the specified nodeset |

## MetaNode

Expand Down
24 changes: 23 additions & 1 deletion docs/source/tools/cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ At the same time, a configuration file named `.cfs-cli.json` will be generated i

In the `cubefs/cli` directory, run the command `./cfs-cli --help` or `./cfs-cli -h` to get the CLI help document.

The CLI is mainly divided into six types of management commands:
The CLI is mainly divided into 11 types of management commands:

| Command | Description |
|-----------------------|----------------------------------------------|
Expand All @@ -29,6 +29,8 @@ The CLI is mainly divided into six types of management commands:
| cfs-cli completion | Generate automatic completion command script |
| cfs-cli volume, vol | Volume management |
| cfs-cli user | User management |
| cfs-cli nodeset | Nodeset management |
| cfs-cli quota | Quota management |

### Cluster Management

Expand Down Expand Up @@ -203,6 +205,26 @@ Flags：
-y, --yes # Skip all questions and set the answer to "yes".
```

### Nodeset Management
``` bash
./cfs-cli nodeset info [NODESET ID] # Get information of nodeset [NODESET ID]
```

``` bash
./cfs-cli nodeset list # Get a list of all nodesets
Flags:
-h, --help help for list
--zone-name string List nodeSets in the specified zone
```

``` bash
./cfs-cli nodeset update [NODESET ID] [flags] # Update the information of nodeset [NODESET ID]
Flags:
--dataNodeSelector string Set the node select policy(datanode) for specify nodeset
-h, --help help for update
--metaNodeSelector string Set the node select policy(metanode) for specify nodeset
```
### Erasure Coding Subsystem Management
::: tip Note
Expand Down

0 comments on commit 4c75f2a

Please sign in to comment.