update document

FederatedAI · Sep 15, 2021 · 0cce50b · 0cce50b
1 parent 0fec05d
commit 0cce50b
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 27 deletions.
diff --git a/document/docs/example/deploy.md b/document/docs/example/deploy.md
@@ -7,7 +7,7 @@
 ```yml
 xxxxxxxxxx
 server.port=8059
-zk.url=172.168.0.1:2181,172.168.0.2:2181,172.168.0.3:2181
+zk.url=192.168.0.1:2181,192.168.0.2:2181,192.168.0.3:2181
 proxy.grpc.intra.port=8879
 proxy.grpc.inter.port=9370
 ```
@@ -21,7 +21,7 @@ xxxxxxxxxx
     "default": {
       "default": [
         {
-          "ip": "172.134.0.1",
+          "ip": "192.134.0.1",
           "port": 9370
         }
       ]
@@ -37,14 +37,14 @@ xxxxxxxxxx
 ```yml
 xxxxxxxxxx
 port=8000
-model.transfer.url=http://172.168.0.2:9380/v1/model/transfer  //FATE flow地址
-zk.url=172.168.0.1:2181,172.168.0.2:2181,172.168.0.3:2181
+model.transfer.url=http://192.168.0.2:9380/v1/model/transfer  //FATE flow地址
+zk.url=192.168.0.1:2181,192.168.0.2:2181,192.168.0.3:2181
 ``` 
 •	guest 的 serving-admin配置
 ```yml
 xxxxxxxxxx
 server.port=8350
-zk.url=172.168.0.1:2181,172.168.0.2:2181,172.168.0.2:2181
+zk.url=192.168.0.1:2181,192.168.0.2:2181,192.168.0.2:2181
 admin.username=admin
 admin.password=admin
 
@@ -55,7 +55,7 @@ admin.password=admin
 ```yml
 xxxxxxxxxx
 server.port=8059
-zk.url=172.134.0.1:2181,172.134.0.2:2181,172.134.0.3:2181
+zk.url=192.134.0.1:2181,192.134.0.2:2181,192.134.0.3:2181
 proxy.grpc.intra.port=8879
 proxy.grpc.inter.port=9370
 ```
@@ -66,7 +66,7 @@ xxxxxxxxxx
     "route_table": {
         "default": {
             "default": [{
-                "ip": "172.134.0.2",
+                "ip": "192.134.0.2",
                 "port": 8000
             }]
         }
@@ -82,8 +82,8 @@ xxxxxxxxxx
 ```yml
 xxxxxxxxxx
 port=8000
-model.transfer.url=http://172.134.0.1:9380/v1/model/transfer
-zk.url=172.134.0.1:2181,172.134.0.2:2181,172.134.0.3:2181
+model.transfer.url=http://192.134.0.1:9380/v1/model/transfer
+zk.url=192.134.0.1:2181,192.134.0.2:2181,192.134.0.3:2181
 feature.single.adaptor=com.webank.ai.fate.serving.adaptor.dataaccess.MockAdapter
 feature.batch.adaptor=com.webank.ai.fate.serving.adaptor.dataaccess.MockBatchAdapter
 ```
@@ -92,7 +92,7 @@ feature.batch.adaptor=com.webank.ai.fate.serving.adaptor.dataaccess.MockBatchAda
 ```yml
 xxxxxxxxxx
 server.port=8350
-zk.url=172.134.0.1:2181,172.134.0.2:2181,172.134.0.3:2181
+zk.url=192.134.0.1:2181,192.134.0.2:2181,192.134.0.3:2181
 admin.username=admin
 admin.password=admin
 

diff --git a/document/docs/img/Deploy.jpg b/document/docs/img/Deploy.jpg
diff --git a/document/docs/img/admin-model.jpg b/document/docs/img/admin-model.jpg
diff --git a/document/docs/img/gen-route.jpg b/document/docs/img/gen-route.jpg
diff --git a/document/docs/img/health-check.jpg b/document/docs/img/health-check.jpg
diff --git a/document/docs/img/inference-single-1.jpg b/document/docs/img/inference-single-1.jpg
diff --git a/document/docs/img/model_sync.jpg b/document/docs/img/model_sync.jpg
diff --git a/document/docs/img/weight.jpg b/document/docs/img/weight.jpg
diff --git a/document/docs/log/log.md b/document/docs/log/log.md
@@ -88,13 +88,13 @@
 
 ### serving-server的日志格式
 ```yml
-2020-08-10 12:47:49,708|6578868d962047c996c0505821cae830|2113|6|5|singleInference|172.16.153.105:8879||
+2020-08-10 12:47:49,708|6578868d962047c996c0505821cae830|2113|6|5|singleInference|192.16.1.1:8879||
 ```
 时间|CaseId|返回码|总耗时|下游通信耗时|服务名称|路由信息|请求参数|返回值
 
 ### serving-proxy的日志格式
 ```yml
-2020-08-10 14:08:39,430|127.0.0.1|1597039719427|9999|10000|0|3|3|unaryCall|172.16.153.136:8869||
+2020-08-10 14:08:39,430|127.0.0.1|1597039719427|9999|10000|0|3|3|unaryCall|192.16.1.5:8869||
 ```
 时间|目标地址|CaseId|GuestAppId|HostAppId|返回码|总耗时|下游通信耗时|服务名称|路由信息|请求参数|返回值
 

diff --git a/document/docs/release/change_log.md b/document/docs/release/change_log.md
@@ -1,4 +1,4 @@
-## FATE-SERVING 2.1 新增特性： 
+## FATE-SERVING 2.1 新增特性
 ```text
 1.支持多host算法模型在线预测，目前支持的多host算法有：纵向LR、纵向SBT。
 2.支持在admin页面以pipeline方式展示模型信息。
@@ -11,7 +11,7 @@
 9.新增一个通用的httpAdaptor用于host获取特征。
 ```
 
-## FATE-SERVING 2.0 支持的特性：
+## FATE-SERVING 2.0 新增特性
 
 ```text
 1.单笔预测，2.0.*版本guest方与host方将并行计算，从而降低了耗时。    
@@ -34,4 +34,4 @@
 
 * 2.0.* 有部分配置项与1.3.* 不同，升级时参考各模块的配置 。
 
-[点击查看](../../../RELEASE.md)更多历史版本信息
+[点击查看](https://github.com/FederatedAI/FATE-Serving/blob/master/RELEASE.md)更多历史版本信息
diff --git a/document/docs/service/admin.md b/document/docs/service/admin.md
@@ -41,6 +41,10 @@ serving-admin仅实现简单的用户登录，用户可业务需求，自行实
     <td>Service ID</td>
     <td>服务ID</td>
   </tr>
+  <tr>
+    <td>FATE Flow Address</td>
+    <td>发布模型的flow的IP地址</td>
+  </tr>
   <tr>
     <td>Role & Party ID</td>
     <td>模型对应的角色和节点ID</td>
@@ -49,6 +53,10 @@ serving-admin仅实现简单的用户登录，用户可业务需求，自行实
     <td>Timestamp</td>
     <td>模型发布时间</td>
   </tr>
+  <tr>
+    <td>Operation</td>
+    <td>模型操作</td>
+  </tr>
 </table>
 
 
@@ -75,22 +83,14 @@ serving-admin仅实现简单的用户登录，用户可业务需求，自行实
 #### 服务管理
 * 服务接口：展示注册中心中各实例注册的服务接口
 
-![weight](../img/weight.jpg)
+![weight](../img/service.jpg)
 
 列表字段  
 <table>
   <tr>
     <td>字段名</td>
     <td>备注</td>
   </tr>
-  <tr>
-    <td>Project</td>
-    <td>服务项目，serving-server为serving，serving-proxy为proxy</td>
-  </tr>
-  <tr>
-    <td>Environment</td>
-    <td>环境，模型Bind操作绑定服务ID后，此字段会显示注册的服务接口的服务ID</td>
-  </tr>
   <tr>
     <td>Name</td>
     <td>接口名称，{Project}/{Environment}/{ServiceName}</td>

diff --git a/document/docs/service/client.md b/document/docs/service/client.md
@@ -1,6 +1,6 @@
 FATE-Serving提供了fate-serving-client工具进行 下载系统对应版本fate-serving-client：
->linux版本：fate-serving-client-2.1.0-linux.tar.gz     
->mac版本：fate-serving-client-2.1.0-darwin.tar.gz
+>linux版本：[fate-serving-client-2.1.0-linux.tar.gz](https://webank-ai-1251170195.cos.ap-guangzhou.myqcloud.com/fate-serving-client-2.1.0-linux.tar.gz )     
+>mac版本：[fate-serving-client-2.1.0-darwin.tar.gz](https://webank-ai-1251170195.cos.ap-guangzhou.myqcloud.com/fate-serving-client-2.1.0-darwin.tar.gz)
 
 在终端中使用`./fate-serving-client`启动， 默认情况下，client连接localhost:8000，使用参数可以指定目标地址`./fate-serving-client [-h host] [-p port] `host为需要连接的serving-server的ip ， port 为serving-server对外暴露的端口。
 >./fate-serving-client -h 127.0.0.1 -p 8000

diff --git a/document/docs/service/register.md b/document/docs/service/register.md
@@ -18,7 +18,7 @@ zookeeper中使用的数据结构如下
 第二级路径：永久节点，各自模块的名字，比如serving-proxy的模块名为proxy ，serving-server的模块名为serving  
 第三级路径：永久节点，ID ，根据接口的不同ID的值不一样。与模型版本强相关的接口，如inference接口，ID为fate-flow推送模型时产生的serviceId ，这样可以使得不同版本模型注册路径不一样。其他接口为字符串online  
 第四级路径：永久节点，固定字符串provider  
-第五级路径：临时节点，详细描述注册信息 eg:  grpc://172.168.1.1:8000
+第五级路径：临时节点，详细描述注册信息 eg:  grpc://192.168.1.1:8000
 
 ### ACL鉴权
 FATE-Serving支持zookeeper acl鉴权，在使用zk注册中心时，启用zookeeper acl鉴权的服务所注册的接口节点，未配置acl鉴权的服务不能访问。启用添加如下配置：