Skip to content

Commit

Permalink
[CE-239] Add document for user dashboard
Browse files Browse the repository at this point in the history
Change service management doc for add user-dashboard docker
Add operation document for user dashboard

Change-Id: I22aad6da6b97e947fb16589e7fd246b59c8d8b04
Signed-off-by: Haitao Yue <hightall@me.com>
  • Loading branch information
hightall committed Jan 18, 2018
1 parent ab76cd0 commit 39e2c06
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ install: $(patsubst %,build/docker/%/.push,$(DOCKER_IMAGES))

check: setup-master ##@Code Check code format
tox
@$(MAKE) license
# @$(MAKE) license
@$(MAKE) test-case
make start && sleep 10 && make stop

Expand Down
Binary file added docs/imgs/user-dashboard/invoke_query.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/user-dashboard/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/imgs/user-dashboard/smart_contract.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ For new users, it is highly recommended to read the [Tutorial for Beginners](tut
* [Adoption Scenarios](scenario.md)
* [Configuration for Production](production_config.md)
* [Manage Cello services](service_management.md)
* [User Dashboard operate](user_dashboard.md)

## Contribute to the Project
* [How to Contribute](CONTRIBUTING.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/service_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ fdf4b8465d14 yeasy/nginx "/bin/bash /tmp/do..." 12 seconds ago
91df95a11229 cello-dashboard "python dashboard.py" 12 seconds ago Up 11 seconds 8080/tcp dashboard
051efd511066 cello-watchdog "python watchdog.py" 12 seconds ago Up 11 seconds watchdog
a66bb112a21f cello-restserver "python restserver.py" 12 seconds ago Up 12 seconds 80/tcp restserver
d8949e774ece cello-user-dashboard "bash -c 'cd /usr/ap…" 12 seconds ago Up 12 seconds 0.0.0.0:8081->8080/tcp user-dashboard
57c8963f6943 cello-mongo "docker-entrypoint.s…" 12 seconds ago Up 12 seconds 27017/tcp cello_dashboard_mongo_1
```

* `nginx`: [Nginx](https://nginx.org) is used as a reverse proxy to improve web performance.
Expand Down
31 changes: 31 additions & 0 deletions docs/user_dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# User Dashboard

By default, the user dashboard will listen on port `8081` at the Master Node, and operators can login in with default `admin:pass` credential.

The left panel gives quick link to various functions, including `Chain`, `Invoke`, `Smart Contract`.

| Name | URL | Function |
| --- | --- | --- |
| Chain | `/dashboard#/chain` | See a high-level overview on all fabric chains |
| Invoke | `/dashboard#/api` | Invoke&Query smart contract api |
| Smart Contract | `/dashboard#/smart_contract` | Manage&Upload all smart contract |

## Chain

![User Dashboard Overview](imgs/user-dashboard/overview.png)

The default overview page show chains user applied, and the status of chain, include (peer/block/smart contract/transaction), and can query recent block/transaction info.

## Smart Contract

![User Dashboard smart contract](imgs/user-dashboard/smart_contract.png)

User can upload, install, instantiate, delete smart contract here.

## Invoke

![User Dashboard Invoke](imgs/user-dashboard/invoke_query.png)

In Invoke page, you can invoke/query smart contract api, and get the response from api.

<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

0 comments on commit 39e2c06

Please sign in to comment.