40a31eeabe
Developers run all sorts of different tools within Git repositories, any of which can leave their own special trashfiles all over the place. We can't every hope to catalog them all, so better to recommend developers simply configure a global core.excludesfile to filter the irrelevant files which tend to get created by their personal choice of tools. Add a comment block explaining this, for clarity, and remove the one current editor-specific entry present. We can, and should of course, continue to list files created by the tools recommended by our workflow (test frameworks, documentation and packaging builds, et cetera). This change is a port of Ib58a57267b064e4142686de6c37a70dbff04b9a7 from the openstack-dev/cookiecutter repository. Change-Id: I251435b436e6cf6b8640b0713eca1573cbddba5d |
||
---|---|---|
doc | ||
examples | ||
lib/puppet | ||
manifests | ||
releasenotes | ||
spec | ||
tests | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
bindep.txt | ||
CHANGELOG.md | ||
Gemfile | ||
LICENSE | ||
metadata.json | ||
Rakefile | ||
README.md | ||
setup.cfg | ||
setup.py | ||
tox.ini |
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.
- 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.