e0561271cf
In order to migrate the code base to the "OpenStack way": * Replace ConfigParser by oslo.config * Replace logging by oslo.log * Use testtools as base class for unit tests * Add tox -e genconfig to generate config file * Start to organize the file structure like other projects * Define 2 cli entry points almanach-collector and almanach-api * The docker-compose.yml is now used to run integration-tests * Integration tests will be moved to tempest in the future * Docker configs should be deprecated and moved to Kolla Change-Id: I89a89a92c7bdb3125cc568323db0f9488e1380db
45 lines
941 B
ReStructuredText
45 lines
941 B
ReStructuredText
========
|
|
Almanach
|
|
========
|
|
|
|
|
|
.. image:: https://badge.fury.io/py/almanach.svg
|
|
:target: https://badge.fury.io/py/almanach
|
|
|
|
Almanach stores the utilization of OpenStack resources (instances and volumes) for each tenant.
|
|
|
|
What is Almanach?
|
|
-----------------
|
|
|
|
The main purpose of this software is to record the usage of the cloud resources of each tenants.
|
|
|
|
Almanach is composed of two parts:
|
|
|
|
- **Collector**: Listen for OpenStack events and store the relevant information in the database.
|
|
- **REST API**: Expose the information collected to external systems.
|
|
|
|
At the moment, Almanach is only able to record the usage of instances and volumes.
|
|
|
|
Resources
|
|
---------
|
|
|
|
Launchpad Projects
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
- https://launchpad.net/almanach
|
|
|
|
Blueprints
|
|
~~~~~~~~~~
|
|
|
|
- https://blueprints.launchpad.net/almanach
|
|
|
|
Bug Tracking
|
|
~~~~~~~~~~~~
|
|
|
|
- https://bugs.launchpad.net/almanach
|
|
|
|
License
|
|
-------
|
|
|
|
Almanach is distributed under Apache 2.0 LICENSE.
|