FileManager #2115

gongweibao · 2017-05-12T09:57:15Z

Fix by Old PR and ISSUE #1902

typhoonzero

把cp等命令的细节的设计统一放到pfs.md文件里，是否会整齐一些？

typhoonzero · 2017-05-12T12:14:31Z

doc/design/file_manager/README.md

@@ -0,0 +1,71 @@
+# FileManager设计文档


FileManager or FileServer保留一个名词？

typhoonzero · 2017-05-12T12:27:19Z

doc/design/file_manager/README.md

+
+### 架构图
+<image src=./src/filemanager.png width=900>
+


在这个图的下面增加一些用户使用的流程会清晰点？

typhoonzero · 2017-05-12T12:30:06Z

doc/design/file_manager/README.md

@@ -0,0 +1,71 @@
+# FileManager设计文档
+## 目标
+在本文档中，我们设计说明了名为FileManager系统，方便用户管理存放到PaddlePaddle Cloud上的文件。   


准确的说，目标是为了让用户上传自己的训练数据以进行分布式训练。

wangkuiyi

这个PR应该是一个design doc，但是写的形式类似manpage，而manpage是manual doc。

这两者的差距是：design doc的review是为了实现过程里大家意见一致。我担心现在的design doc罗列了各种功能，但是不可能短期内都实现，比如sync。

我建议合成一个.md文件即可。说明白现在要解决的一个具体问题，以及应该怎么解决。当这个design doc被大家同意并且merge的时候，大家对代码应该怎么写心里都有数。

wangkuiyi

这个design doc设计的到底是个什么程序？

是用Go RPC写的RPC server，还是一个Restful API server？RPC是frontend server和backend server之间或者backend servers之间通信的机制，不适合写pfs server这样的Web frontend server。如果要和标准Web client technolgoies（比如HTML5）兼容，应该采用与之对应的Web server technology。

wangkuiyi · 2017-05-12T14:50:48Z

doc/design/file_manager/README.md

+### PFSClient
+- 功能： 详细的内容看[Here](./pfs/pfs.md)
+	- 提供用户管理文件的命令
+	- 用Golang写，可以跨平台执行


Golang => Go

wangkuiyi · 2017-05-12T14:50:59Z

doc/design/file_manager/README.md

+主要功能包括：
+
+- 提供常用的命令行管理命令管理文件和目录
+	- 支持的命令在[Here](./pfs/pfs.md)


Here => 这里

用中文的anchor text会报错，这是Sphinx的一个bug。

wangkuiyi · 2017-05-12T14:51:10Z

doc/design/file_manager/README.md

+- 支持大文件的断点上传、下载  
+
+## 名词解释
+- PFS：是Paddlepaddle cloud File System的简称，是对用户文件存储空间的抽象，与之相对的是Local File System。目前我们用CephFS来搭建。


Paddlepaddle => PaddlePaddle

主要是想把PFS的缩写怎么来的表达一下。
Paddlepaddle cloud File System：这个里边大写的字母刚好是PFS

wangkuiyi · 2017-05-12T14:51:22Z

doc/design/file_manager/README.md

+- 支持大文件的断点上传、下载  
+
+## 名词解释
+- PFS：是Paddlepaddle cloud File System的简称，是对用户文件存储空间的抽象，与之相对的是Local File System。目前我们用CephFS来搭建。


Local File System => local filesystem

wangkuiyi · 2017-05-12T14:52:37Z

doc/design/file_manager/README.md

+- [CephFS](http://docs.ceph.com/docs/master/cephfs/)：一个POSIX兼容的文件系统。
+- Chunk：逻辑划上文件分块的单位。
+- [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/)：提供七层协议的反向代理、基于粘性会话的负载均衡。
+- CA：certificate authority<sup>[tls](#tls)</sup>


CA, CRT, Key 用全称就好了，定义成术语更麻烦。

wangkuiyi · 2017-05-12T14:53:04Z

doc/design/file_manager/README.md

+<image src=./src/filemanager.png width=900>
+
+### PFSClient
+- 功能： 详细的内容看[Here](./pfs/pfs.md)


Here => 这里

wangkuiyi · 2017-05-12T14:53:33Z

doc/design/file_manager/README.md

+
+
+### FileServer
+FileServer是一个用GoRPC写的HTTPServer，提供[RESTful API](./RESTAPI.md)接口，接收处理PFSClient端的文件管理请求，并且把结果返回PFSClient端。


GoRPC => Go RPC

wangkuiyi · 2017-05-12T14:53:45Z

doc/design/file_manager/README.md

+
+
+### FileServer
+FileServer是一个用GoRPC写的HTTPServer，提供[RESTful API](./RESTAPI.md)接口，接收处理PFSClient端的文件管理请求，并且把结果返回PFSClient端。


HTTPServer => HTTP server

wangkuiyi · 2017-05-12T14:54:39Z

doc/design/file_manager/README.md

+
+
+### FileServer
+FileServer是一个用GoRPC写的HTTPServer，提供[RESTful API](./RESTAPI.md)接口，接收处理PFSClient端的文件管理请求，并且把结果返回PFSClient端。


用Go语言的标准库rpc写的server叫做RPC server，虽然它也是一个HTTP server，但是那是因为一个用户不需了解的细节——Go RPC用HTTP传输——导致的。

我不记得Go RPC支持暴露Restful API。这个Go RPC server怎么能同时是一个Restful API server呢？

这里的FileServer指的是Go 标准库里已经写好的这个吗？ https://golang.org/pkg/net/http/#FileServer

不是，这个FileServer太简单了。
https://golang.org/pkg/net/http/#FileServer

设计的是RESTful API的接口，这样可以兼容H5。概念混淆了，没有表达清楚。

Yancey1989 · 2017-05-15T03:11:08Z

doc/design/file_manager/README.md

+### PFSServer
+PFSServer提供RESTful API接口，接收处理PFSClient端的文件管理请求，并且把结果返回PFSClient端。
+
+```


这里的```标记看起来是不需要的？

Yancey1989 · 2017-05-15T03:12:40Z

doc/design/file_manager/README.md

+RESTful API
+
+- /api/v1/files
+	- `GET /api/v1/files`: Get attributes of files or directories.


既然是个子标题，不需要重复了吧？ GET: Get attributes ...

这里是想说明在下载之前获取元数据信息么？attributes=>metadata?

子标题那个不是很理解

Yancey1989 · 2017-05-15T03:17:43Z

doc/design/file_manager/README.md

+
+- /api/v1/files
+	- `GET /api/v1/files`: Get attributes of files or directories.
+	- `POST /api/v1/files`: Update files or directories.


Update的操作应该对应PATCH的操作，参考：http://restful-api-design.readthedocs.io/en/latest/methods.html

Yancey1989 · 2017-05-15T03:19:17Z

doc/design/file_manager/README.md

+## 文件传输优化
+
+### 分块文件传输
+用户文件可能是比较大的，上传到Cloud或者下载到本地的时间可能比较长，而且在传输的过程中也可能出现网络不稳定的情况。为了应对以上的问题，我们提出了Chunk的概念，一个Chunk由所在的文件偏移、数据、数据长度及校验值组成。文件数据内容的上传和下载都是都过Chunk的操作来实现的。由于Chunk比较小（默认256K），完成一个传输动作完成的时间也比较短，不容易出错。PFSClient需要在传输完毕最后一个Chunk的时候检查destination文件的MD5值是否和source文件一致。


文件数据内容的上传和下载都是都过Chunk的操作来实现的

文件的上传和下载都是通过对Chunk的操作来实现的

Yancey1989 · 2017-05-15T03:23:54Z

doc/design/file_manager/README.md

+```  
+
+### 生成sparse文件
+当destination文件不存在或者大小和source文件不一致时，可以用[Fallocate](https://Go.org/pkg/syscall/#Fallocate)生成sparse文件，然后就可以并发写入多个Chunk。


没太明白这部分内容，是说要解决断点续传的问题么？

gongweibao added 16 commits May 3, 2017 20:29

add filemanager doc

33eadfb

add cp...

0d7d899

add cmds

e61d972

modify stly

5cdef64

add commands

ee454f9

modify commands

177d35a

modify some bugs

1297bbd

rm no ascii character

5f02c42

rm chinese links

0e0de91

modify by comments

1cc6062

modify by comments

d101426

modify by comments

9910b55

modify by comments

ffd45b7

fix name bugs

327727d

fix by comments

60f69c2

fix by comments

bd69fa3

typhoonzero reviewed May 12, 2017

View reviewed changes

wangkuiyi reviewed May 12, 2017

View reviewed changes

wangkuiyi requested changes May 12, 2017

View reviewed changes

gongweibao added 7 commits May 14, 2017 11:32

fix by comments

b2ccc47

rm not need files

5e36f57

rename pfsclient.md

9221f89

fix bugs

5f0ac85

fix bugs

ebdd6ba

fix bugs

d187cdf

fix bugs

3c70205

Yancey1989 reviewed May 15, 2017

View reviewed changes

fix by yancey

0fb76c3

gongweibao mentioned this pull request May 16, 2017

Filemanager PaddlePaddle/PaddleCloud#21

Closed

wangkuiyi approved these changes May 16, 2017

View reviewed changes

gongweibao merged commit ffbd1ef into PaddlePaddle:develop May 16, 2017

gongweibao deleted the filemanager2 branch January 17, 2021 07:42



		### FileServer
		FileServer是一个用GoRPC写的HTTPServer，提供[RESTful API](./RESTAPI.md)接口，接收处理PFSClient端的文件管理请求，并且把结果返回PFSClient端。

FileManager #2115

FileManager #2115

Conversation

gongweibao commented May 12, 2017 • edited Loading

typhoonzero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangkuiyi left a comment

Choose a reason for hiding this comment

wangkuiyi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gongweibao May 12, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gongweibao commented May 12, 2017 •

edited

Loading

gongweibao May 12, 2017 •

edited

Loading