From 8633a380933a3fe100f58ef6f61716e902fcfeb6 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 22 Nov 2023 09:32:55 +0800 Subject: [PATCH] optimiz IP description (#2367) Co-authored-by: Chris Chen --- .../7.general-query-statements/6.show/17.show-sessions.md | 4 ++-- .../6.show/19.show-meta-leader.md | 2 +- .../7.general-query-statements/6.show/9.show-parts.md | 6 +++--- .../6.deploy-text-based-index/3.deploy-listener.md | 4 ++-- .../1.configurations/1.configurations.md | 4 ++-- .../1.configurations/2.meta-config.md | 6 +++--- .../1.configurations/3.graph-config.md | 6 +++--- .../1.configurations/4.storage-config.md | 6 +++--- .../6.monitor-and-metrics/1.query-performance-metrics.md | 4 ++-- docs-2.0-en/backup-and-restore/3.manage-snapshot.md | 2 +- docs-2.0-en/nebula-console.md | 2 +- docs-2.0-en/reuse/source_connect-to-nebula-graph.md | 2 +- .../7.general-query-statements/6.show/17.show-sessions.md | 4 ++-- .../6.show/19.show-meta-leader.md | 2 +- .../7.general-query-statements/6.show/9.show-parts.md | 8 ++++---- .../6.deploy-text-based-index/3.deploy-listener.md | 4 ++-- .../1.configurations/1.configurations.md | 4 ++-- .../1.configurations/2.meta-config.md | 6 +++--- .../1.configurations/3.graph-config.md | 6 +++--- .../1.configurations/4.storage-config.md | 6 +++--- .../6.monitor-and-metrics/1.query-performance-metrics.md | 4 ++-- docs-2.0-zh/backup-and-restore/3.manage-snapshot.md | 2 +- docs-2.0-zh/nebula-console.md | 2 +- docs-2.0-zh/reuse/source_connect-to-nebula-graph.md | 2 +- .../reuse/source_install-nebula-graph-by-rpm-or-deb.md | 5 ----- 25 files changed, 49 insertions(+), 54 deletions(-) diff --git a/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md b/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md index ea6b821b7fa..3e8871fd303 100644 --- a/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md +++ b/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md @@ -51,6 +51,6 @@ nebula> SHOW SESSION 1635254859271703; | `SpaceName` | The name of the graph space that the user uses currently. It is null (`""`) when you first log in because there is no specified graph space. | | `CreateTime` | The time when the session is created, namely the time when the user logs in. The time zone is specified by `timezone_name` in the configuration file. | | `UpdateTime` | The system will update the time when there is an operation. The time zone is specified by `timezone_name` in the configuration file. | -| `GraphAddr` | The IP address and port of the Graph server that hosts the session. | +| `GraphAddr` | The IP (or hostname) and port of the Graph server that hosts the session. | | `Timezone` | A reserved parameter that has no specified meaning for now. | -| `ClientIp` | The IP address of the client. | +| `ClientIp` | The IP or hostname of the client. | diff --git a/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md b/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md index 604eb343c4a..49debe5835f 100644 --- a/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md +++ b/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md @@ -23,5 +23,5 @@ nebula> SHOW META LEADER; | Parameter | Description | | :--- | :--- | -| `Meta Leader` | Shows the information of the leader in the Meta cluster, including the IP address and port of the server where the leader is located. | +| `Meta Leader` | Shows the information of the leader in the Meta cluster, including the IP (or hostname) and port of the server where the leader is located. | | `secs from last heart beat` | Indicates the time interval since the last heartbeat. This parameter is measured in seconds. | diff --git a/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md b/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md index 30f48dcca05..41e36d9436b 100644 --- a/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md +++ b/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md @@ -40,6 +40,6 @@ The descriptions are as follows. | Parameter | Description | | - | - | | `Partition ID` | The ID of the partition. | -| `Leader` | The IP address and the port of the leader. | -| `Peers` | The IP addresses and the ports of all the replicas. | -| `Losts` | The IP addresses and the ports of replicas at fault. | +| `Leader` | The IP (or hostname) and the port of the leader. | +| `Peers` | The IPs (or hostnames) and the ports of all the replicas. | +| `Losts` | The IPs (or hostnames) and the ports of replicas at fault. | diff --git a/docs-2.0-en/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md b/docs-2.0-en/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md index a8854c52392..6cea2b78885 100644 --- a/docs-2.0-en/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md +++ b/docs-2.0-en/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md @@ -34,8 +34,8 @@ Most configurations are the same as the configurations of [Storage Service](../. | :----------- | :----------------------- | :------------------ | | `daemonize` | `true` | When set to `true`, the process is a daemon process. | | `pid_file` | `pids/nebula-metad-listener.pid` | The file that records the process ID. | -| `meta_server_addrs` | - | IP addresses and ports of all Meta services. Multiple Meta services are separated by commas. | -| `local_ip` | - | The local IP address of the Listener service. Use real IP addresses instead of domain names or loopback IP addresses such as `127.0.0.1`. | +| `meta_server_addrs` | - | IP (or hostname) and ports of all Meta services. Multiple Meta services are separated by commas. | +| `local_ip` | - | The local IP (or hostname) of the Listener service. Use real IP addresses instead of domain names or loopback IP addresses such as `127.0.0.1`. | | `port` | - | The listening port of the RPC daemon of the Listener service. | | `heartbeat_interval_secs` | `10` | The heartbeat interval of the Meta service. The unit is second (s). | | `listener_path` | `data/listener` | The WAL directory of the Listener. Only one directory is allowed. | diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/1.configurations.md index 4ca4cd0ce17..3a713f31f6e 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/1.configurations.md @@ -59,7 +59,7 @@ curl -s 127.0.0.1:19559/flags !!! note - In an actual environment, use the real host IP address instead of `127.0.0.1` in the above example. + In an actual environment, use the real IP (or hostname) instead of `127.0.0.1` in the above example. ## Configuration files @@ -71,7 +71,7 @@ The configuration values in the initial configuration file are for reference onl !!! note - To ensure the availability of services, it is recommended that configurations for the same service be consistent, except for the local IP address `local_ip`. For example, three Storage servers are deployed in one NebulaGraph cluster. The configurations of the three Storage servers are recommended to be consistent, except for the IP address. + To ensure the availability of services, it is recommended that configurations for the same service be consistent, except for `local_ip`. For example, three Storage servers are deployed in one NebulaGraph cluster. The configurations of the three Storage servers are recommended to be consistent, except for `local_ip`. The initial configuration files corresponding to each service are as follows. 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 9285c3a551c..ecc00481f33 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 @@ -52,8 +52,8 @@ For all parameters and their current values, see [Configurations](1.configuratio | Name | Predefined value | Description |Whether supports runtime dynamic modifications| | :----------------------- | :---------------- | :---------------------------------------------------- |:----------------- | -| `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| +| `meta_server_addrs` | `127.0.0.1:9559` | Specifies the IPs (or hostnames) and ports of all Meta Services. Multiple addresses are separated with commas. | No| +|`local_ip` | `127.0.0.1` | Specifies the local IP (or hostname) 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 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| @@ -62,7 +62,7 @@ For all parameters and their current values, see [Configurations](1.configuratio !!! caution - The real IP address must be used in the configuration file. Otherwise, `127.0.0.1/0.0.0.0` cannot be parsed correctly in some cases. + It is recommended to use a real IP when using IP address. Otherwise, `127.0.0.1/0.0.0.0` cannot be parsed correctly in some cases. ## Storage configurations diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/3.graph-config.md index 892e02c476a..5b696dd8d2c 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -62,8 +62,8 @@ For all parameters and their current values, see [Configurations](1.configuratio | Name | Predefined value | Description |Whether supports runtime dynamic modifications| | ----------------------- | ---------------- | ---------------------------------------------------- |------------------| -| `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 Graph Service. The local IP address is used to identify the nebula-graphd process. If it is a distributed cluster or requires remote access, modify it to the corresponding address.| No| +| `meta_server_addrs` | `127.0.0.1:9559` | Specifies the IPs (or hostnames) and ports of all Meta Services. Multiple addresses are separated with commas.| No| +|`local_ip` | `127.0.0.1` | Specifies the local IP (or hostname) for the Graph Service. The local IP address is used to identify the nebula-graphd process. If it is a distributed cluster or requires remote access, modify it to the corresponding address.| No| |`listen_netdev` |`any` | Specifies the listening network device. | No| | `port` | `9669` | Specifies RPC daemon listening port of the Graph service. | No| |`reuse_port` |`false` | When set to `false`, the `SO_REUSEPORT` is closed. | No| @@ -83,7 +83,7 @@ For all parameters and their current values, see [Configurations](1.configuratio !!! caution - The real IP address must be used in the configuration file. Otherwise, `127.0.0.1/0.0.0.0` cannot be parsed correctly in some cases. + It is recommended to use a real IP when using IP address. Otherwise, `127.0.0.1/0.0.0.0` cannot be parsed correctly in some cases. ## Charset and collate configurations 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 98b273a3d9d..1c0e30e7cff 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 @@ -57,8 +57,8 @@ For all parameters and their current values, see [Configurations](1.configuratio | Name | Predefined value | Description |Whether supports runtime dynamic modifications| | :----------------------- | :---------------- | :---------------------------------------------------- |:------------------| -| `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| +| `meta_server_addrs` | `127.0.0.1:9559` | Specifies the IPs (or hostnames) and ports of all Meta Services. Multiple addresses are separated with commas. | No| +|`local_ip` | `127.0.0.1` | Specifies the local IP (or hostname) 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 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| @@ -66,7 +66,7 @@ For all parameters and their current values, see [Configurations](1.configuratio !!! caution - The real IP address must be used in the configuration file. Otherwise, `127.0.0.1/0.0.0.0` cannot be parsed correctly in some cases. + It is recommended to use a real IP when using IP address. Otherwise, `127.0.0.1/0.0.0.0` cannot be parsed correctly in some cases. ## Raft configurations diff --git a/docs-2.0-en/6.monitor-and-metrics/1.query-performance-metrics.md b/docs-2.0-en/6.monitor-and-metrics/1.query-performance-metrics.md index 4ba6f0b5c18..f03a539a8f9 100644 --- a/docs-2.0-en/6.monitor-and-metrics/1.query-performance-metrics.md +++ b/docs-2.0-en/6.monitor-and-metrics/1.query-performance-metrics.md @@ -18,12 +18,12 @@ Each metric of NebulaGraph consists of three fields: name, type, and time range. ### Syntax ```bash -curl -G "http://:/stats?stats= [&format=json]" +curl -G "http://:/stats?stats= [&format=json]" ``` |Parameter|Description| |-|-| -|`ip`|The IP address of the server. You can find it in the configuration file in the installation directory.| +|`host`|The IP (or hostname) of the server. You can find it in the configuration file in the installation directory.| |`port`|The HTTP port of the server. You can find it in the configuration file in the installation directory. The default ports are 19559 (Meta), 19669 (Graph), and 19779 (Storage).| |`metric_name_list`|The metrics names. Multiple metrics are separated by commas (,).| |`&format=json`|Optional. Returns the result in the JSON format.| diff --git a/docs-2.0-en/backup-and-restore/3.manage-snapshot.md b/docs-2.0-en/backup-and-restore/3.manage-snapshot.md index fbf80b7a974..67c0b25adc9 100644 --- a/docs-2.0-en/backup-and-restore/3.manage-snapshot.md +++ b/docs-2.0-en/backup-and-restore/3.manage-snapshot.md @@ -48,7 +48,7 @@ The parameters in the return information are described as follows. |-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Name` | The name of the snapshot directory. The prefix `SNAPSHOT` indicates that the file is a snapshot file, and the suffix indicates the time the snapshot was created (UTC). | | `Status` | The status of the snapshot. `VALID` indicates that the creation succeeded, while `INVALID` indicates that it failed. | -| `Hosts` | IP addresses and ports of all Storage servers at the time the snapshot was created. | +| `Hosts` | The IPs (or hostnames) and ports of all Storage servers at the time the snapshot was created. | ### Snapshot path diff --git a/docs-2.0-en/nebula-console.md b/docs-2.0-en/nebula-console.md index 70727fb324e..7363e51e24a 100644 --- a/docs-2.0-en/nebula-console.md +++ b/docs-2.0-en/nebula-console.md @@ -48,7 +48,7 @@ Parameter descriptions are as follows: | Parameter | Description | | - | - | | `-h/-help` | Shows the help menu. | -| `-addr/-address` | Sets the IP address of the Graph service. The default address is 127.0.0.1. | +| `-addr/-address` | Sets the IP or hostname of the Graph service. The default address is 127.0.0.1. | | `-P/-port` | Sets the port number of the graphd service. The default port number is 9669. | | `-u/-user` | Sets the username of your NebulaGraph account. Before enabling authentication, you can use any existing username. The default username is `root`. | | `-p/-password` | Sets the password of your NebulaGraph account. Before enabling authentication, you can use any characters as the password. | diff --git a/docs-2.0-en/reuse/source_connect-to-nebula-graph.md b/docs-2.0-en/reuse/source_connect-to-nebula-graph.md index 4f595c39b26..bb4ec7b4df2 100644 --- a/docs-2.0-en/reuse/source_connect-to-nebula-graph.md +++ b/docs-2.0-en/reuse/source_connect-to-nebula-graph.md @@ -67,7 +67,7 @@ NebulaGraph supports multiple types of clients, including a CLI client, a GUI cl | Parameter | Description | | - | - | | `-h/-help` | Shows the help menu. | - | `-addr/-address` | Sets the IP address of the Graph service. The default address is 127.0.0.1. | + | `-addr/-address` | Sets the IP (or hostname) of the Graph service. The default address is 127.0.0.1. | | `-P/-port` | Sets the port number of the graphd service. The default port number is 9669. | | `-u/-user` | Sets the username of your NebulaGraph account. Before enabling authentication, you can use any existing username. The default username is `root`. | | `-p/-password` | Sets the password of your NebulaGraph account. Before enabling authentication, you can use any characters as the password. | diff --git a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md index 976d8808494..c5008d1ff9e 100644 --- a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md +++ b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md @@ -49,9 +49,9 @@ nebula> SHOW SESSION 1635254859271703; |`SpaceName`|用户当前所使用的图空间。刚登录时为空（`""`）。| |`CreateTime`|会话的创建时间，即用户认证登录的时间。时区为配置文件中`timezone_name`指定的时区。| |`UpdateTime`|用户有执行操作时，会更新此时间。时区为配置文件中`timezone_name`指定的时区。| -|`GraphAddr`|会话的 Graph 服务地址和端口。| +|`GraphAddr`|会话的 Graph 服务 IP（或主机名）和端口。| |`Timezone`|保留参数，暂无意义。| -|`ClientIp`|会话的客户端 IP 地址。| +|`ClientIp`|会话的客户端 IP 或主机名。| diff --git a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md index 24afa3481dc..cbf79ab9570 100644 --- a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md +++ b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md @@ -23,5 +23,5 @@ nebula> SHOW META LEADER; |参数|说明| |:---|:---| -|`Meta Leader`|Meta 集群的 leader 信息，包括 leader 所在服务器的 IP 地址和端口。| +|`Meta Leader`|Meta 集群的 leader 信息，包括 leader 所在服务器的 IP（或主机名）和端口。| |`secs from last heart beat`|距离上次心跳的时间间隔。单位：秒。| diff --git a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md index 6a14a6e57e3..8b5822b535b 100644 --- a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md +++ b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md @@ -39,7 +39,7 @@ nebula> SHOW PARTS 1; | 参数 | 说明 | | - | - | -| `Partition ID` | 存储分片的 ID | -| `Leader` | 分片对应的 Raft leader 副本的信息，包括 IP 地址与服务端口 | -| `Peers` | 分片对应的所有副本（leader 与 follower）的信息，包括 IP 地址与服务端口 | -| `Losts` | 分片对应的处于离线状态的副本信息，包括 IP 地址和服务端口 | +| `Partition ID` | 存储分片的 ID。 | +| `Leader` | 分片对应的 Raft leader 副本的信息，包括 IP（或主机名）与服务端口。 | +| `Peers` | 分片对应的所有副本（leader 与 follower）的信息，包括 IP（或主机名）与服务端口。 | +| `Losts` | 分片对应的处于离线状态的副本信息，包括 IP（或主机名）和服务端口。 | diff --git a/docs-2.0-zh/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md b/docs-2.0-zh/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md index 46f2f4067a4..45450017f78 100644 --- a/docs-2.0-zh/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md +++ b/docs-2.0-zh/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md @@ -37,8 +37,8 @@ listener 服务与 storaged 服务使用相同的二进制文件，但是二者 | :----------- | :----------------------- | :------------------| | `daemonize` | `true` | 是否启动守护进程。 | | `pid_file` | `pids/nebula-storaged-listener.pid` | 记录进程 ID 的文件。 | -| `meta_server_addrs` | - | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 | -| `local_ip` | - | listener 服务的本地 IP 地址。请使用真实的 listener 机器 IP 地址替换`127.0.0.1`。 | +| `meta_server_addrs` | - | 全部 Meta 服务的 IP（或主机名）和端口。多个 Meta 服务用英文逗号（,）分隔。 | +| `local_ip` | - | listener 服务的 IP（或主机名）。请使用真实的 listener 机器 IP 替换`127.0.0.1`。 | | `port` | - | listener 服务的 RPC 守护进程监听端口。 | | `heartbeat_interval_secs` | `10` | Meta 服务的心跳间隔。单位：秒（s）。 | | `listener_path` | `data/listener` | listener 的 WAL 目录。只允许使用一个目录。 | diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/1.configurations.md index c9631e18884..e9b2bda59e2 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/1.configurations.md @@ -66,7 +66,7 @@ curl -s 127.0.0.1:19559/flags ``` !!! note - 实际环境中需使用真实的主机 IP 地址取代以上示例中的`127.0.0.1`。 + 实际环境中需使用真实的 IP（或主机名）取代以上示例中的`127.0.0.1`。 ## 配置文件简介 @@ -78,7 +78,7 @@ curl -s 127.0.0.1:19559/flags !!! note - 为确保服务的可用性，同类服务的配置建议保持一致，本机 IP 地址`local_ip`除外。例如，一个 {{nebula.name}} 集群中部署了 3 个 Storage 服务器，3 者除 IP 地址外的其它配置建议都相同。 + 为确保服务的可用性，同类服务的配置建议保持一致，本机`local_ip`除外。例如，一个 {{nebula.name}} 集群中部署了 3 个 Storage 服务器，3 者除`local_ip`外的其它配置建议都相同。 下表列出了各服务对应的初始配置文件。 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 040870f1c7b..ebb92ad201e 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 @@ -54,8 +54,8 @@ 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 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| +| `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 守护进程监听端口。同时还会使用相邻的`+1`（`9560`）端口用于 Meta 服务之间的 Raft 通信。 |不支持| | `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 |不支持| | `ws_http_port` | `19559` | HTTP 服务的端口。 |不支持| @@ -64,7 +64,7 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul !!! caution - 必须在配置文件中使用真实的 IP 地址。否则某些情况下`127.0.0.1/0.0.0.0`无法正确解析。 + 使用 IP 时建议使用真实的 IP。否则某些情况下`127.0.0.1/0.0.0.0`无法正确解析。 ## storage 配置 diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md index 10411224cdc..7cecd82c9d2 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -61,8 +61,8 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb | 名称 | 预设值 | 说明 |是否支持运行时动态修改| | ----------------------- | ---------------- | ---------------------------------------------------- |---------------------| -| `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 |不支持| -|`local_ip` | `127.0.0.1` | Graph 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-graphd 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| +| `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP（或主机名）和端口。多个 Meta 服务用英文逗号（,）分隔。 |不支持| +|`local_ip` | `127.0.0.1` | Graph 服务的本地 IP（或主机名）。本地 IP 用于识别 nebula-graphd 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| |`listen_netdev` |`any` |监听的网络设备。 |不支持| | `port` | `9669` | Graph 服务的 RPC 守护进程监听端口。 |不支持| |`reuse_port` |`false` | 是否启用 SO_REUSEPORT。 |不支持| @@ -82,7 +82,7 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb !!! caution - 必须在配置文件中使用真实的 IP 地址。否则某些情况下`127.0.0.1/0.0.0.0`无法正确解析。 + 使用 IP 时建议使用真实的 IP。否则某些情况下`127.0.0.1/0.0.0.0`无法正确解析。 ## charset and collate 配置 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 abee319b864..beb4d794b32 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 @@ -57,8 +57,8 @@ 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 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| +| `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 守护进程监听端口。同时还会使用相邻的`-1`（`9778`）和`+1`（`9780`）端口。
`9778`：Admin 服务（Storage 接收 Meta 命令的服务）占用的端口。
`9780`：Storage 服务之间的 Raft 通信端口。|不支持| | `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 |不支持| | `ws_http_port` | `19779` | HTTP 服务的端口。 |不支持| @@ -66,7 +66,7 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 !!! caution - 必须在配置文件中使用真实的 IP 地址。否则某些情况下`127.0.0.1/0.0.0.0`无法正确解析。 + 使用 IP 时建议使用真实的 IP。否则某些情况下`127.0.0.1/0.0.0.0`无法正确解析。 ## raft 配置 diff --git a/docs-2.0-zh/6.monitor-and-metrics/1.query-performance-metrics.md b/docs-2.0-zh/6.monitor-and-metrics/1.query-performance-metrics.md index 9284c61ab56..6a3cf8697f8 100644 --- a/docs-2.0-zh/6.monitor-and-metrics/1.query-performance-metrics.md +++ b/docs-2.0-zh/6.monitor-and-metrics/1.query-performance-metrics.md @@ -17,12 +17,12 @@ ### 语法 ```bash -curl -G "http://:/stats?stats= [&format=json]" +curl -G "http://:/stats?stats= [&format=json]" ``` |选项|说明| |:---|:---| -|`ip`|服务器的 IP 地址，可以在安装目录内查看配置文件获取。| +|`host`|服务器的 IP 或主机名，可以在安装目录内查看配置文件获取。| |`port`|服务器的 HTTP 端口，可以在安装目录内查看配置文件获取。默认情况下，Meta 服务端口为 19559，Graph 服务端口为 19669，Storage 服务端口为 19779。| |`metric_name_list`|监控指标名称，多个监控指标用英文逗号（,）隔开。| |`&format=json`|将结果以 JSON 格式返回。| diff --git a/docs-2.0-zh/backup-and-restore/3.manage-snapshot.md b/docs-2.0-zh/backup-and-restore/3.manage-snapshot.md index 9991675b42b..567547b2661 100644 --- a/docs-2.0-zh/backup-and-restore/3.manage-snapshot.md +++ b/docs-2.0-zh/backup-and-restore/3.manage-snapshot.md @@ -48,7 +48,7 @@ nebula> SHOW SNAPSHOTS; |:---|:---| |`Name`|快照名称，前缀为`SNAPSHOT`，表示该文件为快照文件，后缀为快照创建的时间点（UTC 时间）。| |`Status`|快照状态。`VALID`表示快照有效，`INVALID`表示快照无效。| -|`Hosts`|创建快照时所有 Storage 服务器的 IP 地址和端口。| +|`Hosts`|创建快照时所有 Storage 服务器的 IP（或主机名）和端口。| ### 快照路径 diff --git a/docs-2.0-zh/nebula-console.md b/docs-2.0-zh/nebula-console.md index 528ca1bff3d..e9ba2cd260c 100644 --- a/docs-2.0-zh/nebula-console.md +++ b/docs-2.0-zh/nebula-console.md @@ -48,7 +48,7 @@ NebulaGraph Console 的获取方式如下： | 参数 | 说明 | | - | - | | `-h/-help` | 显示帮助菜单。 | -| `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。 | +| `-addr/-address` | 设置要连接的 Graph 服务的 IP 或主机名。默认地址为 127.0.0.1。 | | `-P/-port` | 设置要连接的 Graph 服务的端口。默认端口为 9669。| | `-u/-user` | 设置 {{nebula.name}} 账号的用户名。未启用身份认证时，可以使用任意已存在的用户名（默认为`root`）。 | | `-p/-password` | 设置用户名对应的密码。未启用身份认证时，密码可以填写任意字符。 | diff --git a/docs-2.0-zh/reuse/source_connect-to-nebula-graph.md b/docs-2.0-zh/reuse/source_connect-to-nebula-graph.md index 0db64d0c7fe..9dd94ea8fea 100644 --- a/docs-2.0-zh/reuse/source_connect-to-nebula-graph.md +++ b/docs-2.0-zh/reuse/source_connect-to-nebula-graph.md @@ -70,7 +70,7 @@ | 参数 | 说明 | | - | - | | `-h/-help` | 显示帮助菜单。 | - | `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。| + | `-addr/-address` | 设置要连接的 Graph 服务的 IP 或主机名。默认地址为 127.0.0.1。| | `-P/-port` | 设置要连接的 Graph 服务的端口。默认端口为 9669。| | `-u/-user` | 设置 {{nebula.name}} 账号的用户名。未启用身份认证时，可以使用任意已存在的用户名（默认为`root`）。 | | `-p/-password` | 设置用户名对应的密码。未启用身份认证时，密码可以填写任意字符。 | diff --git a/docs-2.0-zh/reuse/source_install-nebula-graph-by-rpm-or-deb.md b/docs-2.0-zh/reuse/source_install-nebula-graph-by-rpm-or-deb.md index 8dc715384b6..c4e2fc791f1 100644 --- a/docs-2.0-zh/reuse/source_install-nebula-graph-by-rpm-or-deb.md +++ b/docs-2.0-zh/reuse/source_install-nebula-graph-by-rpm-or-deb.md @@ -136,11 +136,6 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 ```bash sudo dpkg -i nebula-graph-{{nebula.release}}.ubuntu1804.amd64.deb ``` - - - - - ## 后续操作