rest-server-plugin doc

rest-server-plugin/README.md

@@ -1,12 +1,15 @@
 # rest-server-plugin
 
-## QuickStart
+此服务主要包含基于Octopus TasksetPipeline组件的插件原理实现的若干Feature插件服务,现阶段包括功能插件有:
 
-<!-- add docs here for user -->
+- Debug类型的任务定时停止
+- 多子任务之间相互感知
+- 任务信息翻译为Taskset模板
+- 多子任务批调度启动PodGroup
 
-see [egg docs][egg] for more detail.
+## 开发
 
-### Development
+更详细内容请参考 [egg docs][egg]
 
 ```bash
 $ npm i
@@ -14,18 +17,21 @@ $ npm run dev
 $ open http://localhost:8083/
 ```
 
-### Deploy
+## 部署
 
-```bash
-$ npm start
-$ npm stop
-```
+1. 打包镜像
 
-### npm scripts
+    ```
+    $ docker build -t openi/rest-server-plugin:version .
+    ```
 
-- Use `npm run lint` to check code style.
-- Use `npm test` to run unit test.
-- Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail.
+2. 部署到k8s集群
 
+   通过按需求修改 `./charts/rest-server-plugin/value.yaml` 文件中配置
+  
+    ```
+    // 安装
+    helm install octopus ./charts/rest-server-plugin
+    ```
 
 [egg]: https://eggjs.org