From bd899019ac9ad08bc2fae6bd60412fe011121869 Mon Sep 17 00:00:00 2001 From: mabofu Date: Wed, 4 Jan 2023 20:04:42 +0800 Subject: [PATCH] change dfsbroker module comment to English --- .../handler/GlobalExceptionHandler.java | 1 + .../cluster/service/IClusterService.java | 10 ++++---- .../dsms/dfsbroker/common/RequestUrlEnum.java | 2 +- .../com/dsms/dfsbroker/node/api/NodeApi.java | 5 ++-- .../com/dsms/dfsbroker/node/model/Node.java | 4 +-- .../node/model/remote/OrchDeviceLsResult.java | 10 ++++---- .../node/model/remote/OsdDfResult.java | 8 +++--- .../node/model/remote/OsdRmStatusResult.java | 4 +++ .../dfsbroker/node/service/INodeService.java | 25 +++++++++++-------- 9 files changed, 39 insertions(+), 30 deletions(-) diff --git a/dsms-engine-common/src/main/java/com/dsms/common/handler/GlobalExceptionHandler.java b/dsms-engine-common/src/main/java/com/dsms/common/handler/GlobalExceptionHandler.java index e9a2f7a..c257284 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/handler/GlobalExceptionHandler.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/handler/GlobalExceptionHandler.java @@ -32,6 +32,7 @@ import org.springframework.web.servlet.NoHandlerFoundException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; +import java.util.Optional; /** * 全局异常处理 diff --git a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/cluster/service/IClusterService.java b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/cluster/service/IClusterService.java index bd1e58e..85aca5e 100644 --- a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/cluster/service/IClusterService.java +++ b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/cluster/service/IClusterService.java @@ -23,20 +23,20 @@ import com.dsms.dfsbroker.cluster.model.Cluster; public interface IClusterService extends IService { /** - * 获取集群关于信息 + * get current bound cluster info * - * @return 集群对象 + * @return bound cluster info */ Cluster about(); /** - * 关联集群 + * bind cluster * - * @return 集群信息 + * @return cluster info */ Cluster bind(Cluster cluster); /** - * 解绑集群 + * unbind current cluster */ boolean unbind(); diff --git a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/common/RequestUrlEnum.java b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/common/RequestUrlEnum.java index 6838231..114c744 100644 --- a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/common/RequestUrlEnum.java +++ b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/common/RequestUrlEnum.java @@ -21,7 +21,7 @@ import lombok.AllArgsConstructor; import lombok.Getter; /** - * dfsbroker 请求url枚举 + * dsms-storage restful api url enum */ @Getter @AllArgsConstructor diff --git a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/api/NodeApi.java b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/api/NodeApi.java index ecb92a0..90c6086 100644 --- a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/api/NodeApi.java +++ b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/api/NodeApi.java @@ -55,9 +55,10 @@ public class NodeApi { private CommonApi commonApi; /** - * 获取集群节点列表 + * get dsms-storage node list + * call /mon api * - * @return 节点列表 + * @return /mon response */ public List getNodeList(RemoteRequest remoteRequest) throws Throwable { CommandDirector.constructMonRequest(remoteRequest); diff --git a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/Node.java b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/Node.java index f1bc885..002c9fc 100644 --- a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/Node.java +++ b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/Node.java @@ -33,9 +33,7 @@ public class Node implements Serializable { private static final long serialVersionUID = 1L; - /** - * 节点版本 - */ + @ApiModelProperty("节点version") private String version; @ApiModelProperty("节点id") diff --git a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OrchDeviceLsResult.java b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OrchDeviceLsResult.java index 40941bb..20ab452 100644 --- a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OrchDeviceLsResult.java +++ b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OrchDeviceLsResult.java @@ -22,26 +22,26 @@ import lombok.Data; import java.util.List; /** - * orch device ls 执行结果 + * dsms-storage (orch device ls) execute result */ @Data public class OrchDeviceLsResult { /** - * ceph 响应 addr 字段 + * dsms-storage response addr field */ private String addr; /** - * ceph 响应 devices 字段 + * dsms-storage response devices field */ private List devices; /** - * ceph 响应 labels 字段 + * dsms-storage response labels field */ private List labels; /** - * ceph 响应 name 字段 + * dsms-storage response name field */ private String name; } diff --git a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OsdDfResult.java b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OsdDfResult.java index 928e6ef..9423dd5 100644 --- a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OsdDfResult.java +++ b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OsdDfResult.java @@ -22,21 +22,21 @@ import lombok.Data; import java.util.List; /** - * osd df 执行结果 + * dsms-storage (osd df) execute result */ @Data public class OsdDfResult { /** - * ceph 响应 nodes 字段 + * dsms-storage response nodes field */ private List nodes; /** - * ceph 响应 Stray 字段 + * dsms-storage response stray field */ private List stray; /** - * ceph 响应 summary 字段 + * dsms-storage response summary field */ private Summary summary; } diff --git a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OsdRmStatusResult.java b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OsdRmStatusResult.java index a3b114e..8eb97de 100644 --- a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OsdRmStatusResult.java +++ b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/model/remote/OsdRmStatusResult.java @@ -21,6 +21,10 @@ import lombok.Data; import java.time.LocalDateTime; + +/** + * dsms-storage (orch osd rm status) execute result + */ @Data public class OsdRmStatusResult { diff --git a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/service/INodeService.java b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/service/INodeService.java index 7012013..25bae44 100644 --- a/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/service/INodeService.java +++ b/dsms-engine-dfsbroker/src/main/java/com/dsms/dfsbroker/node/service/INodeService.java @@ -23,27 +23,32 @@ import java.util.List; public interface INodeService { /** - * 节点池列表 - * @return 当前绑定集群的全部节点信息 + * get dsms-storage all node info + * + * @return nodes info list */ List list(); /** - * 单个节点信息 - * @param nodeName 节点名称 - * @return 包含磁盘信息的node对象 + * get dsms-storage special node info + * + * @param nodeName node name + * @return node info */ Node getNodeInfo(String nodeName); /** - * 节点新增磁盘 - * @param nodeName 节点名称 - * @param devicePath 节点路径 + * node add osd + * + * @param nodeName node name + * @param devicePath node disk path */ boolean addOsd(String nodeName, String devicePath); + /** - * 节点移除磁盘 - * @param osdId osdId + * node remove osd + * + * @param osdId osd id */ boolean removeOsd(Integer osdId); -- Gitee