Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update enterprise in docs #1939

Merged
merged 10 commits into from
Jul 7, 2022
Merged
Show file tree
Hide file tree
Changes from 8 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
2 changes: 1 addition & 1 deletion docs-2.0/20.appendix/learning-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@
| 数据监控和运维 | [Nebula Dashboard 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard-ent/1.what-is-dashboard-ent/)和 [Nebula Dashboard 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/1.what-is-dashboard/) | [可视化监控 Nebula Dashboard](https://www.bilibili.com/video/BV1qQ4y1k7gb?) |
| 数据分析 | [Nebula Explorer 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/about-explorer/ex-ug-what-is-explorer/) | [可视化图探索 Nebula Explorer](https://www.bilibili.com/video/BV1fP4y1h7Fx?) |


- 数据导入与导出

| 导入与导出 | 文档 | 视频 |
Expand All @@ -189,6 +188,7 @@
| 数据导入 | [Nebula Exchange 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | [Nebula Graph 数据导入工具——Exchange](https://www.bilibili.com/video/BV1Pq4y177D9)、[Exchange 导入 SST 数据](https://www.bilibili.com/video/BV1y34y1o7Di?) |
| 数据导出 | [Nebula Exchange 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | - |


- 备份与恢复

| 文档 | 视频 |
Expand Down
3 changes: 3 additions & 0 deletions docs-2.0/20.appendix/release-note.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Nebula Graph {{ nebula.release }} release notes

{{ ent.ent_begin }}
## 企业版

### 功能
Expand Down Expand Up @@ -65,3 +66,5 @@
## 历史版本

[历史版本](https://nebula-graph.com.cn/tags/release-note/)

{{ ent.ent_end }}
3 changes: 3 additions & 0 deletions docs-2.0/3.ngql-guide/4.job-statements.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

所有作业管理命令都需要先选择图空间后才能执行。

{{ ent.ent_begin }}
## SUBMIT JOB BALANCE DATA

!!! enterpriseonly
Expand All @@ -31,6 +32,8 @@ nebula> SUBMIT JOB BALANCE DATA;
+------------+
```

{{ ent.ent_end }}

<!-- balance-3.1
## SUBMIT JOB BALANCE IN ZONE

Expand Down
10 changes: 9 additions & 1 deletion docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,18 @@
- 图空间中的数据量越大,`CLEAR SPACE`消耗的时间越长。如果`CLEAR SPACE`的执行因客户端连接超时而失败,可以增大 [Graph 服务配置](../../5.configurations-and-logs/1.configurations/3.graph-config.md)中`storage_client_timeout_ms`参数的值。
- 在`CLEAR SPACE`的执行过程中,向该图空间写入数据的行为不会被自动禁止。这样的写入行为可能导致`CLEAR SPACE`清除数据不完全,残留的数据也可能受到损坏。

!!! enterpriseonly
!!! note

- 社区版 Nebula Graph 不支持在运行`CLEAR SPACE`的同时禁止写入。

{{ ent.ent_begin }}

!!! enterpriseonly

- 企业版 Nebula Graph 支持先运行`SET VARIABLE read_only=true`阻止向 Nebula Graph 写入数据,再运行`CLEAR SPACE`。数据清除成功后运行`SET VARIABLE read_only=false`即可重新允许写入。

{{ ent.ent_end }}

## 语法

```ngql
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Nebula Graph 是针对 NVMe SSD 进行设计和实现的,所有默认参数都

企业版支持在 ARM 架构(包括 Apple Mac M1 和华为鲲鹏)上运行。访问官网获取[商业支持](https://nebula-graph.com.cn/pricing/)。


!!! note

社区用户可以在 ARM MacOS 的 Docker Desktop 上或者 ARM Linux Server 上运行容器化的 Nebula Graph。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,9 @@ master 分支的代码更新速度快,如果安装了 master 分支对应的

## 下一步

{{ ent.ent_begin }}
- (企业版)[设置 License](../deploy-license.md)
{{ ent.ent_end }}

- [管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@

## 下一步

{{ ent.ent_begin }}
- (企业版)[设置 License](../deploy-license.md)

{{ ent.ent_end }}

- [管理 Nebula Graph 服务](../manage-service.md)
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
# 使用生态工具安装 Nebula Graph

用户可以使用以下生态工具安装企业版和社区版的 Nebula Graph:
用户可以使用以下生态工具安装 Nebula Graph:

{{ ent.ent_begin }}
- 企业版 Nebula Dashboard

{{ ent.ent_end }}

- Nebula Operator

## 安装详情

{{ ent.ent_begin }}
- 使用**企业版 Nebula Dashboard** 安装 Nebula Graph 的详情,参见[创建集群](../../nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md)。

{{ ent.ent_end }}

- 使用 **Nebula Operator** 安装 Nebula Graph 的详情,参见[使用 Kubectl 部署 Nebula Graph 集群](../../nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) 或 [使用 Helm 部署 Nebula Graph 集群](../../nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。

{{ ent.ent_begin }}

!!! note

联系销售([[email protected]](mailto:[email protected]))获取企业版 Nebula Graph 的安装包。

{{ ent.ent_end }}
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@ Nebula Graph 不提供官方的集群部署工具,用户可以使用 RPM 或 D

## 手动部署流程

### 1. 安装 Nebula Graph
### 安装 Nebula Graph

在集群的每一台服务器上都安装 Nebula Graph,安装后暂不需要启动服务。安装方式请参见:

- [使用 RPM 或 DEB 包安装 Nebula Graph](2.install-nebula-graph-by-rpm-or-deb.md)

- [使用源码安装 Nebula Graph](1.install-nebula-graph-by-compiling-the-source-code.md)

### 2.(企业版)设置 License。
{{ ent.ent_begin }}
### (企业版)设置 License。

- 如果部署企业版 Nebula Graph,需要设置 License。详情请参见[设置 Nebula Graph 企业版 License](../../4.deployment-and-installation/deploy-license.md)。
如果部署企业版 Nebula Graph,需要设置 License。详情请参见[设置 Nebula Graph 企业版 License](../../4.deployment-and-installation/deploy-license.md)。

- 如果部署社区版 Nebula Graph,略过此步骤。

### 3. 修改配置文件
{{ ent.ent_end }}
### 修改配置文件

修改每个服务器上的 Nebula Graph 配置文件。

Expand Down Expand Up @@ -261,7 +261,7 @@ Nebula Graph 的所有配置文件均位于安装目录的`etc`目录内,包
--port=9779
```

### 4. 启动集群
### 启动集群

依次启动**各个服务器**上的对应进程。

Expand All @@ -287,7 +287,7 @@ sudo /usr/local/nebula/scripts/nebula.service start <metad|graphd|storaged|all>

- `/usr/local/nebula`是 Nebula Graph 的默认安装路径,如果修改过安装路径,请使用实际路径。更多启停服务的内容,请参见[管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md)。

### 5. 检查集群
### 检查集群

安装原生 CLI 客户端 [Nebula Console](../../2.quick-start/3.connect-to-nebula-graph.md#_1),然后连接任何一个已启动 graphd 进程的机器,添加 Storage 主机,然后执行命令`SHOW HOSTS`检查集群状态。例如:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

Nebula Graph 基于 [gflags](https://gflags.github.io/gflags/) 库打造了系统配置,多数配置项都是其中的 flags。Nebula Graph 服务启动时,默认会从[配置文件](#_4)中获取配置信息。对于文件中没有的配置项,系统使用默认值。

{{ ent.ent_begin }}

!!! enterpriseonly

性能、参数、查询语句的调优方式及服务仅在企业版提供。

{{ ent.ent_end }}

!!! note

* 由于配置项多且可能随着 Nebula Graph 的开发发生变化,文档不会介绍所有配置项。按下文说明可在命令行获取配置项的详细说明。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,27 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul

## basics 配置

{{ commu.commu_begin }}

| 名称 | 预设值 | 说明 |
| :----------- | :----------------------- | :------------------|
| `daemonize` | `true` | 是否启动守护进程。 |
| `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 |
| `timezone_name` | - | 指定 Nebula Graph 的时区。初始配置文件中未设置该参数,如需使用请手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如,东八区的设置方式为`--timezone_name=UTC+08:00`。 |

{{ commu.commu_end }}

{{ ent.ent_begin }}

foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
| 名称 | 预设值 | 说明 |
| :----------- | :----------------------- | :------------------|
| `daemonize` | `true` | 是否启动守护进程。 |
| `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 |
| `timezone_name` | - | 指定 Nebula Graph 的时区。初始配置文件中未设置该参数,如需使用请手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如,东八区的设置方式为`--timezone_name=UTC+08:00`。 |
|`license_path`|`share/resources/nebula.license`|企业版 License 路径。企业版需要用户[设置 License](../../4.deployment-and-installation/deploy-license.md) 才可以正常启动并使用企业版功能。仅企业版 Nebula Graph 需要设置本参数,其他周边工具如何设置 License,请参见相应周边工具的部署文档。|

{{ ent.ent_end }}

!!! Note

* 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md)的属性值时,Nebula Graph 会根据`timezone_name`设置的时区将该时间值(TIMESTAMP 类型例外)转换成相应的 UTC 时间,因此在查询中返回的时间类型属性值为 UTC 时间。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb
| ------------------- | ------------------------ | ------------------------------------------ |
| `system_memory_high_watermark_ratio` | `0.8` |内存高水位报警机制的触发阈值。系统内存占用率高于该值会触发报警机制,Nebula Graph 会停止接受查询。|

{{ ent.ent_begin }}
## audit 配置

!!! enterpriseonly
Expand All @@ -108,6 +109,8 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb

详细参数说明参见[审计日志](../2.log-management/audit-log.md)。

{{ ent.ent_end }}

## metrics 配置

| 名称 | 预设值 | 说明 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,8 @@ rocksdb options 配置的格式为`{"<option_name>":"<option_value>"}`,多个

参数的详细说明请参见 [RocksDB 官方文档](https://rocksdb.org/)。

{{ ent.ent_begin }}

## storage cache 配置

!!! enterpriseonly
Expand All @@ -189,6 +191,8 @@ rocksdb options 配置的格式为`{"<option_name>":"<option_value>"}`,多个
| `empty_key_pool_capacity` | `50` | empty_key 缓存池的大小。 单位:兆字节。 |
| `empty_key_item_ttl` | `300` | empty_key 缓存条目的有效时间。单位:秒。 |

{{ ent.ent_end }}

## 超级节点处理(出入边数量极多的点)

在每个点出发的查询获取到边时,直接截断。目的是避免超级节点的邻边过多,单个查询占用过多的硬盘和内存。截取前 `max_edge_returned_per_vertex` 个边,多余的边不返回。该参数作用于全局,不用于单个 space。
Expand Down
4 changes: 4 additions & 0 deletions docs-2.0/7.data-security/1.authentication/1.authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Nebula Graph 支持两种身份验证方式:本地身份验证和 LDAP 验证

开启身份验证后,默认的 God 角色账号为`root`,密码为`nebula`。角色详情请参见[内置角色权限](3.role-list.md)。

{{ ent.ent_begin }}

## OpenLDAP 验证

OpenLDAP 是轻型目录访问协议(LDAP)的开源实现,可以实现账号集中管理。
Expand All @@ -39,3 +41,5 @@ OpenLDAP 是轻型目录访问协议(LDAP)的开源实现,可以实现账
!!! Enterpriseonly

当前仅企业版支持集成 OpenLDAP 进行身份验证,详情请参见[使用 OpenLDAP 进行身份验证](4.ldap.md)。

{{ ent.ent_end }}
63 changes: 62 additions & 1 deletion docs-2.0/7.data-security/1.authentication/2.management-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,39 @@

执行`CREATE USER`语句可以创建新的 Nebula Graph 用户。当前仅** God **角色用户(即`root`用户)能够执行`CREATE USER`语句。

{{ commu.commu_begin }}

- 语法

```ngql
CREATE USER [IF NOT EXISTS] <user_name> [WITH PASSWORD '<password>'];
```

- `IF NOT EXISTS`:检测待创建的用户名是否存在,只有不存在时,才会创建新用户。
- `user_name`:待创建的用户名。
- `password`:用户名对应的密码。

- 示例

```ngql
nebula> CREATE USER user1 WITH PASSWORD 'nebula';
nebula> SHOW USERS;
+---------+-------------------------------+
| Account | IP Whitelist |
+---------+-------------------------------+
| "root" | "" |
| "user1" | "" |
+---------+-------------------------------+
```

{{ commu.commu_end }}

{{ ent.ent_begin }}

- 语法

```ngql
CREATE USER [IF NOT EXISTS] <user_name> [WITH PASSWORD '<password>'] [WITH IP WHITELIST <ip_list>];
CREATE USER [IF NOT EXISTS] <user_name> [WITH PASSWORD '<password>'][WITH IP WHITELIST <ip_list>];
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
```

- `IF NOT EXISTS`:检测待创建的用户名是否存在,只有不存在时,才会创建新用户。
Expand All @@ -38,6 +67,7 @@
| "user2" | "192.168.10.10,192.168.10.12" |
+---------+-------------------------------+
```
{{ ent.ent_end }}

## 授权用户(`GRANT ROLE`)

Expand Down Expand Up @@ -130,6 +160,36 @@
nebula> CHANGE PASSWORD user1 FROM 'nebula' TO 'nebula123';
```

{{ commu.commu_begin }}
## 修改用户密码(`ALTER USER`)

执行`ALTER USER`语句可以修改用户密码,修改时不需要提供旧密码。当前仅** God **角色用户(即`root`用户)能够执行`ALTER USER`语句。

- 语法

```ngql
ALTER USER <user_name> WITH PASSWORD '<password>';
```

foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
- 示例

```ngql
nebula> ALTER USER user2 WITH PASSWORD 'nebula';
nebula> SHOW USERS;
+---------+--------------+
| Account | IP Whitelist |
+---------+--------------+
| "root" | "" |
| "user1" | "" |
| "user2" | "" |
+---------+--------------+

```

{{ commu.commu_end }}

{{ ent.ent_begin }}

## 修改用户密码和 IP 白名单(`ALTER USER`)

执行`ALTER USER`语句可以修改用户密码和 IP 白名单,修改时不需要提供旧密码。当前仅** God **角色用户(即`root`用户)能够执行`ALTER USER`语句。
Expand Down Expand Up @@ -159,6 +219,7 @@

nebula> ALTER USER user2 WITH PASSWORD 'nebula' WITH IP WHITELIST 192.168.10.10;
```
{{ ent.ent_end }}

## 删除用户(`DROP USER`)

Expand Down
3 changes: 3 additions & 0 deletions docs-2.0/8.service-tuning/load-balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

`BALANCE`命令通过创建和执行一组子任务来迁移数据和均衡分片分布,**禁止**停止集群中的任何机器或改变机器的 IP 地址,直到所有子任务完成,否则后续子任务会失败。

{{ ent.ent_begin }}
## 均衡分片分布

!!! enterpriseonly
Expand Down Expand Up @@ -83,6 +84,8 @@

如果有子任务失败,请执行`RECOVER JOB <job_id>`。如果重做负载均衡仍然不能解决问题,请到[Nebula Graph社区](https://discuss.nebula-graph.com.cn/)寻求帮助。

{{ ent.ent_end }}

### 停止负载均衡作业

停止负载均衡作业,请执行命令`STOP JOB <job_id>`。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@
|`tags.path`|string|-|是|指定需要生成 SST 文件的源文件的路径。|
|`tags.repartitionWithNebula`|bool|`false`|否|生成 SST 文件时是否要基于 Nebula Graph 中图空间的 partition 进行数据重分区。开启该功能可减少 DOWNLOAD 和 INGEST SST 文件需要的时间。当图空间的分片数量(partition_num)大于`1`时,请设置为`true`,否则可能会导致生成的数据文件中只包含无 Tag 的点。|

{{ ent.ent_begin }}
### Nebula Graph 源特有参数

!!! enterpriseonly
Expand All @@ -198,6 +199,8 @@
|`tags.noField`|bool|`false`|是|当值为`true`时,仅导出 VID 而不导出属性数据;当值为`false`时导出 VID 和属性数据。|
|`tags.return.fields`|list|`[]`|是|指定要导出的属性。例如,要导出`name`和`age`属性,需将参数值设置为`["name","age"]`。该参数仅在`tags.noField`的值为`false`时生效。|

{{ ent.ent_end }}

## 边配置

对于不同的数据源,边的配置也有所不同,有很多通用参数,也有部分特有参数,配置时需要配置通用参数和不同数据源的特有参数。
Expand Down
Loading