cluster operation (#909)

docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md

@@ -0,0 +1,49 @@
+# Cluster overview
+
+This topic introduces the **Overview** page of Dashboard. You can click **Detail** on the right of the cluster management page to check the overview of a specified cluster.
+
+## Overview
+
+![overview](../figs/ds-001.png)
+
+The **Overview** page has five parts:
+
+- Cluster survey
+- Information
+- Node
+- Status list
+- Service
+
+### Cluster survey
+
+In this part, you can view the number of nodes as well as the number of running and abnormal services of Graphd, Storaged, and Metad. In this example, there is **1** abnormal service in the Graphd service. You can click the **View** button to quickly check the abnormal service.
+
+### Information
+
+In this part, you can view the information of **Cluster name**, **Creation time**, **Creator**, and **Version**.
+
+!!! note
+
+    The version here is the Nebula Graph version installed by the user, not the Dashboard version.
+
+!!! caution
+
+    If the version of Nebula Graph imported by the user is before v2.5.0 or the version is unknown, v2.0.1 will be shown by default.
+
+### Node
+
+- You can view the information of node monitoring quickly and change the displayed information. By default, the CPU information will be shown.
+- You can click ![setup](../figs/Setup.png) on the page to insert a base line.
+- You can click ![watch](../figs/watch.png) to jump to the detailed node monitoring page.
+
+### Status list
+
+This part uses pie charts to visually display the running status of nodes.
+
+### Service
+
+- By default, the information of `query_latency_us` and `slow_query_latency_us` will be shown.
+
+- You can click ![setup](../figs/Setup.png) **Set up** to insert a base line.
+
+- You can click ![watch](../figs/watch.png) **View** to jump to the detailed service monitoring page.

docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md

@@ -0,0 +1,33 @@
+# Cluster monitoring
+
+This topic introduces node monitoring and service monitoring of Dashboard.
+
+## Node
+
+![vertex](../figs/ds-002.png)
+
+On this page, you can view the variation of CPU, Memory, Load, Disk, and Network In/Out quickly.
+
+- To set a base line, click the ![setup](../figs/Setup.png) button.
+- To view the detailed monitoring information, click the ![watch](../figs/watch.png) button. In this example, select `Load` for details. The figure is as follows.
+    ![load](../figs/ds-003.png)
+  - By default, you can view the monitoring data of the latest 1 hour, 6 hours, 12 hours, 1 day, 3 days, 7days, or 14 days.
+  - You can select the machine and monitoring metrics that you want to view. For details of monitoring metrics, see [Monitor parameter](../7.monitor-parameter.md).
+  - You can set a base line as a reference standard.
+
+## Service
+
+![service](../figs/ds-004.png)
+
+On this page, you can view the information of Graph, Meta, and Storage services quickly. In the upper right corner, the number of normal services and abnormal services will be displayed.
+
+!!! note
+
+    In the current **Service** page of the Enterprise Edition, only two monitoring metrics can be set for each service, which can be adjusted by clicking the **Set up** button.
+
+- To view the detailed monitoring information, click the ![watch](../figs/watch.png) button. In this example, select `Graph` for details. The figure is as follows.
+   ![service](../figs/ds-005.png)
+  - By default, you can view the monitoring data of the latest 1 hour, 6 hours, 12 hours, 1 day, 3 days, 7days, or 14 days.
+  - You can select the machine and monitoring metrics that you want to view. For details of monitoring metrics, see [Monitor parameter](../7.monitor-parameter.md).
+  - You can set a base line as a reference standard.
+  - You can view the status of the current service.

docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md

@@ -0,0 +1,81 @@
+# Cluster information
+
+This topic introduces the cluster information of Dashboard. The cluster information has the following six parts:
+
+- Version
+- Leader
+- Partition
+- Service information
+- Partition information
+- Long-term task
+
+Before viewing the cluster information, you need to select any online Graph service address, enter the account to log in to Nebula Graph (not the Dashboard login account), and the corresponding password.
+
+For multi-machine deployment, you can choose any online Graph service address.
+
+!!! caution
+
+    You need to ensure that Nebula Graph services have been deployed and started. For more information, see [Nebula Graph installation and deployment](../../4.deployment-and-installation/1.resource-preparations.md "Click to go to Nebula Graph installation and deployment").
+
+![information](../figs/ds-006.png)
+
+## Version
+
+![Version](../figs/ds-014.png)
+
+On this page, all services and corresponding Nebula versions will be shown.
+
+## Leader
+
+![Leader](../figs/ds-013.png)
+
+On this page, the number of Leaders and the Leader distribution will be shown. You can click the **Balance Leader** button in the upper right corner to distribute Leaders evenly and quickly in the Nebula Graph cluster.
+
+## Partition
+
+![partition](../figs/ds-012.png)
+
+On this page, you can select the specified graph space and view its distribution of Partitions.
+
+## Service information
+
+![Service information](../figs/ds-011.png)
+
+On this page, the information of Storage services will be shown. You can click the **Balance Date** button in the upper right corner to start the task to distribute all partitions in the cluster evenly. The parameter description is as follows:
+
+| Parameter | Description |
+| :--- | :--- |
+| `Host` | The IP address of the host. |
+| `Port` | The port of the host. |
+| `Status` | The host status. |
+| `Git Info Sha` | The commit ID of the current version. |
+| `Leader Count` | The number of Leaders. |
+| `Partition Distribution` | The distribution of partitions. |
+| `Leader Distribution` | The distribution of Leaders. |
+
+## Partition information
+
+![Partition information](../figs/ds-010.png)
+
+On this page, the information of partitions will be shown. Before viewing the partition information, you need to select a graph space in the upper left corner. You can also enter the partition ID into the input box in the upper right corner to filter the shown data. The parameter description is as follows:
+
+|Parameter|Description|
+|:---|:---|
+|`Partition ID`|The ID of the partition.|
+|`Leader`|The IP address and port of the leader.|
+|`Peers`|The IP addresses and ports of all the replicas.|
+|`Losts`|The IP addresses and ports of replicas at fault.|
+
+## Long-term task
+
+![Long-term task](../figs/ds-009.png)
+
+On this page, the information of all jobs will be shown. Before viewing the job information, you need to select a graph space in the upper left corner. Online managing jobs is not supported. For more information, see [Job statements](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md). The parameter description is as follows:
+
+| Parameter | Description |
+| :--- | :--- |
+| `Job ID` | Shows the Job ID. |
+| `Command` | Shows the command type. |
+| `Status` | Shows the status of the job or task. For more information, see [Job statements](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md#_6). |
+|`Start Time`| Shows a timestamp indicating the time when the job or task starts RUNNING.|
+| `Stop Time` | Shows a timestamp indicating the time when the job or task gets `FINISHED`, `FAILED`, or`STOPPED`. |

docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md

@@ -0,0 +1,65 @@
+# Cluster operation
+
+This topic introduces the cluster operation of Dashboard. The cluster operation has the following four parts:
+
+- Node
+- Service
+- Scale
+- Update config
+
+## Node
+
+On this page, the information of all nodes will be shown, including the cluster name, Host(SSH_User), CPU (Core), etc.
+
+- To add a node quickly, click **Add node** and enter the following information, the Host, SSH port, SSH user, SSH password, and select a Nebula Graph package.
+
+- Click the ![plus](../figs/Plus.png) button to view the process name, service type, status, runtime directory of the corresponding node.
+
+  - Click **Node monitoring** to jump to the detailed node monitoring page. For more information, see [Cluster monitoring](../4.cluster-operator/2.monitor.md).
+
+  - Click **Edit node** to modify the SSH port, SSH user, and SSH password.
+
+  - If a node has no service, you can **delete the node**.
+
+![vertex manage](../figs/ds-008.png)
+
+## Service
+
+- On this page, you can select the service type, service status, and Host to filter the shown data, quickly select one or multiple services, and start/stop/restart the service with one click.
+
+- Click the ![nav](../figs/nav-dashboard.png) icon to quickly view the [Service monitoring](../4.cluster-operator/2.monitor.md).
+
+!!! danger
+
+    If you click **Stop**/**Restart**, the running task will be stopped instantly, which may cause data inconsistency. It is recommended to perform this operation during the low peak period of the business.
+
+![Service](../figs/ds-015.png)
+
+## Scale
+
+- On this page, you can **add node** and **import node in batches** quickly, and add **Graph services** and **Storage services** to the existing nodes.
+- Click the **Reset** button to restore to the initial state.
+
+!!! caution
+
+    Currently, you can dynamically scale Storaged and Graphd services through Dashboard. The Metad service cannot be scaled. When scaling a cluster, it is recommended to back up data in advance so that data can be rolled back when scaling fails. For more information, see [FAQ](../../20.appendix/0.FAQ.md#_11).
+
+In this example, storage services with nodes `192.168.8.143` and `192.168.8.167` are added, and Graph services with node `192.168.8.169` are deleted. If the box is dotted and the service name is greyed, it means the service is removed. If the box is solid, it means the service is newly added.
+
+In the **services** below, green indicates services that will be added soon, and red indicates services that will be removed. You can modify the port, HTTP port, and HTTP2 port of the newly added service.
+
+![Scale](../figs/ds-016.png)
+
+## Update config
+
+On this page, you can modify configuration files of Storage and Graph services. For more information, see [Storage service configuration](../../5.configurations-and-logs/1.configurations/4.storage-config.md) and [Graph service configuration](../../5.configurations-and-logs/1.configurations/3.graph-config.md). Updating configuration files is a batch operation, and each Storage/Graph configuration file will be modified.
+
+- After clicking **Save**, the configuration will take effect after the next service restart.
+
+- Click **Save and restart** to directly restart the service to make the configuration take effect immediately.
+
+  !!! danger
+
+        If you click **Save and Restart**, the running task will be stopped and the cluster will be restarted instantly, which may cause data inconsistency. It is recommended to perform this operation during the low peak period of the business.
+
+![Update config](../figs/ds-017.png)