diff --git a/docs-2.0/14.client/5.nebula-python-client.md b/docs-2.0/14.client/5.nebula-python-client.md index ac48035fbe0..5b324e028fb 100644 --- a/docs-2.0/14.client/5.nebula-python-client.md +++ b/docs-2.0/14.client/5.nebula-python-client.md @@ -45,20 +45,10 @@ $ pip install nebula2-python== $ cd nebula-python ``` -3. 执行如下命令安装依赖。 +3. 执行如下命令安装。 ```bash - $ pip install -r requirements.txt - ``` - - !!! note - - 如果想在开发模式下进行单元测试，请安装`requirements-dev.txt`的依赖。 - -4. 执行如下命令安装。 - - ```bash - $ sudo python3 setup.py install + $ pip install . ``` ## 核心代码 diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index 75af2ada887..1ddd90af921 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -297,6 +297,8 @@ nebula-graphd version 2.5.0, Git: c397299c, Build Time: Aug 19 2021 11:20:18 ### 如何扩缩容 +用户可以使用 Dashboard（企业版），在可视化页面对 graphd 和 storaged 进行快速扩缩容，详情参见 [集群操作-扩缩容](../nebula-dashboard-ent/4.cluster-operator/4.manage.md)。 + Nebula Graph {{ nebula.release }} 未提供运维命令以实现自动扩缩容，参考以下步骤： - metad 的扩容和缩容： metad 不支持扩缩容，也不支持迁移到新机器，也不要增加新的 metad 进程。 diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md index c3469051e27..3a2b61a21e5 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -39,8 +39,7 @@ Nebula Graph Studio（简称 Studio）是一款可以通过Web访问的图数据 |:---|:---| | {{ nebula.release }} | {{studio.release}}（3754219）| - +## Nebula Dashboard（企业版） + +Nebula Dashboard（简称Dashboard）是一款用于监控和管理Nebula Graph多集群中机器和服务状态的可视化工具，支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 + +|Nebula Graph版本|Dashboard企业版本（commit id）| +|:---|:---| +| {{ nebula.release }} | {{dashboard-ent.release}}（79248d9） | + ## Nebula Explorer Nebula Explorer（简称Explorer）是一款可以通过Web访问的图探索可视化工具，搭配Nebula Graph内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。详情参见[什么是Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。 diff --git a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md new file mode 100644 index 00000000000..ddf4fefcb34 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md @@ -0,0 +1,33 @@ +# 什么是Nebula Dashboard（企业版） + +Nebula Dashboard（简称Dashboard）是一款用于监控和管理Nebula Graph多集群中机器和服务状态的可视化工具。本文主要介绍企业版Dashboard，社区版详情参见 [什么是Nebula Dashboard（社区版）](../nebula-dashboard/1.what-is-dashboard.md)。 + +## 产品功能 + +- 创建指定版本的Nebula Graph集群，支持批量导入节点、一键添加服务等功能。 +- 支持在可视化界面进行集群导入、数据平衡、扩容缩容等操作。 +- 支持管理多集群并可以查看最近14天內集群的操作记录。 +- 支持在可视化页面进行服务启动、停止、重启操作。 +- 支持快速更新集群中Storage及Graph服务的配置。 +- 监控集群中所有服务的信息，包括服务IP地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟等）。 +- 监控集群中所有机器的状态，包括CPU、内存、负载、磁盘和流量。 +- 监控集群本身的信息，包括集群的服务信息、分区信息、配置和长时任务。 + +## 适用场景 + +- 针对大规模集群，需要可视化的运维监控平台。 +- 需要方便快捷地监测关键指标，集中呈现业务的多个重点信息，保证业务正常运行。 +- 需要多维度（例如时间段、聚合规则、指标）监控集群。 +- 故障发生后，需要复盘问题，确认故障发生时间、异常现象。 + +## 注意事项 + +- 监控数据默认更新频率约为7秒。 +- 监控数据默认保留14天，即只能查询最近14天内的监控数据。 +- 只支持2.0.1及以上版本的Nebula Graph。 +- 建议使用最新版本的Chrome访问Dashboard。 +- 建议使用官方提供的安装包进行集群创建或导入。 + +!!! note + + 监控服务由prometheus提供，更新频率和保留时间等都可以自行修改。详情请参见[prometheus官方文档](https://prometheus.io/docs/prometheus/latest/configuration/configuration/)。 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 new file mode 100644 index 00000000000..573780ac688 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -0,0 +1,138 @@ +# 部署Dashboard + +本文将详细介绍如何安装并部署Dashboard。 + +## 前提条件 + +在部署Dashboard之前，用户需要确认以下信息： + +- 选择并下载符合版本的Dashboard，Dashboard版本和Nebula Graph的版本对应关系如下。 + + | Dashboard版本 | Nebula Graph版本 | + | :-------------------------- | :--------------- | + | {{ dashboard_ent.release }} | 2.x | + +- 准备[MySql](https://www.mysql.com/cn/)环境，创建名称为`dashboard`的数据库。 +- 确保在安装开始前，以下端口处于未被使用状态。 + + | 端口号 | 说明 | + | ------ | --------------------------------- | + | 7005 | Dashboard提供web服务的端口。 | + | 8090 | nebula-http-gateway服务的端口。 | + | 9090 | prometheus服务的端口。 | + | 9200 | nebula-stats-exporter服务的端口。 | + +- 准备License。 + + !!! enterpriseonly + + License仅在企业版提供，请发送邮件至inquiry@vesoft.com。 + + +## 安装及启动 + +1. 根据需要下载tar包，建议选择最新版本。 + + !!! enterpriseonly + + Dashboard仅在企业版提供，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 + +2. 使用`tar -xzvf`解压tar包。 + + ```bash + $ tar -xzvf nebula-graph-dashboard-.tar.gz + ``` + +3. 使用`vim config/config.yaml`命令修改配置文件。 + + ```bash + # 数据库信息 + database: + dialect: mysql # 使用的数据库类型，目前仅支持MySql + host: 192.168.8.157 # 连接的MySql数据库的ip地址 + port: 3306 # 连接的MySql数据库的端口号 + username: root # 登陆MySql的账号 + password: nebula # 登陆MySql的密码 + name: dashboard # 对应的数据库名称 + autoMigrate: true # 自动创建数据库表，默认为true + # exporter端口信息 + exporter: + nodePort: 9100 # node-exporter服务的端口 + nebulaPort: 9200 # nebula-stats-exporter服务的端口 + # 服务信息 + proxy: + gateway: + target: "127.0.0.1:8090" # gateway服务的IP地址和端口 + prometheus: + target: "127.0.0.1:9090" # prometheus服务的IP地址和端口 + ``` + +4. 拷贝License至`nebula-dashboard`目录下。 + + ```bash + $ cp -r + ``` + + 例如： + ```bash + $ cp -r nebula.license /usr/local/nebula-dashboard + ``` + +5. 启动Dashboard。 + + 可以使用以下命令一键启动Dashboard。 + ```bash + $ cd scripts + $ sudo ./dashboard.service start all + ``` + 或是执行以下命令，分别启动prometheus、webserver、exporter和gateway服务以启动Dashboard。 + ```bash + $ cd scripts + $ sudo ./dashboard.server start prometheus # 启动prometheus服务 + $ sudo ./dashboard.server start webserver #启动webserver服务 + $ sudo ./dashboard.server start exporter #启动exporter服务 + $ sudo ./dashboard.server start gateway #启动gateway服务 + ``` + +## 管理Dashboard服务 + +Dashboard使用脚本`dashboard.service`管理服务，包括启动、停止和查看。 + +### 语法 + +```bash +$ sudo /dashboard/scripts/dashboard.service +[-v] [-h] + +``` + +| 参数 | 说明 | +| :------------------------- | :------------------- | +| `dashboard_path` | Dashboard安装路径。 | +| `-v` | 显示详细调试信息。 | +| `-h` | 显示帮助信息。 | +| `start` | 启动服务。 | +| `stop` | 停止服务。 | +| `status` | 查看服务状态。 | +| `prometheus` | 管理prometheus服务。 | +| `webserver` | 管理webserver服务。 | +| `exporter` | 管理exporter服务。 | +| `gateway` | 管理gateway服务。 | +| `all` | 管理所有服务。 | + +### 示例 + +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所有服务状态 +``` + +## 后续操作 + +启动成功后，在浏览器地址栏输入`http://:7005`。 + +在浏览器窗口中看到以下登录界面表示已经成功部署并启动了Dashboard，用户可以通过默认用户名`nebula`和密码`nebula`登陆Dashboard的GOD用户。可以在 [系统设置](../nebula-dashboard-ent/6.system-settings.md) 中修改密码，也可以在 [权限管理](../nebula-dashboard-ent/5.account-management.md) 页面创建权限为ADMIN的账号用来登陆Dashboard。 + +![start-page](../nebula-dashboard-ent/figs/ds-028.png) diff --git a/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md new file mode 100644 index 00000000000..62f29867c08 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md @@ -0,0 +1,42 @@ +# 创建集群 + +本文介绍如何通过Dashboard创建集群。 + +## 操作步骤 + +按以下方式创建集群： + +1. 在集群管理页面，点击 **创建集群** 标签。 +2. 在创建集群页面，完成以下配置： + - 输入 **集群名称**，最大可输入15个字符，本示例设置为`test_foesa`。 + - 选择Nebula Graph安装版本，本示例设置为`v2.6.1`。 + - **添加节点**，需要添加每个节点的相关信息。 + + 1. 配置每个Host的IP信息，本示例设置为`192.168.8.144`。 + 2. 配置 SSH 信息，本示例设置如下：SSH端口号为`22`，SSH用户名为 `vesoft`，SSH 密码为`nebula`。 + 3. 选择 Nebula Graph 安装包，本示例为`nebula-graph-2.6.1.el7.x86_64rpm`。 + 4. （可选）输入节点名，可以对节点进行备注。本示例设置为`Noed_1`。 + + ![cluster](../figs/ds-021.png) + + - **批量导入节点**，需要添加每个节点的相关信息。批量导入需要先选择安装包后点击**下载CSV模版**。按照模版填写后上传，尽量确保节点信息正确，否则容易造成上传失败。 + + ![batch-import](../figs/ds-030.png) + +3. 勾选节点并在节点右上方，点击需要添加的服务。创建集群需要给节点添加3种类型的服务，如果不熟悉Nebula Graph架构，建议点击 **自动添加服务** 按钮。 + + ![add-service](../figs/ds-029.png) + +4. （可选）在下方的服务中，选择编辑meta、graph、storage服务的端口号、HTTP端口号、HTTP2端口号，点击确认保存。 + +5. 点击**创建集群**，确定配置信息无误且节点无冲突后，点击**确认**。 + + ![check](../figs/ds-023.png) + +6. 在集群管理页面中的列表中出现状态为`installing`的集群，需等待3-10分钟，状态变为`healthy`即集群创建成功。如果服务状态为`unhealthy`，表示集群服务中存在非正常运行的服务，请点击详情进行查看。 + + ![installing](../figs/ds-024.png) + +## 后续操作 + +成功创建集群后，用户可以对集群进行操作，详情见[总览](../4.cluster-operator/1.overview.md)。 diff --git a/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md new file mode 100644 index 00000000000..7d5fe0aecbf --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md @@ -0,0 +1,36 @@ +# 导入集群 + +本文介绍如何通过Dashboard导入集群。当前版本仅支持官方下载的DEB、RPM包部署的集群和Dashboard创建的集群导入，暂不支持导入使用Docker和Kubernetes方式部署的集群。 + +## 操作步骤 + +!!! caution + + 在同一集群下，服务需要统一版本。不支持在同一集群中导入不同版本的Nebula Graph实例。 + +1. 在集群管理页面，点击 **导入集群** 标签。 +2. 在导入集群页面，输入连接Nebula Graph的信息： + - Graphd Host：<其中一个Graphd进程的虚机IP>:<端口号>。本示例设置为 `192.168.8.157:9669`。 + - 用户名：连接Nebula Graph的账号，本示例设置为`vesoft`。 + - 密码：连接Nebula Graph的密码，本示例设置为`nebula`。 + + !!! note + + 因为 Nebula Graph 默认不启用身份验证，所以，一般情况下用户可以使用 `root` 账号和任意密码连接 Nebula。 + 当 Nebula Graph 启用了身份验证后，用户只能使用指定的账号和密码连接 Nebula。关于 Nebula Graph 的身份验证功能，参考 [Nebula Graph 用户手册](../../7.data-security/1.authentication/1.authentication.md "点击前往 Nebula Graph 官网")。 + + ![connect](../figs/ds-025.png) + +3. 在连接服务节点页面完成以下配置： + - 输入集群的名称，最大可输入15个字符，本示例设置为`create_1027`。 + - 对节点进行 **授权**，授权需输入每个节点的 SSH 用户名及密码。 + - **批量授权**需要上传CSV文件。请根据下载的CSV文件，编辑每个节点授权信息，尽量确保节点信息正确，否则容易造成上传失败。 + ![批量授权](../figs/ds-026.png) + - 页面中节点状态变为 **已授权**，则该节点授权成功。 + ![授权](../figs/ds-027.png) + +4. 确保所有节点都授权成功，点击 **导入集群**。 + +## 后续操作 + +成功导入集群后，用户可以对集群进行操作，详情见[总览](../4.cluster-operator/1.overview.md)。 \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md new file mode 100644 index 00000000000..99cce87de8f --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md @@ -0,0 +1,49 @@ +# 集群总览 + +本文主要介绍Dashboard的集群总览页面。在集群列表右侧，单击**详情**，即可进入指定集群的集群总览页面。 + +## 概览 + +![overview](../figs/ds-001.png) + +Dashboard 的集群总览页面分为五个部分： + +- 集群概况 +- 集群信息 +- 节点监控 +- 状态列表 +- 服务监控 + +### 集群概况 + +在集群概况中，显示了节点数量，Graphd、Storaged、Metad正在运行服务及异常服务数量。在本示例中，Graphd存在异常服务为 **1**，可以点击 **查看** 按钮，快速查看异常服务。 + +### 集群信息 + +在集群信息中，显示了 **集群名称**、**创建时间**、**创建用户**、**版本** 的信息。 + +!!! note + + 这里的版本信息为用户安装的Nebula Graph版本，而非Dashboard版本。 + +!!! caution + + 如果用户导入的Nebula Graph版本低于v2.5.0或版本未知的情况下，默认显示为v2.0.1。 + +### 节点监控 + +- 支持快速查看节点监控信息，可点击切换展示的信息，默认显示cpu信息。 +- 支持在页面上点击![setup](../figs/Setup.png)插入基准线。 +- 点击![watch](../figs/watch.png)快速跳转至节点监控页面，查看详情信息。 + +### 状态列表 + +用饼图的方式形象的展示节点运行服务状态。 + +### 服务监控 + +- 默认显示`query_latency_us`（查询平均延迟）和`slow_query_latency_us`（慢查询平均延迟）的信息。 + +- 点击![setup](../figs/Setup.png)**设置** 插入基准线。 + +- 点击![watch](../figs/watch.png)快速跳转至服务监控页面，查看详情信息。 \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md new file mode 100644 index 00000000000..551d878f1e8 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md @@ -0,0 +1,33 @@ +# 集群监控 + +本文主要介绍Dashboard的集群监控中的节点监控和服务监控。 + +## 节点监控 + +![vertex](../figs/ds-002.png) + +快速查看CPU、Memory、Load、Disk和Network In/Out变化情况。 + +- 如果需要设置基线，作为参考标准线，可以单击模块右上角的![setup](../figs/Setup.png)按钮。 +- 如果需要查看某一项更详细的监控指标，可以单击模块右上角的![watch](../figs/watch.png)按钮，在示例中选择`Load`查看详情信息，如下图。 + ![load](../figs/ds-003.png) + - 默认最多可选择14天的监控数据进行查看，也可以快捷选择1小时、6小时、12小时、1天、3天、7天和14天，支持修改查看时间。 + - 可以选择需要查看的机器和监控指标。监控指标详情请参见 [监控指标说明](../7.monitor-parameter.md)。 + - 可以设置基线，作为参考标准线。 + +## 服务监控 + +![service](../figs/ds-004.png) + +快速查看Graph、Meta、Storage服务的信息，右上角显示正常服务和异常服务的数量。 + +!!! note + + 当前企业版的服务监控页仅支持每种服务设置两个监控指标，可以单击模块内的设置按钮进行调整。 + +- 如果需要查看某一项更详细的监控指标，可以单击模块右上角的![watch](../figs/watch.png)按钮，在示例中选择 `Graph` 查看详情信息，如下图。 + ![service](../figs/ds-005.png) + - 默认最多可选择14天的监控数据进行查看，也可以快捷选择1小时、6小时、12小时、1天、3天、7天和14天，支持修改查看时间。 + - 可以选择需要查看的机器和监控指标。监控指标详情请参见 [监控指标说明](../7.monitor-parameter.md)。 + - 可以设置基线，作为参考标准线。 + - 可以查看当前服务的状态。 \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md new file mode 100644 index 00000000000..318ae8c2f3e --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md @@ -0,0 +1,81 @@ +# 集群信息 + +本文主要介绍 Dashboard 的集群信息，主要为以下六个部分： + +- 版本 +- Leader +- Partition +- 服务信息 +- 分片信息 +- 长时任务 + +在查看集群信息之前，用户需要选择任意一个在线的Graph服务地址，输入登录Nebula Graph的账号（非Dashboard登录账号）和对应密码。 + +多机部署时，用户可以选择任意一个在线的Graph服务地址。 + +!!! caution + + 用户需要保证Nebula Graph服务已经部署并启动。详细信息，参考[Nebula Graph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。 + +![information](../figs/ds-006.png) + +## 版本 + +![版本](../figs/ds-014.png) + +显示所有服务及对应的Nebula版本。 + +## Leader + +![Leader](../figs/ds-013.png) + +显示Leader数量及Leader的分布，点击右上角的 **Balance Leader** 按钮可以快速在Nebula Graph集群中均衡分布 Leader。 + +## Partition + +![partition](../figs/ds-012.png) + +选择指定图空间，查看指定图空间的Partition分布情况。 + +## 服务信息 + +![服务信息](../figs/ds-011.png) + +展示Storage服务的基本信息。用户可以通过右上角的 **Balance Date** 按钮启动任务，均衡分布集群中的所有分片。参数说明如下： + +| 参数 | 说明 | +| :--- | :--- | +| `Host` | 主机地址 | +| `Port` | 主机端口号 | +| `Status` | 主机状态 | +| `Git Info Sha` | 版本Commit ID | +| `Leader Count` | Leader总数 | +| `Partition Distribution` | 分片分布 | +| `Leader Distribution` | Leader分布 | + +## 分片信息 + +![分片信息](../figs/ds-010.png) + +显示分片信息。用户需要在左上角选择图空间，查看分片信息。也可以通过右上角的输入框，输入分片ID，筛选展示的数据。参数说明如下： + +|参数|说明| +|:---|:---| +|`Partition ID`|分片序号。| +|`Leader`|分片的leader副本的IP地址和端口。| +|`Peers`|分片所有副本的IP地址和端口。| +|`Losts`|分片的故障副本的IP地址和端口。| + +## 长时任务 + +![长时任务](../figs/ds-009.png) + +展示所有作业的信息。查看作业信息之前，用户需要在右上角选择图空间。暂不支持在线管理作业，详情请参见[作业管理](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md)。参数说明如下： + +| 参数 | 说明 | +| :--- | :--- | +| `Job ID` | 显示作业ID。 | +| `Command` | 显示命令类型。 | +| `Status` | 显示作业或任务的状态。状态说明参见 [作业状态](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md#_6)。 | +|`Start Time`|显示作业或任务开始执行的时间。| +| `Stop Time` | 显示作业或任务结束执行的时间，结束后的状态包括`FINISHED`、`FAILED`或`STOPPED`。 | \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md new file mode 100644 index 00000000000..ba735e3bb35 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md @@ -0,0 +1,64 @@ +# 集群操作 + +本文主要介绍 Dashboard 的集群操作，主要为以下四个部分： + +- 节点管理 +- 服务管理 +- 扩缩容 +- 更新配置 + +## 节点管理 + +在节点管理页面中，展示所有的节点详情信息，包括节点名称、Host及SSH用户名称、CPU核等信息。 + +- 点击 **添加节点** 输入Host信息、SSH端口号、用户、密码信息，选择Nebula Graph安装包，可快速添加节点。 + +- 点击 ![plus](../figs/Plus.png) 按钮，查看对应节点服务名、服务类型、服务状态、运行路径等信息。 + + - 点击 **节点监控** 可快速跳转至节点监控页面，详情信息见 [集群监控](../4.cluster-operator/2.monitor.md)。 + + - 点击 **编辑节点** 可修改SSH端口号、用户名、密码。 + + - 当节点上无服务时，可点击 **删除节点**。 + +![vertex manage](../figs/ds-008.png) +## 服务管理 + +- 在服务管理页面，用户可以选择服务类型、服务状态、Host对展示的数据进行筛选，快速选中一个或多个服务，一键启动/停止/重启服务。 + +- 点击 ![nav](../figs/nav-dashboard.png)图标，可快速查看 [服务监控](../4.cluster-operator/2.monitor.md)。 + +!!! danger + + 单击**停止**/**重启**，会立即中断进行中的任务，可能会导致数据不一致，请在业务低峰期执行该操作。 + +![服务管理](../figs/ds-015.png) + +## 扩缩容 + +- 在扩缩容页面，用户可以快速**添加节点**、**批量导入节点**，并对已存在的节点添加 **Graph服务** 及 **Storage服务**。 +- 点击 **重置** 按钮，可以恢复到初始状态。 + +!!! caution + + 目前仅支持对graphd和storaged进行扩缩容，不支持移除或添加metad服务。扩缩容集群时，建议提前备份数据，以便故障发生时回滚数据。关于扩缩容，详情参见[如何扩缩容](../../20.appendix/0.FAQ.md#_11)。 + +在该示例中，新增了节点为`192.168.8.143`和`192.168.8.167`的Storage服务，删除了节点为`192.168.8.169`的Graph服务。虚线框并置灰服务名表示移除的服务，实线框表示添加的服务。 + +在下方的**服务**中，绿色表示即将新增的服务，红色表示即将移除的服务。可以修改新增服务的端口号、HTTP端口号、HTTP2端口号信息。 + +![扩缩容](../figs/ds-016.png) + +## 更新配置 + +更新配置页面可以修改Storage及Graph服务的配置文件，具体参数及描述见 [Storage服务配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md) 和 [Graph服务配置](../../5.configurations-and-logs/1.configurations/3.graph-config.md)。更新配置文件为批量操作，将会修改每一个Storage/Graph的配置文件。 + +- 点击保存后，在下一次服务重启后配置即生效。 + +- 点击 **保存并重启** 可直接重启服务使配置立即生效。 + + !!! danger + + 单击**保存并重启**，会立即中断进行中的任务重启集群，可能会导致数据不一致，请在业务低峰期执行该操作。 + +![更新配置](../figs/ds-017.png) \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/5.operation-record.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/5.operation-record.md new file mode 100644 index 00000000000..38023563056 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/5.operation-record.md @@ -0,0 +1,7 @@ +# 操作记录 + +本文主要介绍Dashboard的操作记录。 + +![操作记录](../figs/ds-018.png) + +在操作页面可以看到1小时、6小时、12小时、1天、3天、7天和14天的操作记录，操作人、操作、时间、集群的信息。 \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/6.settings.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/6.settings.md new file mode 100644 index 00000000000..95749bf5dc8 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/6.settings.md @@ -0,0 +1,21 @@ +# 其他设置 + +本文主要介绍Dashboard的其他设置。 + +- 集群信息：显示集群名称、创建时间、创建用户信息。 + +- 解除绑定：解除绑定后从平台移除该集群的信息，对集群的服务和Nebula数据不做任何操作。 + + !!! note + + 在执行该操作时，用户需要输入集群名称确定解除绑定。 + + ![解除绑定](../figs/ds-019.png) + +- 删除集群：删除集群会停止集群服务同时保留Nebula数据，并解除与平台的信息绑定，请谨慎操作。 + + !!! note + + 在执行该操作时，用户需要输入集群名称确定删除集群。 + + ![删除集群](../figs/ds-020.png) diff --git a/docs-2.0/nebula-dashboard-ent/5.account-management.md b/docs-2.0/nebula-dashboard-ent/5.account-management.md new file mode 100644 index 00000000000..91ee2c944bd --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/5.account-management.md @@ -0,0 +1,9 @@ +# 权限管理 + +用户使用默认GOD用户（默认账号为`nebula`，密码为`nebula`）登录，可在权限管理页面，创建或删除ADMIN权限的账号。下图为GOD用户的权限管理页面。 + +![god](../nebula-dashboard-ent/figs/ds-032.png) + +用户使用创建的ADMIN账号登陆，不能对其他的账号进行操作，仅能查看用户名、角色、创建时间。下图为ADMIN用户的权限管理页面。 + +![admin](../nebula-dashboard-ent/figs/ds-031.png)) \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/6.system-settings.md b/docs-2.0/nebula-dashboard-ent/6.system-settings.md new file mode 100644 index 00000000000..1a8554d6854 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/6.system-settings.md @@ -0,0 +1,25 @@ +# 系统设置 + +本文提供了在使用 Dashboard 时可能会使用的系统设置。 + +## 平台设置 + +在标签栏中点击**平台设置**，用户可以完成以下修改： + +- 修改标题、Logo图片、封面图。 +- 快速修改语言，目前仅支持中文和英文。 +- 开关帮助提示。 + +![settings](../nebula-dashboard-ent/figs/ds-033.png) + +## 帮助信息 + +点击帮助信息，可快速跳转至 Dashboard 文档页面、Nebula Graph文档、官网或论坛等页面。 + +![help](../nebula-dashboard-ent/figs/ds-034.png) + +## 用户信息 + +点击右上角 **个人信息** 可修改密码或登出账号。 + +![information](../nebula-dashboard-ent/figs/ds-035.png) \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md new file mode 100644 index 00000000000..ca4ad0dca1f --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -0,0 +1,104 @@ +# 监控指标说明 + +本文介绍Dashboard中展示的Nebula Graph监控指标。 + +!!! note + + 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于1 KB/s时单位为Bytes/s。 + +## 机器 + +### CPU + +|参数|说明| +|:---|:---| +|`cpu_utilization`| CPU已使用百分比| +|`cpu_idle`| CPU空闲百分比| +|`cpu_wait`| 等待IO操作的CPU百分比| +|`cpu_user`| 用户空间（非Nebula Graph图空间）占用的CPU百分比| +|`cpu_system`| 内核空间（非Nebula Graph内核空间）占用的CPU百分比| + +### 内存 + +|参数|说明| +|:---|:---| +|`memory_utilization`| 内存已使用百分比| +|`memory_used`| 已使用内存（包括缓存）| +|`memory_actual_used`| 实际使用内存（不包括缓存）| +|`memory_free`| 空闲内存| + +### 负载 + +|参数|说明| +|:---|:---| +|`load_1m`| 最近1分钟系统平均负载| +|`load_5m`| 最近5分钟系统平均负载| +|`load_15m`| 最近15分钟系统平均负载| + +### 磁盘 + +|参数|说明| +|:---|:---| +|`disk_used`| 磁盘已使用存储空间| +|`disk_free`| 磁盘剩余存储空间| +|`disk_readbytes`| 磁盘每秒读取的字节数| +|`disk_writebytes`| 磁盘每秒写入的字节数| +|`disk_readiops`| 磁盘每秒的读请求数量| +|`disk_writeiops`| 磁盘每秒的写请求数量| +|`inode_utilization`| inode已使用百分比| + +### 流量 + +|参数|说明| +|:---|:---| +|`network_in_rate`| 网卡每秒接收的字节数| +|`network_out_rate`| 网卡每秒发送的字节数| +|`network_in_errs`| 网卡每秒接收错误的字节数| +|`network_out_errs`| 网卡每秒发送错误的字节数| +|`network_in_packets`| 网卡每秒接收的数据包数量| +|`network_out_packets`| 网卡每秒发送的数据包数量| + +## 服务 + +### 周期 + +指标统计的时间范围，当前支持5秒、60秒、600秒和3600秒，分别表示最近5秒、最近1分钟、最近10分钟和最近1小时。 + +### 聚合方式 + +|参数|说明| +|:---|:---| +|`rate`| 周期内平均每秒操作的速率| +|`sum`| 周期内操作的总和| +|`avg`| 周期内响应平均耗时| +|`P75`| 周期内响应耗时从小到大排列，顺序处于75%位置的分位数| +|`P95`| 周期内响应耗时从小到大排列，顺序处于95%位置的分位数| +|`P99`| 周期内响应耗时从小到大排列，顺序处于99%位置的分位数| +|`P999`| 周期内响应耗时从小到大排列，顺序处于99.9%位置的分位数| + +### Graph + +|参数|说明| +|:---|:---| +|`num_queries`| 查询数量| +|`num_slow_queries`| 慢查询数量| +|`query_latency_us`| 查询平均延迟| +|`slow_query_latency_us`| 慢查询平均延迟| +|`num_query_errors`| 查询错误数量| + +### Meta + +|参数|说明| +|:---|:---| +|`heartbeat_latency_us`| 心跳延迟| +|`num_heartbeats`| 心跳次数| + +### Storage + +|参数|说明| +|:---|:---| +|`add_edges_latency_us`| 添加边的平均延迟| +|`add_vertices_latency_us`| 添加点的平均延迟| +|`delete_edges_latency_us`| 删除边的平均延迟| +|`delete_vertices_latency_us`| 删除点的平均延迟| +|`get_neighbors_latency_us`| 查询邻居平均延迟| diff --git a/docs-2.0/nebula-dashboard-ent/8.faq.md b/docs-2.0/nebula-dashboard-ent/8.faq.md new file mode 100644 index 00000000000..a952bda6265 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/8.faq.md @@ -0,0 +1,46 @@ +# 常见问题FAQ + +本文列出了使用Dashboard时可能遇到的常见问题，用户可以使用文档中心或者浏览器的搜索功能查找相应问题。 + +## 什么是集群、节点和服务？ + +- 集群：Dashboard集群特指由多个Nebula Graph服务所在的节点组成的一组系统。 +- 节点：特指承载运行Nebula Graph服务的物理或虚拟机。 +- 服务：特指Nebula服务，包括Metad，Storaged和Graphd。 + +## 什么是集群的状态？ + +集群的状态有以下几种： + +- installing：集群正在创建中，过程大约需要等待3～10分钟。 +- healthy：集群中所有服务正常运行。 +- unhealthy：集群服务中存在非正常运行的服务。 + +## 为什么要授权节点？ + +由于集群的管理操作需要获取对应节点的SSH信息，因此Dashboard在执行操作前，需要先拥有最少可执行权限的SSH账号密码信息。 + +## 什么是扩缩容？ + +Nebula Graph是分布式图数据库，可以支持运行时动态扩展和缩减服务。也可以通过Dashboard可视化的动态扩展或缩减Storage和Graph服务（不可以扩缩容Metad）。 + +## 为什么不能操作Meta服务？ + +Meta服务主要存储Nebula Graph数据库中的元数据。一旦Meta服务出现问题，整个集群会面临瘫痪风险。且Meta处理的数据量较少，一般不会出现扩缩容场景，因此我们直接在Dashboard中禁用了操作Meta，防止出现用户误操作导致集群不可用的情况。 + +## 扩缩容之后对数据有什么影响？ + +- 扩容Storage，Dashboard会在指定的机器上创建并运行Storage服务，对已有数据不会造成影响，可以在集群信息标签页下的 `服务信息` 页面和 `Leader` 页面，根据自身需求选择进行`Balance Data`或者`Balance Leader`操作。 +- 缩容Storage，Dashboard会自动执行`Balance Data Remove`语句，确保被指定的服务上的数据分片迁移完成后，停止服务。 +- 扩缩容Graph对数据不会有影响。 + +## 为什么无法启动Dashboard（企业版）？ + +- 确保License已拷贝至Dashboard目录中，且执行了`bash ./scripts/start.sh`命令。 +- 确保License未过期。 + +用户也可以在Dashboard目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件，仍无法启动Dashboard，请前往 [Nebula Graph 官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往 Nebula Graph 官方论坛") 咨询。 + +## 是否可以手动添加Nebula Graph安装包？ + +Dashboard支持手动添加安装包，可以点击 [如何获取 Nebula Graph](https://nebula-graph.com.cn/download/) 下载所需系统和版本的RPM包或DEB包，添加到`dashboard/download/nebula-graph`路径下。在创建、扩容集群时，可选择添加的包进行部署。 \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/figs/Plus.png b/docs-2.0/nebula-dashboard-ent/figs/Plus.png new file mode 100644 index 00000000000..520a0500527 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/Plus.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/Setup.png b/docs-2.0/nebula-dashboard-ent/figs/Setup.png new file mode 100644 index 00000000000..a309c270da8 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/Setup.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-001.png b/docs-2.0/nebula-dashboard-ent/figs/ds-001.png new file mode 100644 index 00000000000..105463503db Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-001.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-002.png b/docs-2.0/nebula-dashboard-ent/figs/ds-002.png new file mode 100644 index 00000000000..f9c92339597 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-002.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-003.png b/docs-2.0/nebula-dashboard-ent/figs/ds-003.png new file mode 100644 index 00000000000..da212faba09 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-003.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-004.png b/docs-2.0/nebula-dashboard-ent/figs/ds-004.png new file mode 100644 index 00000000000..a059c11515a Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-004.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-005.png b/docs-2.0/nebula-dashboard-ent/figs/ds-005.png new file mode 100644 index 00000000000..a0c51a9da40 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-005.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-006.png b/docs-2.0/nebula-dashboard-ent/figs/ds-006.png new file mode 100644 index 00000000000..e8d8972135c Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-006.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-007.png b/docs-2.0/nebula-dashboard-ent/figs/ds-007.png new file mode 100644 index 00000000000..3f67a146781 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-007.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-008.png b/docs-2.0/nebula-dashboard-ent/figs/ds-008.png new file mode 100644 index 00000000000..812dd130070 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-008.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-009.png b/docs-2.0/nebula-dashboard-ent/figs/ds-009.png new file mode 100644 index 00000000000..9f82ec10e2e Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-009.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-010.png b/docs-2.0/nebula-dashboard-ent/figs/ds-010.png new file mode 100644 index 00000000000..91e3d7b876c Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-010.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-011.png b/docs-2.0/nebula-dashboard-ent/figs/ds-011.png new file mode 100644 index 00000000000..8129c8d66de Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-011.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-012.png b/docs-2.0/nebula-dashboard-ent/figs/ds-012.png new file mode 100644 index 00000000000..0eb5bdb78cf Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-012.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-013.png b/docs-2.0/nebula-dashboard-ent/figs/ds-013.png new file mode 100644 index 00000000000..19363b3604b Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-013.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-014.png b/docs-2.0/nebula-dashboard-ent/figs/ds-014.png new file mode 100644 index 00000000000..846fda638bb Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-014.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-015.png b/docs-2.0/nebula-dashboard-ent/figs/ds-015.png new file mode 100644 index 00000000000..9fd8591b1e5 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-015.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-016.png b/docs-2.0/nebula-dashboard-ent/figs/ds-016.png new file mode 100644 index 00000000000..1184826c99b Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-016.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-017.png b/docs-2.0/nebula-dashboard-ent/figs/ds-017.png new file mode 100644 index 00000000000..ec3ff96adb1 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-017.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-018.png b/docs-2.0/nebula-dashboard-ent/figs/ds-018.png new file mode 100644 index 00000000000..9db114f51ef Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-018.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-019.png b/docs-2.0/nebula-dashboard-ent/figs/ds-019.png new file mode 100644 index 00000000000..d039eac6853 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-019.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-020.png b/docs-2.0/nebula-dashboard-ent/figs/ds-020.png new file mode 100644 index 00000000000..c060afc7bff Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-020.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-021.png b/docs-2.0/nebula-dashboard-ent/figs/ds-021.png new file mode 100644 index 00000000000..b09aaa72ec0 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-021.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-022.png b/docs-2.0/nebula-dashboard-ent/figs/ds-022.png new file mode 100644 index 00000000000..3d6a8784236 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-022.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-023.png b/docs-2.0/nebula-dashboard-ent/figs/ds-023.png new file mode 100644 index 00000000000..caac3eb6126 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-023.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-024.png b/docs-2.0/nebula-dashboard-ent/figs/ds-024.png new file mode 100644 index 00000000000..7d7ef0886b3 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-024.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-025.png b/docs-2.0/nebula-dashboard-ent/figs/ds-025.png new file mode 100644 index 00000000000..0ffe57afa33 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-025.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-026.png b/docs-2.0/nebula-dashboard-ent/figs/ds-026.png new file mode 100644 index 00000000000..d536f1ae4c9 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-026.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-027.png b/docs-2.0/nebula-dashboard-ent/figs/ds-027.png new file mode 100644 index 00000000000..398e8b0d7d0 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-027.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-028.png b/docs-2.0/nebula-dashboard-ent/figs/ds-028.png new file mode 100644 index 00000000000..c4350729a39 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-028.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-029.png b/docs-2.0/nebula-dashboard-ent/figs/ds-029.png new file mode 100644 index 00000000000..3f417ada6b7 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-029.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-030.png b/docs-2.0/nebula-dashboard-ent/figs/ds-030.png new file mode 100644 index 00000000000..415927abd8d Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-030.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-031.png b/docs-2.0/nebula-dashboard-ent/figs/ds-031.png new file mode 100644 index 00000000000..3dd73b65b9c Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-031.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-032.png b/docs-2.0/nebula-dashboard-ent/figs/ds-032.png new file mode 100644 index 00000000000..319aa676414 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-032.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-033.png b/docs-2.0/nebula-dashboard-ent/figs/ds-033.png new file mode 100644 index 00000000000..a3c801fc3b4 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-033.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-034.png b/docs-2.0/nebula-dashboard-ent/figs/ds-034.png new file mode 100644 index 00000000000..5dc68c156ee Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-034.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-035.png b/docs-2.0/nebula-dashboard-ent/figs/ds-035.png new file mode 100644 index 00000000000..322df86ffea Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-035.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/nav-dashboard.png b/docs-2.0/nebula-dashboard-ent/figs/nav-dashboard.png new file mode 100644 index 00000000000..af833745435 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/nav-dashboard.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/watch.png b/docs-2.0/nebula-dashboard-ent/figs/watch.png new file mode 100644 index 00000000000..a8021b617a9 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/watch.png differ diff --git a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md index 12e1d841d37..c641a5e7ef0 100644 --- a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md +++ b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md @@ -1,6 +1,10 @@ -# 什么是Nebula Dashboard +# 什么是Nebula Dashboard（社区版） -Nebula Dashboard（简称Dashboard）是一款用于监控Nebula Graph集群中机器和服务状态的可视化工具。 +Nebula Dashboard（简称Dashboard）是一款用于监控Nebula Graph集群中机器和服务状态的可视化工具。本文主要介绍社区版 Dashboard，企业版详情参见 [什么是Nebula Dashboard（企业版）](../nebula-dashboard-ent/what-is-dashboard-ent.md)。 + +!!! enterpriseonly + + 企业版增加了可视化创建集群、批量导入集群、快速扩缩容等功能，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 ## 产品功能 @@ -10,12 +14,6 @@ Nebula Dashboard（简称Dashboard）是一款用于监控Nebula Graph集群中 - 监控集群本身的信息，包括集群的服务信息、分区信息、配置和长时任务。 -- 企业版功能：（TODO: planning） - -!!! enterpriseonly - - Dashboard分为社区版和企业版，大部分功能为二者通用，仅企业版提供的功能会进行标注说明。 - ## 适用场景 如果有以下任一需求，都可以使用Dashboard： diff --git a/mkdocs.yml b/mkdocs.yml index 8c309babdd7..037612edd91 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -89,6 +89,8 @@ extra: release: 1.0.1 base100: 1.0.0 branch: v1.0.1 + dashboard_ent: + release: 1.0.0 console: release: 2.6.0 branch: v2.6.0 @@ -382,13 +384,31 @@ nav: - 无法访问 Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md - Studio 常见问题: nebula-studio/troubleshooting/st-ug-faq.md - - Nebula Dashboard: + - Nebula Dashboard（社区版）: - 什么是Nebula Dashboard: nebula-dashboard/1.what-is-dashboard.md - 部署Dashboard: nebula-dashboard/2.deploy-dashboard.md - 连接Dashboard: nebula-dashboard/3.connect-dashboard.md - Dashboard页面介绍: nebula-dashboard/4.use-dashboard.md - 监控指标说明: nebula-dashboard/6.monitor-parameter.md + - Nebula Dashboard（企业版）: + - 什么是Nebula Dashboard: nebula-dashboard-ent/1.what-is-dashboard-ent.md + - 部署Dashboard: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md + - 创建及导入集群: + - 创建集群: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md + - 导入集群: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md + - 集群操作: + - 集群总览: nebula-dashboard-ent/4.cluster-operator/1.overview.md + - 集群监控: nebula-dashboard-ent/4.cluster-operator/2.monitor.md + - 集群信息: nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md + - 集群操作: nebula-dashboard-ent/4.cluster-operator/4.manage.md + - 操作记录: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md + - 其他设置: nebula-dashboard-ent/4.cluster-operator/6.settings.md + - 权限管理: nebula-dashboard-ent/5.account-management.md + - 系统设置: nebula-dashboard-ent/6.system-settings.md + - 监控指标说明: nebula-dashboard-ent/7.monitor-parameter.md + - 常见问题FAQ: nebula-dashboard-ent/8.faq.md + - Nebula Explorer: - 什么是Nebula Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md - 安装与登录: