Skip to content

Commit 67fe6f6

Browse files
imbajinimbajin
authored
doc: add EN for vermeer(OLAP) & server auth (#396)
1 parent 1df9227 commit 67fe6f6

File tree

5 files changed

+495
-32
lines changed

5 files changed

+495
-32
lines changed

‎content/cn/docs/quickstart/hugegraph-server.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 1
66

77
### 1 HugeGraph-Server 概述
88

9-
HugeGraph-Server 是 HugeGraph 项目的核心部分，包含 Core、Backend、API 等子模块。
9+
HugeGraph-Server 是 HugeGraph 项目的核心部分，包含 graph-core、backend、API 等子模块。
1010

1111
Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存储，目前支持的后端包括：Memory、Cassandra、ScyllaDB 以及 RocksDB，API 模块提供 HTTP Server，将 Client 的 HTTP 请求转化为对 Core 的调用。
1212

@@ -22,8 +22,6 @@ Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存
2222
**在往下阅读之前先执行 `java -version` 命令确认 jdk 版本**
2323

2424
> 注：使用 Java 8 启动 HugeGraph-Server 会失去一些**安全性**的保障，也会降低性能相关指标
25-
>
26-
> 我们推荐生产或对外网暴露访问的环境使用 Java 11 并考虑开启 [Auth 权限认证](/cn/docs/config/config-authentication/)。
2725
2826
### 3 部署
2927

@@ -34,6 +32,8 @@ Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存
3432
- 方式 3：源码编译
3533
- 方式 4：使用 tools 工具部署 (Outdated)
3634

35+
**注意** 生产或对外网暴露访问的环境必须使用 Java 11 并开启 [Auth 权限认证](/cn/docs/config/config-authentication/), 否则会有安全隐患。
36+
3737
#### 3.1 使用 Docker 容器 (便于**测试**)
3838
<!-- 3.1 is linked by another place. if change 3.1's title, please check -->
3939

@@ -127,6 +127,10 @@ mvn package -DskipTests
127127

128128
执行成功后，在 hugegraph 目录下生成 `*hugegraph-*.tar.gz` 文件，就是编译生成的 tar 包。
129129

130+
<details>
131+
<summary>过时的 tools 工具安装</summary>
132+
133+
```bash
130134
#### 3.4 使用 tools 工具部署 (Outdated)
131135
132136
HugeGraph-Tools 提供了一键部署的命令行工具，用户可以使用该工具快速地一键下载、解压、配置并启动 HugeGraph-Server 和 HugeGraph-Hubble，最新的 HugeGraph-Toolchain 中已经包含所有的这些工具，直接下载它解压就有工具包集合了
@@ -148,6 +152,7 @@ bin/hugegraph deploy -v {hugegraph-version} -p {install-path} [-u {download-path
148152
```
149153

150154
`{hugegraph-version}` 表示要部署的 HugeGraphServer 及 HugeGraphStudio 的版本，用户可查看 `conf/version-mapping.yaml` 文件获取版本信息，`{install-path}` 指定 HugeGraphServer 及 HugeGraphStudio 的安装目录，`{download-path-prefix}` 可选，指定 HugeGraphServer 及 HugeGraphStudio tar 包的下载地址，不提供时使用默认下载地址，比如要启动 0.6 版本的 HugeGraph-Server 及 HugeGraphStudio 将上述命令写为 `bin/hugegraph deploy -v 0.6 -p services` 即可。
155+
</details>
151156

152157
### 4 配置
153158

@@ -169,7 +174,7 @@ HugeGraphServer 启动时会连接后端存储并尝试检查后端存储版本
169174

170175
由于各种后端所需的配置（hugegraph.properties）及启动步骤略有不同，下面逐一对各后端的配置及启动做介绍。
171176

172-
如果想要使用 HugeGraph 鉴权模式，在后面正式启动 Server 之前应按照 [Server 鉴权配置](https://hugegraph.apache.org/cn/docs/config/config-authentication/) 进行配置。
177+
**注:** 如果想要开启 HugeGraph 权限系统，在启动 Server 之前应按照 [Server 鉴权配置](https://hugegraph.apache.org/cn/docs/config/config-authentication/) 进行配置。(尤其是生产环境/外网环境须开启)
173178

174179
##### 5.1.1 RocksDB
175180

‎content/cn/docs/quickstart/hugegraph-spark.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "HugeGraph-Spark Quick Start"
33
linkTitle: "(Deprecated) Analysis with HugeGraph-Spark"
44
draft: true
5-
weight: 7
5+
weight: 100
66
---
77

88
> Note: HugeGraph-Spark 已经停止维护, 不再更新, 请转向使用 hugegraph-computer, 感谢理解

‎content/cn/docs/quickstart/hugegraph-vermeer.md‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "HugeGraph-Vermeer Quick Start"
3-
linkTitle: "使用 Vermeer 计算框架"
4-
weight: 8
3+
linkTitle: "(OLAP) Vermeer 内存图计算框架"
4+
weight: 7
55
---
66

77
## 一、Vermeer 概述
88

99
### 1.1 运行架构
1010

11-
Vermeer 是一个 Go 编写的高性能内存优先的图计算框架，支持 15+ OLAP 图算法的极速计算，包含 master 和 worker 两种角色。master 目前只有一个，worker 可以有多个。
11+
Vermeer 是一个 `Go`编写的高性能内存优先的图计算框架 (一次启动，任意执行)，支持 15+ OLAP 图算法的极速计算 (大部分秒~分钟级别完成执行)，包含 master 和 worker 两种角色。master 目前只有一个 (可增加 HA)，worker 可以有多个。
1212

1313
master 是负责通信、转发、汇总的节点，计算量和占用资源量较少。worker 是计算节点，用于存储图数据和运行计算任务，占用大量内存和 cpu。grpc 和 rest 模块分别负责内部通信和外部调用。
1414

@@ -36,7 +36,6 @@ master 是负责通信、转发、汇总的节点，计算量和占用资源量
3636
request 示例：
3737

3838
```javascript
39-
4039
POST http://localhost:8688/tasks/create
4140
{
4241
"task_type": "load",
@@ -60,7 +59,7 @@ POST http://localhost:8688/tasks/create
6059

6160
request 示例：
6261

63-
```
62+
```javascript
6463
POST http://localhost:8688/tasks/create
6564
{
6665
"task_type": "compute",
@@ -91,7 +90,7 @@ PageRank 算法适用于网页排序、社交网络重点人物发掘等场景
9190

9291
request 示例：
9392

94-
```
93+
```javascript
9594
POST http://localhost:8688/tasks/create
9695
{
9796
"task_type": "compute",
@@ -113,7 +112,7 @@ POST http://localhost:8688/tasks/create
113112

114113
request 示例：
115114

116-
```
115+
```javascript
117116
POST http://localhost:8688/tasks/create
118117
{
119118
"task_type": "compute",
@@ -135,7 +134,7 @@ POST http://localhost:8688/tasks/create
135134

136135
request 示例：
137136

138-
```
137+
```javascript
139138
POST http://localhost:8688/tasks/create
140139
{
141140
"task_type": "compute",
@@ -157,7 +156,7 @@ POST http://localhost:8688/tasks/create
157156

158157
request 示例：
159158

160-
```
159+
```javascript
161160
POST http://localhost:8688/tasks/create
162161
{
163162
"task_type": "compute",
@@ -179,7 +178,7 @@ POST http://localhost:8688/tasks/create
179178

180179
request 示例：
181180

182-
```
181+
```javascript
183182
POST http://localhost:8688/tasks/create
184183
{
185184
"task_type": "compute",
@@ -201,7 +200,7 @@ POST http://localhost:8688/tasks/create
201200

202201
request 示例：
203202

204-
```
203+
```javascript
205204
POST http://localhost:8688/tasks/create
206205
{
207206
"task_type": "compute",
@@ -227,7 +226,7 @@ POST http://localhost:8688/tasks/create
227226

228227
request 示例：
229228

230-
```
229+
```javascript
231230
POST http://localhost:8688/tasks/create
232231
{
233232
"task_type": "compute",
@@ -248,7 +247,7 @@ K-Core 算法，标记所有度数为 K 的顶点，适用于图的剪枝，查
248247

249248
request 示例：
250249

251-
```
250+
```javascript
252251
POST http://localhost:8688/tasks/create
253252
{
254253
"task_type": "compute",
@@ -270,7 +269,7 @@ POST http://localhost:8688/tasks/create
270269

271270
request 示例：
272271

273-
```
272+
```javascript
274273
POST http://localhost:8688/tasks/create
275274
{
276275
"task_type": "compute",
@@ -292,7 +291,7 @@ POST http://localhost:8688/tasks/create
292291

293292
request 示例：
294293

295-
```
294+
```javascript
296295
POST http://localhost:8688/tasks/create
297296
{
298297
"task_type": "compute",
@@ -317,7 +316,7 @@ Vermeer 上实现的分布式 Louvain 算法受节点顺序、并行计算等因
317316

318317
request 示例：
319318

320-
```
319+
```javascript
321320
POST http://localhost:8688/tasks/create
322321
{
323322
"task_type": "compute",
@@ -342,7 +341,7 @@ Jaccard index , 又称为 Jaccard 相似系数（Jaccard similarity coefficient
342341

343342
request 示例：
344343

345-
```
344+
```javascript
346345
POST http://localhost:8688/tasks/create
347346
{
348347
"task_type": "compute",
@@ -367,7 +366,7 @@ POST http://localhost:8688/tasks/create
367366

368367
request 示例：
369368

370-
```
369+
```javascript
371370
POST http://localhost:8688/tasks/create
372371
{
373372
"task_type": "compute",
@@ -392,7 +391,7 @@ POST http://localhost:8688/tasks/create
392391

393392
request 示例：
394393

395-
```
394+
```javascript
396395
POST http://localhost:8688/tasks/create
397396
{
398397
"task_type": "compute",
@@ -415,7 +414,7 @@ POST http://localhost:8688/tasks/create
415414

416415
request 示例：
417416

418-
```
417+
```javascript
419418
POST http://localhost:8688/tasks/create
420419
{
421420
"task_type": "compute",
@@ -435,7 +434,7 @@ POST http://localhost:8688/tasks/create
435434

436435
在有向图的数学理论中，如果一个图的每一个顶点都可从该图其他任意一点到达，则称该图是强连通的。在任意有向图中能够实现强连通的部分我们称其为强连通分量。它表明各个点之间的连通性，区分不同的连通社区。
437436

438-
```
437+
```javascript
439438
POST http://localhost:8688/tasks/create
440439
{
441440
"task_type": "compute",
@@ -451,3 +450,5 @@ POST http://localhost:8688/tasks/create
451450
}
452451
```
453452

453+
> 🚧, 后续随时更新完善，欢迎随时提出建议和意见。
454+

‎content/en/docs/quickstart/hugegraph-server.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 1
66

77
### 1 HugeGraph-Server Overview
88

9-
`HugeGraph-Server` is the core part of the HugeGraph Project, contains submodules such as Core, Backend, API.
9+
`HugeGraph-Server` is the core part of the HugeGraph Project, contains submodules such as graph-core, backend, API.
1010

1111
The Core Module is an implementation of the Tinkerpop interface; The Backend module is used to save the graph data to the data store, currently supported backends include: Memory, Cassandra, ScyllaDB, RocksDB; The API Module provides HTTP Server, which converts Client's HTTP request into a call to Core Module.
1212

@@ -24,9 +24,7 @@ and configure by yourself.
2424

2525
**Be sure to execute the `java -version` command to check the jdk version before reading**
2626

27-
> Note: Using Java8 will lose some security guarantees, we recommend using Java11 in production or
28-
>
29-
> environments exposed to the public network and enable [Auth authentication](/docs/config/config-authentication/).
27+
> Note: Using Java8 will lose some security guarantees, we recommend using Java11 in production
3028
3129
### 3 Deploy
3230

@@ -37,6 +35,8 @@ There are four ways to deploy HugeGraph-Server components:
3735
- Method 3: Source code compilation
3836
- Method 4: One-click deployment
3937

38+
**Note:** If it's exposed to the public network, **must enable** [Auth authentication](/docs/config/config-authentication/) to ensure safety (so as the legacy version).
39+
4040
#### 3.1 Use Docker container (Convenient for Test/Dev)
4141

4242
<!-- 3.1 is linked by another place. if change 3.1's title, please check -->
@@ -145,7 +145,9 @@ The execution log is as follows:
145145

146146
After successful execution, `*hugegraph-*.tar.gz` files will be generated in the hugegraph directory, which is the tarball generated by compilation.
147147

148-
#### 3.4 One-click deployment
148+
<details>
149+
<summary> Outdated tools</summary>
150+
#### 3.4 One-click deployment (Outdated)
149151

150152
`HugeGraph-Tools` provides a command-line tool for one-click deployment, users can use this tool to quickly download, decompress, configure and start `HugeGraphServer` and `HugeGraph-Hubble` with one click.
151153

@@ -170,6 +172,7 @@ bin/hugegraph deploy -v {hugegraph-version} -p {install-path} [-u {download-path
170172
```
171173

172174
`{hugegraph-version}` indicates the version of HugeGraphServer and HugeGraphStudio to be deployed, users can view the `conf/version-mapping.yaml` file for version information, `{install-path}` specify the installation directory of HugeGraphServer and HugeGraphStudio, `{download-path-prefix}` optional, specify the download address of HugeGraphServer and HugeGraphStudio tarball, use default download URL if not provided, for example, to start HugeGraph-Server and HugeGraphStudio version 0.6, write the above command as `bin/hugegraph deploy -v 0.6 -p services`.
175+
</details>
173176

174177
### 4 Config
175178

@@ -190,7 +193,7 @@ If you need to access HugeGraphServer externally, please modify the `restserver.
190193

191194
Since the configuration (hugegraph.properties) and startup steps required by various backends are slightly different, the following will introduce the configuration and startup of each backend one by one.
192195

193-
If you want to use HugeGraph authentication mode, you should follow the [Server Authentication Configuration](https://hugegraph.apache.org/docs/config/config-authentication/) before you start Server later.
196+
Follow the [Server Authentication Configuration](https://hugegraph.apache.org/docs/config/config-authentication/) before you start Server later.
194197

195198
##### 5.1.1 Memory
196199

0 commit comments

Comments
 (0)