3a29769588
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: I64ee0c5c15d9cfda8ba16349e928d32a28f5d2ad
Team and repository tags
AODH
Table of Contents
- Overview - What is the AODH module?
- Module Description - What does the module do?
- Setup - The basics of getting started with AODH
- 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
- Repository - The project source code repository
- Contributors - Those with commits
- Release Notes - Release notes for the project
Overview
The AODH 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 Alarming service for OpenStack.
Module Description
The AODH module is a thorough attempt to make Puppet capable of managing the entirety of AODH. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the AODH module to assist in manipulation of configuration files.
Setup
What the AODH module affects
- AODH, the Alarming service for OpenStack.
Installing AODH
puppet module install openstack/aodh
Beginning with AODH
To utilize the AODH module's functionality you will need to declare multiple resources. This is not an exhaustive list of all the components needed, we recommend you consult and understand the core OpenStack documentation.
Implementation
AODH
AODH is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
Limitations
- All the AODH types use the CLI tools and so need to be ran on the AODH 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.