a2056aa3d3
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/28db7449a3750f099a10e70211bdc3c0 Change-Id: I40102559a56aabac56081ac711135756e9d20213
86 lines
2.7 KiB
Markdown
86 lines
2.7 KiB
Markdown
Team and repository tags
|
|
========================
|
|
|
|
[](http://governance.openstack.org/reference/tags/index.html)
|
|
|
|
<!-- Change things from this point on -->
|
|
|
|
watcher
|
|
=======
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Overview - What is the watcher module?](#overview)
|
|
2. [Module Description - What does the module do?](#module-description)
|
|
3. [Setup - The basics of getting started with watcher](#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 watcher module is a part of [OpenStack](https://www.openstack.org), 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 Watcher service for OpenStack.
|
|
|
|
Module Description
|
|
------------------
|
|
|
|
The watcher module is a thorough attempt to make Puppet capable of managing the entirety of watcher. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the watcher module to assist in manipulation of configuration files.
|
|
|
|
Setup
|
|
-----
|
|
|
|
**What the watcher module affects**
|
|
|
|
* [Watcher](https://wiki.openstack.org/wiki/Watcher), the Watcher service for OpenStack.
|
|
|
|
### Installing watcher
|
|
|
|
watcher is not currently in Puppet Forge, but is anticipated to be added soon. Once that happens, you'll be able to install watcher with:
|
|
puppet module install openstack/watcher
|
|
|
|
### Beginning with watcher
|
|
|
|
To utilize the watcher module's functionality you will need to declare multiple resources.
|
|
|
|
Implementation
|
|
--------------
|
|
|
|
### watcher
|
|
|
|
watcher is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
|
|
|
|
Limitations
|
|
------------
|
|
|
|
* All the watcher types use the CLI tools and so need to be ran on the watcher 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-rspec/blob/master/README.md
|
|
|
|
Development
|
|
-----------
|
|
|
|
Developer documentation for the entire puppet-openstack project.
|
|
|
|
* http://docs.openstack.org/developer/puppet-openstack-guide/
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* https://github.com/openstack/puppet-watcher/graphs/contributors
|