fb5961a3be
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/c5283aeba974b8c750f2422f6501f108 Change-Id: I12aa9273538647a83243b0886a88ec302d090e8c
85 lines
2.7 KiB
Markdown
85 lines
2.7 KiB
Markdown
Team and repository tags
|
|
========================
|
|
|
|
[](http://governance.openstack.org/reference/tags/index.html)
|
|
|
|
<!-- Change things from this point on -->
|
|
|
|
AODH
|
|
====
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Overview - What is the AODH module?](#overview)
|
|
2. [Module Description - What does the module do?](#module-description)
|
|
3. [Setup - The basics of getting started with AODH](#setup)
|
|
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
|
|
5. [Limitations - OS compatibility, etc.](#limitations)
|
|
6. [Development - Guide for contributing to the module](#development)
|
|
7. [Contributors - Those with commits](#contributors)
|
|
|
|
Overview
|
|
--------
|
|
|
|
The AODH module is a part of [OpenStack](https://github.com/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](http://docs.openstack.org/developer/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](http://docs.openstack.org) 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:
|
|
|
|
```shell
|
|
bundle install
|
|
bundle exec rake acceptance
|
|
```
|
|
|
|
For more information on writing and running beaker-rspec tests visit the documentation:
|
|
|
|
* https://github.com/puppetlabs/beaker/wiki/How-to-Write-a-Beaker-Test-for-a-Module
|
|
|
|
Development
|
|
-----------
|
|
|
|
Developer documentation for the entire puppet-openstack project.
|
|
|
|
* http://docs.openstack.org/developer/puppet-openstack-guide/
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* https://github.com/openstack/puppet-aodh/graphs/contributors
|