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

Dashboard deployment change #1509

Merged
merged 2 commits into from
Jul 18, 2022
Merged

Dashboard deployment change #1509

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3a0755
add server related parameters
abby-cyber Jul 13, 2022
35f6245
dashboard-deployment-change
abby-cyber Jul 13, 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
107 changes: 71 additions & 36 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
Expand Up @@ -8,7 +8,12 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these:

- 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 MySQL database named as `dashboard` is create. Make sure the default character set of the database is `utf8`.
- MySQL and SQLite are supported to store Dashboard metadata. To use MySQL, make sure that the environment of [MySQL](https://www.mysql.com/) is ready and a MySQL database named as `dashboard` is create. Make sure the default character set of the database is `utf8`.

!!! note

No SQLite environment is required when using SQLite to store Dashboard metadata.

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

| Port | Description |
Expand Down Expand Up @@ -50,35 +55,50 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these:
3. Edit `vim /usr/local/nebula-dashboard-ent/config/config.yaml` to modify the configuration.

```bash
# Information about the database
server:
host: 0.0.0.0 # Specifies the address segment that can access Dashboard.
port: 7005 # The default port used to access Dashboard Enterprise Edition.
certFile: "" # The local device certificate path for accessing Dashboard via HTTPS.
keyFile: "" # The local device certificate key path for accessing Dashboard via HTTPS.
database:
dialect: mysql # The type of database used, which currently only supports MySQL.
dialect: sqlite # The database type used to store metadata. Only support SQLite and MySQL currently. The default value is SQLite.
autoMigrate: true # Whether to automatically create a database table. Defaults to true.

# SQLite-related configurations, configured only when dialect is set to sqlite.
sqliteFilePath: data/dashboard.sqlite.db # The default path for storing information in SQLite.

# MySQL-related configurations, configured only when dialect is set to mysql.
host: 192.168.8.157 # The IP address of the connected MySQL database.
port: 3306 # The port of the connected MySQL database.
username: root # The username to log in MySQL.
password: nebula # The password to log in MySQL.
name: dashboard # The name of the corresponding database.
autoMigrate: true # Auto database tables creation, the default value of which is true.

# Information about the exporter port
exporter:
nodePort: 9100 # The port of the node-exporter service.
nebulaPort: 9200 # The port of the nebula-stats-exporter service.

# Information of services
proxy:
prometheus:
target: "127.0.0.1:9090" # The IP address and port of the prometheus service.
alertmanager:
target: "127.0.0.1:9093" # The IP address and port of the Alertmanager service.

# 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.
webAddress: http://127.0.0.1:7005 # The external access for Dashboard. It can be set as a hostname, used for interface callbacks. For example, the invitee who is invited by mail can use this link to access Dashboard.
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.
Expand All @@ -87,14 +107,11 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these:
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.
monitor:
onStart:
disableNodeExporterDeploy: false
disableNebulaExporterConfig: false
disablePrometheusConfig: false
disablePrometheusRule: false
disableAlertManagerRoutes: false
disableRecoveryAlertMessage: false
...
# BR
br:
backupLogsDir: "logs/br/backupLogsDir"
restoreLogsDir: "logs/br/restoreLogsDir"
```

4. Copy the license file to the `nebula-dashboard-ent` directory.
Expand Down Expand Up @@ -192,21 +209,30 @@ sudo /dashboard/scripts/dashboard.service restart all #Restart Dashboard.
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.
During the installation process, you need to enter the path to the license and choose a database for storing Dashboard metadata. Currently, we support MySQL and SQLite.

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.
```
=== "SQLite"

```bash
Nebula Dashboard Enterprise version need license, please enter the license file path(~/nebula.license): /home/vesoft/license/nebula.license
Which database do you want to use? [sqlite | mysql]:sqlite # The default value is SQLite.
Do you want to start the service now? [Y/N]: y
```
=== "MySQL"

```bash
Nebula Dashboard Enterprise version need license please enter the license file path(~/nebula.license): /home/vesoft/license/nebula.license
Which database do you want to use? [sqlite | mysql]:mysql
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.
Do you want to start the service now? [Y/N]: y
```

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

Expand Down Expand Up @@ -301,21 +327,30 @@ sudo rpm -e <package_name>
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.
During the installation process, you need to enter the path to the license and choose a database for storing Dashboard metadata. Currently, we support MySQL and SQLite.

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.
```
=== "SQLite"

```bash
Nebula Dashboard Enterprise version need license, please enter the license file path(~/nebula.license): /home/vesoft/license/nebula.license
Which database do you want to use? [sqlite | mysql]:sqlite # The default value is SQLite.
Do you want to start the service now? [Y/N]: y
```
=== "MySQL"

```bash
Nebula Dashboard Enterprise version need license please enter the license file path(~/nebula.license): /home/vesoft/license/nebula.license
Which database do you want to use? [sqlite | mysql]:mysql
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.
Do you want to start the service now? [Y/N]: y
```

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

Expand Down