Skip to content

Commit

Permalink
Modify the description of neighbor ports (vesoft-inc#2341)
Browse files Browse the repository at this point in the history
  • Loading branch information
@cooper-lzy
cooper-lzy authored Nov 10, 2023
1 parent 117d66f commit 62e0576
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 46 deletions.
39 changes: 18 additions & 21 deletions docs-2.0-en/20.appendix/port-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br/>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. <br/>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. <br/>The neighboring ports `-1` (`9778`) and `+1` (`9780`) are also used. <br/>`9778`: The port used by the Admin service, which receives Meta commands for Storage. <br/>`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.<br/>Also the port for Storage Listener in inter-cluster data synchronization, used for synchronizing Storage data from the primary cluster. <br/>The neighboring ports `-1` (`9788`) and `+1` (`9790`) are also used.<br/>`9788`: An internal port.<br/>`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. <br/>The neighboring ports `-1` (`9568`) and `+1` (`9570`) are also used.<br/>`9568`: An internal port.<br/>`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. <br/>The neighboring ports `-1` (`9888`) and `+1` (`9890`) are also used.<br/>`9888`: An internal port.<br/>`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. |
2 changes: 1 addition & 1 deletion docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br/> `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. <br/>`9778`: The port used by the Admin service, which receives Meta commands for Storage. <br/>`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|
Expand Down
Loading

0 comments on commit 62e0576

Please sign in to comment.