75ea848948
Reorganize that 'Release Notes' in README and make the 'Release Notes' an independent chapter. Change-Id: I38cc77ab4997c5c9b2df19c1e7438879ee968f4a
Team and repository tags
cloudkitty
Table of Contents
- Overview - What is the cloudkitty module?
- Module Description - What does the module do?
- Setup - The basics of getting started with cloudkitty
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
Overview
The cloudkitty module is a part of OpenStack, an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects not part of the core software. The module its self is used to flexibly configure and manage the Rating-as-a-Service for OpenStack.
Module Description
The cloudkitty module is a thorough attempt to make Puppet capable of managing the entirety of cloudkitty. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the cloudkitty module to assist in manipulation of configuration files.
Setup
What the cloudkitty module affects
- Cloudkitty, the Rating-as-a-Service for OpenStack.
Installing cloudkitty
cloudkitty is not currently in Puppet Forge, but is anticipated to be added soon. Once that happens, you'll be able to install cloudkitty with:
puppet module install openstack/cloudkitty
Beginning with cloudkitty
To utilize the cloudkitty module's functionality you will need to declare multiple resources.
Implementation
cloudkitty
cloudkitty is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
Limitations
- All the cloudkitty types use the CLI tools and so need to be ran on the cloudkitty node.
Beaker-Rspec
This module has beaker-rspec tests
To run the tests on the default vagrant node:
bundle install
bundle exec rake acceptance
For more information on writing and running beaker-rspec tests visit the documentation:
Development
Developer documentation for the entire puppet-openstack project.