Merge branch 'v3.1.0' of github.com:vesoft-inc/nebula-docs-cn into v3…

….1.0
vesoft-inc · Apr 26, 2022 · 48051a7 · 48051a7
2 parents 6d6b1b2 + 987ec02
commit 48051a7
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 17 deletions.
diff --git a/docs-2.0/20.appendix/releasenote.md → docs-2.0/20.appendix/release-notes.md b/docs-2.0/20.appendix/releasenote.md → docs-2.0/20.appendix/release-notes.md
@@ -9,7 +9,7 @@
 - 优化路径以减少冗余路径和时间复杂度。[#4126](https://github.com/vesoft-inc/nebula/pull/4162) 
 - 优化获取属性的方式进而优化`MATCH`语句的性能。[#3750](https://github.com/vesoft-inc/nebula/pull/3750) 
 - 优化`GO`、`YIELD`子句，减少不必要的属性读取。[#3974](https://github.com/vesoft-inc/nebula/pull/3974) 
-- 支持获取属性时 Filter 及 Limit 下推。 [#3844](https://github.com/vesoft-inc/nebula/pull/3844) [#3839](https://github.com/vesoft-inc/nebula/pull/3839) 
+- 支持获取属性时 Filter 及`LIMIT`下推。 [#3844](https://github.com/vesoft-inc/nebula/pull/3844) [#3839](https://github.com/vesoft-inc/nebula/pull/3839) 
 - 支持`LOOKUP`聚合下推。[#3504](https://github.com/vesoft-inc/nebula/pull/3504) 
 - `maxHop`在匹配可变长度路径中是可选的。[#3881](https://github.com/vesoft-inc/nebula/pull/3881) 
 - 使用`DROP SPACE`之后图空间将进行物理删除。[#3913](https://github.com/vesoft-inc/nebula/pull/3913) 
@@ -28,7 +28,7 @@
 - 新增`KILL QUERY`的权限检查。当启用身份验证时，具有 GOD 角色的用户可以终止所有查询，而具有其他角色的用户只能终止自己的查询。[#3896](https://github.com/vesoft-inc/nebula/pull/3896) 
 - 新增 distcc、sccache 等编译方式的支持。[#3896](https://github.com/vesoft-inc/nebula/pull/3896) 
 - meta dump 工具支持更多可 dump 的表。[#3870](https://github.com/vesoft-inc/nebula/pull/3870) 
-- 存储层将写操作（INSERT VERTEX 或者 EDGE）的并发控制，从报错并要求客户端重试，改为内部排队，以便客户端更简单适配。[#3926](https://github.com/vesoft-inc/nebula/pull/3926)
+- 存储层将写操作（`INSERT VERTEX`或者`INSERT EDGE`）的并发控制，从报错并要求客户端重试，改为内部排队，以便客户端更简单适配。[#3926](https://github.com/vesoft-inc/nebula/pull/3926)
 
 ## 缺陷修复
 
@@ -39,8 +39,8 @@
 - 修复获取`profile`查询的 JSON 结果导致的崩溃问题。[#3998](https://github.com/vesoft-inc/nebula/pull/3998) 
 - 修复 Lambda 函数中的`async`接口运行完毕且`threadManager`中的任务未执行时的崩溃问题。[#4000](https://github.com/vesoft-inc/nebula/pull/4000) 
 - 修复`GROUP BY`输出的缺陷。[#4128](https://github.com/vesoft-inc/nebula/pull/4128) 
-- 修复`SHOW HOSTS`有时不能不显示版本的缺陷。[#4116](https://github.com/vesoft-inc/nebula/pull/4116) 
-- 修复`id(n) == $var`，`id(n) IN [$var]`， `id(n) == $var.foo.bar`， `id(n) IN $var.foo.bar`参数化的缺陷。[#4024](https://github.com/vesoft-inc/nebula/pull/4024) 
+- 修复`SHOW HOSTS`有时不能显示版本的缺陷。[#4116](https://github.com/vesoft-inc/nebula/pull/4116) 
+- 修复`id(n) == $var`，`id(n) IN [$var]`，`id(n) == $var.foo.bar`，`id(n) IN $var.foo.bar`参数化的缺陷。[#4024](https://github.com/vesoft-inc/nebula/pull/4024) 
 - 修复`MATCH...WHERE`中出现错误路径方向的缺陷。[#4091](https://github.com/vesoft-inc/nebula/pull/4091) 
 - 修复`WHERE`子句同时引用多`MATCH`变量结果显示不正确的缺陷。 [#4143](https://github.com/vesoft-inc/nebula/pull/4143) 
 - 修复优化规则的缺陷。[#4146](https://github.com/vesoft-inc/nebula/pull/4146) 

diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md
@@ -106,6 +106,7 @@ PROP
 REBUILD
 RECOVER
 REMOVE
+RESTART
 RETURN
 REVERSELY
 REVOKE

diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md
@@ -4,16 +4,16 @@ Nebula Graph 基于 [gflags](https://gflags.github.io/gflags/) 库打造了系
 
 !!! enterpriseonly
 
-    性能、参数、查询语句的调优方式及服务。
+    性能、参数、查询语句的调优方式及服务仅在企业版提供。
 
 !!! note
 
-    * 由于配置项数多且可能随着 Nebula Graph 的开发发生变化，文档不会介绍所有配置项。按下文说明可在命令行获取配置项的详细说明。
+    * 由于配置项多且可能随着 Nebula Graph 的开发发生变化，文档不会介绍所有配置项。按下文说明可在命令行获取配置项的详细说明。
     * 不建议修改文档未介绍的配置项，除非已经熟悉源代码并完全了解配置项的作用。
 
 !!! compatibility "历史版本兼容性"
 
-    1.x 版本的文档提供了使用 CONFIGS 命令修改缓存中配置的方法，但在生产环境中使用该方法容易导致集群配置与本地配置文件不一致。因此，2.x 版本的文档中将不再介绍 CONFIGS 命令的使用方法。
+    1.x 版本的文档提供了使用 CONFIGS 命令修改缓存中配置的方法，但在生产环境中使用该方法容易导致集群配置与本地配置文件不一致。因此，自 2.x 版本开始文档中将不再介绍 CONFIGS 命令的使用方法。
 
 ## 查看配置项列表与说明
 

diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md
@@ -101,7 +101,11 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb
 
 ## audit 配置
 
-仅 Nebula Graph 企业版支持审计日志功能。详细参数说明参见[审计日志](../2.log-management/audit-log.md)。
+!!! enterpriseonly
+
+    仅 Nebula Graph 企业版支持审计日志功能。
+
+详细参数说明参见[审计日志](../2.log-management/audit-log.md)。
 
 ## metrics 配置
 

diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md
@@ -193,10 +193,6 @@ rocksdb options 配置的格式为`{"<option_name>":"<option_value>"}`，多个
 | :------------------- | :------------------------ | :------------------------------------------ |
 | max_edge_returned_per_vertex | 2147483647 | 每个稠密点，最多返回多少条边，多余的边截断不返回。配置文件默认未设置。 |
 
-!!! compatibility
-
-    Nebula Graph 1.x 中的蓄水池采样方法在 Nebula Graph {{ nebula.release }} 不再支持。
-
 ## 数据量大而内存不够时
 
 如果数据量很大但内存不够，则推荐把 storage 配置中的 `enable_partitioned_index_filter` 设置为 `true`；但由于缓存了较少的 RocksDB 索引，性能会受影响。
diff --git a/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md b/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md
@@ -31,7 +31,7 @@
 
 ```bash
 [nebula-br]$ bin/br version
-Nebula Backup And Restore Utility Tool,V-0.6.0
+Nebula Backup And Restore Utility Tool,V-{{br.release}}
    GitSha: 079e7c7
    GitRef: master
 please run "help" subcommand for more infomation.

diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
@@ -18,6 +18,7 @@
   | 9090   | Prometheus 服务的端口。            |
   | 9200   | nebula-stats-exporter 服务的端口。 |
   | 9093   | Alertmanager 服务的端口。接收 Prometheus 告警，发送告警通知给 Dashboard。|
+  | 9100   | node-exporter 的服务端口。在集群创建后，自动部署在目标机器内，收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。   |
 
 - 准备 License。
 

diff --git a/docs-2.0/reuse/source_manage-service.md b/docs-2.0/reuse/source_manage-service.md
@@ -41,11 +41,11 @@ $ sudo /usr/local/nebula/scripts/nebula.service
 
 ## 使用 systemd 管理服务
 
-为方便使用，Nebula Graph 支持用 systemd 管理服务，通过`systemctl`启动、停止、重启和查看服务。
+为方便使用，Nebula Graph 企业版支持用 systemd 管理服务，通过`systemctl`启动、停止、重启和查看服务。
 
 !!! note
 
-    安装 Nebula Graph 后，systemd 所需的`.service`文件在安装目录的`etc/unit`目录内，使用 RPM/DEB 包安装的 Nebula Graph，会自动将这些`.service`文件放入`/usr/lib/systemd/system`目录内，并且`ExecStart`也会根据指定的 Nebula Graph 安装路径进行生成，因此可以直接使用`systemctl`命令。
+    安装 Nebula Graph 企业版后，systemd 所需的`.service`文件在安装目录的`etc/unit`目录内，使用 RPM/DEB 包安装的 Nebula Graph，会自动将这些`.service`文件放入`/usr/lib/systemd/system`目录内，并且`ExecStart`也会根据指定的 Nebula Graph 安装路径进行生成，因此可以直接使用`systemctl`命令。
 
     其他方式安装 Nebula Graph，需要用户手动将`.service`文件移动到`/usr/lib/systemd/system`目录内，并修改`.service`文件内的`ExecStart`的文件路径，才可以正常使用`systemctl`命令。
 

diff --git a/docs-2.0/synchronization-and-migration/replication-between-clusters.md b/docs-2.0/synchronization-and-migration/replication-between-clusters.md
@@ -277,13 +277,21 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。
   +-------------+
   ```
 
+## 停止/重启数据同步
+
+数据同步时，listener 会持续发送 WAL 给 drainer。
+
+如果需要停止数据同步，可以使用`stop sync`命令。此时 listener 会停止向 drainer 发送 WAL。
+
+如果需要重启数据同步，可以使用`restart sync`命令。此时 listener 会向 drainer 发送停止期间堆积的 WAL。如果 listener 上的 WAL 丢失， listener 会从主集群拉取快照重新进行同步。
+
 ## 切换主从集群
 
 如果因为业务需要进行数据迁移，或者灾备恢复后需要切换主从集群，需要手动进行切换。
 
 !!! note
 
-  在切换主从之前需要为新的主集群搭建并启动 listener 服务（示例 IP 为`192.168.10.105`），为新的从集群搭建并启动 drainer 服务（示例 IP 为`192.168.10.106`）。
+    在切换主从之前需要为新的主集群搭建并启动 listener 服务（示例 IP 为`192.168.10.105`），为新的从集群搭建并启动 drainer 服务（示例 IP 为`192.168.10.106`）。
 
 1. 登录主集群，取消 drainer 和 listener 服务。
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -97,7 +97,7 @@ extra:
     branch: release-3.1
     tag: v3.1.0
   dashboard:
-    release: 3.0.0
+    release: 1.1.0
     tag: v1.1.0
     base100: 1.0.0
     branch: v1.1.0
-Original file line number
+Diff line change
@@ Expand Up / @@ -106,6 +106,7 @@ PROP @@
     REBUILD
     RECOVER
     REMOVE
+    RESTART
     RETURN
     REVERSELY
     REVOKE
@@ Expand Down @@