merge from 3.5 (vesoft-inc#2957)

* merge from 3.5 * Update 2.install-tools.md --------- Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>
cooper-lzy · Aug 11, 2023 · 4622746 · 4622746
1 parent c2b64f1
commit 4622746
Show file tree

Hide file tree

Showing 48 changed files with 635 additions and 404 deletions.
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -61,7 +61,7 @@ jobs:
 
       - name : prepare
         run: sh ./prepare.sh
-      # if 'both', set each file 'community' and 'enterprise' seperately.
+      # if 'both', set each file 'community' and 'enterprise' separately.
       - name: Update database_edition.yml
         run: |
           import yaml 

diff --git a/community_versions.json b/community_versions.json
@@ -1 +1 @@
-[{"version": "3.5.0", "title": "3.5.0", "aliases": []}, {"version": "3.4.1", "title": "3.4.1", "aliases": []},  {"version": "3.3.0", "title": "3.3.0", "aliases": []}, {"version": "3.2.1", "title": "3.2.1", "aliases": []}, {"version": "3.1.3", "title": "3.1.3", "aliases": []}, {"version": "3.0.2", "title": "3.0.2", "aliases": []}, {"version": "2.6.2", "title": "2.6.2", "aliases": []}, {"version": "master", "title": "master", "aliases": []}]
+[{"version": "3.5.0", "title": "3.5.0", "aliases": []},{"version": "3.4.2", "title": "3.4.2", "aliases": []},{"version": "3.4.1", "title": "3.4.1", "aliases": []}, {"version": "3.4.0", "title": "3.4.0", "aliases": []}, {"version": "3.3.0", "title": "3.3.0", "aliases": []}, {"version": "3.2.1", "title": "3.2.1", "aliases": []}, {"version": "3.1.3", "title": "3.1.3", "aliases": []}, {"version": "3.0.2", "title": "3.0.2", "aliases": []}, {"version": "2.6.2", "title": "2.6.2", "aliases": []}, {"version": "master", "title": "master", "aliases": []}]
diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md
@@ -110,7 +110,7 @@ Storage 服务是由 nebula-storaged 进程提供的，用户可以根据场景
 
 {{nebula.name}}使用强类型 Schema。
 
-对于点或边的属性信息，{{nebula.name}}会将属性信息编码后按顺序存储。由于属性的长度是固定的，查询时可以根据偏移量快速查询。在解码之前，需要先从 Meta 服务中查询具体的 Schema 信息（并缓存）。同时为了支持在线变更 Schema，在编码属性时，会加入对应的 Schema 版本信息。
+对于点或边的属性信息，{{nebula.name}}会将属性信息编码后按顺序存储。由于定长属性的长度是固定的，查询时可以根据偏移量快速查询。在解码之前，需要先从 Meta 服务中查询具体的 Schema 信息（并缓存）。同时为了支持在线变更 Schema，在编码属性时，会加入对应的 Schema 版本信息。
 
 ## 数据分片
 

diff --git a/docs-2.0/14.client/6.nebula-go-client.md b/docs-2.0/14.client/6.nebula-go-client.md
@@ -40,11 +40,11 @@ NebulaGraph GO 客户端提供 Connection Pool 和 Session Pool 两种使用方
 
 - Session Pool
 
-  详细示例请参见 [session_pool_example.go](https://github.com/vesoft-inc/nebula-go/blob/{{go.branch}}/session_pool_example/session_pool_example.go)。
+  详细示例请参见 [session_pool_example.go](https://github.com/vesoft-inc/nebula-go/blob/{{go.branch}}/examples/session_pool_example/session_pool_example.go)。
 
   使用限制请参见 [Usage example](https://github.com/vesoft-inc/nebula-go/blob/{{go.branch}}/README.md#usage-example)。
 
 - Connection Pool
 
-  详细示例请参见 [graph_client_basic_example](https://github.com/vesoft-inc/nebula-go/blob/{{go.branch}}/basic_example/graph_client_basic_example.go) 和 [graph_client_goroutines_example](https://github.com/vesoft-inc/nebula-go/blob/{{go.branch}}/gorountines_example/graph_client_goroutines_example.go)。
+  详细示例请参见 [graph_client_basic_example](https://github.com/vesoft-inc/nebula-go/blob/{{go.branch}}/examples/basic_example/graph_client_basic_example.go) 和 [graph_client_goroutines_example](https://github.com/vesoft-inc/nebula-go/blob/{{go.branch}}/examples/gorountines_example/graph_client_goroutines_example.go)。
 
diff --git a/docs-2.0/2.quick-start/1.quick-start-overview.md b/docs-2.0/2.quick-start/1.quick-start-overview.md
diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md
@@ -29,7 +29,7 @@
 
     {{nebula.name}} {{ nebula.release }} 与 历史版本 （包括{{nebula.name}} 1.x 和 2.x) 的数据格式、客户端通信协议均**双向不兼容**。
     使用**老版本**客户端连接**新版本**服务端，会导致服务进程**退出**。
-    数据格式升级参见[升级{{nebula.name}}历史版本至当前版本](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md)。
+    数据格式升级参见[升级{{nebula.name}}历史版本至当前版本](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-comm.md)。
     客户端与工具均需要[下载对应版本](../20.appendix/6.eco-tool-version.md)。
 
 {{ comm.comm_end }}
@@ -40,7 +40,7 @@
 
     {{nebula.name}} {{ nebula.release }} 与 历史版本 （包括{{nebula.name}} 1.x 和 2.x) 的数据格式、客户端通信协议均**双向不兼容**。
     使用**老版本**客户端连接**新版本**服务端，会导致服务进程**退出**。
-    数据格式升级参见[升级{{nebula.name}}历史版本至当前版本](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md)。
+    数据格式升级参见[升级{{nebula.name}}历史版本至当前版本](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent.md)。
     客户端与工具均需要[下载对应版本](../20.appendix/6.eco-tool-version.md)。
 
 {{ent.ent_end}}
@@ -53,15 +53,25 @@
 
 ## 关于执行报错
 
-### 如何处理错误信息 `SemanticError: Missing yield clause.`
+### 如何处理错误信息`-1005:GraphMemoryExceeded: (-2600）`
+
+这个错误是由 Memory Tracker 发出的，它在观察到内存使用超过了设定阈值时发出警报。这个机制可以帮助避免服务进程被系统的 OOM（Out of Memory）killer 终止。解决步骤：
+
+1. 检查内存使用情况：首先，你需要查看命令执行过程中的内存用量。如果内存使用量确实很高，那么这个错误可能是预期中的情况。
+
+2. 检查 Memory Tracker 的配置：如果内存使用量并不高，检查 Memory Tracker 的相关配置。这包括`memory_tracker_untracked_reserved_memory_mb`（未被跟踪的预留内存量，单位为 MB），`memory_tracker_limit_ratio`（内存限制比例），以及`memory_purge_enabled`（是否启用内存清理）。关于 Memory Tracker 的配置，参见 [memory tracker 配置](../5.configurations-and-logs/1.configurations/4.storage-config.md#memory_tracker)。
+
+3. 优化配置：根据实际情况，调整这些配置。例如，如果可用内存限制过低，可以调高`memory_tracker_limit_ratio`的值。
+
+### 如何处理错误信息`SemanticError: Missing yield clause`
 
 从{{nebula.name}} 3.0.0 开始，查询语句`LOOKUP`、`GO`、`FETCH`必须用`YIELD`子句指定输出结果。详情请参见[YIELD](../3.ngql-guide/8.clauses-and-options/yield.md)。
 
-### 如何处理错误信息 `Host not enough!`
+### 如何处理错误信息`Host not enough!`
 
 从 3.0.0 版本开始，在配置文件中添加的 Storage 节点无法直接读写，配置文件的作用仅仅是将 Storage 节点注册至 Meta 服务中。必须使用`ADD HOSTS`命令后，才能正常读写 Storage 节点。详情参见[管理 Storage 主机](../4.deployment-and-installation/manage-storage-host.md)。
 
-### 如何处理错误信息 `To get the property of the vertex in 'v.age', should use the format 'var.tag.prop'`
+### 如何处理错误信息`To get the property of the vertex in 'v.age', should use the format 'var.tag.prop'`
 
 从 3.0.0 版本开始，`pattern`支持同时匹配多个 Tag，所以返回属性时，需要额外指定 Tag 名称。即从`RETURN 变量名.属性名`改为`RETURN 变量名.Tag名.属性名`。
 
@@ -77,7 +87,7 @@
 
 -->
 
-### 如何处理错误信息 `Storage Error E_RPC_FAILURE`
+### 如何处理错误信息`Storage Error E_RPC_FAILURE`
 
 报错原因通常为 Graph 服务向 Storage 服务请求了过多的数据，导致 Storage 服务超时。请尝试以下解决方案：
 
@@ -87,7 +97,7 @@
 * 为 Storage 服务器提供性能更好的 SSD 或者内存。
 * 重试请求。
 
-### 如何处理错误信息 `The leader has changed. Try again later`
+### 如何处理错误信息`The leader has changed. Try again later`
 
 已知问题，通常需要重试 1-N 次 (N==partition 数量）。原因为 meta client 更新 leader 缓存需要 1-2 个心跳或者通过错误触发强制更新。
 
@@ -515,37 +525,7 @@ dmp 文件是错误报告文件，详细记录了进程退出的信息，可以
 
 如果修改过配置文件中预设的端口，请找出实际使用的端口并在防火墙中开放它们。
 
-周边工具各自使用不同的端口。以下是{{nebula.name}}内核及周边工具使用的默认端口信息：
-
-| 序号 | 所属产品/服务          | 类型 | 默认端口                      | 说明                                                         |
-| :--- | :--------------------- | :--- | :---------------------------- | :----------------------------------------------------------- |
-| 1    | {{nebula.name}}            | TCP  | 9669                          | Graph 服务的 RPC 守护进程监听端口（通常用于客户端连接Graph服务）。 |
-| 2    | {{nebula.name}}            | TCP  | 19669                         | Graph 服务的 HTTP 端口。                                     |
-| 3    | {{nebula.name}}            | TCP  | 19670                         | Graph 服务的 HTTP/2 端口。（3.x 后已弃用该端口）                    |
-| 4    | {{nebula.name}}            | TCP  | 9559                          | Meta 服务的 RPC 守护进程监听端口。（通常由 Graph 服务和 Storage 服务发起请求，用于获取和更新图数据库的元数据信息。 |
-| 5    | {{nebula.name}}            | TCP  | 9560                          | Meta 服务之间的 Raft 通信端口。                              |
-| 6    | {{nebula.name}}            | TCP  | 19559                         | Meta 服务的 HTTP 端口。                                      |
-| 7    | {{nebula.name}}            | TCP  | 19560                         | Meta 服务的 HTTP/2 端口。（3.x 后已弃用该端口）                     |
-| 8    | {{nebula.name}}            | TCP  | 9777                          | Storage 服务中，Drainer 服务占用端口（仅在企业版集群中暴露）。 |
-| 9    | {{nebula.name}}            | TCP  | 9778                          | Storage 服务中，Admin 服务占用端口。                         |
-| 10   | {{nebula.name}}            | TCP  | 9779                          | Storage 服务的 RPC 守护进程监听端口。（通常由 Graph 服务发起请求，用于执行数据存储相关的操作，例如读取、写入或删除数据。） |
-| 11   | {{nebula.name}}            | TCP  | 9780                          | Storage 服务之间的 Raft 通信端口。                           |
-| 12   | {{nebula.name}}            | TCP  | 19779                         | Storage 服务的 HTTP 端口。                                   |
-| 13   | {{nebula.name}}            | TCP  | 19780                         | Storage 服务的 HTTP/2 端口。（3.x 后已弃用该端口）                  |
-| 14   | {{nebula.name}}            | TCP  | 8888                          | 备份和恢复功能的 Agent 服务端口。Agent 是集群中每台机器的一个守护进程，用于启停{{nebula.name}}服务和上传、下载备份文件。 |
-| 15   | {{nebula.name}}            | TCP  | 9789、9790、9788 | 全文索引中 Raft Listener 的端口，从 Storage 服务读取数据，然后将它们写入 Elasticsearch 集群。<br/>也是集群间数据同步中 Storage Listener 的端口。用于同步主集群的 Storage 数据。端口 9790、9788 由端口 9789 加一减一后自动生成。 |
-| 16   | {{nebula.name}}            | TCP  | 9200                          | {{nebula.name}}使用该端口与 Elasticsearch 进行 HTTP 通信，以执行全文搜索查询和管理全文索引。 |
-| 17   | {{nebula.name}}            | TCP  | 9569、9570、9568| 集群间数据同步功能中 Meta Listener 的端口，用于同步主集群的 Meta 数据。端口 9570、9568 由端口 9569 加一减一后自动生成。 |
-| 18   | {{nebula.name}}            | TCP  | 9889、9890、9888 | 集群间数据同步功能中 Drainer 服务端口。用于同步 Storage、Meta 数据给从集群。端口 9890、9888 由端口 9889 加一减一后自动生成。|
-| 19   | NebulaGraph Studio     | TCP  | 7001                          | Studio 提供 Web 服务占用端口。                               |
-| 20   | {{dashboard_ent.name}} | TCP  | 8090                          | Nebula HTTP Gateway 依赖服务端口。为集群服务提供 HTTP 接口，执行 nGQL 语句与{{nebula.name}}数据库进行交互。 |
-| 21   | {{dashboard_ent.name}} | TCP  | 9200                          | Nebula Stats Exporter 依赖服务端口。收集集群的性能指标，包括服务 IP 地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟 等）。 |
-| 22   | {{dashboard_ent.name}} | TCP  | 9100                          | Node Exporter 依赖服务端口。收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。 |
-| 23   | {{dashboard_ent.name}} | TCP  | 9091                          | Prometheus 服务的端口。存储监控数据的时间序列数据库。        |
-| 24   | NebulaGraph Dashboard | TCP  | 7003                          | Dashboard 社区版 提供 Web 服务占用端口。                     |
-| 25   | {{dashboard_ent.name}} | TCP  | 7005                          | {{dashboard_ent.name}}提供 Web 服务占用端口。                     |
-| 26   | {{dashboard_ent.name}} | TCP  | 9093                          | Alertmanager 服务的端口。接收 Prometheus 告警，发送告警通知给{{dashboard_ent.name}}。 |
-| 27   | {{explorer.name}}  | TCP  | 7002                          | {{explorer.name}}提供的 Web 服务占用端口。                           |
+更多端口信息，参见[公司产品端口全集](port-guide.md)。
 
 ### 如何测试端口是否已开放？
 

diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md
@@ -166,7 +166,7 @@ NebulaGraph Console 是{{nebula.name}}的原生 CLI 客户端。如何使用请
 {{comm.comm_begin}}
 ## NebulaGraph Docker Compose
 
-Docker Compose 可以快速部署{{nebula.name}}集群。如何使用请参见 [Docker Compose 部署 NebulaGraph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)。
+Docker Compose 可以快速部署{{nebula.name}}集群。如何使用请参见 [Docker Compose 部署 NebulaGraph](../2.quick-start/1.quick-start-overview.md)。
 
 |{{nebula.name}}版本|Docker Compose 版本|
 |:---|:---|

diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md
@@ -97,7 +97,7 @@
 
   | 文档                                                         |
   | ------------------------------------------------------------ |
-  | [升级{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/) |
+  | [升级{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-comm/) |
 
 ### 3.3 配置Nebula
 
@@ -262,7 +262,7 @@
   |[图数据库在安全风控场景的应用 @BOSS 直聘](https://www.bilibili.com/video/BV1Rh41117G9)|
   |[更多文档](https://nebula-graph.com.cn/posts/)   、[视频](https://space.bilibili.com/472621355/channel/series)                |
 ## 6. 常见问题
-
+ 
   | 文档                                                         |
   | ------------------------------------------------------------ |
   | [常见问题 FAQ](https://docs.nebula-graph.com.cn/{{nebula.release}}/20.appendix/0.FAQ/#faq) |
@@ -302,4 +302,4 @@
 
 - 有关{{nebula.name}}语言的概述，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)中的 2.8 节。
 
-{{comm.comm_end}}
+{{comm.comm_end}}