08148ffd1b
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: Ibdfd87dd41f746c65d9694560cd61586af22ad87 |
||
|---|---|---|
| doc | ||
| lib/puppet | ||
| manifests | ||
| releasenotes | ||
| spec | ||
| tests | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| Gemfile | ||
| LICENSE | ||
| README.md | ||
| Rakefile | ||
| bindep.txt | ||
| metadata.json | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
README.md
Team and repository tags
watcher
Table of Contents
- Overview - What is the watcher module?
- Module Description - What does the module do?
- Setup - The basics of getting started with watcher
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
- Release Notes - Release notes for the project
- Repository - The project source code repository
Overview
The watcher 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 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, 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:
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.