From c9b5a07bbba7c098206181fe5b1da57745c78797 Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 21 Dec 2021 10:54:24 +0800 Subject: [PATCH 1/8] [wip]add utilization rate note & version compatibility --- .../nebula-dashboard-ent/1.what-is-dashboard-ent.md | 10 ++++++++++ .../2.deploy-connect-dashboard-ent.md | 6 +----- docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md | 8 +++++--- docs-2.0/nebula-dashboard/1.what-is-dashboard.md | 10 ++++++++++ docs-2.0/nebula-dashboard/2.deploy-dashboard.md | 8 -------- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 8 +++++--- 6 files changed, 31 insertions(+), 19 deletions(-) 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 index 80d45f8a4f0..c61c7401be5 100644 --- 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 @@ -45,3 +45,13 @@ Nebula Dashboard Enterprise Edition (Dashboard for short) is a visualization too !!! note The monitoring feature is supported by Prometheus. The update frequency and retention intervals can be modified. For details, see [Prometheus](https://prometheus.io/docs/prometheus/latest/configuration/configuration/). + +## Version compatibility + +The version correspondence between Nebula Graph and Dashboard Enterprise Edition is as follows. + +|Nebula Graph version|Dashboard version| +|:---|:---| +|2.0.1~2.6.1|1.0.2| +|2.0.1~2.6.1|1.0.1| +|2.0.1~2.6.1|1.0.0| 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 index 4f77aae27d2..ecee0bc45f8 100644 --- 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 @@ -6,11 +6,7 @@ This topic will introduce how to install and deploy Dashboard in detail. Before deploying Dashboard, you must do a check of these: -- Select and download Dashboard of the correct version. The version correspondence between Dashboard and Nebula Graph is as follows. - - | Dashboard version | Nebula Graph version | - | :-------------------------- | :--------------- | - | {{ dashboard_ent.release }} | 2.x | +- Select and download Dashboard of the correct version. For information about the version correspondence between Dashboard and Nebula Graph, see [Version compatibility](1.what-is-dashboard-ent.md). - The environment of [MySQL](https://www.mysql.com/) is ready and a database named as `dashboard` is created. - Before the installation starts, the following ports are not occupied. diff --git a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md index 010ef5f5906..c116ff51c79 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -2,11 +2,13 @@ This topic will describe the monitoring metrics in Nebula Dashboard. -!!! note +## Machine - The default unit in **Disk** and **Network** is byte. The unit will be changed with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s. +!!! note -## Machine + - The operating system of the monitored machine is Linux by default. + - The default unit in **Disk** and **Network** is byte. The unit will be changed with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s. + - For all versions of Dashboard Enterprise Edition, the memory occupied by Buff and Cache will not be counted in the memory usage. ### CPU 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 ff0b09e6d43..81d3559b3ad 100644 --- a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md +++ b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md @@ -38,6 +38,16 @@ You can use Dashboard in one of the following scenarios: The monitoring service is supported by Prometheus. The update frequency and retention intervals can be modified. For details, see [Prometheus](https://prometheus.io/docs/prometheus/latest/configuration/configuration/). +## Version compatibility + +The version correspondence between Nebula Graph and Dashboard Community Edition is as follows. + +|Nebula Graph version|Dashboard version| +|:---|:---| +|2.x|1.1.0| +|2.0.1~2.5.1|1.0.2| +|2.0.1~2.5.1|1.0.1| + ## Release note [Release](https://github.com/vesoft-inc/nebula-dashboard/releases/tag/{{dashboard.branch}}) diff --git a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md index 2d4047be329..b3535d73832 100644 --- a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md +++ b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md @@ -2,14 +2,6 @@ The deployment of Dashboard involves five services. This topic will describe how to deploy Dashboard in detail. To download and compile the latest source code of Nebula Dashboard, follow the instructions on the [nebula dashboard GitHub page](https://github.com/vesoft-inc/nebula-dashboard). -## Nebula Graph releases - -The correspondence between the Dashboard release and the Nebula Graph release is as follows. - -|Dashboard|Nebula Graph| -|:---|:---| -|{{dashboard.release}}|2.x| - ## Prerequisites Before you deploy Dashboard, you must confirm that: diff --git a/docs-2.0/nebula-dashboard/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index 4a78e03e389..48801c50bd2 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -2,11 +2,13 @@ This topic will describe the monitoring metrics in Nebula Dashboard. -!!! note +## Machine - The default unit in **Disk** and **Network** is byte. The unit will change with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s. +!!! note -## Machine + - The operating system of the monitored machine is Linux by default. + - The default unit in **Disk** and **Network** is byte. The unit will change with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s. + - For versions of Dashboard Community Edition equal to and greater than v1.1.0, the memory occupied by Buff and Cache will not be counted in the memory usage. ### CPU From 640438d0b02168571de30e6bc4ce9aed39606139 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 12:26:13 +0800 Subject: [PATCH 2/8] Update docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> --- docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md index c116ff51c79..6d782c2b48e 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -7,7 +7,7 @@ This topic will describe the monitoring metrics in Nebula Dashboard. !!! note - The operating system of the monitored machine is Linux by default. - - The default unit in **Disk** and **Network** is byte. The unit will be changed with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s. + - The default unit for **Disk** and **Network** is byte. The unit changes with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit is Bytes/s. - For all versions of Dashboard Enterprise Edition, the memory occupied by Buff and Cache will not be counted in the memory usage. ### CPU From 710926290b60f19b809a9a2b83db0fb61219f79b Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 12:27:40 +0800 Subject: [PATCH 3/8] Update 7.monitor-parameter.md --- docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md index 6d782c2b48e..cc26eefd41b 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -6,7 +6,7 @@ This topic will describe the monitoring metrics in Nebula Dashboard. !!! note - - The operating system of the monitored machine is Linux by default. + - All the machine metrics listed below are for the Linux operating system. - The default unit for **Disk** and **Network** is byte. The unit changes with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit is Bytes/s. - For all versions of Dashboard Enterprise Edition, the memory occupied by Buff and Cache will not be counted in the memory usage. From 7775ed99778746ea3b1110bd0af070be6809119d Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 12:27:47 +0800 Subject: [PATCH 4/8] Create 7.monitor-parameter.md From 2ab901c2181f20479641776e76d99673f4407387 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 12:28:27 +0800 Subject: [PATCH 5/8] Update docs-2.0/nebula-dashboard/6.monitor-parameter.md --- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index 48801c50bd2..7d4b740d64d 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -6,7 +6,7 @@ This topic will describe the monitoring metrics in Nebula Dashboard. !!! note - - The operating system of the monitored machine is Linux by default. + - All the machine metrics listed below are for the Linux operating system. - The default unit in **Disk** and **Network** is byte. The unit will change with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s. - For versions of Dashboard Community Edition equal to and greater than v1.1.0, the memory occupied by Buff and Cache will not be counted in the memory usage. From 1d366fffc0a6e847e324f2399e09363d69a383a7 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 12:56:14 +0800 Subject: [PATCH 6/8] Update 1.what-is-dashboard.md --- docs-2.0/nebula-dashboard/1.what-is-dashboard.md | 1 - 1 file changed, 1 deletion(-) 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 81d3559b3ad..c8d5b2b2f45 100644 --- a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md +++ b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md @@ -44,7 +44,6 @@ The version correspondence between Nebula Graph and Dashboard Community Edition |Nebula Graph version|Dashboard version| |:---|:---| -|2.x|1.1.0| |2.0.1~2.5.1|1.0.2| |2.0.1~2.5.1|1.0.1| From 7c1bd6708f02ec21380c8019984673b0771d88a7 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 12:56:56 +0800 Subject: [PATCH 7/8] Update 6.monitor-parameter.md --- docs-2.0/nebula-dashboard/6.monitor-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard/6.monitor-parameter.md b/docs-2.0/nebula-dashboard/6.monitor-parameter.md index 7d4b740d64d..f5f3666a1b6 100644 --- a/docs-2.0/nebula-dashboard/6.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard/6.monitor-parameter.md @@ -8,7 +8,7 @@ This topic will describe the monitoring metrics in Nebula Dashboard. - All the machine metrics listed below are for the Linux operating system. - The default unit in **Disk** and **Network** is byte. The unit will change with the data magnitude as the page displays. For example, when the flow is less than 1 KB/s, the unit will be Bytes/s. - - For versions of Dashboard Community Edition equal to and greater than v1.1.0, the memory occupied by Buff and Cache will not be counted in the memory usage. + - For versions of Dashboard Community Edition greater than v1.0.2, the memory occupied by Buff and Cache will not be counted in the memory usage. ### CPU From 7e5bf8ea727e605eb5022eafe2d6887986b32c8f Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 31 Dec 2021 12:57:03 +0800 Subject: [PATCH 8/8] Create 6.monitor-parameter.md