-
Notifications
You must be signed in to change notification settings - Fork 445
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file is required by readthedoc.org to build docs. Change-Id: I28bc0193977001b52e2961c5c7a8fb642cd894aa Signed-off-by: Baohua Yang <yangbaohua@gmail.com>
- Loading branch information
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
![Cello](docs/imgs/logo.png) | ||
|
||
**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository, | ||
where active development is ongoing. Issue tracking is handled in [Jira](https://jira.hyperledger.org/secure/RapidBoard.jspa?rapidView=111) | ||
|
||
## Incubation Notice | ||
|
||
This project is a Hyperledger project in _Incubation_. It was proposed to the community and documented [here](https://docs.google.com/document/d/1E2i5GRqWsIag7KTxjQ_jQdDiWcuikv3KqXeuw7NaceM/edit), and was approved by [Hyperledger TSC at 2017-01-07](https://lists.hyperledger.org/pipermail/hyperledger-tsc/2017-January/000535.html). Information on what _Incubation_ entails can be found in the [Hyperledger Project Lifecycle document](https://goo.gl/4edNRc). | ||
|
||
Platform to provide Blockchain as a Service! | ||
|
||
Using Cello, we can | ||
|
||
* Provision customizable Blockchains instantly, e.g., a 6-node chain using PBFT consensus. | ||
* Maintain a pool of running blockchains healthy with no manual operations. | ||
* Check the system status, scale the chain numbers, change resources... through a dashboard. | ||
|
||
![Typical Scenario](docs/imgs/scenario.png) | ||
|
||
You can also find more [scenarios](docs/scenario.md). | ||
|
||
## Features | ||
|
||
* Manage the lifecycle of blockchains, e.g., create/delete/keep health automatically. | ||
* Response nearly instantly, even with hundreds of chains, or nodes. | ||
* Support customized (e.g., size, consensus) blockchains request, currently we support [hyperledger fabric](https://github.com/hyperledger/fabric). | ||
* Support native Docker host or swarm host as the compute nodes, more supports on the way. | ||
* Support heterogeneous architecture, e.g., Z, Power and X86, from bare-metal servers to virtual machines. | ||
* Extend with monitor/log/health features by employing additional components. | ||
|
||
## Docs | ||
|
||
### User Docs | ||
* [Dashboard](docs/dashboard.md) | ||
|
||
### Operator Docs | ||
* [Installation & Deployment](docs/deployment.md) | ||
* [Scenarios](docs/scenario.md) | ||
* [Production Configuration](docs/production_config.md) | ||
|
||
### Development Docs | ||
* [How to contribute](docs/CONTRIBUTING.md) | ||
* We're following [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](docs/code_style.md) | ||
* [Architecture Design](docs/arch.md) | ||
* [Database Model](docs/db.md) | ||
* [API](api/restserver_v2.md) | ||
* [Develop react js](docs/reactjs.md) | ||
|
||
## Why named Cello? | ||
Can u find anyone better at playing chains? :) | ||
|
||
## License <a name="license"></a> | ||
The Hyperledger Project uses the [Apache License Version 2.0](LICENSE) software license. |