Merge pull request #13 from laincloud/readme

fix readme

Author: bibaijin

README.md

@@ -7,8 +7,33 @@
 
 相关文档见 [Entry 应用文档](https://laincloud.gitbooks.io/white-paper/content/outofbox/entry.html)
 
-## Licensing
-Entry is released under [MIT](https://github.com/laincloud/entry/blob/master/LICENSE) license.
+## 架构
+
+### 整体架构
+
+整体架构如下图所示：
+
+![整体架构](docs/figures/entry.png)
+
+- LAIN 应用所有者可以通过 `lain-cli` 或者 `console` 进入除 entry 之外的 LAIN 应用
+- 系统管理员可以在 https://entry.${LAIN_DOMAIN}/web 搜索、回放用户会话或者搜索用户命令
+
+### 审计
+
+`Entry` 设计了完善的审计框架：
+
+- `Entry` 审计所有经自己建立的用户会话
+- 系统管理员还可以从 LAIN 节点进入所有的 LAIN 应用（包括 entry），这时由堡垒机负责审计
+
+如下图所示：
+
+![审计框架](docs/figures/audit.png)
+
+### 数据库
+
+`Entry` 将用户会话和命令存储于数据库，数据表如下图所示：
+
+![数据表](docs/figures/database.png)
 
 ## 部署
 
@@ -23,17 +48,19 @@ lain secret add ${LAIN-Domain} web /lain/app/prod.json -f example.json
 > - `smtp.address` 需要包含端口，如：${mail-address}:25
 > - `smtp.password` 可选，为空时不使用 auth
 
-## 审计
-
 ## 开发
 
-### 由 `swagger.yml` 生成代码
-
-```
-go get -u github.com/go-swagger/go-swagger/cmd/swagger  # 安装 swagger
-swagger generate server -f ./swagger.yml -t server/gen  # 生成代码
-```
-
-- `server/gen` 下除 `server/gen/restapi/configure_entry.go` 外均由 `go-swagger` 生成，请不要手动修改
+- `server/gen` 下除 `server/gen/restapi/configure_entry.go` 外均由 [go-swagger](https://github.com/go-swagger/go-swagger) 生成，请不要手动修改
 - `server/gen/restapi/configure_entry.go` 包含初始化逻辑以及后端 API 配置
 - `server/handler` 包含后端 API 的实际逻辑
+
+> 由 `swagger.yml` 生成代码：
+>
+> ```
+> go get -u github.com/go-swagger/go-swagger/cmd/swagger  # 安装 swagger
+> swagger generate server -f ./swagger.yml -t server/gen  # 生成代码
+> ```
+
+## Licensing
+
+Entry is released under [MIT](https://github.com/laincloud/entry/blob/master/LICENSE) license.

docs/figures/audit.dot

@@ -6,11 +6,13 @@ digraph G {
   lainNode [label="LAIN Node"];
   allContainers [label="All containers"];
   appOwner [label="App Owner"]
+  entry [label="Entry"]
   ordinaryContainers [label="Containers other than entry"]
 
-  lainAdmin -> bastion;
+  lainAdmin -> bastion [label="authorize"];
   bastion -> lainNode [label="audit"];
   lainNode -> allContainers [label="docker exec"];
 
-  appOwner -> ordinaryContainers [label="Authentication, authorize, proxy and audit by entry"];
+  appOwner -> entry [label="authorize"];
+  entry -> ordinaryContainers [label="audit"];
 }

docs/figures/audit.png

@@ -13,5 +13,10 @@
         "host": "127.0.0.1",
         "port": 3306,
         "db_name": "entry"
+    },
+    "smtp": {
+        "address": "fake:25",
+        "from_email": "[email protected]",
+        "password": ""
     }
 }