refactor_docs
gongweibao 8 years ago
parent 33eadfb8bd
commit 0d7d8990db

@ -5,7 +5,7 @@
## Module
### Client
Client是用户操作的界面,支持的命令如下
Client是用户操作的命令行程序,支持的命令如下
- ls
@ -39,8 +39,12 @@ mv
### FileServer
FileServer是gorpc写的HttpServer, 用来接收Client的REST API的请求自身由kubernets来管理。
REST API说明
功能说明:
- gorpc写的HttpServer
- 响应外部的REST API的请求
- 在kubernets中运行
REST API说明:
- file
@ -56,6 +60,17 @@ DELETE /file: Delete a File
GET /file/chunk: Get a chunk info
POST /file/chunk: Update a chunk
```
为什么有chunk的抽象
用户文件可能是比较大的上传到Cloud或者下载到本地的时间可能比较长而且在传输的过程中也可能出现网络不稳定的情况。为了应对以上的问题我们提出了chunk的概念。chunk由所在的文件偏移、数据、数据长度及校验值组成。数据内容的上传和下载都是都过chunk的操作来实现的。由于chunk比较小默认256K完成一个传输动作的transaction的时间也比较短不容易出错。
```
type Chunk struct {
filePos int64
checkSum uint32
len uint32
data []byte
}
```
- dir
@ -67,6 +82,35 @@ DELETE /dir: Delete a directory
## 流程
### cp
### 断点续传
### sync
### 关于文件权限
- 每一个用户在Cloud注册后可以申请分配用户空间系统默认会在CephFS上分配一个固定大小比如初始10G的、有所有权限的volume对用户而言就是自己的`home`目录。用户彼此之间的数据是隔离的、无法访问的。用户的空间大小第一期也不允许扩大。
- 公共数据集合放到一个单独的volume下对所有外部用户只读。由于其被读取的可能比较频繁需要提高其备份数防止成为热点文件。
### 关于认证
> 通信各方都需要有各自的身份证。一个公司可以自签名一个CA身份证并 且用它来给每个雇员以及每个程序签署身份证。这样,只要每台电脑上都预先安 装好公司自己的CA身份证就可以用这个身份证验证每个雇员和程序的身份了。 这是目前很多公司的常用做法
身份的认证来自于用户或者程序是否有crt标识身份以及是否有可信的CA确认这个身份证是否有效。我们这里描述的crt涉及到两个部分一个是Client端程序访问FileServer的crt不妨称之为Client crt另外一个是FileServer访问CephFS的crt不妨称之为CephFS crt。
- Client和FileServer相互认证的办法
`cloud.paddlepaddle.org`需要有自己的CAFileServer和注册用户也要为其生成各自的私钥(key)、crt。这样用户把CA、自己的key和crt下载到本地后Client程序可以用之和FileServer可以做相互的认证
- CephFS验证FileServer的身份的两种方法
- 第一种每一个用户都有自己单独的访问CephFS crt。
用户访问其空间时由FileServer读取它然后才可以在CephFS上完成操作。
- 第二种CephFS crt只有一个也就是admin crt拥有所有volume的读写权限。
FileServer从Client crt提取Client的身份username限制其可以操作的volume。 我们选择这种。
### 关于cp
cp的关键在于需要Client端对比src和dst的文件chunks的checkSum是否保持一致不一致的由Client Get或者Post完成。藉由上述的方法完成断点的数据传输。
优化的方法:
- dst文件不存在时可以没有Get的过程只有Post。
- 文件的chunks信息可以做cache不用每次启动传输都去读和计算。这个由于比较复杂第一期暂时不做。
tricky
- 可以用[Fallocate](https://golang.org/pkg/syscall/#Fallocate)让dst和src文件保持相同的大小。这样chunk就可以写固定的偏移上。
## 参考文档
- [Do you see tls?](https://github.com/k8sp/tls/blob/master/README.md)

Loading…
Cancel
Save