f6059c17fb
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Icd290fa16cb0754a43223740bc47d74d133dd4c8 |
||
|---|---|---|
| doc | ||
| examples | ||
| lib/puppet | ||
| manifests | ||
| releasenotes | ||
| spec | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| CONTRIBUTING.rst | ||
| Gemfile | ||
| LICENSE | ||
| README.md | ||
| Rakefile | ||
| bindep.txt | ||
| metadata.json | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
README.md
Team and repository tags
panko
Table of Contents
- Overview - What is the panko module?
- Module Description - What does the module do?
- Setup - The basics of getting started with panko
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Beaker-Rspec - Beaker-rspec tests for the project
- Development - Guide for contributing to the module
- Contributors - Those with commits
- Release Notes - Release notes for the project
- Repository - The project source code repository
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.