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

【merge on 720】add-dashboard-ent-to-3.1.0 #1972

Merged
merged 2 commits into from
Jul 19, 2022
Merged
Show file tree
Hide file tree
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
7 changes: 4 additions & 3 deletions docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Grap

用户也可以[在线试用 Dashboard](https://dashboard.nebula-graph.io/clusters)部分功能。

![intro-overview](https://docs-cdn.nebula-graph.com.cn/figures/intro-overview-2022-4-14_cn.gif)
![intro-overview](https://docs-cdn.nebula-graph.com.cn/figures/intro-overview-20220711-cn.gif)

## 产品功能

Expand All @@ -15,9 +15,11 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Grap
- 支持管理多集群并可以查看最近 14 天內集群的操作记录。
- 支持在可视化页面进行服务启动、停止、重启操作。
- 支持快速更新集群中 Storage 及 Graph 服务的配置。
- 支持全局调整监控数据的页面更新频率。
- 监控集群中所有服务的信息,包括服务 IP 地址、版本和监控指标(例如查询数量、查询延迟、心跳延迟等)。
- 监控集群中所有机器的状态,包括 CPU、内存、负载、磁盘和流量。
- 监控集群本身的信息,包括集群的服务信息、分区信息、配置和长时任务。
- 支持根据监控信息设置告警通知。

## 适用场景

Expand All @@ -28,8 +30,7 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Grap

## 注意事项

- 监控数据默认更新频率约为 7 秒。
- 监控数据默认保留 14 天,即只能查询最近 14 天内的监控数据。
- 监控数据默认保留 14 天,即只能查询最近 14 天内任意时间段的监控数据。
- 只支持 2.5.0 及以上版本的 Nebula Graph。
- 建议使用最新版本的 Chrome 访问 Dashboard。
- 建议使用官方提供的安装包进行集群创建或导入。
Expand Down
81 changes: 81 additions & 0 deletions docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Nebula Dashboard 企业版 License

License 是为用户提供的软件授权证书。用户在部署 Nebula Dashboard 企业版时,需要设置 License 才能正常启动 Nebula Dashboard 企业版。本文介绍 Nebula Dashboard 企业版的 License 相关信息。


## 注意事项

- 没有设置 License 时,Nebula Dashboard 企业版无法启动。

- 请勿修改 License,否则会导致 License 失效。

- License 快过期时,请及时发送邮件至**[email protected]**申请续期。

- License 的过期缓冲为 14 天:

- 过期前 30 天和过期当天,服务启动时会打印日志进行提醒。

- 过期后仍可继续使用 14 天。

- 过期 14 天后,服务无法启动,并会打印日志进行提醒。

## 获取方式

用户需发送邮件至**[email protected]**申请 Nebula Dashboard 企业版 License。

!!! note

填写 [Nebula Dashboard 试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。

## Nebula Dashboard 企业版 License 说明

Nebula Dashboard 企业版 License 是一个名为`nebula.license`的文件,内容示例如下:

```bash
----------License Content Start----------
{
"vendor": "vesoft",
"organization": "doc",
"issuedDate": "2022-06-06T16:00:00.000Z",
"expirationDate": "2023-05-31T15:59:59.000Z",
"product": "nebula_graph_dashboard",
"version": ">=3.2.0",
"licenseType": "enterprise",
"gracePeriod": 14,
"clusterCode": "BAIAEAiAQAAG"
}
----------License Content End----------

----------License Key Start----------
Rrjip5cxxxxxxxxxxxxx5zKoQ==
----------License Key End----------
```

License 文件包含生效时间、过期时间等信息。说明如下。

|参数|说明|
|:---|:---|
|`vendor`| 发放渠道。|
|`organization`| 用户名称。|
|`issuedDate`| License 生效时间。|
|`expirationDate`| License 过期时间。|
|`product`| 产品类型。Nebula Dashboard 企业版的产品类型为`nebula_graph_dashboard`。|
|`version`| 版本支持的信息。|
|`licenseType`| License 类型(预留参数)。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。|
|`gracePeriod`| 证书过期后可继续使用服务的缓冲时间(单位天),超过缓冲期后停止服务。试用版的 License 过期后无缓冲期,默认值为 0。 |
|`clusterCode`| 用户的硬件信息,也是集群的唯一标识码。试用版的 License 中无此参数。 |

## 使用方式

关于如何使用 Nebula Dashboard 企业版 License,参见[部署 Dashboard 企业版](2.deploy-connect-dashboard-ent.md)。

## 续期操作

按照以下操作续期 Nebula Dashboard 企业版 License。

1. 发送邮件至`[email protected]`申请新的 Nebula Dashboard 企业版 License 文件`nebula.license`。
2. 在 Nebula Dashboard 企业版的安装目录下(例如,`/usr/local/nebula-dashboard-ent`),使用新的 License 文件替换旧的 License 文件。

!!! note

Nebula Dashboard 企业版 License 过期后,用户无法登录 Dashboard。为了保证业务正常运行,请及时更新 License。
65 changes: 65 additions & 0 deletions docs-2.0/nebula-dashboard-ent/11.manage-package.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# 安装包管理

Nebula Dashboard 企业版支持管理 Nebula Graph 安装包,可以下载社区版的各个版本,或者手动上传安装包。

## 注意事项

- 只有`admin`角色的用户可以管理安装包。

- 不支持下载企业版安装包。请发送邮件至 **[email protected]** 申请企业版安装包,然后手动上传。

## 查看安装包

![安装包管理页面](https://docs-cdn.nebula-graph.com.cn/figures/package-manage-22-6-7.png)

1. 在 Dashboard 企业版顶部导航栏,单击**平台设置**。

2. 在左侧导航栏单击**安装包管理**,右侧会显示已有安装包的列表,展示安装包名称、版本、大小和创建时间。

用户可以通过右上角的搜索框进行筛选。

## 下载安装包

1. 在 Dashboard 企业版顶部导航栏,单击**平台设置**。

2. 在左侧导航栏单击**安装包管理**。

3. 单击**下载安装包**,选择要下载的安装包。说明如下:

!!! note

下载已存在的安装包,会提示覆盖原有安装包。

- 版本:支持 v2.5 以上的稳定版本。
- 平台:支持 CentOS 7/8、Ubuntu 1604/1804/2004。
- 安装包类型:支持 RPM、DEB、tar.gz。

4. 单击**下载**。

下载任务可以在[任务中心](10.tasks.md)查看任务信息,类型为`package download`。如果任务状态为`success`,返回**安装包管理**页面,即可查看到新下载的安装包。

## 上传安装包

如果在下载安装包的列表里没有需要的安装包,用户可以手动上传安装包,例如上传企业版安装包。

1. 在 Dashboard 企业版顶部导航栏,单击**平台设置**。

2. 在左侧导航栏单击**安装包管理**。

3. 单击**上传安装包**,选择本地要上传的安装包。类型可以是 RPM、DEB 或 tar.gz。查看界面上方的上传进度,等待上传完成。

上传任务可以在[任务中心](10.tasks.md)查看任务信息,类型为`package upload`。如果任务状态为`success`,返回**安装包管理**页面,即可查看到新上传的安装包。

## 删除安装包

1. 在 Dashboard 企业版顶部导航栏,单击**平台设置**。

2. 在左侧导航栏单击**安装包管理**,右侧会显示已有安装包的列表,找到需要删除的安装包。

3. 在目标安装包的操作列,单击**删除**并确认。

## 常见问题

### 上传安装包时报错`Request Entity Too Large`如何处理?

如果用户使用 Nginx 做反向代理,默认限制上传文件大小为 1 MB,请在`nginx.conf`中的`http{}`段中添加`client_max_body_size 200m;`,即允许上传最大 200 MB 的文件。
Loading