Skip to content

Commit

Permalink
Update 2.deploy-dashboard.md (#1093)
Browse files Browse the repository at this point in the history
  • Loading branch information
abby-cyber committed Feb 10, 2022
1 parent d69d4a4 commit be5bc1c
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions docs-2.0/nebula-dashboard/2.deploy-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,20 @@ Download the tar package as needed, and it is recommended to select the latest v

| Dashboard package | Nebula Graph version |
| :----- | :----- |
| [nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | 2.5.1~3.0.0 |
| [nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-dashboard/{{ dashboard.release }}/nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | 2.5.1~3.0.0 |

## Service

Run `tar -xvf {{dashboard.release}}.tar.gz` to decompress the installation package. There are 5 services in the `nebula-graph-dashboard`. The descriptions are as follows.
Run `tar -xvf nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz` to decompress the installation package. There are four services in the `nebula-dashboard/vendors`. The descriptions are as follows.

|Name|Description||Port|
|:---|:---|:---|
|node-exporter | Collects the source information of machines in the cluster, including the CPU, memory, load, disk, and network. |9100|
|nebula-stats-exporter | Collects the performance metrics in the cluster, including the IP addresses, versions, and monitoring metrics (such as the number of queries, the latency of queries, the latency of heartbeats, and so on). |9200|
|prometheus | The time series database that stores monitoring data. |9090|
|nebula-http-gateway | Provides HTTP ports for cluster services to execute nGQL statements to interact with the Nebula Graph database. |8090|
|nebula-graph-dashboard| Provides the Dashboard service. Note that its name is the same as its superordinate. The following `nebula-graph-dashboard` refers to this service. |7003|

The above five services should be deployed as follows.
The above four services should be deployed as follows.

## Procedure

Expand All @@ -64,12 +63,11 @@ After the service is started, you can enter `<IP>:9100` in the browser to check

!!! note

You only need to deploy the `nebula-stats-exporter` service on the machine where the `nebula-graph-dashboard` service is installed.
You only need to deploy the `nebula-stats-exporter` service on the machine where the `nebula-dashboard` service is installed.

1. Modify the `config.yaml` file in `nebula-stats-exporter` to deploy the HTTP ports of all the services. The example is as follows:

```bash
version: v0.0.4
clusters:
- name: nebula
instances:
Expand Down Expand Up @@ -123,7 +121,7 @@ After the service is started, you can enter `<IP>:9200` in the browser to check

!!! note

You only need to deploy the `prometheus` service on the machine where the `nebula-graph-dashboard` service is installed.
You only need to deploy the `prometheus` service on the machine where the `nebula-dashboard` service is installed.

1. Modify the `prometheus.yaml` file in `prometheus` to deploy the IP addresses and ports of the `node-exporter` service and the `nebula-stats-exporter`. The example is as follows:

Expand All @@ -135,12 +133,12 @@ After the service is started, you can enter `<IP>:9200` in the browser to check
- job_name: 'nebula-stats-exporter'
static_configs:
- targets: [
'192.168.xx.100:9200', # nebula-stats-exporter 服务的 IP 地址和端口。
'192.168.xx.100:9200', # IP address and port of nebula-stats-exporter.
]
- job_name: 'node-exporter'
static_configs:
- targets: [
'192.168.xx.100:9100', # node-exporter 服务的 IP 地址和端口。
'192.168.xx.100:9100', # IP address and port of node-exporter.
'192.168.xx.101:9100'
]
```
Expand All @@ -161,7 +159,7 @@ After the service is started, you can enter `<IP>:9090` in the browser to check

!!! note

You only need to deploy the `nebula-http-gateway` service on the machine where the `nebula-graph-dashboard` service is installed.
You only need to deploy the `nebula-http-gateway` service on the machine where the `nebula-dashboard` service is installed.

To start the service, run the following statement in `nebula-http-gateway`:

Expand All @@ -171,24 +169,24 @@ $ nohup ./nebula-httpd &

After the service is started, you can enter `<IP>:8090` in the browser to check whether the service is started normally.

### How to deploy the `nebula-graph-dashboard` service
### How to deploy the `nebula-dashboard` service

1. Modify the `config.json` file in `nebula-dashboard/` to deploy the IP address and port of the Graph Service and Proxy. The example is as follows:

```bash
port: 7003
proxy:
gateway:
target: "127.0.0.1:8090" // change gateway service proxy
target: "127.0.0.1:8080" // change gateway service proxy
prometheus:
target: "127.0.0.1:9091" // change prometheus service proxy
target: "127.0.0.1:9090" // change prometheus service proxy
nebulaServer:
ip: "192.168.8.143" // change to nebula graph service ip
port: 9669 // change to nebula graph service port
...
```

2. To start the service, run the following statement in `nebula-graph-dashboard`:
2. To start the service, run the following statement in `nebula-dashboard`:

```bash
$ nohup ./dashboard &
Expand All @@ -205,5 +203,5 @@ $ kill $(lsof -t -i :9100) # stop the node-exporter service
$ kill $(lsof -t -i :9200) # stop the nebula-stats-exporter service
$ kill $(lsof -t -i :9090) # stop the prometheus service
$ kill $(lsof -t -i :8090) # stop the nebula-http-gateway service
$ kill $(lsof -t -i :7003) # 停止 nebula-graph-dashboard service
$ kill $(lsof -t -i :7003) # stop dashboard service
```

0 comments on commit be5bc1c

Please sign in to comment.