openstack/puppet-panko
Code Issues Proposed changes
020a8e3fe5
puppet-panko/README.md
Flavio Percoco 9bb0b75adc 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/34a04ef337969c3460c69f75c6165473

Change-Id: Icba89044a7f4e14eae8d8b27fc0b5eaf400eea06
2016-11-25 17:37:15 +01:00

2.7 KiB
Raw Blame History

Team and repository tags

Team and repository tags

panko

Table of Contents

  1. Overview - What is the panko module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with panko
  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 panko 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 events service for OpenStack.

Module Description

The panko module is a thorough attempt to make Puppet capable of managing the entirety of panko. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the panko module to assist in manipulation of configuration files.

Setup

What the panko module affects

  • Panko, the events service for OpenStack.

Installing panko

panko is not currently in Puppet Forge, but is anticipated to be added soon.  Once that happens, you'll be able to install panko with:
puppet module install openstack/panko

Beginning with panko

To utilize the panko module's functionality you will need to declare multiple resources.

Implementation

panko

panko is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.

Limitations

  • All the panko types use the CLI tools and so need to be ran on the panko 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