Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optimiz IP description #2367

Merged
merged 1 commit into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,16 @@ 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. <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|

!!! 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Each metric of NebulaGraph consists of three fields: name, type, and time range.
### Syntax

```bash
curl -G "http://<ip>:<port>/stats?stats=<metric_name_list> [&format=json]"
curl -G "http://<host>:<port>/stats?stats=<metric_name_list> [&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.|
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0-en/backup-and-restore/3.manage-snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0-en/nebula-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. <!--If NebulaGraph is deployed on [NebulaGraph Cloud](https://docs.nebula-graph.io/3.1.0/nebula-cloud/1.what-is-cloud/), you need to create a Private Link and set the IP address of the Private Endpoint as the parameter value.--> |
| `-addr/-address` | Sets the IP or hostname of the Graph service. The default address is 127.0.0.1. <!--If NebulaGraph is deployed on [NebulaGraph Cloud](https://docs.nebula-graph.io/3.1.0/nebula-cloud/1.what-is-cloud/), you need to create a Private Link and set the IP or hostname of the Private Endpoint as the parameter value.--> |
| `-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. |
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0-en/reuse/source_connect-to-nebula-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. <!--If NebulaGraph is deployed on [NebulaGraph Cloud](https://docs.nebula-graph.io/2.6.2/nebula-cloud/1.what-is-cloud/), you need to create a Private Link and set the IP address of the Private Endpoint as the parameter value.--> |
| `-addr/-address` | Sets the IP (or hostname) of the Graph service. The default address is 127.0.0.1. <!--If NebulaGraph is deployed on [NebulaGraph Cloud](https://docs.nebula-graph.io/2.6.2/nebula-cloud/1.what-is-cloud/), you need to create a Private Link and set the IP address of the Private Endpoint as the parameter value.--> |
| `-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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 或主机名。|



Original file line number Diff line number Diff line change
Expand Up @@ -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`|距离上次心跳的时间间隔。单位:秒。|
Original file line number Diff line number Diff line change
Expand Up @@ -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(或主机名)和服务端口。 |
Original file line number Diff line number Diff line change
Expand Up @@ -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 目录。只允许使用一个目录。 |
Expand Down
Loading