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.

Sign up for GitHub

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 2.deploy-connect-dashboard-ent.md #1173

Merged
merged 4 commits into from
Mar 31, 2022
Merged

Update 2.deploy-connect-dashboard-ent.md #1173

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d614dbc
Update 2.deploy-connect-dashboard-ent.md
abby-cyber Mar 16, 2022
e7c9783
Update 2.deploy-connect-dashboard-ent.md
abby-cyber Mar 23, 2022
8dd13d5
Update 2.deploy-connect-dashboard-ent.md
abby-cyber Mar 23, 2022
7d23188
Update 2.deploy-connect-dashboard-ent.md
abby-cyber Mar 24, 2022
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
251 changes: 222 additions & 29 deletions docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Deploy Dashboard
# Deploy Dashboard Enterprise Edition

This topic will introduce how to install and deploy Dashboard in detail.
This topic will introduce how to deploy Dashboard Enterprise Edition in detail.

## Prerequisites

Before deploying Dashboard, you must do a check of these:
Before deploying Dashboard Enterprise Edition, you must do a check of these:

- Select and download Dashboard of the correct version. For information about the version correspondence between Dashboard and Nebula Graph, see [Version compatibility](1.what-is-dashboard-ent.md).
- Select and download Dashboard Enterprise Edition of the correct version. For information about the version correspondence between Dashboard Enterprise Edition and Nebula Graph, see [Version compatibility](1.what-is-dashboard-ent.md).

- The environment of [MySQL](https://www.mysql.com/) is ready and a database named as `dashboard` is created.
- Before the installation starts, the following ports are not occupied.

| Port | Description |
| ---- | ---- |
| 7005 | The port through which Dashboard provides the web service. |
| 7005 | The port through which Dashboard Enterprise Edition provides the web service. |
| 9090 | The port of the prometheus service. |
| 9200 | The port of the nebula-stats-exporter service. |
| 9093 | The port of the Alertmanager service, used to receive Prometheus alerts and then send them to Dashboard.|
Expand All @@ -24,24 +24,26 @@ Before deploying Dashboard, you must do a check of these:

The license is only available in the Enterprise Edition. To obtain the license, apply for [Nebula Dashboard Free Trial](https://forms.gle/AxVejqKjWT9Z8HLq8).

## Install and start
## Deploy Dashboard Enterprise Edition with TAR

1. Select and download the tar package according to your needs. It is recommended to select the latest version.
### Installation

1. Select and download the TAR package according to your needs. It is recommended to select the latest version.

!!! enterpriseonly

For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).
You can [apply online](https://docs.google.com/forms/d/e/1FAIpQLSeALEyndeE9btlcI1VMbfDewyWMuPxwglPsYvcYOlfx245KJA/viewform) for Dashboard Enterprise Edition free trial. To purchase, contact our sales team via email ([email protected]). For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).

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

```bash
$ tar -xzvf nebula-dashboard-ent-<version>.linux-amd64.tar.gz
tar -xzvf nebula-dashboard-ent-<version>.linux-amd64.tar.gz
```

For example:

```bash
$ tar -xzvf nebula-dashboard-ent-{{dashboard_ent.release}}.linux-amd64.tar.gz
tar -xzvf nebula-dashboard-ent-{{dashboard_ent.release}}.linux-amd64.tar.gz
```

3. Edit `vim config/config.yaml` to modify the configuration.
Expand Down Expand Up @@ -76,7 +78,7 @@ Before deploying Dashboard, you must do a check of these:
system:
webAddress: http://127.0.0.1:7005 # The address to access Dashboard for the invitee who is invited by mail.
messageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default.
# LDAP 信息
# LDAP information
ldap:
server: ldap://127.0.0.1 # The LDAP server address.
bindDN: cn=admin,dc=vesoft,dc=com # The LDAP login username.
Expand All @@ -89,45 +91,44 @@ Before deploying Dashboard, you must do a check of these:
4. Copy the license file to the `nebula-dashboard-ent` directory.

```bash
$ cp -r <license> <dashboard_path>
cp -r <license> <dashboard_path>
```

For example:

```bash
$ cp -r nebula.license /usr/local/nebula-dashboard-ent
cp -r nebula.license /usr/local/nebula-dashboard-ent
```

5. Start Dashboard.

You can use the following command to start the Dashboard with one click.

```bash
$ cd scripts
$ sudo ./dashboard.service start all
cd scripts
sudo ./dashboard.service start all
```

Or execute the following commands to start prometheus, webserver, exporter and gateway services to start Dashboard.

```bash
$ cd scripts
$ sudo ./dashboard.service start prometheus # Start prometheus service
$ sudo ./dashboard.service start webserver # Start webserver service
$ sudo ./dashboard.service start exporter # Start exporter service
$ sudo ./dashboard.service start gateway # Start gateway service
cd scripts
sudo ./dashboard.service start prometheus # Start prometheus service
sudo ./dashboard.service start webserver # Start webserver service
sudo ./dashboard.service start exporter # Start exporter service
sudo ./dashboard.service start gateway # Start gateway service
```

!!! note

If you change the configuration file after starting Dashboard, you can run `dashboard.service restart all` in the `scripts` directory to synchronize the changes to the Dashboard client page.
## Manage Dashboard Service

You can use the `dashboard.service` script to start, stop, and check the Dashboard services.
### Manage Dashboard Service

### Syntax
You can use the `dashboard.service` script to start, stop, and check the Dashboard services.

```bash
$ sudo <dashboard_path>/dashboard/scripts/dashboard.service
sudo <dashboard_path>/dashboard/scripts/dashboard.service
[-v] [-h]
<start|stop|status> <prometheus|webserver|exporter|gateway|all>
```
Expand All @@ -151,10 +152,202 @@ $ sudo <dashboard_path>/dashboard/scripts/dashboard.service
Dashboard is installed in the current directory, and you can use the following commands to manage services.

```bash
$ sudo /dashboard/scripts/dashboard.service start all #Start Dashboard.
$ sudo /dashboard/scripts/dashboard.service stop all #Stop Dashboard.
$ sudo /dashboard/scripts/dashboard.service status all #Check Dashboard status.
$ sudo /dashboard/scripts/dashboard.service restart all #Restart Dashboard.
sudo /dashboard/scripts/dashboard.service start all #Start Dashboard.
sudo /dashboard/scripts/dashboard.service stop all #Stop Dashboard.
sudo /dashboard/scripts/dashboard.service status all #Check Dashboard status.
sudo /dashboard/scripts/dashboard.service restart all #Restart Dashboard.
```

## Deploy Dashboard Enterprise Edition with RPM

### Installation

1. Download an RPM package.

!!! enterpriseonly

You can [apply online](https://docs.google.com/forms/d/e/1FAIpQLSeALEyndeE9btlcI1VMbfDewyWMuPxwglPsYvcYOlfx245KJA/viewform) for Dashboard Enterprise Edition free trial. To purchase, contact our sales team via email ([email protected]). For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).


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

For example, run the following command to install Dashboard Enterprise Edition. Installation path is `/usr/local/nebula-dashboard-ent` by default.

```bash
sudo rpm -i nebula-dashboard-ent-<version>.x86_64.rpm
```

You can also run the following command to specify the installation path.

```bash
sudo rpm -i nebula-dashboard-ent-xxx.rpm --prefix=<path>
```

During the installation process, you need to enter the path to the license and MySQL-related information, including the IP and port to connect to MySQL, the account and password to log into MySQL, and the MySQL database name.

For example:

```
Nebula Dashboard Enterprise version need license, please enter the license file path(~/nebula.license): /home/vesoft/nebula.license # The path to the license.

Do you want to start the service now?[Y/N]: y
Step1: set mysql database config
Enter mysql host(127.0.0.1): 192.168.8.157 # The IP address of the connected MySQL database.
Enter mysql service port(3306): # The port of the connected MySQL database. The default port is 3306.
Enter mysql username(root): # The username to log in MySQL.
Enter mysql password(nebula): # The password to log in MySQL.
Enter mysql database name(dashboard): # The name of the corresponding database.
```

3. (Optional) Run the following commands to view the status of and start all the services.

```
sudo systemctl list-dependencies nebula-dashboard.target # View the status of all the services.
sudo systemctl start nebula-dashboard.target # Start all the services.
```

You can also view, start, and stop a single service. For example:

```
sudo systemctl {status|stop|start} {nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service}
```


4. (Optional) To configure recipients of cluster alert notifications and to configure LDAP accounts, run `vim /usr/local/nebula-dashboard-ent/config/config.yaml` and add the following settings.

```
# Information of the sender's Email used to invite LDAP accounts.
mail:
host: smtp.office365.com # The SMTP server address.
port: 587 # The port number of the SMTP server.
username: "" # The SMTP server account name.
password: "" # The SMTP server password.
# System information
system:
webAddress: http://127.0.0.1:7005 # The address to access Dashboard for the invitee who is invited by mail.
messageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default.
# LDAP information
ldap:
server: ldap://127.0.0.1 # The LDAP server address.
bindDN: cn=admin,dc=vesoft,dc=com # The LDAP login username.
bindPassword: "" # The LDAP login password.
baseDN: dc=vesoft,dc=com # Set the path to query user data.
userFilter: "&(objectClass=*)" # Set a filter to LDAP search queries.
emailKey: mail # Set the field name used to restore email in LDAP.
```

### View logs

You can view the Dashboard Enterprise Edition operation logs in the `/var/log/messages` path.

For example:

```
sudo cat /var/log/messages
```

### Uninstallation

To uninstall Dashboard Enterprise Edition deployed with RPM, run the following command.

```
sudo rpm -e <package_name>
```

## Deploy Dashboard Enterprise Edition with DEB

### Installation

1. Download a DEB package.

!!! enterpriseonly

You can [apply online](https://docs.google.com/forms/d/e/1FAIpQLSeALEyndeE9btlcI1VMbfDewyWMuPxwglPsYvcYOlfx245KJA/viewform) for Dashboard Enterprise Edition free trial. To purchase, contact our sales team via email ([email protected]). For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).

2. Install the package.

```
sudo dpkg -i <package_name>
```

!!! note

Custom installation paths are not supported when installing Dashboard Enterprise Edition with DEB. The default installation path is `/usr/local/nebula-dashboard-ent/`.

For example, to install the DEB package of the {{dashboard_ent.release}} version:

```
sudo dpkg -i nebula-dashboard-ent-{{dashboard_ent.release}}.ubuntu1804.amd64.deb
```

During the installation process, you need to enter the path to the license and MySQL-related information, including the IP and port to connect to MySQL, the account and password to log into MySQL, and the MySQL database name.

For example:

```
Nebula Dashboard Enterprise version need license, please enter the license file path(~/nebula.license): /home/vesoft/nebula.license # The path to the license.

Do you want to start the service now?[Y/N]: y
Step1: set mysql database config
Enter mysql host(127.0.0.1): 192.168.8.157 # The IP address of the connected MySQL database.
Enter mysql service port(3306): # The port of the connected MySQL database. The default port is 3306.
Enter mysql username(root): # The username to log in MySQL.
Enter mysql password(nebula): # The password to log in MySQL.
Enter mysql database name(dashboard): # The name of the corresponding database.
```

3. (Optional) Run the following commands to view the status of and start all the services.

```
sudo systemctl list-dependencies nebula-dashboard.target # View the status of all the services.
sudo systemctl start nebula-dashboard.target # Start all the services.
```

You can also view, start, and stop a single service. For example:

```
sudo systemctl {status|stop|start} {nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service}
```

4. (Optional) To configure recipients of cluster alert notifications and to configure LDAP accounts, run `vim /usr/local/nebula-dashboard-ent/config/config.yaml` and add the following settings.

```
# Information of the sender's Email used to invite LDAP accounts.
mail:
host: smtp.office365.com # The SMTP server address.
port: 587 # The port number of the SMTP server.
username: "" # The SMTP server account name.
password: "" # The SMTP server password.
# System information
system:
webAddress: http://127.0.0.1:7005 # The address to access Dashboard for the invitee who is invited by mail.
messageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default.
# LDAP information
ldap:
server: ldap://127.0.0.1 # The LDAP server address.
bindDN: cn=admin,dc=vesoft,dc=com # The LDAP login username.
bindPassword: "" # The LDAP login password.
baseDN: dc=vesoft,dc=com # Set the path to query user data.
userFilter: "&(objectClass=*)" # Set a filter to LDAP search queries.
emailKey: mail # Set the field name used to restore email in LDAP.
```

### View logs

You can view the Dashboard Enterprise Edition operation logs in the `/var/log/syslog` path.

For example:

```
sudo cat /var/log/syslog
```

### Uninstallation

To uninstall Dashboard Enterprise Edition, run the following command.

```
sudo dpkg -r <package_name>
```

## Connect to Dashboard
Expand Down