Dashboard ent 220 config file updates (#1063)

* Dashboard-ent-220-config_file updates * Update 2.deploy-connect-dashboard-ent.md
vesoft-inc · Jan 25, 2022 · d6acec6 · d6acec6
1 parent 5e1744c
commit d6acec6
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 54 deletions.
diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
@@ -16,7 +16,7 @@ Before deploying Dashboard, you must do a check of these:
   | 7005 | The port through which Dashboard 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.|
 - The license is ready.
 
   !!! enterpriseonly
@@ -33,71 +33,92 @@ Before deploying Dashboard, you must do a check of these:
 
 2. Use `tar -xzvf` to decompress the tar package.
 
-   ```bash
-   $ tar -xzvf nebula-dashboard-ent-<version>.linux-amd64.tar.gz 
-   ```
+  ```bash
+  $ tar -xzvf nebula-dashboard-ent-<version>.linux-amd64.tar.gz 
+  ```
 
-   For example:
+  For example:
 
-   ```bash
-   $ tar -xzvf nebula-dashboard-ent-1.0.0.linux-amd64.tar.gz 
-   ```
+  ```bash
+  $ tar -xzvf nebula-dashboard-ent-1.0.0.linux-amd64.tar.gz 
+  ```
 
 3. Edit `vim config/config.yaml` to modify the configuration.
 
-   ```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
-   ```
+  ```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:
+    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.
+    messageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default. 
+  # LDAP 信息
+  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.
+  ```
 
 4. Copy the license file to the `nebula-dashboard-ent` directory.
 
-   ```bash
-   $ cp -r <license> <dashboard_path>
-   ```
+  ```bash
+  $ cp -r <license> <dashboard_path>
+  ```
+
+  For example:
 
-   For example:
-
-   ```bash
-   $ cp -r nebula.license /usr/local/nebula-dashboard-ent
-   ```
+  ```bash
+  $ 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.
+  You can use the following command to start the Dashboard with one click.
 
-   ```bash
-   $ cd scripts
-   $ sudo ./dashboard.service start all
-   ```
+  ```bash
+  $ cd scripts
+  $ sudo ./dashboard.service start all
+  ```
 
-   Or execute the following commands to start prometheus, webserver, exporter and gateway services to start Dashboard.
+  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
-   ```
+  ```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
+  ```
+
+!!! 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.
@@ -129,9 +150,10 @@ $ 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 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 
+$ 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.
 ```
 
 ## Connect to Dashboard

diff --git a/docs-2.0/nebula-dashboard-ent/9.alerts.md b/docs-2.0/nebula-dashboard-ent/9.alerts.md
@@ -11,7 +11,7 @@ On the left side navigation bar of the **Cluster Management** page, click **Noti
 - You can filter alert messages by severity, type, and status. Click **Reset** to empty all filtering results.
 - You can set the processing status of alert messages. The status is `unsolved` by default, and you can set the status to `Dealing` or `Solved`.
 
-Alert messages cannot be deleted. In the `nebula-dashboard-ent/config/config.yaml` file, `messageStore` sets the number of days to keep alert messages, the value of which is 90 by default.
+Alert messages cannot be deleted. In the `nebula-dashboard-ent/config/config.yaml` file, `messageStore` sets the number of days to keep alert messages, the value of which is 90 by default. For more information about the configuration file, see [Deploy Dashboard](2.deploy-connect-dashboard-ent.md)。
 
 ## Alert rules