diff --git a/CONTRIBUTE-CN.md b/CONTRIBUTE-CN.md new file mode 100644 index 00000000..b699e98b --- /dev/null +++ b/CONTRIBUTE-CN.md @@ -0,0 +1,40 @@ +## NEBULAGRAPH Dashboard 贡献指南 +感谢您感兴趣参与贡献 NebulaGraph Dashboard. 请阅读完本篇指南以了解如何进行开发和提交代码至仓库。 + +## 本地部署 +![](./architecture.png) + +### 开发环境 +- nodejs >= v16 + +### 技术栈 +- typescript +- nodejs + +### 本地启动项目 +1. fork 本仓库至您的github个人仓库中 +2. clone[仓库代码](https://github.com/vesoft-inc/nebula-dashboard.git) +``` +git clone https://github.com/vesoft-inc/nebula-dashboard.git +``` +3. 安装node modules +``` +npm install +``` +4. 将vendors/config-relaease.yaml 复制到devserver文件夹，并改名为config.yaml.并修改config.yaml,以使本地web可以连接获取到prometheus数据以及知道监控哪个 NebulaGraph 集群 + +4. 启动项目 +``` +npm run dev +``` +5. 访问 ```http://localhost:7003```查看本地web页面 + +### 如何提交 +1. 创建提交 +``` +git add . +git commit -m "your commit info" +git push [your self origin] +``` + +2. 创建pull request diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 00000000..f207d17b --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,40 @@ +## NEBULAGRAPH Dashboard Contributing Guide +Thank you for your interest in contributing to the NebulaGraph Dashboard. Please read this guide to learn how to develop and submit code to the repository. + +## 本地部署 +![](./architecture.png) + +### Development Environment +- nodejs >= v16 + +### Technology Stack +- typescript +- nodejs + +### Get Start in Local +1. fork this repository to your personal github repository. +2. clone[repository code](https://github.com/vesoft-inc/nebula-dashboard.git) +``` +git clone https://github.com/vesoft-inc/nebula-dashboard.git +``` +3. install node modules +``` +npm install +``` +4. Copy vendors/config-relaease.yaml to the devserver folder and rename it to config.yaml. And modify config.yaml so that the local web can connect to get prometheus data and know which NebulaGraph cluster to monitor. + +4. Start Project +``` +npm run dev +``` +5. Visit ```http://localhost:7003``` to view the local web page + +### How to commit +1. Create Commit +``` +git add . +git commit -m "your commit info" +git push [your self origin] +``` + +2. create pull request diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 5f5a52ab..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,20 +0,0 @@ -## NebulaGraph Dashboard Contributing Guide -Thank you for being interested in contributing to NebulaGraph Dashboard. Before submitting your contribution, please make sure to take a moment and read through the following guidelines - -A high level overview of tools used: - -- TypeScript as the development language -- Webpack for bundling -- Egg.js for api proxy -- Prettier and styleLint for code formating - -Commit information must contain one item in list below: - -'feat', // add function (添加功能) -'mod', // modify changes (修改) -'fix', // fix bugs -'docs', // docs modify -'refactor', // refactor (重构) -'test', // test (测试) -'chore', // other things like scaffold, ci/cd (其他诸如构建部署等修改) -'revert', // revert commit \ No newline at end of file diff --git a/DEPLOY-CN.md b/DEPLOY-CN.md new file mode 100644 index 00000000..34bcca55 --- /dev/null +++ b/DEPLOY-CN.md @@ -0,0 +1,126 @@ +## 前提条件 + +在部署 Dashboard 之前，用户需要确认以下信息： + +- NebulaGraph 服务已经部署并启动。详细信息参考 [NebulaGraph 安装部署](https://docs.nebula-graph.com.cn/master/4.deployment-and-installation/1.resource-preparations/ "点击前往 NebulaGraph 安装部署")。 + +- 确保以下端口未被使用： + + - 9200 + + - 9100 + + - 9090 + + - 8090 + + - 7003 + +- 待监控的机器上已经安装 node_exporter。安装方法请参见 [node-exporter 官方文档](https://prometheus.io/docs/guides/node-exporter/)。 + +## 操作步骤 +1. 下载 TAR 包 [nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz)。 +2. 执行命令`tar -xvf nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz`解压缩。 +3.进入解压缩的`nebula-dashboard`文件夹内，修改配置文件`config.yaml`。 + 配置文件内主要包含 4 种依赖服务的配置和集群的配置。依赖服务的说明如下。 + + |服务名称|默认端口号|说明| + |:---|:---|:---| + |nebula-http-gateway | 8090| 为集群服务提供 HTTP 接口，执行 nGQL 语句与 NebulaGraph 数据库进行交互。| + |nebula-stats-exporter | 9200| 收集集群的性能指标，包括服务 IP 地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟 等）。| + |node-exporter | 9100| 收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。| + |prometheus | 9090| 存储监控数据的时间序列数据库。| + + 配置文件说明如下。 + + ```yaml + port: 7003 # Web 服务端口。 + gateway: + ip: hostIP # 部署 Dashboard 的机器 IP。 + port: 8090 + https: false # 是否为 HTTPS 端口。 + runmode: dev # 程序运行模式，包括 dev、test、prod。一般用于区分不同运行环境。 + stats-exporter: + ip: hostIP # 部署 Dashboard 的机器 IP。 + nebulaPort: 9200 + https: false # 是否为 HTTPS 端口。 + node-exporter: + - ip: nebulaHostIP_1 # 部署 NebulaGraph 的机器 IP。 + port: 9100 + https: false # 是否为 HTTPS 端口。 + # - ip: nebulaHostIP_2 + # port: 9100 + # https: false + prometheus: + ip: hostIP # 部署 Dashboard 的机器 IP。 + prometheusPort: 9090 + https: false # 是否为 HTTPS 端口。 + scrape_interval: 5s # 收集监控数据的间隔时间。默认为 1 分钟。 + evaluation_interval: 5s # 告警规则扫描时间间隔。默认为 1 分钟。 + # 集群节点信息 + nebula-cluster: + name: 'default' # 集群名称 + metad: + - name: metad0 + endpointIP: nebulaMetadIP # 部署 Meta 服务的机器 IP。 + port: 9559 + endpointPort: 19559 + # - name: metad1 + # endpointIP: nebulaMetadIP + # port: 9559 + # endpointPort: 19559 + graphd: + - name: graphd0 + endpointIP: nebulaGraphdIP # 部署 Graph 服务的机器 IP。 + port: 9669 + endpointPort: 19669 + # - name: graphd1 + # endpointIP: nebulaGraphdIP + # port: 9669 + # endpointPort: 19669 + storaged: + - name: storaged0 + endpointIP: nebulaStoragedIP # 部署 Storage 服务的机器 IP。 + port: 9779 + endpointPort: 19779 + # - name: storaged1 + # endpointIP: nebulaStoragedIP + # port: 9779 + # endpointPort: 19779 + ``` + +1. 执行`sudo ./dashboard.service start all`一键启动服务。 +>`dashboard.service`脚本可以一键管理 Dashboard 服务。支持`start`、`restart`、`stop`、`status`操作。 +2. 执行`sudo ./dashboard.service status all`查看服务启动状态，显示全部服务RUNNING之后，浏览器访问 `http://ip:7003`查看Dashboard页面 + +### 容器部署 +如果使用容器部署 Dashboard，同样是修改配置文件`config.yaml`，修改完成后，执行`docker-compose up -d`即可启动容器。 + +执行`docker-compose stop`命令停止容器部署的 Dashboard。 + +## 管理 Dashboard 服务 + +Dashboard 使用脚本`dashboard.service`管理服务，包括启动、停止和查看。 + +```bash +$ sudo /dashboard.service +[-v] [-h] + +``` + +| 参数 | 说明 | +| :------------------------- | :------------------- | +| `dashboard_path` | Dashboard 安装路径。 | +| `-v` | 显示详细调试信息。 | +| `-h` | 显示帮助信息。 | +| `start` | 启动服务。 | +| `restart` | 重启服务。 | +| `stop` | 停止服务。 | +| `status` | 查看服务状态。 | +| `prometheus` | 管理 prometheus 服务。 | +| `webserver` | 管理 webserver 服务。 | +| `exporter` | 管理 exporter 服务。 | +| `gateway` | 管理 gateway 服务。 | +| `all` | 管理所有服务。 | + +> 查看 Dashboard 版本可以使用命令`./dashboard.service -version`。 diff --git a/DEPLOY.md b/DEPLOY.md index c44c9774..791ee6f9 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -1,105 +1,131 @@ -# NebulaGraph Dashboard Production Guide（Linux) - -## Environment -- Node.js (>= 10.12.0) -- Linux - -## Download -` wget https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/nebula-graph-dashboard-${version}.x86_64.tar.gz` - -## Unpress -`tar -xvf nebula-graph-dashboard-${version}.x86_64.tar.gz` - - -## Directory descrption -Five packages in nebula-graph-dashboard -- nebula-graph-dashboard ------------------------- FE service -- nebula-stats-exporter --------------------- NebulaGraph Metric Service -- node-exporter ----------------------------- Machine Metric Service -- prometheus -------------------------------- Data saving Service -- nebula-http-gateway ----------------------- Network Service - -Attention: the file under these packages is compiled under Linux environment, can only be used in Linux. If you want to use dashboard in other enviroments, please download package according to [README.md](README.md) - -## Quick Start - -1. Node-exporter：for machine metrics -- packages： `node-exporter` -- location：if you want in cluster,each machine needs install node exporter -- Start： - ```bash - ## node-exporter should run in - $ cd /nebula-dashboard/vendors/node-exporter - $ nohup ./node-exporter --web.listen-address=":9100" & +## Prerequisites + +Before you deploy Dashboard, you must confirm that: + +- The NebulaGraph services are deployed and started. For more information, see [NebulaGraph Database Manual](https://docs.nebula-graph.io/master/4.deployment-and-installation/1.resource-preparations/). + +- Before the installation starts, the following ports are not occupied. + + - 9200 + + - 9100 + + - 9090 + + - 8090 + + - 7003 + + +- The node-exporter is installed on the machines to be monitored. For details on installation, see [Prometheus document](https://prometheus.io/docs/guides/node-exporter/). + +## Steps +1. Download the tar package[nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz) as needed. + +2. Run `tar -xvf nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz` to decompress the installation package. + +3. Modify the `config.yaml` file in `nebula-dashboard`. + + The configuration file contains the configurations of four dependent services and configurations of clusters. The descriptions of the dependent services are as follows. + + |Service|Default port| Description| + |:---|:---|:---| + |nebula-http-gateway |8090| Provides HTTP ports for cluster services to execute nGQL statements to interact with the NebulaGraph database. | + |nebula-stats-exporter |9200| Collects the performance metrics in the cluster, including the IP addresses, versions, and monitoring metrics (such as the number of queries, the latency of queries, the latency of heartbeats, and so on). | + |node-exporter |9100| Collects the source information of nodes in the cluster, including the CPU, memory, load, disk, and network. | + |prometheus |9090| The time series database that stores monitoring data. | + + The descriptions of the configuration file are as follows. + + ```yaml + port: 7003 # Web service port. + gateway: + ip: hostIP # The IP of the machine where the Dashboard is deployed. + port: 8090 + https: false # Whether to enable HTTPS. + runmode: dev # Program running mode, including dev, test, and prod. It is used to distinguish between different running environments generally. + stats-exporter: + ip: hostIP # The IP of the machine where the Dashboard is deployed. + nebulaPort: 9200 + https: false # Whether to enable HTTPS. + node-exporter: + - ip: nebulaHostIP_1 # The IP of the machine where the NebulaGraph is deployed. + port: 9100 + https: false # Whether to enable HTTPS. + # - ip: nebulaHostIP_2 + # port: 9100 + # https: false + prometheus: + ip: hostIP # The IP of the machine where the Dashboard is deployed. + prometheusPort: 9090 + https: false # Whether to enable HTTPS. + scrape_interval: 5s # The interval for collecting the monitoring data, which is 1 minute by default. + evaluation_interval: 5s # The interval for running alert rules, which is 1 minute by default. + # Cluster node info + nebula-cluster: + name: 'default' # Cluster name + metad: + - name: metad0 + endpointIP: nebulaMetadIP # The IP of the machine where the Meta service is deployed. + port: 9559 + endpointPort: 19559 + # - name: metad1 + # endpointIP: nebulaMetadIP + # port: 9559 + # endpointPort: 19559 + graphd: + - name: graphd0 + endpointIP: nebulaGraphdIP # The IP of the machine where the Graph service is deployed. + port: 9669 + endpointPort: 19669 + # - name: graphd1 + # endpointIP: nebulaGraphdIP + # port: 9669 + # endpointPort: 19669 + storaged: + - name: storaged0 + endpointIP: nebulaStoragedIP # The IP of the machine where the Storage service is deployed. + port: 9779 + endpointPort: 19779 + # - name: storaged1 + # endpointIP: nebulaStoragedIP + # port: 9779 + # endpointPort: 19779 ``` - Service address: http://127.0.0.1:9100 - -2. Nebula-stats-exporter：for NebulaGraph metrics -- packages: `nebula-stats-exporter` -- location：in the same machine with nebula-graph-dashboard -- dependency: modify ：`config.yml` according to NebulaGraph service address - Start： - ```bash - $ cd /nebula-dashboard/vendors/nebula-stats-exporter - $ nohup ./nebula-stats-exporter --listen-address=":9200" --bare-metal --bare-metal-config=./config.yaml & - ``` - Service address: http://127.0.0.1:9200 - -3. Prometheus -- packages `prometheus` -- location：in the same machine with nebula-graph-dashboard -- dependency：modify ：`./vendors/prometheus/prometheus.yaml` according to node-exporter and nebula-stats-exporter service address -- Start： - ```bash - $ cd /nebula-dashboard/vendors/prometheus - $ nohup ./prometheus --config.file=./prometheus.yaml & - ``` - Service address: http://127.0.0.1:9090 - -4. Nebula-http-gateway -- packages: `nebula-http-gateway` -- location：in the same machine with nebula-graph-dashboard -- Start： - ```bash - $ cd /nebula-dashboard/vendors/nebula-http-gateway - $ nohup ./nebula-httpd & - ``` -- Service address: http://127.0.0.1:8090 -5. nebula-graph-dashboard -- packages: `nebula-graph-dashboard` +4. Run `./dashboard.service start all` to start the services. +5. Execute `sudo ./dashboard.service status all` to view the service startup status, after displaying all services RUNNING, visit `http://ip:7003` with the browser to view the Dashboard page. -- Modify proxy and connection setting: `./config.json` - ``` - port: 7003 - proxy: - gateway: - target: "127.0.0.1:8090" // change gateway service proxy - prometheus: - target: "127.0.0.1:9091" // change prometheus service proxy - nebulaServer: - "ip": "192.168.8.143" // change to NebulaGraph service ip - "port": 9669 // change to NebulaGraph service port - ``` -- Start: - ```bash - $ ./dashboard & - ``` -- service address: http://127.0.0.1:7003 +### Deploy Dashboard with Docker Compose +If you are deploying Dashboard using docker, you should also modify the configuration file `config.yaml`, and then run `docker-compose up -d` to start the container. -1. Open NebulaGraph Dashboard in browser -url: http://{{ip}}:7003 +> If you change the port number in `config.yaml`, the port number in `docker-compose.yaml` needs to be consistent as well. +Run `docker-compose stop` to stop the container. -## Stop Service -Using `kill pid` ： +## Manage services in Dashboard + +You can use the `dashboard.service` script to start, restart, stop, and check the Dashboard services. ```bash -$ kill $(lsof -t -i :9200) # stop nebula-stats-exporter service -$ kill $(lsof -t -i :9100) # stop node-exporter service -$ kill $(lsof -t -i :9090) # stop prometheus service -$ kill $(lsof -t -i :8090) # stop nebula-http-gateway -$ kill $(lsof -t -i :7003) # stop nebula-graph-dashboard +$ sudo /dashboard.service +[-v] [-h] + ``` - +| Parameter | Description | +| :------------------------- | :------------------- | +| `dashboard_path` | Dashboard installation path. | +| `-v` | Display detailed debugging information. | +| `-h` | Display help information. | +| `start` | Start the target services. | +| `restart` | Restart the target services. | +| `stop` | Stop the target services. | +| `status` | Check the status of the target services. | +| `prometheus` | Set the prometheus service as the target service. | +| `webserver` | Set the webserver Service as the target service. | +| `exporter` | Set the exporter Service as the target service. | +| `gateway` | Set the gateway Service as the target service. | +| `all` | Set all the Dashboard services as the target services. | + +> To view the Dashboard version, run the command `./dashboard.service -version`. diff --git a/README-CN.md b/README-CN.md index e69de29b..2d899960 100644 --- a/README-CN.md +++ b/README-CN.md @@ -0,0 +1,51 @@ +

+ +
中文 | English +
一款用于监控 NebulaGraph 集群中机器和服务状态的可视化工具。
+

+ +# NebulaGraph Dashboard是什么 +**NebulaGraph Dashboard**（简称 Dashboard）是一款用于监控 NebulaGraph 集群中机器和服务状态，以及可视化查看集群服务信息的可视化管理工具。 + +## 产品功能 +- 监控集群中所有机器的状态，包括 CPU、内存、负载、磁盘和流量。 +- 监控集群中所有服务的信息，包括服务 IP 地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟等）。 +- 监控集群本身的信息，包括集群的服务信息、分区信息、配置和长时任务。 +- 支持全局调整监控数据的页面更新频率。 +- 查看集群的配置信息 + +## 适用场景 +如果有以下任一需求，都可以使用 NebulaGraph Dashboard： +- 需要方便快捷地监测关键指标，集中呈现业务的多个重点信息，保证业务正常运行。 +- 需要多维度（例如时间段、聚合规则、指标）监控集群。 +- 故障发生后，需要复盘问题，确认故障发生时间、异常现象。 + +## 开始部署 +- 获取Dashboard安装包 +- 部署Dashboard + +## 详细文档 +NebulaGraph Dashboard的详细文档可以在 文档 查看 + +## 如何贡献 + +- 参与贡献 + +## 版本兼容性 +NebulaGraph 的版本和 Dashboard 社区版的版本对应关系如下。 + +|NebulaGraph 版本|Dashboard 版本| +|:---|:---| +|3.3.0 |3.2.0| +|2.5.0 ~ 3.2.0|3.1.0| +|2.5.x ~ 3.1.0|1.1.1| +|2.0.1 ~ 2.5.1|1.0.2| +|2.0.1 ~ 2.5.1|1.0.1| + +## 界面预览 + + + +
+ + \ No newline at end of file diff --git a/README.md b/README.md index 5ecc4ca0..8dd55f14 100644 --- a/README.md +++ b/README.md @@ -1,120 +1,49 @@ -# NebulaGraph Dashboard -NebulaGraph Dashboard is a tool that assists NebulaGraph in daily service monitoring and management - -![](introduction.png) - -## Architecture -![](./architecture.png) - -## Deploy in Production -If you plan to set up dashboard in production, refer to：[production guide](DEPLOY.md) - -## Development -#### Prerequisites -- Node.js (>= 10.12.0) -- Go 1.13+ and beego -- NebulaGraph (>=2.0) - -#### Quick Start -1. Set up `node-exporter` service where you want to collect machine metrics such as local dev. - - Download [node_exporter](https://prometheus.io/download/#node_exporter) according to your environment - - Run - ``` - $ tar -xvf node_exporter-{version}.tar.gz - $ cd node_exporter-{version} - $ ./node_exporter --web.listen-address=":9100" - ``` - -2. Set up `nebula-stats-exporter` to collect your NebulaGraph service metrics. - - Download nebula-stats-exporter and build - - Run - ``` - $ git clone https://github.com/vesoft-inc/nebula-stats-exporter.git - $ cd nebula-stats-exporter - $ make build - ``` - - - Modify `/vendors/nebula-stats-exporter/config.yaml` under nebula-graph-dashboard directory - ``` - # Example: - version: v0.0.4 - clusters: - - name: nebula - - instance: - -name metad0 // instance name as a symble - endpointIP: 10.17.101.126 // metrics service IP - endpointPort: 32839 // metrics service Ports - componentType: metad // metrics service type, should be one of metad,graphd or storaged - ``` - [More about the NebulaGraph metrics](https://docs.nebula-graph.com.cn/2.5.0/6.monitor-and-metrics/1.query-performance-metrics/) - - Run - ``` - ./nebula-stats-exporter --listen-address=":9200" --bare-metal --bare-metal-config={pwd}/nebula-graph-dashboard/vendors/nebula-stats-exporter/config.yaml & - ``` - -3. Set up `prometheus` - - Download [prometheus](https://prometheus.io/download/#prometheus) according to your environment - - - Modify `/vendors/prometheus/prometheus.yaml` according to node-exporter and nebula-stats-exporter ip and port config - - - Run - ``` - $ tar -xvf prometheus-${version}.tar.gz - $ cd prometheus-{version} - $ ./prometheus --config.file={pwd}/nebula-graph-dashboard/vendors/prometheus/prometheus.yaml & - ``` - -4. Set up `nebula-http-gateway` - - - Download nebula-http-gateway - ``` - $ git clone https://github.com/vesoft-inc/nebula-http-gateway.git - ``` - - - Modify http port in the `nebula-http-gateway/conf/app.conf` under the installation directory - ``` - httpport = 8090 - ``` - - Build - ``` - $ cd /path/to/nebula-http-gateway - $ make - ``` - - Run - ``` - $ ./nebula-httpd - ``` - -5. Start `nebula-graph-dashboard` - - Modify proxy and connection setting: `./vendors/config-release.json` - ``` - port: 7003 - proxy: - gateway: - target: "127.0.0.1:8090" // change gateway service proxy - prometheus: - target: "127.0.0.1:9091" // change prometheus service proxy - nebulaServer: - "ip": "192.168.8.143" // change to NebulaGraph service ip - "port": 9669 // change to NebulaGraph service port - ``` - - - Start - If you want to deploy in development mode, do this way: - ``` - $ npm install - $ npm run dev - ``` - If you want to deploy in production mode, do this way: - ``` - $ npm install - $ npm run build - $ npm run pkg - $ cp -r vendors/config-release.json ./config.json - $ ./dashboard & - ``` - -## Documentation - -+ [中文](https://docs.nebula-graph.com.cn/3.2.0/nebula-dashboard/1.what-is-dashboard/) -+ [ENGLISH](https://docs.nebula-graph.io/3.2.0/nebula-dashboard/1.what-is-dashboard/) +

+ +
英文 | 中文 +
A visualization tool that monitors the status of machines and services in NebulaGraph clusters.
+

+ +# What is NebulaGraph Dashboard +**NebulaGraph Dashboard** Community Edition (Dashboard for short) is a visualization tool that monitors the status of machines and services in NebulaGraph clusters. + +## Features +- The status of all the machines in clusters, including CPU, memory, load, disk, and network. +- The information of all the services in clusters, including the IP addresses, versions, and monitoring metrics (such as the number of queries, the latency of queries, the latency of heartbeats, and so on). +- The information of clusters, including the information of services, partitions, configurations, and long-term tasks. +- Set how often the metrics page refreshes. +- Check NebulaGraph config info. + +## Scenarios +You can use Dashboard in one of the following scenarios: +- You want to monitor key metrics conveniently and quickly, and present multiple key information of the business to ensure the business operates normally. +- You want to monitor clusters from multiple dimensions (such as the time, aggregate rules, and metrics). +- After a failure occurs, you need to review it and confirm its occurrence time and unexpected phenomena. + +## Get Started +- Get Dashboard Installation package +- Deploy Dashboard + +## Documentation +The NebulaGraph Dashboard docuementaion is available at Documentation + +## Contributing +If you're interested in contributing to the NebulaGraph Dashboard project: +- Learn hot wo set up you local environment, in developer guide + +## Version compatibility +The version correspondence between NebulaGraph and Dashboard Community Edition is as follows. + +|NebulaGraph Version|Dashboard Version| +|:---|:---| +|3.3.0 |3.2.0| +|2.5.0 ~ 3.2.0|3.1.0| +|2.5.x ~ 3.1.0|1.1.1| +|2.0.1 ~ 2.5.1|1.0.2| +|2.0.1 ~ 2.5.1|1.0.1| + +## Preview + + +
+