openstack/puppet-cloudkitty
Code Issues Proposed changes
Files
e45091d66dd899e93065ffb44f18f6ef7901c3c2
puppet-cloudkitty/README.md
Flavio Percoco 82f898efde Show team and repo badges on README 
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/31e99dc9fb0b5b532aef43a59db90788

Change-Id: I6e9fd54f107090381e65dc92ab6fc3ed92349e15
2016-11-25 17:17:03 +01:00

2.8 KiB
Raw Blame History

Team and repository tags

Team and repository tags

cloudkitty

Table of Contents

  1. Overview - What is the cloudkitty module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with cloudkitty
  4. Implementation - An under-the-hood peek at what the module is doing
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. 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.

Contributors