-
Notifications
You must be signed in to change notification settings - Fork 82
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
deploy dashboard and account #893
Changes from all commits
8053fb5
4601d37
ca055be
2b5d850
ee08dd0
b1b9fbf
b68d16d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
# Deploy Dashboard | ||
|
||
This topic will introduce how to install and deploy Dashboard in detail. | ||
|
||
## Prerequisites | ||
|
||
Before deploying Dashboard, you must do a check of these | ||
|
||
- Select and download Dashboard of the correct version. The version correspondence between Dashboard and Nebula Graph is as follows. | ||
|
||
| Dashboard version | Nebula Graph version | | ||
| :-------------------------- | :--------------- | | ||
| {{ dashboard_ent.release }} | 2.x | | ||
|
||
- The environment of [MySql](https://www.mysql.com/) is ready and a database named as `dashboard` is created. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MySQL |
||
- Before the installation starts, the following ports are not occupied. | ||
|
||
| Port | Description | | ||
| ---- | ---- | | ||
| 7005 | The port through which Dashboard provides the web service. | | ||
| 8090 | The port of the nebula-http-gateway service. | | ||
| 9090 | The port of the prometheus service. | | ||
| 9200 | The port of the nebula-stats-exporter service. | | ||
|
||
- The license is ready. | ||
|
||
!!! enterpriseonly | ||
|
||
The license is only available in the Enterprise Edition. To obtain the license, send email to [email protected]. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. an email/emails? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. haha Email is not a countable noun > < |
||
|
||
## Install and start | ||
|
||
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/). | ||
|
||
2. Use `tar -xzvf` to decompress the tar package. | ||
|
||
```bash | ||
$ tar -xzvf nebula-graph-dashboard-<version>.tar.gz | ||
``` | ||
|
||
3. Use `vim config/config.yaml` to modify the configuration. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Edit might be more precise than use. |
||
|
||
```bash | ||
# Information about the database | ||
database: | ||
dialect: mysql # The type of database used, which currently only supports 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: | ||
gateway: | ||
target: "127.0.0.1:8090" # The IP address and port of the gateway service | ||
prometheus: | ||
target: "127.0.0.1:9090" # The IP address and port of the prometheus service | ||
``` | ||
|
||
4. Copy the license file to the `nebula-dashboard` directory. | ||
|
||
```bash | ||
$ cp -r <license> <dashboard_path> | ||
``` | ||
|
||
For example: | ||
```bash | ||
$ cp -r nebula.license /usr/local/nebula-dashboard | ||
``` | ||
|
||
!!! enterpriseonly | ||
|
||
The license is only available in the Enterprise Edition. To obtain the license, send email to [email protected]. | ||
|
||
5. Start Dashboard. | ||
|
||
You can use the following command to start the Dashboard with one click. | ||
```bash | ||
$ bash ./scripts/start.sh | ||
``` | ||
Or execute the following commands to start prometheus, webserver, exporter and gateway services to start Dashboard. | ||
Comment on lines
+86
to
+90
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Leave a blank line between block elements in case there is a problem. |
||
|
||
```bash | ||
$ cd scripts | ||
$ sudo ./dashboard.server start prometheus # Start prometheus service | ||
$ sudo ./dashboard.server start webserver # Start webserver service | ||
$ sudo ./dashboard.server start exporter # Start exporter service | ||
$ sudo ./dashboard.server start gateway # Start gateway service | ||
``` | ||
|
||
## Manage Dashboard Service | ||
|
||
You can use the `dashboard.service` script to start, stop, and check the Dashboard services. | ||
|
||
### Syntax | ||
|
||
```bash | ||
$ sudo <dashboard_path>/dashboard/scripts/dashboard.service | ||
[-v] [-h] | ||
<start|stop|status> <prometheus|webserver|exporter|gateway|all> | ||
``` | ||
|
||
| Parameter | Description | | ||
| :------------------------- | :------------------- | | ||
| `dashboard_path` | Dashboard installation path. | | ||
| `-v` | Display detailed debugging information. | | ||
| `-h` | Display help information. | | ||
| `start` | Start the target services. | | ||
| `stop` | Stop the target services. | | ||
| `status` | Check the status of the target services. | | ||
| `prometheus` | Set the prometheus Service as the target service. | | ||
| `webserver` | Set the webserver Service as the target service. | | ||
| `exporter` | Set the exporter Service as the target service. | | ||
| `gateway` | Set the gateway Service as the target service. | | ||
| `all` | Set all the Dashboard services as the target services. | | ||
|
||
### Examples | ||
|
||
Dashboard is installed in the current directory, and you can use the following commands to manage services. | ||
```bash | ||
Comment on lines
+128
to
+129
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A blank line in between |
||
$ sudo /dashboard/scripts/dashboard.service start all #start all Dashboard service | ||
$ sudo /dashboard/scripts/dashboard.service stop all #stop all Dashboard service | ||
$ sudo /dashboard/scripts/dashboard.service status all #check all Dashboard service | ||
``` | ||
|
||
## Next to do | ||
|
||
After Dashboard is successfully started, you can enter `http://<ip_address>:7005` in the address bar of a browser. | ||
|
||
If the following login interface is shown in the browser, then you have successfully deployed and started Dashboard. You can log into the GOD user of Dashboard with the default username `nebula` and password `nebula`. You can modify the password in [System Settings](../nebula-dashboard-ent/6.system-settings.md). And you also can use the GOD account to create a new account with the permission ADMIN on the [Account Management](../nebula-dashboard-ent/5.account-management.md) to log into the Dashboard. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can log into the GOD user of Dashboard with the default username --->You can log into the Dashboard as a GOD user with the xxx |
||
|
||
 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Authority management | ||
|
||
By default, you can log in with the GOD role (`nebula` as the default username and `nebula` as the default password). And the ADMIN account can be created or deleted on the authority management page. | ||
|
||
 | ||
|
||
You cannot perform operations on other accounts using the ADMIN account you created except for viewing the user name, the role, and the creation time. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. user name or username? |
||
|
||
 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
End with colon?