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

update explorer #887

Merged
merged 4 commits into from
Nov 8, 2021
Merged
Show file tree
Hide file tree
Changes from 2 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 @@ -2,6 +2,8 @@

Nebula Explorer (Explorer in short) is a browser-based visualization tool. It is used with the Nebula Graph core to visualize interaction with graph data. Even if there is no experience in graph database, you can quickly become a graph exploration expert.

![explorer](../figs/explorer-en.png)

!!! enterpriseonly

Explorer is only available in the enterprise version.
Expand All @@ -10,7 +12,6 @@ Nebula Explorer (Explorer in short) is a browser-based visualization tool. It is

You can also try some functions online in [Explorer](https://explorer.nebula-graph.io/).

![explorer](../figs/explorer-en.png)

## Scenarios

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To connect Explorer to Nebula Graph, follow these steps:

- If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords.

![The Config Server page shows the fields to be configured for connection](../figs/ex-ug-001-1.png)
![The Config Server page shows the fields to be configured for connection](../figs/ex-ug-002-1.png)

2. After the configuration, click the **Login** button.

Expand Down
132 changes: 87 additions & 45 deletions docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# Deploy Explorer

This topic describes how to deploy Explorer locally by RPM, and tar package.
This topic describes how to deploy Explorer locally by RPM and tar package.
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

## Nebula Graph version

!!! Note

Explorer is released separately, not synchronized with Nebula Graph core. And the naming of Explorer is different from that of Nebula Graph. The version correspondence between Nebula Graph and Explorer is as follows.
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

| Nebula Graph version | Explorer version |
| --- | --- |
| 2.5.x | 2.0.0 |
| 2.6.x | 2.1.0 |

## RPM-based Explorer

Expand All @@ -15,13 +26,13 @@ Before you deploy Explorer, you must do a check of these:
| Port | Description |
| ---- | ---- |
| 7002 | Web service provided by Explorer |
| 8070 | Nebula-http-gateway service |

- The Linux distribution is CentOS, installed with [Node.js](https://nodejs.org/en/) of version above v10.16.0+ and [Go](https://golang.org/) of version above 1.13.

!!! caution

At present, the package provided by Nebula Explorer can be used in Linux environment only. If users use mac or other environments, clone [http-gateway repo](https://github.com/vesoft-inc/nebula-http-gateway), modify the `httpport = 8070` in the `nebula-http-gateway/conf/app.conf` file, and use the `make` command to compile and start Nebula Explorer.
By default, Explorer uses the port `7002`. You can modify the `httpport` in the `conf/app.conf` file in the installation directory and restart the service.

- The Linux distribution is CentOS.
- GO of version above 1.13 is installed.

### Install

Expand All @@ -33,40 +44,70 @@ Before you deploy Explorer, you must do a check of these:

2. Use `sudo rpm -i <rpm>` to install RPM package.

For example, install Explorer, use the following command:
For example, use the following command to install Explorer. The default installation path is `/usr/local/nebula-explorer`.

```bash
$ sudo rpm -i nebula-graph-explorer-<version>.x86_64.rpm
$ sudo rpm -i nebula-explorer-<version>.x86_64.rpm
```

### Uninstall
You can also install it to the specified path using the following command:
```bash
$ sudo rpm -i nebula-explorer-xxx.rpm --prefix=<path>
```

Users can uninstall Explorer using the following command:
3. Copy the license to the installation path.

```bash
$ sudo rpm -e nebula-graph-explorer-<version>.x86_64
```
```bash
$ cp -r <license> <explorer_path>
```

For example:
```bash
$ cp -r nebula.license /usr/local/nebula-explorer
```

!!! enterpriseonly

### Exception handling
License is only available in the Enterprise Edition. For more information, send an email to [email protected].
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

4. After adding the license, you need to stop and restart the service using the following command.

```bash
$ systemctl stop nebula-explorer #Stop the service
$ systemctl start nebula-explorer #Start the service
```

If the automatic start fails during the installation process or you want to manually start or stop the service, use the following command:
### Start and stop

- Start the service manually.
You can use SystemCTL to start and stop the service.

```bash
$ sudo sh ./scripts/start.sh
$ systemctl status nebula-explorer #Check the status
$ systemctl stop nebula-explorer #Stop the service
$ systemctl start nebula-explorer #Start the service
```

- Stop the service manually
You can also start or stop the service manually using the following command in the installation directory.

```bash
$ sudo sh ./scripts/stop.sh
$ cd ./scripts/rpm
$ bash ./start.sh #Start the service
$ bash ./stop.sh #Stop the service
```

### Uninstall

You can uninstall Explorer using the following command:

```bash
$ sudo rpm -e nebula-graph-explorer-<version>.x86_64
```

## tar-based Explorer

### Prerequisites

Before you deploy Explorer, you must do a check of these:
Before deploying Explorer, you must check the following information:

- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md).

Expand All @@ -75,63 +116,64 @@ Before you deploy Explorer, you must do a check of these:
| Port | Description |
| ---- | ---- |
| 7002 | Web service provided by Explorer |
| 8070 | Nebula-http-gateway service |

- The Linux distribution is CentOS, installed with [Node.js](https://nodejs.org/en/) of version above v10.16.0+ and [Go](https://golang.org/) of version above 1.13.

!!! caution

At present, the package provided by Nebula Explorer can be used in Linux environment only. If users use mac or other environments, clone [http-gateway repo](https://github.com/vesoft-inc/nebula-http-gateway), modify the `httpport = 8070` in the `nebula-http-gateway/conf/app.conf` file, and use the `make` command to compile and start Nebula Explorer.
By default, Explorer uses the port `7002`. You can modify the `httpport` in the `conf/app.conf` file in the installation directory and restart the service.

### Install
- The Linux distribution is CentOS.
- GO of version above 1.13 is installed.

### Install and deploy

1. Select and download the tar package according to your needs. It is recommended to select the latest version. Common links are as follows:

!!! enterpriseonly

Explorer is only available in the enterprise version. Click [Pricing](https://nebula-graph.io/pricing/) to see more.
Explorer is only available in the Enterprise Edition. Click [Pricing](https://nebula-graph.io/pricing/) to see more.

2. Use `tar -xvf` to decompress the tar package.

```bash
tar -xvf nebula-graph-explorer-<version>.tar.gz
$ tar -xvf nebula-graph-explorer-<version>.tar.gz
```

### Procedure

!!! Note

The root directory `nebula-graph-explorer` has two installation packages: nebula-graph-explorer and nebula-http-gateway. You need to deploy and start the services separately on the same machine to complete the deployment of Explorer.'

1. Deploy and start nebula-http-gateway.
3. Copy the license to the `nebula-explorer` directory.

```bash
$ cd nebula-http-gateway
$ nohup ./nebula-httpd &
$ cp -r <license> <explorer_path>
```

2. Deploy and start nebula-graph-explorer.

For example:
```bash
$ cd nebula-graph-explorer
$ npm run start
$ cp -r nebula.license /usr/local/nebula-explorer
```

!!! enterpriseonly

License is only available in the Enterprise Edition. For more information, send an email to [email protected].
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

4. Enter the `nebula-explorer` folder to start Explorer.

```bash
$ cd nebula-explorer
$ ./nebula-httpd &
```

### Stop Service

You can use `kill pid` to stop the service:
You can use `kill pid` to stop the service.

```bash
$ kill $(lsof -t -i :8070) # stop nebula-http-gateway
$ cd nebula-graph-explorer
$ npm run stop # stop nebula-graph-explorer
$ kill $(lsof -t -i :7002)
```

## Next to do

When Explorer is started, use `http://ip address:7002` to get access to Explorer.
When Explorer is started, use `http://<ip_address>:7002` to get access to Explorer.

Seeing the following login interface, Explorer is successfully connected to Nebula Graph.

![Nebula Explorer](../figs/ex-ug-001-1.png)
![Nebula Explorer](../figs/ex-ug-002-1.png)

After entering the Explorer login interface, you need to connect to Nebula Graph. For more information, refer to [Connecting to the Nebula Graph](../deploy-connect/ex-ug-connect.md).
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-002-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-017-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-018-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-023.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-025-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-027-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ Move the mouse to the vertex or edge to view in detail. The following shows the

Explorer supports batch selection and views the data of multiple vertexes and edges. The detailed data can be opened and viewed in the vertexes and edges overview at the lower-left corner of the canvas. It also supports exporting CSV files of selected vertexes or edges.

![review](../figs/ex-ug-027.png)
![review](../figs/ex-ug-027-1.png)

### Frame selection

After clicking the ![frameselect](../figs/nav-frameSelect.png) icon, hold down the left button to drag and select multiple vertexes and edges. Examples are as follows:

![select](../figs/ex-ug-023-1.png)
![select](../figs/ex-ug-023.png)

### Click to select multiple vertexes and edges

Click the ![singleselect](../figs/nav-singleSelect.png) icon or hold down Shift, click and select multiple vertexes and edges with the mouse, and click the blank space to cancel the selection. Examples are as follows:

![select](../figs/ex-ug-025.png)
![select](../figs/ex-ug-025-1.png)

## Quick operation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The canvas is mainly divided into:

- Vertexes and Edges overview: It is hidden by default and only displayed when the vertex and edge are selected on the current canvas. Click on the icon in the following, and the user can open the menu to view the detailed data of the selected vertexes and edges in the current canvas.

![review](../figs/ex-ug-027.png)
![review](../figs/ex-ug-027-1.png)

For more information, see [canvas operation](../operation-guide/ex-ug-canvas.md).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Relationship list

You can select vertexes and edges in the relationship list. Select 12 points where Tag is `player`, and select 9 edges where Edge is `serve`. An example is as follows:
You can select vertexes and edges in the relationship list. Select 8 points where Tag is `player`, and select 5 edges where Edge is `serve`. An example is as follows:

![select](../figs/ex-ug-017.png)
![select](../figs/ex-ug-017-1.png)

At the same time, you can modify the color and icon of the Tag to make the key nodes more prominent.

By default, VID with identical tags have the same color, and it is also allowed to manually modify the color of a vertex or a group of vertexes with identical tags. For example, if the vertex label is `player`, modify the color of one of the vertexes, and you can click to view it in the relationship list. The example is as follows:

![icon](../figs/ex-ug-018.png)
![icon](../figs/ex-ug-018-1.png)