cyclops-support

The Cyclops Dashboard is one of the support services as part of CYCLOPS - A Rating, Charging & Billing solution for cloud being developed by InIT Cloud Computing Lab at ZHAW

It is the place for users to check their usage data, connect to cloud providers and manage bills. Admins can use it to configure the different microservices and maintain user accounts.

The dashboard interacts with the different micro service of CYCLOPS. The data for resource consumption visualization is gathered by the interaction with Usage Data Records Micro Service. The coonfiguration of rate policy and generated charge for a user is accessed by the dashboard through that APIs of Rate & Charge Micro Service.

Architecture

* CYCLOPS Rating Charging & Billing Framework

Installation

1. Check out this repository
2. Switch to the installation directory: cd path/to/repository/dashboard/installation
3. Make sure the hosts-file contains a route to localhost, otherwise OpenAM setup will fail
4. execute cat /etc/hosts | grep $HOSTNAME
5. it should output a line similar to 127.0.0.1 localhost myhostname
6. If it doesn't, run this as root: echo "127.0.0.1 myhostname" >> /etc/hosts
7. Make the installation script executable: sudo chmod +x install.sh
8. Run the installation script as root: sudo ./install.sh
9. Follow the script instructions
10. Wait for the setup to complete
11. Follow the configuration guide to finish setting up OpenAM

For more in-depth documentation, see:

• Installing OpenAM
• Configuring OpenAM
• Communication Flow
• Javadoc
• Development Environment
• Directory Structure

Features

Currently, the following features are implemented:

• [User] Authentication / Authorisation via OpenAM
• [User] Linking an account to OpenStack
• [User] Dynamically created charts for usage data
• [User] Dynamically created charts for rate data
• [User] Dynamically created charts for charge data
• [User] Alert Messages
• [User] Charts for external meters
• [User] View billing information and bill PDFs
• [Admin] Listing users and admins
• [Admin] Displaying list of all available meters
• [Admin] Configuring UDR Microservice to use different set of meters
• [Admin] User Management
• [Admin] Configure Rate Microservice
• [Admin] Create bills for users
• [Admin] Add external meters

Components & Libraries

• AngularJS
• AngularJS ui-router
• angular-toasty
• angular-loading-bar
• angular-ui bootstrap
• DateJS
• D3
• NVD3
• angular-NVD3
• Jasmine
• Bootstrap
• SB Admin 2 (Bootstrap Theme)
• Tomcat7
• RESTLET

Communication

• Issues/Ideas/Suggestions : GitHub Issue
• Website : http://blog.zhaw.ch/icclab/
• Tweet us @ICC_Lab

Developed @

License

  Licensed under the Apache License, Version 2.0 (the "License"); you may
  not use this file except in compliance with the License. You may obtain
  a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  License for the specific language governing permissions and limitations
  under the License.