imbajin commented on code in PR #374: URL: https://github.com/apache/incubator-hugegraph-doc/pull/374#discussion_r1818908910
########## content/cn/docs/quickstart/hugegraph-vermeer.md: ########## @@ -0,0 +1,452 @@ +--- +title: "HugeGraph-Computer Quick Start" +linkTitle: "使用 Vermeer 计算框架" +weight: 8 +--- + +## 一、Vermeer概述 + +### 1.1 运行架构 + +Vermeer是一个高性能计算框架，支持15+钟OLAP图算法的快速计算，包含msater和worker两种角色。master只有一个，worker可以有多个。 + +msater是负责通信、转发、汇总的节点，计算量和占用资源量较少。worker是计算节点，用于存储图数据和运行计算任务，占用大量内存和cpu。grpc和rest模块分别负责内部通信和外部调用。 + +该框架的运行配置可以通过命令行参数传入，也可以通过位于config/目录下的配置文件指定，--env 参数可以指定使用哪个配置文件，例如--env=master 指定使用 master.ini。需要注意master需要指定监听的端口号 ，worker 需要指定监听端口号和master的 ip:port。 + +### 1.2 运行方法 + +在进入文件夹目录后输入./vermeer --env=master或./vermeer --env=worker01 + +## 二、任务创建类rest api + +### 2.1 简介 + +此类rest api提供所有创建任务的功能，包括读取图数据和多种计算功能，提供异步返回和同步返回两种接口。返回的内容均包含所创建任务的信息。使用vermeer的整体流程是先创建读取图的任务，待图读取完毕后创建计算任务执行计算。图不会自动被删除，在一个图上运行多个计算任务无需多次重复读取，如需删除可用删除图接口。任务状态可分为读取任务状态和计算任务状态。通常情况下客户端仅需了解创建、任务中、任务结束和任务错误四种状态。图状态是图是否可用的判断依据，若图正在读取中或图状态错误，无法使用该图创建计算任务。图删除接口仅在loaded和error状态且该图无计算任务时可用。 + +可以使用的url如下： + +- 异步返回接口 POST http://master_ip:port/tasks/create 仅返回任务创建是否成功，需通过主动查询任务状态判断是否完成。 +- 同步返回接口 POST http://master_ip:port/tasks/create/sync 在任务结束后返回。 + +### 2.2 加载图数据 + +具体参数参考Vermeer参数列表文档。 + +request示例： + +``` +POST http://10.81.116.77:8688/tasks/create Review Comment: ```suggestion POST http://localhost:8688/tasks/create ``` so as other ip ########## content/cn/docs/quickstart/hugegraph-vermeer.md: ########## @@ -0,0 +1,452 @@ +--- +title: "HugeGraph-Computer Quick Start" Review Comment: ```suggestion title: "HugeGraph-Vermeer Quick Start" ``` Also could add computer V2 (In-memory flag?) ########## content/cn/docs/quickstart/hugegraph-vermeer.md: ########## @@ -0,0 +1,452 @@ +--- +title: "HugeGraph-Computer Quick Start" +linkTitle: "使用 Vermeer 计算框架" +weight: 8 +--- + +## 一、Vermeer概述 + +### 1.1 运行架构 + +Vermeer是一个高性能计算框架，支持15+钟OLAP图算法的快速计算，包含msater和worker两种角色。master只有一个，worker可以有多个。 + +msater是负责通信、转发、汇总的节点，计算量和占用资源量较少。worker是计算节点，用于存储图数据和运行计算任务，占用大量内存和cpu。grpc和rest模块分别负责内部通信和外部调用。 + +该框架的运行配置可以通过命令行参数传入，也可以通过位于config/目录下的配置文件指定，--env 参数可以指定使用哪个配置文件，例如--env=master 指定使用 master.ini。需要注意master需要指定监听的端口号 ，worker 需要指定监听端口号和master的 ip:port。 + +### 1.2 运行方法 + +在进入文件夹目录后输入./vermeer --env=master或./vermeer --env=worker01 + +## 二、任务创建类rest api + +### 2.1 简介 + +此类rest api提供所有创建任务的功能，包括读取图数据和多种计算功能，提供异步返回和同步返回两种接口。返回的内容均包含所创建任务的信息。使用vermeer的整体流程是先创建读取图的任务，待图读取完毕后创建计算任务执行计算。图不会自动被删除，在一个图上运行多个计算任务无需多次重复读取，如需删除可用删除图接口。任务状态可分为读取任务状态和计算任务状态。通常情况下客户端仅需了解创建、任务中、任务结束和任务错误四种状态。图状态是图是否可用的判断依据，若图正在读取中或图状态错误，无法使用该图创建计算任务。图删除接口仅在loaded和error状态且该图无计算任务时可用。 + +可以使用的url如下： + +- 异步返回接口 POST http://master_ip:port/tasks/create 仅返回任务创建是否成功，需通过主动查询任务状态判断是否完成。 +- 同步返回接口 POST http://master_ip:port/tasks/create/sync 在任务结束后返回。 + +### 2.2 加载图数据 + +具体参数参考Vermeer参数列表文档。 + +request示例： + +``` Review Comment: ```suggestion ```javascript ``` so as other code blocks -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
