mirror of
https://github.com/cubefs/cubefs.git
synced 2026-08-02 02:00:56 +00:00
feat(doc): update doc for v3.4.0
Signed-off-by: chihe <chihe@oppo.com>
This commit is contained in:
chihe
Victor1319
parent
de8867da5d
commit
ee346d86b6
@ -1,4 +1,4 @@
|
||||
## Release v3.3.2 - 2024/10/28
|
||||
## Release v3.4.0 - 2024/10/28
|
||||
|
||||
### **UPGRAGDE NOTICE**
|
||||
UPGRAGDE NOTICE
|
||||
@ -34,6 +34,9 @@ Note: Provides basic capabilities of the snapshot version in v3.4.0(beta version
|
||||
* `meta`: Under heavy pressure from deleting a large number of extents, the deletion efficiency is too low. (#3518, @NaturalSelect)
|
||||
* `master`: Simplify the return results of the datanode/disk query decomission status interface. (#3507, @bboyCH4)
|
||||
* `client`: when volume is deleted, cfs-client need to exit. (#3512, @longerfly)
|
||||
* `master`: Add config to control http pool size. (#3567, @Victor1319)
|
||||
* `metanode`: Persist access time for inode in meta node . (#3565, @bboyCH4)
|
||||
* `client`: Support libsdk to determine whether it is a file or directory based on mode.(#3566 , @longerfly)
|
||||
|
||||
|
||||
### **Bugfix**
|
||||
|
||||
@ -96,6 +96,8 @@ curl -v "http://192.168.0.11:17010/disk/decommission"
|
||||
| addr | string | 要下线的磁盘的节点地址 |
|
||||
| disk | string | 故障磁盘 |
|
||||
| count | int | 每次下线个数，默认0，代表全部下线 |
|
||||
| diskDisable | bool | 是否禁用磁盘，即禁止在下线的磁盘上新建dp，默认为true |
|
||||
| decommissionType | int | 下线类型，默认0,代表手动下线；1表示自动下线 |
|
||||
|
||||
## 迁移
|
||||
|
||||
@ -175,7 +177,7 @@ v3.2.1新增接口
|
||||
## 取消磁盘下线
|
||||
|
||||
``` bash
|
||||
curl -v "http://192.168.0.11:17320/disk/cancelDecommission?addr=192.168.0.12:17310&disk=/home/service/var/data1"
|
||||
curl -v "http://192.168.0.11:17320/disk/pauseDecommission?addr=192.168.0.12:17310&disk=/home/service/var/data1"
|
||||
```
|
||||
|
||||
参数列表
|
||||
@ -186,7 +188,7 @@ curl -v "http://192.168.0.11:17320/disk/cancelDecommission?addr=192.168.0.12:173
|
||||
| disk | string | 下线磁盘地址 |
|
||||
|
||||
::: tip 提示
|
||||
v3.2.1新增接口
|
||||
v3.4.0新增接口
|
||||
:::
|
||||
|
||||
## 取消节点下线
|
||||
@ -199,8 +201,18 @@ curl -v "http://192.168.0.11:17010/dataNode/cancelDecommission?addr=192.168.0.33
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|--------|--------------------------|
|
||||
| addr | string | 数据节点和master的交互地址 |
|
||||
| addr | string | 数据节点地址 |
|
||||
|
||||
::: tip 提示
|
||||
v3.2.1新增接口
|
||||
:::
|
||||
|
||||
## 查询所有下线磁盘
|
||||
|
||||
``` bash
|
||||
curl -v "http://192.168.0.11:17010/disk/queryAllDecommissionDisk"
|
||||
```
|
||||
|
||||
::: tip 提示
|
||||
v3.4.0新增接口
|
||||
:::
|
||||
@ -3,7 +3,7 @@
|
||||
## 增加节点
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/raftNode/add?addr=10.196.59.197:17010&id=3"
|
||||
curl -v "http://192.168.0.1:17010/raftNode/add?addr=10.196.59.197:17010&id=3"
|
||||
```
|
||||
|
||||
增加新的master节点到raft复制组。
|
||||
@ -18,7 +18,7 @@ curl -v "http://10.196.59.198:17010/raftNode/add?addr=10.196.59.197:17010&id=3"
|
||||
## 删除节点
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/raftNode/remove?addr=10.196.59.197:17010&id=3"
|
||||
curl -v "http://192.168.0.1:17010/raftNode/remove?addr=10.196.59.197:17010&id=3"
|
||||
```
|
||||
|
||||
从raft复制组中移除某个节点。
|
||||
@ -29,3 +29,24 @@ curl -v "http://10.196.59.198:17010/raftNode/remove?addr=10.196.59.197:17010&id=
|
||||
|------|--------|-------------------------|
|
||||
| addr | string | master的ip地址, 格式为ip:port |
|
||||
| id | uint64 | master的节点标识 |
|
||||
|
||||
## 获取nodeset列表
|
||||
|
||||
``` bash
|
||||
curl -v "http://192.168.0.1:17010/nodeSet/list"
|
||||
```
|
||||
获取集群的nodeset列表。
|
||||
|
||||
## 获取nodeset详细信息
|
||||
|
||||
``` bash
|
||||
curl -v "http://192.168.0.1:17010//nodeSet/get?nodesetId=1"
|
||||
```
|
||||
|
||||
获取集群中nodeset的详细信息
|
||||
|
||||
参数列表
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|--------|-------------------------|
|
||||
| nodesetId | string | nodeset编号 |
|
||||
|
||||
@ -3,31 +3,22 @@
|
||||
## 创建
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/metaPartition/create?name=test&start=10000"
|
||||
curl -v "http://192.168.0.1:17010/metaPartition/create?count=10&name=test"
|
||||
```
|
||||
|
||||
手动切分元数据分片，如果卷的最大的元数据分片 **inode** 的范围是
|
||||
`[begin, end)`:
|
||||
|
||||
- 若 **start** 大于 **begin** 小于 **end**参数，原来最大的元数据分片的inode范围变为 `[begin, start]`，新创建的元数据分片的范围是 `[start+1,+inf)`
|
||||
- 若 **start** 小于 **begin**，max为当前分片上最大的inode编号，则inode范围变为 `[begin, max+16777216]`，新创建的元数据分片的范围是 `[max+16777217,+inf)` ;
|
||||
- 若 **start** 大于 **end**，max为当前分片上最大的inode编号，则inode范围变为 `[begin, start]`，新创建的元数据分片的范围是 `[start+1, +inf)` ;
|
||||
|
||||
::: warning 注意
|
||||
start过大会导致单个分片上inode过大，占用较大内存，当最后一个分片上inode过多时，也会触发mp自动分裂的。
|
||||
:::
|
||||
批量创建元数据分区
|
||||
|
||||
参数列表
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|-------|--------|-------------|
|
||||
| name | string | 卷的名字 |
|
||||
| start | uint64 | 根据此值切分元数据分片 |
|
||||
| count | uint64 | 新增的mp数目 |
|
||||
|
||||
## 查询
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/metaPartition/get?id=1" | python -m json.tool
|
||||
curl -v "http://192.168.0.1:17010/metaPartition/get?id=1" | python -m json.tool
|
||||
```
|
||||
|
||||
展示元数据分片的详细信息，包括分片ID，分片的起始范围等等。
|
||||
@ -62,7 +53,7 @@ curl -v "http://10.196.59.198:17010/metaPartition/get?id=1" | python -m json.too
|
||||
## 下线副本
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/metaPartition/decommission?id=13&addr=10.196.59.202:17210"
|
||||
curl -v "http://192.168.0.1:17010/metaPartition/decommission?id=13&addr=10.196.59.202:17210"
|
||||
```
|
||||
|
||||
下线元数据分片的某个副本，并且创建一个新的副本。
|
||||
@ -77,7 +68,7 @@ curl -v "http://10.196.59.198:17010/metaPartition/decommission?id=13&addr=10.196
|
||||
## 比对副本
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/metaPartition/load?id=1"
|
||||
curl -v "http://192.168.0.1:17010/metaPartition/load?id=1"
|
||||
```
|
||||
|
||||
发送比对副本任务到各个副本，然后检查各个副本的Crc是否一致。
|
||||
|
||||
@ -14,5 +14,9 @@
|
||||
{
|
||||
"label": "v3.3.2",
|
||||
"value": "release-3.3.2"
|
||||
},
|
||||
{
|
||||
"label": "v3.4.0",
|
||||
"value": "release-3.4.0"
|
||||
}
|
||||
]
|
||||
|
||||
@ -91,6 +91,10 @@ Parameter List
|
||||
| Parameter | Type | Description |
|
||||
|-----------|--------|--------------------------------------------------|
|
||||
| addr | string | The node address of the disk to be taken offline |
|
||||
| disk | string | Faulty disk address |
|
||||
| count | int | Number of dp to take offline each time, default is 0, which represents all dp offline. |
|
||||
| diskDisable | bool | Whether to disable the disk, i.e., prohibit creating new data partitions on the offline disks. Default is true |
|
||||
| decommissionType | int | Offline type, default is 0, which represents manual offline; 1 indicates automatic offline |
|
||||
|
||||
## Migration
|
||||
|
||||
@ -169,7 +173,7 @@ New interface in v3.2.1
|
||||
## Cancel Disk Decommission
|
||||
|
||||
``` bash
|
||||
curl -v "http://192.168.0.11:17320/disk/cancelDecommission?addr=192.168.0.12:17310&disk=/home/service/var/data1"
|
||||
curl -v "http://192.168.0.11:17320/disk/pauseDecommission?addr=192.168.0.12:17310&disk=/home/service/var/data1"
|
||||
```
|
||||
|
||||
Parameter List
|
||||
@ -180,7 +184,7 @@ Parameter List
|
||||
| disk | string | Address of the disk to be decommissioned |
|
||||
|
||||
::: tip Note
|
||||
New interface in v3.2.1
|
||||
New interface in v3.4.0
|
||||
:::
|
||||
|
||||
## Cancel Node Decommission
|
||||
@ -193,8 +197,18 @@ Parameter List
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|--------|------------------------------------------------------|
|
||||
| addr | string | Address for interaction between data node and master |
|
||||
| addr | string | Address for data node |
|
||||
|
||||
::: tip Note
|
||||
New interface in v3.2.1
|
||||
:::
|
||||
|
||||
## Query all offline disks
|
||||
|
||||
``` bash
|
||||
curl -v "http://192.168.0.11:17010/disk/queryAllDecommissionDisk"
|
||||
```
|
||||
|
||||
::: tip Note
|
||||
New interface in v3.4.0
|
||||
:::
|
||||
@ -3,7 +3,7 @@
|
||||
## Add Node
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/raftNode/add?addr=10.196.59.197:17010&id=3"
|
||||
curl -v "http://192.168.0.1:17010/raftNode/add?addr=10.196.59.197:17010&id=3"
|
||||
```
|
||||
|
||||
Adds a new master node to the raft replication group.
|
||||
@ -18,7 +18,7 @@ Parameter List
|
||||
## Remove Node
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/raftNode/remove?addr=10.196.59.197:17010&id=3"
|
||||
curl -v "http://192.168.0.1:17010/raftNode/remove?addr=10.196.59.197:17010&id=3"
|
||||
```
|
||||
|
||||
Removes a node from the raft replication group.
|
||||
@ -29,3 +29,24 @@ Parameter List
|
||||
|-----------|--------|----------------------------------------------------|
|
||||
| addr | string | IP address of the master, in the format of ip:port |
|
||||
| id | uint64 | Node identifier of the master |
|
||||
|
||||
## Retrieve the nodeset list of the cluster
|
||||
|
||||
``` bash
|
||||
curl -v "http://192.168.0.1:17010/nodeSet/list"
|
||||
```
|
||||
Retrieve the nodeset list of the cluster.
|
||||
|
||||
## Retrieve detailed information about the nodeset
|
||||
|
||||
``` bash
|
||||
curl -v "http://192.168.0.1:17010//nodeSet/get?nodesetId=1"
|
||||
```
|
||||
|
||||
Retrieve detailed information about the nodeset
|
||||
|
||||
Parameter List
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|------|--------|-------------------------|
|
||||
| nodesetId | string | odeset identifier |
|
||||
@ -3,30 +3,22 @@
|
||||
## Create
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/metaPartition/create?name=test&start=10000"
|
||||
curl -v "http://192.168.0.1:17010/metaPartition/create?count=10&name=test"
|
||||
```
|
||||
|
||||
Manually splits the metadata shard. If the maximum metadata shard inode range of the volume is `[begin, end)`:
|
||||
|
||||
- If **start** is greater than **begin** and less than **end**, the inode range of the original maximum metadata shard becomes `[begin, start]`, and the range of the newly created metadata shard is `[start+1,+inf)`.
|
||||
- If **start** is less than **begin**, max is the maximum inode number on the current shard, and the inode range becomes `[begin, max+16777216]`, and the range of the newly created metadata shard is `[max+16777217,+inf)`.
|
||||
- If **start** is greater than **end**, max is the maximum inode number on the current shard, and the inode range becomes `[begin, start]`, and the range of the newly created metadata shard is `[start+1, +inf)`.
|
||||
|
||||
::: warning Note
|
||||
A large **start** value will cause a large inode on a single shard, occupying a large amount of memory. When there are too many inodes on the last shard, automatic splitting of the metadata partition will also be triggered.
|
||||
:::
|
||||
Batch create meta partitions.
|
||||
|
||||
Parameter List
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|--------|----------------------------------------------|
|
||||
| name | string | Volume name |
|
||||
| start | uint64 | Split the metadata shard based on this value |
|
||||
| count | uint64 | Number of newly added mp |
|
||||
|
||||
## Query
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/metaPartition/get?id=1" | python -m json.tool
|
||||
curl -v "http://192.168.0.1:17010/metaPartition/get?id=1" | python -m json.tool
|
||||
```
|
||||
|
||||
Displays detailed information about the metadata shard, including the shard ID, the starting range of the shard, etc.
|
||||
@ -61,7 +53,7 @@ Response Example
|
||||
## Decommission Replica
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/metaPartition/decommission?id=13&addr=10.196.59.202:17210"
|
||||
curl -v "http://192.168.0.1:17010/metaPartition/decommission?id=13&addr=10.196.59.202:17210"
|
||||
```
|
||||
|
||||
Removes a replica of the metadata shard and creates a new replica.
|
||||
@ -76,7 +68,7 @@ Parameter List
|
||||
## Compare Replica
|
||||
|
||||
``` bash
|
||||
curl -v "http://10.196.59.198:17010/metaPartition/load?id=1"
|
||||
curl -v "http://192.168.0.1:17010/metaPartition/load?id=1"
|
||||
```
|
||||
|
||||
Sends a task to compare the replica to each replica, and then checks whether the CRC of each replica is consistent.
|
||||
|
||||
@ -14,5 +14,9 @@
|
||||
{
|
||||
"label": "v3.3.2",
|
||||
"value": "release-3.3.2"
|
||||
},
|
||||
{
|
||||
"label": "v3.4.0",
|
||||
"value": "release-3.4.0"
|
||||
}
|
||||
]
|
||||
|
||||
Loading…
Reference in New Issue
Block a user
