diff --git a/docs-2.0-en/20.appendix/port-guide.md b/docs-2.0-en/20.appendix/port-guide.md index 55d7e2fcb3d..7b2f69c9b52 100644 --- a/docs-2.0-en/20.appendix/port-guide.md +++ b/docs-2.0-en/20.appendix/port-guide.md @@ -4,26 +4,23 @@ The following are the default ports used by NebulaGraph core and peripheral tool | No. | Product / Service | Type | Default | Description | | :--- | :--------------------- | :--- | :---------------------------- | :----------------------------------------------------------- | -| 1 | NebulaGraph | TCP | 9669 | Graph service RPC daemon listening port (commonly used for client connections to the Graph service). | +| 1 | NebulaGraph | TCP | 9669 | Graph service RPC daemon listening port. Commonly used for client connections to the Graph service. | | 2 | NebulaGraph | TCP | 19669 | Graph service HTTP port. | | 3 | NebulaGraph | TCP | 19670 | Graph service HTTP/2 port. (Deprecated after version 3.x) | -| 4 | NebulaGraph | TCP | 9559 | Meta service RPC daemon listening port. (Commonly used by Graph and Storage services for querying and updating metadata in the graph database). | -| 5 | NebulaGraph | TCP | 9560 | Raft communication port between Meta services. | -| 6 | NebulaGraph | TCP | 19559 | Meta service HTTP port. | -| 7 | NebulaGraph | TCP | 19560 | Meta service HTTP/2 port. (Deprecated after version 3.x) | -| 8 | NebulaGraph | TCP | 9778 | Admin service port in Storage services. | -| 9 | NebulaGraph | TCP | 9779 | Storage service RPC daemon listening port. (Commonly used by Graph services for data storage-related operations, such as reading, writing, or deleting data). | -| 10 | NebulaGraph | TCP | 9780 | Raft communication port between Storage services. | -| 11 | NebulaGraph | TCP | 19779 | Storage service HTTP port. | -| 12 | NebulaGraph | TCP | 19780 | Storage service HTTP/2 port. (Deprecated after version 3.x) | -| 13 | NebulaGraph | TCP | 8888 | Backup and restore Agent service port. The Agent is a daemon running on each machine in the cluster, responsible for starting and stopping NebulaGraph services and uploading and downloading backup files. | -| 14 | NebulaGraph | TCP | 9789, 9790, and 9788 | Full-text index Raft Listener port, which reads data from Storage services and writes it to the Elasticsearch cluster.
Also the port for Storage Listener in inter-cluster data synchronization, used for synchronizing Storage data from the primary cluster. Ports 9790 and 9788 are generated by adding and subtracting one from port 9789. | -| 15 | NebulaGraph | TCP | 9200 | NebulaGraph uses this port for HTTP communication with Elasticsearch to perform full-text search queries and manage full-text indexes. | -| 16 | NebulaGraph | TCP | 9569, 9570, and 9568| Meta Listener port in inter-cluster data synchronization, used for synchronizing Meta data from the primary cluster. Ports 9570 and 9568 are generated by adding and subtracting one from port 9569. | -| 17 | NebulaGraph | TCP | 9889, 9890, and 9888 |Drainer service port in inter-cluster data synchronization, used for synchronizing Storage and Meta data to the primary cluster. Ports 9890 and 9888 are generated by adding and subtracting one from port 9889. | -| 18 | NebulaGraph Studio | TCP | 7001 | Studio web service port. | -| 19 | NebulaGraph Dashboard | TCP | 8090 | Nebula HTTP Gateway dependency service port. Provides an HTTP interface for cluster services to interact with the NebulaGraph database using nGQL statements.0 | -| 21 | NebulaGraph Dashboard | TCP | 9200 | Nebula Stats Exporter dependency service port. Collects cluster performance metrics, including service IP addresses, versions, and monitoring metrics (such as query count, query latency, heartbeat latency, etc.). | -| 21 | NebulaGraph Dashboard | TCP | 9100 | Node Exporter dependency service port. Collects resource information for machines in the cluster, including CPU, memory, load, disk, and traffic. | -| 22 | NebulaGraph Dashboard | TCP | 9090 | Prometheus service port. Time-series database for storing monitoring data. | -| 23 | NebulaGraph Dashboard | TCP | 7003 | Dashboard Community Edition web service port. | +| 4 | NebulaGraph | TCP | 9559, 9560 | `9559` is the RPC daemon listening port for Meta service. Commonly used by Graph and Storage services for querying and updating metadata in the graph database.
The neighboring `+1` (`9560`) port is used for Raft communication between Meta services.| +| 5 | NebulaGraph | TCP | 19559 | Meta service HTTP port. | +| 6 | NebulaGraph | TCP | 19560 | Meta service HTTP/2 port. (Deprecated after version 3.x) | +| 7 | NebulaGraph | TCP | 9779, 9778, 9780 | `9779` is the RPC daemon listening port for Storage service. Commonly used by Graph services for data storage-related operations, such as reading, writing, or deleting data.
The neighboring ports `-1` (`9778`) and `+1` (`9780`) are also used.
`9778`: The port used by the Admin service, which receives Meta commands for Storage.
`9780`: The port used for Raft communication between Storage services. | +| 8 | NebulaGraph | TCP | 19779 | Storage service HTTP port. | +| 9 | NebulaGraph | TCP | 19780 | Storage service HTTP/2 port. (Deprecated after version 3.x) | +| 10 | NebulaGraph | TCP | 8888 | Backup and restore Agent service port. The Agent is a daemon running on each machine in the cluster, responsible for starting and stopping NebulaGraph services and uploading and downloading backup files. | +| 11 | NebulaGraph | TCP | 9789, 9788, 9790 | `9789` is the Raft Listener port for Full-text index, which reads data from Storage services and writes it to the Elasticsearch cluster.
Also the port for Storage Listener in inter-cluster data synchronization, used for synchronizing Storage data from the primary cluster.
The neighboring ports `-1` (`9788`) and `+1` (`9790`) are also used.
`9788`: An internal port.
`9790`: The port used for Raft communication. | +| 12 | NebulaGraph | TCP | 9200 | NebulaGraph uses this port for HTTP communication with Elasticsearch to perform full-text search queries and manage full-text indexes. | +| 13 | NebulaGraph | TCP | 9569, 9568, 9570| `9569` is the Meta Listener port in inter-cluster data synchronization, used for synchronizing Meta data from the primary cluster.
The neighboring ports `-1` (`9568`) and `+1` (`9570`) are also used.
`9568`: An internal port.
`9570`: The port used for Raft communication. | +| 14 | NebulaGraph | TCP | 9889, 9888, 9890 |Drainer service port in inter-cluster data synchronization, used for synchronizing Storage and Meta data to the primary cluster.
The neighboring ports `-1` (`9888`) and `+1` (`9890`) are also used.
`9888`: An internal port.
`9890`: The port used for Raft communication. | +| 15 | NebulaGraph Studio | TCP | 7001 | Studio web service port. | +| 16 | NebulaGraph Dashboard | TCP | 8090 | Nebula HTTP Gateway dependency service port. Provides an HTTP interface for cluster services to interact with the NebulaGraph database using nGQL statements.0 | +| 17 | NebulaGraph Dashboard | TCP | 9200 | Nebula Stats Exporter dependency service port. Collects cluster performance metrics, including service IP addresses, versions, and monitoring metrics (such as query count, query latency, heartbeat latency, etc.). | +| 18 | NebulaGraph Dashboard | TCP | 9100 | Node Exporter dependency service port. Collects resource information for machines in the cluster, including CPU, memory, load, disk, and traffic. | +| 19 | NebulaGraph Dashboard | TCP | 9090 | Prometheus service port. Time-series database for storing monitoring data. | +| 20 | NebulaGraph Dashboard | TCP | 7003 | Dashboard Community Edition web service port. | diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md index 5af658343f0..9285c3a551c 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md @@ -54,7 +54,7 @@ For all parameters and their current values, see [Configurations](1.configuratio | :----------------------- | :---------------- | :---------------------------------------------------- |:----------------- | | `meta_server_addrs` | `127.0.0.1:9559` | Specifies the IP addresses and ports of all Meta Services. Multiple addresses are separated with commas. | No| |`local_ip` | `127.0.0.1` | Specifies the local IP for the Meta Service. The local IP address is used to identify the nebula-metad process. If it is a distributed cluster or requires remote access, modify it to the corresponding address.| No| -| `port` | `9559` | Specifies RPC daemon listening port of the Meta service. The external port for the Meta Service is predefined to `9559`. The internal port is predefined to `port + 1`, i.e., `9560`. Nebula Graph uses the internal port for multi-replica interactions. | No| +| `port` | `9559` | Specifies RPC daemon listening port of the Meta service. The neighboring `+1` (`9560`) port is used for Raft communication between Meta services. | No| | `ws_ip` | `0.0.0.0` | Specifies the IP address for the HTTP service. | No| | `ws_http_port` | `19559` | Specifies the port for the HTTP service. | No| |`ws_storage_http_port`|`19779`| Specifies the Storage service listening port used by the HTTP protocol. It must be consistent with the `ws_http_port` in the Storage service configuration file. This parameter only applies to standalone NebulaGraph.| No| diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md index 331e4ca79b7..98b273a3d9d 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -59,7 +59,7 @@ For all parameters and their current values, see [Configurations](1.configuratio | :----------------------- | :---------------- | :---------------------------------------------------- |:------------------| | `meta_server_addrs` | `127.0.0.1:9559` | Specifies the IP addresses and ports of all Meta Services. Multiple addresses are separated with commas. | No| |`local_ip` | `127.0.0.1` | Specifies the local IP for the Storage Service. The local IP address is used to identify the nebula-storaged process. If it is a distributed cluster or requires remote access, modify it to the corresponding address.| No| -| `port` | `9779` | Specifies RPC daemon listening port of the Storage service. The external port for the Meta Service is predefined to `9779`. The internal port is predefined to `9777`, `9778`, and `9780`. Nebula Graph uses the internal port for multi-replica interactions.
`9778`: The port used by the Admin service, which receives Meta commands for Storage. `9780`: The port used for Raft communication.| No| +| `port` | `9779` | Specifies RPC daemon listening port of the Storage service. The neighboring ports `-1` (`9778`) and `+1` (`9780`) are also used.
`9778`: The port used by the Admin service, which receives Meta commands for Storage.
`9780`: The port used for Raft communication between Storage services.| No| | `ws_ip` | `0.0.0.0` | Specifies the IP address for the HTTP service. | No| | `ws_http_port` | `19779` | Specifies the port for the HTTP service. | No| |`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise NebulaGraph **CANNOT** work normally. This configuration is measured in seconds. | Yes| diff --git a/docs-2.0-zh/20.appendix/port-guide.md b/docs-2.0-zh/20.appendix/port-guide.md index 92c3092653e..93d224f93ca 100644 --- a/docs-2.0-zh/20.appendix/port-guide.md +++ b/docs-2.0-zh/20.appendix/port-guide.md @@ -4,26 +4,23 @@ | 序号 | 所属产品/服务 | 类型 | 默认端口 | 说明 | | :--- | :--------------------- | :--- | :---------------------------- | :----------------------------------------------------------- | -| 1 | {{nebula.name}} | TCP | 9669 | Graph 服务的 RPC 守护进程监听端口（通常用于客户端连接Graph服务）。 | +| 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 | 9778 | Storage 服务中，Admin 服务占用端口。 | -| 9 | {{nebula.name}} | TCP | 9779 | Storage 服务的 RPC 守护进程监听端口。（通常由 Graph 服务发起请求，用于执行数据存储相关的操作，例如读取、写入或删除数据。） | -| 10 | {{nebula.name}} | TCP | 9780 | Storage 服务之间的 Raft 通信端口。 | -| 11 | {{nebula.name}} | TCP | 19779 | Storage 服务的 HTTP 端口。 | -| 12 | {{nebula.name}} | TCP | 19780 | Storage 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | -| 13 | {{nebula.name}} | TCP | 8888 | 备份和恢复功能的 Agent 服务端口。Agent 是集群中每台机器的一个守护进程，用于启停{{nebula.name}}服务和上传、下载备份文件。 | -| 14 | {{nebula.name}} | TCP | 9789、9790、9788 | 全文索引中 Raft Listener 的端口，从 Storage 服务读取数据，然后将它们写入 Elasticsearch 集群。
也是集群间数据同步中 Storage Listener 的端口。用于同步主集群的 Storage 数据。端口 9790、9788 由端口 9789 加一减一后自动生成。 | -| 15 | {{nebula.name}} | TCP | 9200 | {{nebula.name}}使用该端口与 Elasticsearch 进行 HTTP 通信，以执行全文搜索查询和管理全文索引。 | -| 16 | {{nebula.name}} | TCP | 9569、9570、9568| 集群间数据同步功能中 Meta Listener 的端口，用于同步主集群的 Meta 数据。端口 9570、9568 由端口 9569 加一减一后自动生成。 | -| 17 | {{nebula.name}} | TCP | 9889、9890、9888 | 集群间数据同步功能中 Drainer 服务端口。用于同步 Storage、Meta 数据给从集群。端口 9890、9888 由端口 9889 加一减一后自动生成。| -| 18 | NebulaGraph Studio | TCP | 7001 | Studio 提供 Web 服务占用端口。 | -| 19 | NebulaGraph Dashboard | TCP | 8090 | Nebula HTTP Gateway 依赖服务端口。为集群服务提供 HTTP 接口，执行 nGQL 语句与{{nebula.name}}数据库进行交互。 | -| 20 | NebulaGraph Dashboard | TCP | 9200 | Nebula Stats Exporter 依赖服务端口。收集集群的性能指标，包括服务 IP 地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟 等）。 | -| 21 | NebulaGraph Dashboard | TCP | 9100 | Node Exporter 依赖服务端口。收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。 | -| 22 | NebulaGraph Dashboard | TCP | 9090 | Prometheus 服务的端口。存储监控数据的时间序列数据库。 | -| 23 | NebulaGraph Dashboard | TCP | 7003 | Dashboard 社区版 提供 Web 服务占用端口。 | +| 4 | {{nebula.name}} | TCP | 9559、9560 | `9559`是 Meta 服务的 RPC 守护进程监听端口。通常由 Graph 服务和 Storage 服务发起请求，用于获取和更新图数据库的元数据信息。
同时还会使用相邻的`+1`（`9560`）端口用于 Meta 服务之间的 Raft 通信。 | +| 5 | {{nebula.name}} | TCP | 19559 | Meta 服务的 HTTP 端口。 | +| 6 | {{nebula.name}} | TCP | 19560 | Meta 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | +| 7 | {{nebula.name}} | TCP | 9779、9778、9780 | `9779`是 Storage 服务的 RPC 守护进程监听端口。通常由 Graph 服务发起请求，用于执行数据存储相关的操作，例如读取、写入或删除数据。
同时还会使用相邻的`-1`（`9778`）和`+1`（`9780`）端口。
`9778`：Admin 服务（Storage 接收 Meta 命令的服务）占用的端口。
`9780`：Storage 服务之间的 Raft 通信端口。 | +| 8 | {{nebula.name}} | TCP | 19779 | Storage 服务的 HTTP 端口。 | +| 9 | {{nebula.name}} | TCP | 19780 | Storage 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | +| 10 | {{nebula.name}} | TCP | 8888 | 备份和恢复功能的 Agent 服务端口。Agent 是集群中每台机器的一个守护进程，用于启停{{nebula.name}}服务和上传、下载备份文件。 | +| 11 | {{nebula.name}} | TCP | 9789、9788、9790 | `9789`是全文索引中 Raft Listener 的端口，从 Storage 服务读取数据，然后将它们写入 Elasticsearch 集群。
也是集群间数据同步中 Storage Listener 的端口。用于同步主集群的 Storage 数据。
同时还会使用相邻的`-1`（`9788`）和`+1`（`9790`）端口。
`9788`：内部端口。
`9790`：Raft 通信端口。 | +| 12 | {{nebula.name}} | TCP | 9200 | {{nebula.name}}使用该端口与 Elasticsearch 进行 HTTP 通信，以执行全文搜索查询和管理全文索引。 | +| 13 | {{nebula.name}} | TCP | 9569、9568、9570| `9569`是集群间数据同步功能中 Meta Listener 的端口，用于同步主集群的 Meta 数据。
同时还会使用相邻的`-1`（`9568`）和`+1`（`9570`）端口。
`9568`：内部端口。
`9570`：Raft 通信端口。 | +| 14 | {{nebula.name}} | TCP | 9889、9888、9890 | `9889`是集群间数据同步功能中 Drainer 服务端口。用于同步 Storage、Meta 数据给从集群。
同时还会使用相邻的`-1`（`9888`）和`+1`（`9890`）端口。
`9888`：内部端口。
`9890`：Raft 通信端口。| +| 15 | NebulaGraph Studio | TCP | 7001 | Studio 提供 Web 服务占用端口。 | +| 16 | NebulaGraph Dashboard | TCP | 8090 | Nebula HTTP Gateway 依赖服务端口。为集群服务提供 HTTP 接口，执行 nGQL 语句与{{nebula.name}}数据库进行交互。 | +| 17 | NebulaGraph Dashboard | TCP | 9200 | Nebula Stats Exporter 依赖服务端口。收集集群的性能指标，包括服务 IP 地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟 等）。 | +| 18 | NebulaGraph Dashboard | TCP | 9100 | Node Exporter 依赖服务端口。收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。 | +| 19 | NebulaGraph Dashboard | TCP | 9090 | Prometheus 服务的端口。存储监控数据的时间序列数据库。 | +| 20 | NebulaGraph Dashboard | TCP | 7003 | Dashboard 社区版 提供 Web 服务占用端口。 | diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md index 98cbf99c197..bedd3d7cf3f 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md @@ -56,7 +56,7 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul | :----------------------- | :---------------- | :---------------------------- |:------------------| | `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 |不支持| |`local_ip` | `127.0.0.1` | Meta 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-metad 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| -| `port` | `9559` | Meta 服务的 RPC 守护进程监听端口。Meta 服务对外端口为`9559`，对内端口为`对外端口+1`，即`9560`，{{nebula.name}}使用内部端口进行多副本间的交互。 |不支持| +| `port` | `9559` | Meta 服务的 RPC 守护进程监听端口。同时还会使用相邻的`+1`（`9560`）端口用于 Meta 服务之间的 Raft 通信。 |不支持| | `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 |不支持| | `ws_http_port` | `19559` | HTTP 服务的端口。 |不支持| |`ws_storage_http_port`|`19779`| HTTP 协议监听 Storage 服务的端口，需要和 Storage 服务配置文件中的`ws_http_port`保持一致。仅存算合并版{{nebula.name}}需要设置本参数。|不支持| diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md index 7518a834d44..270d5efd4e5 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -59,7 +59,7 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 | :----------------------- | :---------------- | :------------------------|:----------------------- | | `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 |不支持| |`local_ip` | `127.0.0.1` | Storage 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-storaged 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| -| `port` | `9779` | Storage 服务的 RPC 守护进程监听端口。Storage 服务对外端口为`9779`，对内端口为`9777`、`9778`和`9780`，{{nebula.name}}使用内部端口进行多副本间的交互。`9778`：Admin 服务（Storage 接收 Meta 命令的服务）占用的端口；`9780`：Raft 通信端口。|不支持| +| `port` | `9779` | Storage 服务的 RPC 守护进程监听端口。同时还会使用相邻的`-1`（`9778`）和`+1`（`9780`）端口。
`9778`：Admin 服务（Storage 接收 Meta 命令的服务）占用的端口。
`9780`：Storage 服务之间的 Raft 通信端口。|不支持| | `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 |不支持| | `ws_http_port` | `19779` | HTTP 服务的端口。 |不支持| |`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 |支持|