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

Explorer 220 content&updates #1084

Merged
merged 2 commits into from
Feb 10, 2022
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 @@ -2,8 +2,6 @@

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 @@ -24,13 +22,17 @@ You can use Explorer in one of these scenarios:

Explorer has these features:

- Easy to use and user-friendly: Explorer can be deployed in simple steps. And use simple visual interaction, no need to conceive nGQL sentences, easy to realize graph exploration.
- [Easy to use](../deploy-connect/ex-ug-deploy.md): Explorer can be deployed in simple steps. And

- [User-friendly](../ex-ug-shortcuts.md): Explorer uses simple visual interaction, no need to conceive nGQL sentences, easy to realize graph exploration.

- [Flexible](../ex-ug-query-exploration.md): Explorer supports querying data through VID, Tag, and Subgraph.

- Flexible: Explorer supports querying data through VID, Tag, Subgraph.
- [Exploration operations](../ex-ug-graph-exploration.md): Explorer supports exploration operations on multiple vertices, querying the common neighbors of multiple vertices, and querying the path between the source vertex and the destination vertex.

- Multiple operations: Explorer supports operations such as expanding operations on multiple vertexes, querying the common neighbors of multiple vertexes, and querying the path between the start vertex and the end vertex.
- [Various display](../canvas-operations/canvas-overview.md): Explorer supports modifying the color and icon of the vertex in the canvas to highlight key nodes. Data can also be displayed in different modes.

- Various display: Explorer supports modifying the color and icon of the vertex in the canvas to highlight key nodes. You can also freely choose the data display mode in `dagre`, `force`, and `circular`.
- [Data storage](../canvas-operations/canvas-snapshot.md): Data on a canvas can be stored and exported.

## Authentication

Expand Down
12 changes: 7 additions & 5 deletions docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,14 @@ 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-002-1.png)

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

If you can see the interface as shown in the below, it means you have successfully connected to the Nebula Graph database.
!!! note

One session continues for up to 30 minutes. If you do not operate Explorer within 30 minutes, the active session will time out and you must connect to Nebula Graph again.
# Clear connection

When Explorer is still connected to a Nebula Graph database, in the navigation bar on the left side of the page, select **Settings** ![icon](../figs/nav-setup.png) > **Clear Connect**.

![The Console page shows that the connection is successful](../figs/ex-ug-051-1.png "Nebula Graph is connected")

One session continues for up to 30 minutes. If you do not operate Explorer within 30 minutes, the active session will time out and you must connect to Nebula Graph again.
After that, if the **configuration database** page is displayed on the browser, it means that Explorer has successfully disconnected from the Nebula Graph.
47 changes: 26 additions & 21 deletions docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@ This topic describes how to deploy Explorer locally by RPM and tar packages.

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

## RPM-based Explorer
## RPM-based deployment

### Prerequisites

Before you deploy Explorer, you must do a check of these:

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

- Before the installation starts, the following ports are not occupied.

Expand All @@ -39,7 +40,7 @@ Before you deploy Explorer, you must do a check of these:

License is only available in the Enterprise Edition. To obtain the license, apply for [Nebula Explorer Free Trial](https://docs.google.com/forms/d/e/1FAIpQLSctV0HC0HDxZc-65IHj44qpZk3fATBPAYM1SjJsbXmdL5cs9w/viewform).

### Install
### Installation

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

Expand Down Expand Up @@ -82,29 +83,29 @@ Before you deploy Explorer, you must do a check of these:

You can use SystemCTL to start and stop the service.

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

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

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

### Uninstall
### Uninstallation

You can uninstall Explorer using the following command:

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

## tar-based Explorer
## TAR-based deployment

### Prerequisites

Expand All @@ -130,15 +131,15 @@ Before deploying Explorer, you must check the following information:

License is only available in the Enterprise Edition. To obtain the license, apply for [Nebula Explorer Free Trial](https://docs.google.com/forms/d/e/1FAIpQLSctV0HC0HDxZc-65IHj44qpZk3fATBPAYM1SjJsbXmdL5cs9w/viewform).

### Install and deploy
### Installation

1. Select and download the tar package according to your needs. It is recommended to select the latest version. Common links are as follows:
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 Edition. Click [Pricing](https://nebula-graph.io/pricing/) to see more.

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

```bash
$ tar -xvf nebula-graph-explorer-<version>.tar.gz
Expand Down Expand Up @@ -174,8 +175,12 @@ $ kill $(lsof -t -i :7002)

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.
The following login page shows that Explorer is successfully connected to Nebula Graph.

![Nebula Explorer Login page](../figs/explorer_deploy.png)

!!! note

![Nebula Explorer](../figs/ex-ug-002-1.png)
When logging into Nebula Explorer for the first time, the content of *END USER LICENSE AGREEMENT* is displayed on the login page. Please read it and then click **I agree**.

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).

This file was deleted.

Binary file added docs-2.0/nebula-explorer/figs/2d-mode.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/3d-mode.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/Thumbnail-Grid.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/Thumbnail-Radial.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 modified docs-2.0/nebula-explorer/figs/Thumbnail-graphView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-2.0/nebula-explorer/figs/Thumbnail-sphereView.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 modified docs-2.0/nebula-explorer/figs/Thumbnail-treeView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/console_delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/console_run.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/dataview.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 removed docs-2.0/nebula-explorer/figs/ex-ug-001-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-001.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-002-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-004.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-006.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-009.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-011.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-012.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-013.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-014.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-015.png
Binary file not shown.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-016.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-017-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-017.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-018-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-018.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-023-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-023.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-024-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-025-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-025.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-026.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-027-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-027.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-028.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-029-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-050.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-051-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/ex-ug-051.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/explorer-en.png
Diff not rendered.
Binary file added docs-2.0/nebula-explorer/figs/graph-snapshot.png
Binary file added docs-2.0/nebula-explorer/figs/layout.gif
Binary file added docs-2.0/nebula-explorer/figs/list-add.png
Binary file added docs-2.0/nebula-explorer/figs/list-left.png
Binary file modified docs-2.0/nebula-explorer/figs/nav-Revoke.png
Binary file added docs-2.0/nebula-explorer/figs/nav-commonNeighbor.png
Binary file added docs-2.0/nebula-explorer/figs/nav-console.png
Binary file removed docs-2.0/nebula-explorer/figs/nav-delete.png
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/nav-deleteReverse.png
Diff not rendered.
Binary file added docs-2.0/nebula-explorer/figs/nav-expand.png
Binary file modified docs-2.0/nebula-explorer/figs/nav-filter.png
Binary file added docs-2.0/nebula-explorer/figs/nav-findPath.png
Binary file removed docs-2.0/nebula-explorer/figs/nav-frameSelect.png
Diff not rendered.
Binary file modified docs-2.0/nebula-explorer/figs/nav-graphSpace.png
Binary file modified docs-2.0/nebula-explorer/figs/nav-help.png
Binary file modified docs-2.0/nebula-explorer/figs/nav-miss.png
Binary file modified docs-2.0/nebula-explorer/figs/nav-missReverse.png
Binary file removed docs-2.0/nebula-explorer/figs/nav-moveCanvas.png
Diff not rendered.
Binary file modified docs-2.0/nebula-explorer/figs/nav-propertyView.png
Binary file removed docs-2.0/nebula-explorer/figs/nav-query.png
Diff not rendered.
Binary file added docs-2.0/nebula-explorer/figs/nav-query2.png
Binary file modified docs-2.0/nebula-explorer/figs/nav-setup.png
Binary file removed docs-2.0/nebula-explorer/figs/nav-singleSelect.png
Diff not rendered.
Binary file added docs-2.0/nebula-explorer/figs/node-filtering.png
Binary file added docs-2.0/nebula-explorer/figs/query_subgraph.png
Binary file added docs-2.0/nebula-explorer/figs/query_tag.png
Binary file added docs-2.0/nebula-explorer/figs/redo.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs-2.0/nebula-explorer/figs/sidebar-unfold.png
Diff not rendered.
Binary file added docs-2.0/nebula-explorer/figs/snapshot-delete.png
Binary file added docs-2.0/nebula-explorer/figs/snapshot-export.png
Binary file added docs-2.0/nebula-explorer/figs/snapshot-history.png
Binary file added docs-2.0/nebula-explorer/figs/snapshot-import.png
Binary file added docs-2.0/nebula-explorer/figs/thumbnail.png
Binary file added docs-2.0/nebula-explorer/figs/topbar-exportCSV.png
Binary file added docs-2.0/nebula-explorer/figs/topbar-exportPNG.png
Binary file added docs-2.0/nebula-explorer/figs/vid_query.gif
Binary file added docs-2.0/nebula-explorer/figs/visualization.gif
26 changes: 14 additions & 12 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -435,18 +435,20 @@ nav:
- FAQ: nebula-dashboard-ent/8.faq.md

- Nebula Explorer:
- What is Nebula Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md
- Deploy and connect:
- Deploy Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md
- Connect to Nebula Graph: nebula-explorer/deploy-connect/ex-ug-connect.md
- Reset connections: nebula-explorer/deploy-connect/ex-ug-reset-connection.md
- Operation guide:
- Page overview: nebula-explorer/operation-guide/ex-ug-page-overview.md
- Start query: nebula-explorer/operation-guide/ex-ug-query-exploration.md
- Graph exploration and expansion: nebula-explorer/operation-guide/ex-ug-graph-exploration.md
- Canvas operation: nebula-explorer/operation-guide/ex-ug-canvas.md
- Relationship list: nebula-explorer/operation-guide/ex-ug-relationship-list.md
- Shortcuts: nebula-explorer/operation-guide/ex-ug-shortcuts.md
- What is Nebula Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md
- Deploy and connect:
- Deploy Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md
- Connect to Nebula Graph: nebula-explorer/deploy-connect/ex-ug-connect.md
- Page overview: nebula-explorer/ex-ug-page-overview.md
- Start querying: nebula-explorer/ex-ug-query-exploration.md
- Vertex Filter: nebula-explorer/node-filtering.md
- Graph exploration: nebula-explorer/ex-ug-graph-exploration.md
- Canvas:
- Overview: nebula-explorer/canvas-operations/canvas-overview.md
- Visualization modes: nebula-explorer/canvas-operations/visualization-mode.md
- Snapshots: nebula-explorer/canvas-operations/canvas-snapshot.md
- Explorer console: nebula-explorer/explorer-console.md
- Basic operations and shortcuts: nebula-explorer/ex-ug-shortcuts.md

- Nebula Importer:
- Use Nebula Importer: nebula-importer/use-importer.md
Expand Down