Skip to content

Commit

Permalink
update (#3015)
Browse files Browse the repository at this point in the history 
* update

* Update ex-ug-deploy.md

* dashboard notification
  • Loading branch information
@cooper-lzy
cooper-lzy authored Oct 7, 2023
1 parent 7bf4155 commit 658237c
Show file tree
Hide file tree
Showing 2 changed files with 170 additions and 213 deletions.
287 changes: 83 additions & 204 deletions docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,76 +42,13 @@
tar -xzvf yueshu-dashboard-{{dashboard_ent.release}}.linux-amd64.tar.gz -C /usr/local/
```

3. （可选）进入解压后的文件夹，在`etc`目录内修改`config.yaml`文件，设置相关配置。
3. 进入解压后的文件夹。

```bash
Name: dashboard-api
Host: 0.0.0.0 # 指定能访问{{dashboard_ent.name}}的地址。
Port: 7005 # 访问{{dashboard_ent.name}}的默认端口。
MaxBytes: 1073741824 # Http 可接受请求的最大 ContentLength，默认为 1048576。取值范围：0 ~ 8388608。
Timeout: 60000 # 访问超时时间。
Log: # {{dashboard_ent.name}}运行日志设置。
KeepDays: 7 # 日志保留天数。
Mode: file # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。
Encoding: plain # 日志编码方式，支持 plain 和 json。
Database:
Dialect: sqlite # 使用的数据库类型，目前支持 SQLite 和 MySQL，默认使用 SQLite。
AutoMigrate: true # 自动创建数据库表，默认为 true。
Host: 127.0.0.1 # 连接的 MySQL 数据库的 IP 地址。
Port: 3306 # 连接的 MySQL 数据库的端口号。
Username: root # 登录 MySQL 的账户。
Password: nebula # 登录 MySQL 的密码。
Name: dashboard # 对应的数据库名称。

# exporter 端口信息
Exporter:
NodePort: 9100 # node-exporter 服务的端口。
NebulaPort: 9200 # nebula-stats-exporter 服务的端口。

# 服务信息
Proxy:
PrometheusAddr: 127.0.0.1:9091 # prometheus 服务的 IP 地址和端口。
AlertmanagerAddr: 127.0.0.1:9093 # alertmanager 服务的 IP 地址和端口。

# 自建 Prometheus 服务配置。如果使用本软件自带的 Prometheus 服务，无需设置。
# PrometheusConfig:
# Auth: # 如果 Prometheus 开启了认证功能，需要配置以下参数。优先使用 AccessToken。
# Username: "" # Prometheus HTTP API 服务的账户。
# Password: "" # 账户对应密码。
# AccessToken: "" # Prometheus HTTP API 的 access token。
# RuleImport: # 远程更新告警规则到 Prometheus 服务的配置。
# Enable: false # 是否开启远程更新。
# URL: "https://xxxx/prometheus/import" # 更新告警规则的接口地址。
# Method: POST # 更新方式。只支持 POST 操作。
# Auth: # 如果 URL 的接口开启了认证功能，需要配置以下参数。优先使用 AccessToken。
# AccessToken: "" # URL 接口的 access token。
# Username: "" # URL 的认证账户。
# Password: "" # 账户对应密码。

# 邀请 LDAP 账号的发件人邮箱信息
Mail:
Host: smtp.office365.com # SMTP 服务器地址。
Port: 587 # SMTP 服务器的端口号。
Username: "" # SMTP 服务器的用户名。
Password: "" # SMTP 服务器的密码。

# 慢查询设置
SlowQuery:
Enable: true # 慢查询数据轮询开关。
MessageStore: 14 # 慢查询数据存储时长。单位：天。
ScrapeInterval: 2m # 拉取慢查询数据的间隔时间，例如:1s、10s、2m、3h。

# 系统信息
System:
WebAddress: http://127.0.0.1:7005 # 外网访问{{dashboard_ent.name}}的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问{{dashboard_ent.name}}。
MessageStore: 90 # 保存告警消息的天数，默认 90 天。

CloudProvider: "" # 云提供商名称。

LicenseManagerURL: "" # License Manager 所在的主机 IP，端口默认为9119。
```
4. （可选）如果已部署 LM 服务，在`etc`目录内修改`config.yaml`文件。设置`LicenseManagerURL`的值为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。如果未部署 LM 服务，可以在连接{{dashboard_ent.name}}后，在可视化页面中部署。

更多配置介绍参见文末**配置文件说明**部分。

4. 启动{{dashboard_ent.name}}。
5. 启动{{dashboard_ent.name}}。

可以使用以下命令一键启动{{dashboard_ent.name}}。

Expand Down Expand Up @@ -158,76 +95,13 @@
sudo rpm -ivh yueshu-dashboard-xxx.rpm --prefix=<path>
```

3. （可选）进入解压后的文件夹，在`etc`目录内修改`config.yaml`文件，设置相关配置。
3. 进入安装后的文件夹。

```bash
Name: dashboard-api
Host: 0.0.0.0 # 指定能访问{{dashboard_ent.name}}的地址。
Port: 7005 # 访问{{dashboard_ent.name}}的默认端口。
MaxBytes: 1073741824 # Http 可接受请求的最大 ContentLength，默认为 1048576。取值范围：0 ~ 8388608。
Timeout: 60000 # 访问超时时间。
Log: # {{dashboard_ent.name}}运行日志设置。
KeepDays: 7 # 日志保留天数。
Mode: file # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。
Encoding: plain # 日志编码方式，支持 plain 和 json。
Database:
Dialect: sqlite # 使用的数据库类型，目前支持 SQLite 和 MySQL，默认使用 SQLite。
AutoMigrate: true # 自动创建数据库表，默认为 true。
Host: 127.0.0.1 # 连接的 MySQL 数据库的 IP 地址。
Port: 3306 # 连接的 MySQL 数据库的端口号。
Username: root # 登录 MySQL 的账户。
Password: nebula # 登录 MySQL 的密码。
Name: dashboard # 对应的数据库名称。

# exporter 端口信息
Exporter:
NodePort: 9100 # node-exporter 服务的端口。
NebulaPort: 9200 # nebula-stats-exporter 服务的端口。

# 服务信息
Proxy:
PrometheusAddr: 127.0.0.1:9091 # prometheus 服务的 IP 地址和端口。
AlertmanagerAddr: 127.0.0.1:9093 # alertmanager 服务的 IP 地址和端口。

# 自建 Prometheus 服务配置。如果使用本软件自带的 Prometheus 服务，无需设置。
# PrometheusConfig:
# Auth: # 如果 Prometheus 开启了认证功能，需要配置以下参数。优先使用 AccessToken。
# Username: "" # Prometheus HTTP API 服务的账户。
# Password: "" # 账户对应密码。
# AccessToken: "" # Prometheus HTTP API 的 access token。
# RuleImport: # 远程更新告警规则到 Prometheus 服务的配置。
# Enable: false # 是否开启远程更新。
# URL: "https://xxxx/prometheus/import" # 更新告警规则的接口地址。
# Method: POST # 更新方式。只支持 POST 操作。
# Auth: # 如果 URL 的接口开启了认证功能，需要配置以下参数。优先使用 AccessToken。
# AccessToken: "" # URL 接口的 access token。
# Username: "" # URL 的认证账户。
# Password: "" # 账户对应密码。

# 邀请 LDAP 账号的发件人邮箱信息
Mail:
Host: smtp.office365.com # SMTP 服务器地址。
Port: 587 # SMTP 服务器的端口号。
Username: "" # SMTP 服务器的用户名。
Password: "" # SMTP 服务器的密码。

# 慢查询设置
SlowQuery:
Enable: true # 慢查询数据轮询开关。
MessageStore: 14 # 慢查询数据存储时长。单位：天。
ScrapeInterval: 2m # 拉取慢查询数据的间隔时间，例如:1s、10s、2m、3h。

# 系统信息
System:
WebAddress: http://127.0.0.1:7005 # 外网访问{{dashboard_ent.name}}的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问{{dashboard_ent.name}}。
MessageStore: 90 # 保存告警消息的天数，默认 90 天。

CloudProvider: "" # 云提供商名称。

LicenseManagerURL: "" # License Manager 所在的主机 IP，端口默认为9119。
```
4. （可选）如果已部署 LM 服务，在`etc`目录内修改`config.yaml`文件。设置`LicenseManagerURL`的值为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。如果未部署 LM 服务，可以在连接{{dashboard_ent.name}}后，在可视化页面中部署。

更多配置介绍参见文末**配置文件说明**部分。

4. 使用以下命令查看所有服务状态、启动服务。
5. 使用以下命令查看所有服务状态、启动服务。

```
sudo systemctl list-dependencies nebula-dashboard.target # 查看状态
Expand Down Expand Up @@ -266,76 +140,13 @@ sudo rpm -e <package_name>

使用 DEB 包安装{{dashboard_ent.name}}时不支持自定义安装路径。

3. （可选）进入解压后的文件夹，在`etc`目录内修改`config.yaml`文件，设置相关配置。
3. 进入安装后的文件夹。

```bash
Name: dashboard-api
Host: 0.0.0.0 # 指定能访问{{dashboard_ent.name}}的地址。
Port: 7005 # 访问{{dashboard_ent.name}}的默认端口。
MaxBytes: 1073741824 # Http 可接受请求的最大 ContentLength，默认为 1048576。取值范围：0 ~ 8388608。
Timeout: 60000 # 访问超时时间。
Log: # {{dashboard_ent.name}}运行日志设置。
KeepDays: 7 # 日志保留天数。
Mode: file # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。
Encoding: plain # 日志编码方式，支持 plain 和 json。
Database:
Dialect: sqlite # 使用的数据库类型，目前支持 SQLite 和 MySQL，默认使用 SQLite。
AutoMigrate: true # 自动创建数据库表，默认为 true。
Host: 127.0.0.1 # 连接的 MySQL 数据库的 IP 地址。
Port: 3306 # 连接的 MySQL 数据库的端口号。
Username: root # 登录 MySQL 的账户。
Password: nebula # 登录 MySQL 的密码。
Name: dashboard # 对应的数据库名称。

# exporter 端口信息
Exporter:
NodePort: 9100 # node-exporter 服务的端口。
NebulaPort: 9200 # nebula-stats-exporter 服务的端口。

# 服务信息
Proxy:
PrometheusAddr: 127.0.0.1:9091 # prometheus 服务的 IP 地址和端口。
AlertmanagerAddr: 127.0.0.1:9093 # alertmanager 服务的 IP 地址和端口。

# 自建 Prometheus 服务配置。如果使用本软件自带的 Prometheus 服务，无需设置。
# PrometheusConfig:
# Auth: # 如果 Prometheus 开启了认证功能，需要配置以下参数。优先使用 AccessToken。
# Username: "" # Prometheus HTTP API 服务的账户。
# Password: "" # 账户对应密码。
# AccessToken: "" # Prometheus HTTP API 的 access token。
# RuleImport: # 远程更新告警规则到 Prometheus 服务的配置。
# Enable: false # 是否开启远程更新。
# URL: "https://xxxx/prometheus/import" # 更新告警规则的接口地址。
# Method: POST # 更新方式。只支持 POST 操作。
# Auth: # 如果 URL 的接口开启了认证功能，需要配置以下参数。优先使用 AccessToken。
# AccessToken: "" # URL 接口的 access token。
# Username: "" # URL 的认证账户。
# Password: "" # 账户对应密码。

# 邀请 LDAP 账号的发件人邮箱信息
Mail:
Host: smtp.office365.com # SMTP 服务器地址。
Port: 587 # SMTP 服务器的端口号。
Username: "" # SMTP 服务器的用户名。
Password: "" # SMTP 服务器的密码。

# 慢查询设置
SlowQuery:
Enable: true # 慢查询数据轮询开关。
MessageStore: 14 # 慢查询数据存储时长。单位：天。
ScrapeInterval: 2m # 拉取慢查询数据的间隔时间，例如:1s、10s、2m、3h。

# 系统信息
System:
WebAddress: http://127.0.0.1:7005 # 外网访问{{dashboard_ent.name}}的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问{{dashboard_ent.name}}。
MessageStore: 90 # 保存告警消息的天数，默认 90 天。

CloudProvider: "" # 云提供商名称。

LicenseManagerURL: "" # License Manager 所在的主机 IP，端口默认为9119。
```
4. （可选）如果已部署 LM 服务，在`etc`目录内修改`config.yaml`文件。设置`LicenseManagerURL`的值为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。如果未部署 LM 服务，可以在连接{{dashboard_ent.name}}后，在可视化页面中部署。

更多配置介绍参见文末**配置文件说明**部分。

4. 使用以下命令查看所有服务状态、启动服务。
5. 使用以下命令查看所有服务状态、启动服务。

```
sudo systemctl list-dependencies nebula-dashboard.target # 查看状态
Expand Down Expand Up @@ -445,6 +256,74 @@ sudo dpkg -r <package_name>
journalctl -u nbd-prometheus.service -b
```

## 配置文件说明

```yaml
Name: dashboard-api
Host: 0.0.0.0 # 指定能访问{{dashboard_ent.name}}的地址。
Port: 7005 # 访问{{dashboard_ent.name}}的默认端口。
MaxBytes: 1073741824 # Http 可接受请求的最大 ContentLength，默认为 1048576。取值范围：0 ~ 8388608。
Timeout: 60000 # 访问超时时间。
Log: # {{dashboard_ent.name}}运行日志设置。
KeepDays: 7 # 日志保留天数。
Mode: file # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。
Encoding: plain # 日志编码方式，支持 plain 和 json。
Database:
Dialect: sqlite # 使用的数据库类型，目前支持 SQLite 和 MySQL，默认使用 SQLite。
AutoMigrate: true # 自动创建数据库表，默认为 true。
Host: 127.0.0.1 # 连接的 MySQL 数据库的 IP 地址。
Port: 3306 # 连接的 MySQL 数据库的端口号。
Username: root # 登录 MySQL 的账户。
Password: nebula # 登录 MySQL 的密码。
Name: dashboard # 对应的数据库名称。

# exporter 端口信息
Exporter:
NodePort: 9100 # node-exporter 服务的端口。
NebulaPort: 9200 # nebula-stats-exporter 服务的端口。

# 服务信息
Proxy:
PrometheusAddr: 127.0.0.1:9091 # prometheus 服务的 IP 地址和端口。
AlertmanagerAddr: 127.0.0.1:9093 # alertmanager 服务的 IP 地址和端口。

# 自建 Prometheus 服务配置。如果使用本软件自带的 Prometheus 服务，无需设置。
# PrometheusConfig:
# Auth: # 如果 Prometheus 开启了认证功能，需要配置以下参数。优先使用 AccessToken。
# Username: "" # Prometheus HTTP API 服务的账户。
# Password: "" # 账户对应密码。
# AccessToken: "" # Prometheus HTTP API 的 access token。
# RuleImport: # 远程更新告警规则到 Prometheus 服务的配置。
# Enable: false # 是否开启远程更新。
# URL: "https://xxxx/prometheus/import" # 更新告警规则的接口地址。
# Method: POST # 更新方式。只支持 POST 操作。
# Auth: # 如果 URL 的接口开启了认证功能，需要配置以下参数。优先使用 AccessToken。
# AccessToken: "" # URL 接口的 access token。
# Username: "" # URL 的认证账户。
# Password: "" # 账户对应密码。

# 邀请 LDAP 账号的发件人邮箱信息
Mail:
Host: smtp.office365.com # SMTP 服务器地址。
Port: 587 # SMTP 服务器的端口号。
Username: "" # SMTP 服务器的用户名。
Password: "" # SMTP 服务器的密码。

# 慢查询设置
SlowQuery:
Enable: true # 慢查询数据轮询开关。
MessageStore: 14 # 慢查询数据存储时长。单位：天。
ScrapeInterval: 2m # 拉取慢查询数据的间隔时间，例如:1s、10s、2m、3h。

# 系统信息
System:
WebAddress: http://127.0.0.1:7005 # 外网访问{{dashboard_ent.name}}的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问{{dashboard_ent.name}}。
MessageStore: 90 # 保存告警消息的天数，默认 90 天。

CloudProvider: "" # 云提供商名称。
LicenseManagerURL: "" # License Manager 所在的主机 IP，端口默认为9119。
```
## 后续操作
[连接{{dashboard_ent.name}}](3.connect-dashboard.md)
Loading

0 comments on commit 658237c

Please sign in to comment.