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

update #2276

Merged
Merged

update #2276

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
291 changes: 86 additions & 205 deletions docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
Original file line number Diff line number Diff line change
@@ -47,75 +47,13 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these:
tar -xzvf nebula-dashboard-ent-{{dashboard_ent.release}}.linux-amd64.tar.gz -C /usr/local/
```

3. Enter the extracted folder and modify the `config.yaml` file in the `etc` directory to set the `LicenseManagerURL` parameter to the host IP and port number `9119` where the License Manager ([LM](../9.about-license/2.license-management-suite/3.license-manager.md)) is located and to set the relevant configuration.
3. Enter the extracted folder.

```bash
Name: dashboard-api
Host: 0.0.0.0 # Specifies the address segment that can access Dashboard.
Port: 7005 # The default port used to access Dashboard Enterprise Edition.
MaxBytes: 1073741824 # The maximum content length of an Http request that can be accepted. The default value is 1048576. Value range: 0 ~ 8388608.
Timeout: 60000 # Timeout duration of the access.
Log: # Dashboard run log settings.
KeepDays: 7 # The number of days for keeping log.
Mode: file # The save mode of logs, including console and file. console means the service logs are logged in webserver.log. file means the service logs are logged in access.log, error.log, severe.log, slow.log, and stat.log respectively.
Encoding: plain # Log encoding method, plain and json are supported.
Database:
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.
Host: 127.0.0.1 # 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.

# 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:
PrometheusAddr: 127.0.0.1:9091 # The IP address and port of the prometheus service.
AlertmanagerAddr: 127.0.0.1:9093 # The IP address and port of the Alertmanager service.

# Self-built Prometheus service configuration. If you are using the Prometheus service included with the software, you do not need to set these parameters.
# PrometheusConfig:
# Auth: # If authentication is enabled in Prometheus, the following parameters need to be configured. AccessToken is preferred.
# Username: "" # The account of the Prometheus HTTP API service.
# Password: "" # The password for the account.
# AccessToken: "" # The access token of the Prometheus HTTP API service.
# RuleImport: # Configuration for remotely updating alert rules to the Prometheus service.
# Enable: false # Whether to enable remote updating.
# URL: "https://xxxx/prometheus/import" # The interface address for updating the alert rule.
# Method: POST # Update method. Only POST operations are supported.
# Auth: # If the authentication is enabled on the interface of the URL, the following parameters need to be configured. AccessToken is preferred. AccessToken is preferred.
# AccessToken: "" # The access token of the URL interface.
# Username: "" # The authentication account of the URL interface.
# Password: "" # The password for the account.

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

# SlowQuery
SlowQuery:
Enable: true # The switch of slowquery data polling.
MessageStore: 14 # Slow queary data store time (day).
ScrapeInterval: 2m # The interval time for slow query data pulling, eg: 1s, 10s, 2m, 3h

# System information
System:
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.

CloudProvider: "" # cloud provider name, used for aliyun now.
LicenseManagerURL: "" # license manager url.
```

4. Start Dashboard.
4. (Optional) If the LM service has been deployed, modify the `config.yaml` file in the `etc` directory. Set the value of `LicenseManagerURL` to the IP of the host where LM is located and the port number to `9119`, for example `192.168.8.100:9119`. If the LM service is not deployed, it can be deployed in the visualization page after connecting Dashboard Enterprise Edition.

For more configuration descriptions, see the **Configuration file description** section at the end of the topic.

5. Start Dashboard.

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

@@ -163,75 +101,13 @@ The Linux version used is CentOS and lsof has been installed.
sudo rpm -i nebula-dashboard-ent-xxx.rpm --prefix=<path>
```

3. Enter the extracted folder and modify the `config.yaml` file in the `etc` directory to set the `LicenseManagerURL` parameter to the host IP and port number `9119` where the License Manager ([LM](../9.about-license/2.license-management-suite/3.license-manager.md)) is located and to set the relevant configuration.
3. Enter the extracted folder.

```bash
Name: dashboard-api
Host: 0.0.0.0 # Specifies the address segment that can access Dashboard.
Port: 7005 # The default port used to access Dashboard Enterprise Edition.
MaxBytes: 1073741824 # The maximum content length of an Http request that can be accepted. The default value is 1048576. Value range: 0 ~ 8388608.
Timeout: 60000 # Timeout duration of the access.
Log: # Dashboard run log settings.
KeepDays: 7 # The number of days for keeping log.
Mode: file # The save mode of logs, including console and file. console means the service logs are logged in webserver.log. file means the service logs are logged in access.log, error.log, severe.log, slow.log, and stat.log respectively.
Encoding: plain # Log encoding method, plain and json are supported.
Database:
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.
Host: 127.0.0.1 # 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.

# 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:
PrometheusAddr: 127.0.0.1:9091 # The IP address and port of the prometheus service.
AlertmanagerAddr: 127.0.0.1:9093 # The IP address and port of the Alertmanager service.

# Self-built Prometheus service configuration. If you are using the Prometheus service included with the software, you do not need to set these parameters.
# PrometheusConfig:
# Auth: # If authentication is enabled in Prometheus, the following parameters need to be configured. AccessToken is preferred.
# Username: "" # The account of the Prometheus HTTP API service.
# Password: "" # The password for the account.
# AccessToken: "" # The access token of the Prometheus HTTP API service.
# RuleImport: # Configuration for remotely updating alert rules to the Prometheus service.
# Enable: false # Whether to enable remote updating.
# URL: "https://xxxx/prometheus/import" # The interface address for updating the alert rule.
# Method: POST # Update method. Only POST operations are supported.
# Auth: # If the authentication is enabled on the interface of the URL, the following parameters need to be configured. AccessToken is preferred. AccessToken is preferred.
# AccessToken: "" # The access token of the URL interface.
# Username: "" # The authentication account of the URL interface.
# Password: "" # The password for the account.

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

# SlowQuery
SlowQuery:
Enable: true # The switch of slowquery data polling.
MessageStore: 14 # Slow queary data store time (day).
ScrapeInterval: 2m # The interval time for slow query data pulling, eg: 1s, 10s, 2m, 3h

# System information
System:
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.

CloudProvider: "" # cloud provider name, used for aliyun now.
LicenseManagerURL: "" # license manager url.
```

4. Run the following commands to view the status of and start all the services.
4. (Optional) If the LM service has been deployed, modify the `config.yaml` file in the `etc` directory. Set the value of `LicenseManagerURL` to the IP of the host where LM is located and the port number to `9119`, for example `192.168.8.100:9119`. If the LM service is not deployed, it can be deployed in the visualization page after connecting Dashboard Enterprise Edition.

For more configuration descriptions, see the **Configuration file description** section at the end of the topic.

5. 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.
@@ -274,76 +150,13 @@ sudo rpm -e <package_name>
sudo dpkg -i nebula-dashboard-ent-{{dashboard_ent.release}}.ubuntu1804.amd64.deb
```

3. Enter the extracted folder and modify the `config.yaml` file in the `etc` directory to set the `LicenseManagerURL` parameter to the host IP and port number `9119` where the License Manager ([LM](../9.about-license/2.license-management-suite/3.license-manager.md)) is located and to set the relevant configuration.

3. Enter the extracted folder.

```bash
Name: dashboard-api
Host: 0.0.0.0 # Specifies the address segment that can access Dashboard.
Port: 7005 # The default port used to access Dashboard Enterprise Edition.
MaxBytes: 1073741824 # The maximum content length of an Http request that can be accepted. The default value is 1048576. Value range: 0 ~ 8388608.
Timeout: 60000 # Timeout duration of the access.
Log: # Dashboard run log settings.
KeepDays: 7 # The number of days for keeping log.
Mode: file # The save mode of logs, including console and file. console means the service logs are logged in webserver.log. file means the service logs are logged in access.log, error.log, severe.log, slow.log, and stat.log respectively.
Encoding: plain # Log encoding method, plain and json are supported.
Database:
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.
Host: 127.0.0.1 # 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.

# 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:
PrometheusAddr: 127.0.0.1:9091 # The IP address and port of the prometheus service.
AlertmanagerAddr: 127.0.0.1:9093 # The IP address and port of the Alertmanager service.

# Self-built Prometheus service configuration. If you are using the Prometheus service included with the software, you do not need to set these parameters.
# PrometheusConfig:
# Auth: # If authentication is enabled in Prometheus, the following parameters need to be configured. AccessToken is preferred.
# Username: "" # The account of the Prometheus HTTP API service.
# Password: "" # The password for the account.
# AccessToken: "" # The access token of the Prometheus HTTP API service.
# RuleImport: # Configuration for remotely updating alert rules to the Prometheus service.
# Enable: false # Whether to enable remote updating.
# URL: "https://xxxx/prometheus/import" # The interface address for updating the alert rule.
# Method: POST # Update method. Only POST operations are supported.
# Auth: # If the authentication is enabled on the interface of the URL, the following parameters need to be configured. AccessToken is preferred. AccessToken is preferred.
# AccessToken: "" # The access token of the URL interface.
# Username: "" # The authentication account of the URL interface.
# Password: "" # The password for the account.

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

# SlowQuery
SlowQuery:
Enable: true # The switch of slowquery data polling.
MessageStore: 14 # Slow queary data store time (day).
ScrapeInterval: 2m # The interval time for slow query data pulling, eg: 1s, 10s, 2m, 3h

# System information
System:
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.

CloudProvider: "" # cloud provider name, used for aliyun now.
LicenseManagerURL: "" # license manager url.
```

4. Run the following commands to view the status of and start all the services.
4. (Optional) If the LM service has been deployed, modify the `config.yaml` file in the `etc` directory. Set the value of `LicenseManagerURL` to the IP of the host where LM is located and the port number to `9119`, for example `192.168.8.100:9119`. If the LM service is not deployed, it can be deployed in the visualization page after connecting Dashboard Enterprise Edition.

For more configuration descriptions, see the **Configuration file description** section at the end of the topic.

5. 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.
@@ -453,6 +266,74 @@ The following section presents two methods for managing the Dashboard service. I
journalctl -u nbd-prometheus.service -b
```

## Configuration file description

```bash
Name: dashboard-api
Host: 0.0.0.0 # Specifies the address segment that can access Dashboard.
Port: 7005 # The default port used to access Dashboard Enterprise Edition.
MaxBytes: 1073741824 # The maximum content length of an Http request that can be accepted. The default value is 1048576. Value range: 0 ~ 8388608.
Timeout: 60000 # Timeout duration of the access.
Log: # Dashboard run log settings.
KeepDays: 7 # The number of days for keeping log.
Mode: file # The save mode of logs, including console and file. console means the service logs are logged in webserver.log. file means the service logs are logged in access.log, error.log, severe.log, slow.log, and stat.log respectively.
Encoding: plain # Log encoding method, plain and json are supported.
Database:
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.
Host: 127.0.0.1 # 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.

# 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:
PrometheusAddr: 127.0.0.1:9091 # The IP address and port of the prometheus service.
AlertmanagerAddr: 127.0.0.1:9093 # The IP address and port of the Alertmanager service.

# Self-built Prometheus service configuration. If you are using the Prometheus service included with the software, you do not need to set these parameters.
# PrometheusConfig:
# Auth: # If authentication is enabled in Prometheus, the following parameters need to be configured. AccessToken is preferred.
# Username: "" # The account of the Prometheus HTTP API service.
# Password: "" # The password for the account.
# AccessToken: "" # The access token of the Prometheus HTTP API service.
# RuleImport: # Configuration for remotely updating alert rules to the Prometheus service.
# Enable: false # Whether to enable remote updating.
# URL: "https://xxxx/prometheus/import" # The interface address for updating the alert rule.
# Method: POST # Update method. Only POST operations are supported.
# Auth: # If the authentication is enabled on the interface of the URL, the following parameters need to be configured. AccessToken is preferred. AccessToken is preferred.
# AccessToken: "" # The access token of the URL interface.
# Username: "" # The authentication account of the URL interface.
# Password: "" # The password for the account.

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

# SlowQuery
SlowQuery:
Enable: true # The switch of slowquery data polling.
MessageStore: 14 # Slow queary data store time (day).
ScrapeInterval: 2m # The interval time for slow query data pulling, eg: 1s, 10s, 2m, 3h

# System information
System:
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.

CloudProvider: "" # cloud provider name, used for aliyun now.
LicenseManagerURL: "" # license manager url.
```

## Next to do

[Connect to Dashboard](3.connect-dashboard.md)
95 changes: 87 additions & 8 deletions docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md
Original file line number Diff line number Diff line change
@@ -44,19 +44,21 @@ In addition, if you need to use **Workflow** for complex graph computing, you ne

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

For example, use the following command to install Explorer. The default installation path is `/usr/local/nebula-explorer`.
For example, use the following command to install Explorer. The default installation path is `/usr/local/nebula-explorer`.

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

You can also install it to the specified path using the following command:
```bash
sudo rpm -i nebula-explorer-<version>.x86_64.rpm --prefix=<path>
```
You can also install it to the specified path using the following command:
```bash
sudo rpm -i nebula-explorer-<version>.x86_64.rpm --prefix=<path>
```

3. Enter the extracted folder, and modify the `app-config.yaml` file in the `config` directory, set the value of `LicenseManagerURL` to the host IP of LM and the port number `9119`, for example, `192.168.8.100:9119`.

For more configuration descriptions, see the **Configuration file description** section at the end of the topic.

4. (Optional) Configure the Dag Controller. See the **Configure Dag Controller** section below.

5. Enter the folder `nebula-explorer`, and start the service using the following command.
@@ -117,6 +119,8 @@ sudo rpm -e nebula-graph-explorer-<version>.x86_64

3. Enter the extracted folder, and modify the `app-config.yaml` file in the `config` directory, set the value of `LicenseManagerURL` to the host IP of LM and the port number `9119`, for example, `192.168.8.100:9119`.

For more configuration descriptions, see the **Configuration file description** section at the end of the topic.

4. (Optional) Configure the Dag Controller. See the **Configure Dag Controller** section below.

5. Enter the folder `nebula-explorer`, and start the service using the following command.
@@ -164,6 +168,8 @@ sudo dpkg -r nebula-explorer

3. Enter the extracted folder, and modify the `app-config.yaml` file in the `config` directory, set the value of `LicenseManagerURL` to the host IP of LM and the port number `9119`, for example, `192.168.8.100:9119`.

For more configuration descriptions, see the **Configuration file description** section at the end of the topic.

4. (Optional) Configure the Dag Controller. See the **Configure Dag Controller** section below.

5. Enter the folder `nebula-explorer`, and start the service using the following command.
@@ -271,6 +277,79 @@ The Dag Controller can perform complex graph computing with NebulaGraph Analytic
exec_file: /home/xxx/nebula-analytics/scripts/run_algo.sh
```

## Configuration file description

```yaml
Name: explorer
Version: {{explorer.release}}
Database: yueshu
Host: 0.0.0.0 # Specifies the address where explorer can be accessed.
Port: 7002 # The default access port for explorer.
# The following parameters need to be configured when using SSL encrypted access or inline frames. Currently only self-signed certificates are supported, see the iframework section for how to do this.
# CertFile: "./config/Explorer.crt" # The path to the SSL public key certificate.
# KeyFile: "./config/Explorer.key" # The path to the SSL key.
MaxBytes: 1073741824 # The maximum ContentLength that HTTP can accept, default is 1048576. range: 0 ~ 8388608.
Timeout: 30000 # Access timeout time.
# The deployment mode of explorer, supports single and multiple instances.The optional values are single and multi.
# In multi-instance mode, local storage service (data import) will be disabled to ensure data consistency between instances.
# AppInstance: "multi"
Log: # explorer run log settings. See https://go-zero.dev/en/docs/tutorials/go-zero/configuration/log/
Mode: file # Log saving method. The optional values are: console and file. console means the service log will be recorded in webserver.log; file means the service log will be recorded in access.log, error.log, sever.log, slow.log, and stat.log respectively.
Level: error # Log output level. The optional values are: debug, info, error, and severe.
KeepDays: 7 # The number of days the log is retained.
Env: "local"
Debug:
Enable: false # Whether to enable Debug mode.
Auth:
TokenName: "explorer_token" # The name of the token after login.
AccessSecret: "login_secret" # The secret of the token after login.
AccessExpire: 259200 # The validity of the token after login, in seconds.
File:
UploadDir: "./data/upload/" # The path where the uploaded files are stored when importing data.
TasksDir: "./data/tasks" # Task file storage path. Includes imported tasks, workflow tasks, etc.
TaskIdPath: "./data/taskId.data" # The task ID storage path.
DB:
Enable: true
LogLevel: 4 # Database runtime log levels. 1, 2, 3, and 4 correspond to Silent, ERROR, Warn, and INFO, respectively.
IgnoreRecordNotFoundError: false
AutoMigrate: true # Whether or not to automatically create database tables. The default is true.
Type: "sqlite3" # The type of database used in the backend. Supports mysql and sqlite3.
Host: "127.0.0.1:3306" # The IP and port of the database.
Name: "nebula" # Database name.
User: "root" # Database username.
Password: "123456" # Database password.
SqliteDbFilePath: "./data/tasks.db" # This parameter is required for sqlite3 only. The address of the database file.
MaxOpenConns: 30 # Maximum number of active connections in the connection pool.
MaxIdleConns: 10 # Maximum number of free connections in the connection pool.
Analytics:
Host: "http://127.0.0.1:9002" # The address of the DAG service for the workflow.
# RPC_HDFS_PASSWORD: "passward" # The password for the HDFS RPC service.
OAuth:
Enable: false
ClientID: "10274xxxx-v2kn8oe6xxxxx.apps.googleusercontent.com" # The client ID of the OAuth service.
ClientSecret: "GOCSPX-8Enxxxxx" # The client key for the OAuth service.
AuthURL: "https://accounts.google.com/o/oauth2/v2/auth" # The URL of the OAuth service.
TokenURL: "https://oauth2.googleapis.com/token" # The URL to get the access token.
Scopes: "https://www.googleapis.com/auth/userinfo.email" # The scope of the OAuth service.
UserInfoURL: "https://www.googleapis.com/oauth2/v1/userinfo" # The URL to get the user information.
UsernameKey: "email" # Username field.
Organization: "vesoft" # OAuth Vendor name.
TokenName: "oauth_token" # The name of the token in the cookie.
RedirectURL: "http://127.0.0.1:7002/login" # The redirect URL for the OAuth service.
AvatarKey: "picture" # The key for the avatar in the user information.
IframeMode:
Enable: false # Whether to enable iframe mode.
Any source is allowed by default.
# Origins: # The source whitelist of iframe. Any source is allowed by default.
# - "http://192.168.8.8"
LicenseManagerURL: http://192.168.8.100:9119 # license manager url.
CorsOrigins: [] # The list of domains that are allowed to initiate cross-domain requests.
```

## Next to do

[Connect to Explorer](ex-ug-connect.md)