compass-web/v2/README.md
jiahuay afd2091e1c Add README
Change-Id: I8c9ba5a8815f3d95436845c50daf5ee23f8aeac0
2014-10-22 11:40:12 -07:00

2.2 KiB

Compass-Web V2

Compass-Web V2 is an AngularJS based project for distributed systems deployment and monitoring.

Why Compass-Web V2?

Compass-Web V2 is designed to help users have a streamlined OpenStack deployment experience, and provide extensibility to deploy other distributed systems such as Ceph system. It targets to make a great-practice structure to ensure code resuability and module extensibility.

Compass-Web V2 also comes prepackaged with the required frameworks: AngularUI Router Twitter Bootstrap, Angular Bootstrap, ngTable, Font Awesome, D3, NVD3 etc.

Directory Structure

v2/
├── assets/
│   ├── css/
│   │   ├── <css files>
│   ├── font/
│   │   ├── <font files>
│   └── img/
│       ├── <image files>
├── dash/
│   ├── <kibana monitoring app>
├── data/
│   ├── <config data>
├── index.html
├── src/
│   ├── app/
│   │   ├── app.js
│   │   ├── appDev.js
│   │   ├── services.js
│   │   ├── cluster/
│   │   │   ├── <cluster module>
│   │   ├── login/
│   │   │   ├── <login module>
│   │   ├── monitoring/
│   │   │   ├── <monitoring module>
│   │   ├── server/
│   │   │   ├── <server module>
│   │   ├── topnav/
│   │   │   ├── <top navbar module>
│   │   ├── user/
│   │   │   ├── <user module>
│   │   └── wizard/
│   │       ├── <wizard module>
│   ├── common/
│   │   ├── <reusable component>
│   ├── bootstrap.js
│   └── main.js
└── vendor/
    ├── <libraries>

Functional Modules

  • Cluster Module *

  • Monitoring Module *

  • Server Module *

  • Wizard Module *