Skip to content

Commit 143912f

Browse files
committed
Add more documentation
Add tutorials; Add terminology; Rewrite the dashboard operations; Add more screenshots. Change-Id: I8677d5a036f053ae30cf01695aefaac3c9f7467d Signed-off-by: Baohua Yang <yangbaohua@gmail.com>
1 parent d47ad57 commit 143912f

13 files changed

+147
-32
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ You can also find more [scenarios](docs/scenario.md).
3232
## Documentation
3333

3434
### Operational Docs
35-
* [Installation & Deployment](docs/deployment.md)
36-
* [Dashboard](docs/dashboard.md)
35+
* [Installation & Deployment](docs/install.md)
36+
* [Terminologies](docs/terminology.md)
37+
* [Tutorial](docs/tutorial.md)
3738
* [Scenarios](docs/scenario.md)
3839
* [Production Configuration](docs/production_config.md)
3940

docs/arch.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@
22

33
Here we discuss the architecture design for the mangement services on the Master node.
44

5-
## Terminology
6-
* Cluster | Chain: A blockchain with unique access API address, including several peer nodes. May support Hyperledger Fabric, SawthoothLake and Iroha.
7-
* Host: A resource server, usually it can be a naive Docker host or a Swarm cluster.
8-
* Master Node: Running the cello platform, to manage the compute nodes.
9-
* Compute | Worker Node: The servers to have blockchains running inside.
5+
106

117
## Philosophy and principles
128
The architecture will follow the following principles:

docs/dashboard.md

Lines changed: 56 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,81 @@
11
# Dashboard
22

3-
System operators can utilize dashboard service to check system status or change configurations.
3+
By default, the dashboard will listen on port `8080` at the Master Node.
4+
5+
The left panel gives quick link to various functions, including `overview`, `system status`, `Hosts`, `Active Clusters`, `Inused Clusters`, `Release History` and `About`.
6+
7+
| Name | URL | Function |
8+
| --- | --- | --- |
9+
| Overview | `/index` | See a high-level overview on system status |
10+
| System Status | `/stat` | See statistics on the system |
11+
| Hosts | `/hosts` | Operate on the hosts managed by the system |
12+
| Active Clusters | `/clusters?type=active` | Operate on existing running chains in the pool |
13+
| Inused Clusters | `/clusters?type=inused` | Operate on user occupied chains in the system |
14+
| Released History | `/clusters?type=released` | See cluster releasing history data |
415

5-
The dashboard service will listen on port `8080`.
616

717
## Overview
818

9-
URL: `/index`.
19+
![Dashboard Overview](imgs/dashboard_overview.png)
20+
21+
22+
The default overview page show the overall status of the system, e.g., how many hosts are deployed within the system, how many clusters are running on those hosts. And there are status numbers for both hosts and clusters.
1023

11-
See a high-level overview on system status.
1224

13-
## System Status
25+
## System Status Page
1426

15-
URL: `/stat`.
27+
![dashboard status](imgs/dashboard_status.png)
1628

17-
See statistics on the system.
29+
The system status page shows the host and cluster statistics in terms of types and active/inactive in the system.
1830

1931
## Hosts
2032

21-
URL: `/hosts`.
33+
![dashboard hosts](imgs/dashboard_hosts.png)
34+
35+
In Host page, you can manage all the existing hosts in the pool, and add new hosts. The host shows its `Type` (e.g., SINGLE for Native Docker, or SWARM for Docker Swarm), `Status` (active or not) , `Chains` (How many chains running in the host), `Cap` (Capacity) and `Log Config` (level, receiver). Those non-schedulable host will have a grey line
36+
37+
In the Action dropdown menu, you can
38+
39+
* Fillup: Fill a host with chains till it's full `capacity`.
40+
* Clean: Clean all unused chains at the host.
41+
* Config: Set configurations of the host, e.g., `name` or `capacity`.
42+
* Reset: Reset everything on the host, useful when u meet problems of running chains on the host. Notice a host can be `reset` only when there's no inused chains on it.
43+
* Delete: Remove the host from the pool, then the system will not care about it.
44+
45+
### Add Host
46+
47+
You can click the `Add Host` button to add more hosts into the pool.
48+
49+
![dashboard add-host](imgs/dashboard_add_host.png)
50+
51+
52+
## Active Chains
53+
54+
The `Active Chains` page shows all existing running chains in the system, with their Name, Type, Status, Health, Size and Host. Those inused chains will have a grey line.
55+
56+
57+
![dashboard clusters](imgs/dashboard_clusters.png)
2258

23-
Operate on the hosts managed by the system.
59+
In the Action dropdown menu, you can
2460

25-
## Clusters_active
61+
* Start: Start a chain that is not running.
62+
* Stop: Stop a running chain to stopped status.
63+
* Restart: Restart a chain.
64+
* Delete: Delete the chain.
65+
* Release: Release a user-occupuied chain back to the pool, which will be deleted later.
2666

27-
URL: `/clusters?type=active`.
67+
You can click the `Add Chain` button to add more chains into the pool if there are non-full hosts.
2868

29-
Operate on existing running chains in the pool.
69+
![dashboard add-cluster](imgs/dashboard_add_cluster.png)
3070

31-
## Clusters_inused
3271

33-
URL: `/clusters?type=inused`.
72+
## Inused Chains
3473

35-
Operate on user occupied chains in the system.
74+
Filter out those running chains that are occupied by users.
3675

37-
## Clusters_released
76+
## Release History
3877

39-
URL: `/clusters?type=released`.
78+
Record all the user releasing chain history.
4079

41-
See cluster releasing history data.
4280

43-
## Screenshots
4481

45-
![dashboard-main](imgs/dashboard_main.png)
46-
![dashboard-status](imgs/dashboard_status.png)
47-
![dashboard-hosts](imgs/dashboard_hosts.png)
48-
![dashboard-clusters](imgs/dashboard_clusters.png)
49-
![dashboard-add-host](imgs/dashboard_add_host.png)
50-
![dashboard-add-cluster](imgs/dashboard_add_cluster.png)

docs/imgs/dashboard_clusters.png

14.7 KB
Loading

docs/imgs/dashboard_hosts.png

1.36 KB
Loading

docs/imgs/dashboard_main.png

-68.4 KB
Binary file not shown.

docs/imgs/dashboard_overview.png

64.5 KB
Loading

docs/imgs/dashboard_status.png

10.2 KB
Loading

docs/imgs/tutorial_add_chain.png

30.1 KB
Loading

docs/imgs/tutorial_add_host.png

41 KB
Loading

0 commit comments

Comments
 (0)