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 2.deploy-connect-dashboard-ent.md #1565

Merged
merged 18 commits into from
Mar 28, 2022
Merged
Changes from 16 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
237 changes: 220 additions & 17 deletions docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# 部署 Dashboard
# 部署 Dashboard 企业版

本文将详细介绍如何安装并部署 Dashboard。
本文将详细介绍如何安装并部署 Dashboard 企业版

## 前提条件

在部署 Dashboard 之前,用户需要确认以下信息:

- 选择并下载符合版本的 Dashboard。关于 Dashboard 版本和 Nebula Graph 的版本对应关系,参见[版本兼容性](1.what-is-dashboard-ent.md)。
- 选择并下载符合版本的 Dashboard。关于 Dashboard 版本和 Nebula Graph 的版本对应关系,参见 [版本兼容性](1.what-is-dashboard-ent.md)。

- 准备版本为 5.7 以上的 [MySQL](https://www.mysql.com/cn/) 环境,创建名称为`dashboard`的数据库。

- 确保在安装开始前,以下端口处于未被使用状态。

| 端口号 | 说明 |
Expand All @@ -24,15 +25,17 @@

License 仅在企业版提供,申请 License 需填写 [Nebula Dashboard 试用申请](https://wj.qq.com/s2/9437467/b3b1)。

## 安装及启动
## 使用 TAR 包部署

### 安装

1. 根据需要下载 tar 包,建议选择最新版本。
1. 根据需要下载 TAR 包,建议选择最新版本。

!!! enterpriseonly

Dashboard 仅在企业版提供,点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。
用户可以[在线申请](https://wj.qq.com/s2/9437467/b3b1)试用 Dashboard 企业版;如需购买,通过邮箱([email protected])联系销售人员。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。

2. 使用`tar -xzvf`解压 tar 包。
2. 使用`tar -xzvf`解压 TAR 包。

```bash
$ tar -xzvf nebula-dashboard-ent-<version>.linux-amd64.tar.gz
Expand Down Expand Up @@ -100,11 +103,13 @@
5. 启动 Dashboard。

可以使用以下命令一键启动 Dashboard。

```bash
$ cd scripts
$ sudo ./dashboard.service start all
```
或是执行以下命令,分别启动 prometheus、webserver、exporter 和 gateway 服务以启动 Dashboard。

```bash
$ cd scripts
$ sudo ./dashboard.service start prometheus # 启动 Prometheus 服务
Expand All @@ -116,11 +121,10 @@
!!! note

在启动 Dashboard 后,如再修改配置文件的话,在修改后,可在`scripts`目录下执行`dashboard.service restart all`同步修改至 Dashboard 客户端页面中。
## 管理 Dashboard 服务

Dashboard 使用脚本`dashboard.service`管理服务,包括启动、停止和查看。
### 管理 Dashboard 服务

### 语法
Dashboard 使用脚本`dashboard.service`管理服务,包括启动、停止和查看。

```bash
$ sudo <dashboard_path>/dashboard/scripts/dashboard.service
Expand All @@ -145,11 +149,212 @@ $ sudo <dashboard_path>/dashboard/scripts/dashboard.service
### 示例

Dashboard 的安装在当前目录下,用户可以用以下命令管理服务。

```bash
$ sudo /dashboard/scripts/dashboard.service start all #启动 Dashboard 所有服务
$ sudo /dashboard/scripts/dashboard.service stop all #停止 Dashboard 所有服务
$ sudo /dashboard/scripts/dashboard.service status all #查看 Dashboard 所有服务状态
$ sudo /dashboard/scripts/dashboard.service restart all #重启 Dashboard 所有服务状态
$ sudo /dashboard/scripts/dashboard.service start all #启动 Dashboard 所有服务。
$ sudo /dashboard/scripts/dashboard.service stop all #停止 Dashboard 所有服务。
$ sudo /dashboard/scripts/dashboard.service status all #查看 Dashboard 所有服务状态。
$ sudo /dashboard/scripts/dashboard.service restart all #重启 Dashboard 所有服务状态。
```

## 使用 RPM 包部署

### 安装

1. 下载 RPM 包。

!!! enterpriseonly

用户可以[在线申请](https://wj.qq.com/s2/9437467/b3b1)试用 Dashboard 企业版;如需购买,通过邮箱([email protected])联系销售人员。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。

2. 使用`sudo rpm -ivh <package_name>`命令安装 RPM 包。

例如,安装 Dashboard 企业版需要运行以下命令,默认安装路径为`/usr/local/nebula-dashboard-ent`:

```bash
sudo rpm -ivh nebula-dashboard-ent-<version>.x86_64.rpm
```

也可以使用以下命令安装到指定路径:
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

```bash
sudo rpm -ivh nebula-dashboard-ent-xxx.rpm --prefix=<path>
```

在可视化的安装过程中,用户需要输入 License 的路径,MySQL 相关的信息,包括连接 MySQL 的 IP和端口,登录 MySQL 的账户及密码,MySQL 数据库名称。

例如:

```
Nebula Dashboard Enterprise version need license, please enter the license file path(~/nebula.license): /home/vesoft/nebula.license # 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 # 连接的 MySQL 数据库的 IP 地址。

Enter mysql service port(3306): # 连接的 MySQL 数据库的端口号。默认3306。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

Enter mysql username(root): # 登录 MySQL 的账户。

Enter mysql password(nebula): # 登录 MySQL 的密码。

Enter mysql database name(dashboard): # MySQL 数据库名称。

```

3. (可选)使用以下命令查看所有服务状态、启动服务。

```
sudo systemctl list-dependencies nebula-dashboard.target # 查看状态
sudo systemctl start nebula-dashboard.target # 启动服务
```

用户也可以执行以下命令查看、启停单一服务,例如:

```
sudo systemctl status|stop|start nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
```


4. (可选)如需配置集群告警信息的接收人及配置 LDAP 账户,使用`vim /usr/local/nebula-dashboard-ent/config/config.yaml`命令添加以下配置。

```
# 邀请 LDAP 账号的发件人邮箱信息
mail:
host: smtp.office365.com # SMTP 服务器地址。
port: 587 # SMTP 服务器的端口号。
username: "" # SMTP 服务器的用户名。
password: "" # SMTP 服务器的密码。
# 系统信息
system:
webAddress: http://127.0.0.1:7005 # 邮件被邀请人连接 Dashboard 的访问地址。
messageStore: 90 # 保存告警消息的天数,默认 90 天。
# LDAP 信息
ldap:
server: ldap://127.0.0.1 # LDAP 服务器地址。
bindDN: cn=admin,dc=vesoft,dc=com # LDAP 服务器登录用户名。
bindPassword: "" # LDAP 服务器登录密码。
baseDN: dc=vesoft,dc=com # 查询用户数据的路径。
userFilter: "&(objectClass=*)" # 查询条件。
emailKey: mail # LDAP 数据库存放邮箱信息的字段名。
```
### 查看日志

用户可以在`/var/log/messages`路径下查看 Dashboard 企业版的操作日志。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

例如:

```
sudo cat /var/log/messages
```

### 卸载

执行以下命令卸载通过 RPM 包部署的 Dashboard。

```
sudo rpm -e <package_name>
```

## 使用 DEB 包部署

### 安装

1. 下载 DEB 包。

!!! enterpriseonly

用户可以[在线申请](https://wj.qq.com/s2/9437467/b3b1)试用 Dashboard 企业版;如需购买,通过邮箱([email protected])联系销售人员。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。


2. 使用`sudo dpkg -i <package_name>`命令安装 DEB 包。

例如,安装 Dashboard 企业版需要运行以下命令,默认安装路径为`/usr/local/nebula-dashboard-ent`:

```bash
sudo dpkg -i nebula-dashboard-ent-{{dashboard_ent.release}}.ubuntu1804.amd64.deb
```

!!! note

使用 DEB 包安装 Dashboard 企业版时不支持自定义安装路径。

在可视化的安装过程中,用户需要输入 License 的路径,MySQL 相关的信息,包括连接 MySQL 的 IP和端口,登录 MySQL 的账户及密码,MySQL 数据库名称。

例如:

```
Nebula Dashboard Enterprise version need license, please enter the license file path(~/nebula.license): /home/vesoft/nebula.license # 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 # 连接的 MySQL 数据库的 IP 地址。

Enter mysql service port(3306): # 连接的 MySQL 数据库的端口号。默认3306。

Enter mysql username(root): # 登录 MySQL 的账户。

Enter mysql password(nebula): # 登录 MySQL 的密码。

Enter mysql database name(dashboard): # MySQL 数据库名称。

```

3. (可选)使用以下命令查看所有服务状态、启动服务。

```
sudo systemctl list-dependencies nebula-dashboard.target # 查看状态
sudo systemctl start nebula-dashboard.target # 启动服务
```

用户也可以执行以下命令查看、启停单一服务,例如:

```
sudo systemctl status|stop|start nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
```

4. (可选)如需配置集群告警信息的接收人及配置 LDAP 账户,使用`vim /usr/local/nebula-dashboard-ent/config/config.yaml`命令添加以下配置。

```
# 邀请 LDAP 账号的发件人邮箱信息
mail:
host: smtp.office365.com # SMTP 服务器地址。
port: 587 # SMTP 服务器的端口号。
username: "" # SMTP 服务器的用户名。
password: "" # SMTP 服务器的密码。
# 系统信息
system:
webAddress: http://127.0.0.1:7005 # 邮件被邀请人连接 Dashboard 的访问地址。
messageStore: 90 # 保存告警消息的天数,默认 90 天。
# LDAP 信息
ldap:
server: ldap://127.0.0.1 # LDAP 服务器地址。
bindDN: cn=admin,dc=vesoft,dc=com # LDAP 服务器登录用户名。
bindPassword: "" # LDAP 服务器登录密码。
baseDN: dc=vesoft,dc=com # 查询用户数据的路径。
userFilter: "&(objectClass=*)" # 查询条件。
emailKey: mail # LDAP 数据库存放邮箱信息的字段名。
```
### 查看日志

用户可以在`/var/log/syslog`路径下查看 Dashboard 企业版的操作日志。

例如:

```
sudo cat /var/log/syslog
```

### 卸载

执行以下命令卸载通过 DEB 包部署的 Dashboard。

```
sudo dpkg -r <package_name>
```

## 连接 Dashboard
Expand All @@ -164,6 +369,4 @@ $ sudo /dashboard/scripts/dashboard.service restart all #重启 Dashboard 所有

首次登录企业版 Nebula Dashboard 的时候,页面显示*最终用户许可协议*的内容,请仔细阅读并单击**同意**。

用户可以使用初始化用户名`nebula`和密码`nebula`登录 Dashboard。登录 Dashboard 后可创建 LDAP 账户和普通账户,然后使用不同的账户登录 Dashboard。关于账户的详情,参见[权限管理](../nebula-dashboard-ent/5.account-management.md)。


用户可以使用初始化用户名`nebula`和密码`nebula`登录 Dashboard。登录 Dashboard 后可创建 LDAP 账户和普通账户,然后使用不同的账户登录 Dashboard。关于账户的详情,参见 [权限管理](../nebula-dashboard-ent/5.account-management.md)。