Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions content/cn/docs/quickstart/hugegraph-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 1

### 1 HugeGraph-Server 概述

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

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

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

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

### 3 部署

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

**注意** 生产或对外网暴露访问的环境必须使用 Java 11 并开启 [Auth 权限认证](/cn/docs/config/config-authentication/), 否则会有安全隐患。

#### 3.1 使用 Docker 容器 (便于**测试**)
<!-- 3.1 is linked by another place. if change 3.1's title, please check -->

Expand Down Expand Up @@ -127,6 +127,10 @@ mvn package -DskipTests

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

<details>
<summary>过时的 tools 工具安装</summary>

```bash
#### 3.4 使用 tools 工具部署 (Outdated)

HugeGraph-Tools 提供了一键部署的命令行工具,用户可以使用该工具快速地一键下载、解压、配置并启动 HugeGraph-Server 和 HugeGraph-Hubble,最新的 HugeGraph-Toolchain 中已经包含所有的这些工具,直接下载它解压就有工具包集合了
Expand All @@ -148,6 +152,7 @@ bin/hugegraph deploy -v {hugegraph-version} -p {install-path} [-u {download-path
```

`{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` 即可。
</details>

### 4 配置

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

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

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

##### 5.1.1 RocksDB

Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/hugegraph-spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "HugeGraph-Spark Quick Start"
linkTitle: "(Deprecated) Analysis with HugeGraph-Spark"
draft: true
weight: 7
weight: 100
---

> Note: HugeGraph-Spark 已经停止维护, 不再更新, 请转向使用 hugegraph-computer, 感谢理解
Expand Down
43 changes: 22 additions & 21 deletions content/cn/docs/quickstart/hugegraph-vermeer.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: "HugeGraph-Vermeer Quick Start"
linkTitle: "使用 Vermeer 计算框架"
weight: 8
linkTitle: "(OLAP) Vermeer 内存图计算框架"
weight: 7
---

## 一、Vermeer 概述

### 1.1 运行架构

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

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

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

```javascript

POST http://localhost:8688/tasks/create
{
"task_type": "load",
Expand All @@ -60,7 +59,7 @@ POST http://localhost:8688/tasks/create

request 示例:

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

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -113,7 +112,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -135,7 +134,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -157,7 +156,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -179,7 +178,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -201,7 +200,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -227,7 +226,7 @@ POST http://localhost:8688/tasks/create

request 示例:

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

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -270,7 +269,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -292,7 +291,7 @@ POST http://localhost:8688/tasks/create

request 示例:

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

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -342,7 +341,7 @@ Jaccard index , 又称为 Jaccard 相似系数(Jaccard similarity coefficient

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -367,7 +366,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -392,7 +391,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -415,7 +414,7 @@ POST http://localhost:8688/tasks/create

request 示例:

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -435,7 +434,7 @@ POST http://localhost:8688/tasks/create

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

```
```javascript
POST http://localhost:8688/tasks/create
{
"task_type": "compute",
Expand All @@ -451,3 +450,5 @@ POST http://localhost:8688/tasks/create
}
```

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

15 changes: 9 additions & 6 deletions content/en/docs/quickstart/hugegraph-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 1

### 1 HugeGraph-Server Overview

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

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.

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

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

> Note: Using Java8 will lose some security guarantees, we recommend using Java11 in production or
>
> environments exposed to the public network and enable [Auth authentication](/docs/config/config-authentication/).
> Note: Using Java8 will lose some security guarantees, we recommend using Java11 in production

### 3 Deploy

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

**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).

#### 3.1 Use Docker container (Convenient for Test/Dev)

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

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

#### 3.4 One-click deployment
<details>
<summary> Outdated tools</summary>
#### 3.4 One-click deployment (Outdated)

`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.

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

`{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`.
</details>

### 4 Config

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

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.

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.
Follow the [Server Authentication Configuration](https://hugegraph.apache.org/docs/config/config-authentication/) before you start Server later.

##### 5.1.1 Memory

Expand Down
Loading