Team and repository tags
========================

[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-watcher.svg)](https://governance.openstack.org/tc/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)
8. [Release Notes - Release notes for the project](#release-notes)
9. [Repository - The project source code repository](#repository)

Overview
--------

The watcher module is a part of [OpenStack](https://opendev.org/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 itself 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://docs.openstack.org/watcher/latest/), 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.

Development
-----------

Developer documentation for the entire puppet-openstack project.

* https://docs.openstack.org/puppet-openstack-guide/latest/

Contributors
------------

* https://github.com/openstack/puppet-watcher/graphs/contributors

Release Notes
-------------

* https://docs.openstack.org/releasenotes/puppet-watcher

Repository
----------

* https://opendev.org/openstack/puppet-watcher