bilean/doc/source/overview.rst
lvdongbing 550fde3c91 Fix docs
Missing conf.py makes gate-bilean-docs fail, this patch fixes this
issue, and initialize some docs.

Change-Id: I9f74bf4e7391d596a446f21ea4e4bf0247b395ce
2016-01-12 04:07:15 -05:00

2.0 KiB

Overview

The mission for Bilean project is to provide a generic billing service for an OpenStack cloud, it implements trigger-type billing based on other OpenStack services' notification.

Components

The developers are focusing on creating an OpenStack style project using OpenStack design tenets, implemented in Python. We have started with a close interaction with Heat project.

bilean

The bilean tool is A CLI communicates with the bilean-api to manage rules, policies, users, resources, jobs and events. End developers could also use the Bilean REST API directly.

bilean-api

The bilean-api component provides an OpenStack-native REST API that processes API requests by sending them to the bilean-engine over RPC.

bilean-notification

The bilean-notification component monitors the message bus for data provided by other OpenStack components such as Nova, then converts notifications into billing resources and sends to bilean-engine over AMQP.

bilean-engine

The bilean-engine does the main billing work, operates all users, rules, policies, resources, jobs and events.

Installation

You will need to make sure you have a suitable environment for deploying Bilean. Please refer to Installation <guide-install> for detailed instructions on setting up an environment to use the Bilean service.