OpenStack Vitrage Puppet Module
Go to file
ZhongShengping 24ffda5777 Dissuade .gitignore references to personal tools
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: I7bced986c5386e6d5fd62f2be38d1994f86d9ca3
2018-10-08 11:39:25 +08:00
doc Follow the new PTI for document build 2018-02-28 14:46:18 +08:00
examples Replace port 35357 with 5000 2018-07-18 10:31:43 +02:00
lib/puppet Fix filename of api-paste.ini 2017-07-26 09:31:51 +08:00
manifests Merge "Replace port 35357 with 5000 for "auth_url"" 2018-06-19 07:31:03 +00:00
releasenotes Update reno for stable/rocky 2018-08-20 18:44:04 +00:00
spec modulesync: sync and add nodepool-bionic for beaker 2018-07-18 16:20:33 +02:00
tests Fix the smoke testing link 2018-07-30 12:31:36 -04:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-08 11:39:25 +08:00
.gitreview Added .gitreview 2015-12-09 10:12:41 +00:00
.zuul.yaml switch documentation job to new PTI 2018-08-31 08:24:47 -04:00
Gemfile Load puppet-openstack_spec_helper locally during tests 2018-02-12 10:53:40 +08:00
LICENSE Update LICENSE 2018-04-06 20:15:16 +08:00
README.md Add the missing 'Table of Contents' 2018-08-28 13:34:12 +00:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:35 -05:00
bindep.txt modulesync: sync and add nodepool-bionic for beaker 2018-07-18 16:20:33 +02:00
metadata.json Bump version for the start of Stein 2018-08-30 12:11:25 -06:00
setup.cfg Update URLs in documents according to document migration 2017-07-14 08:54:58 +08:00
setup.py Add basic structure for ReNo 2016-10-07 14:58:43 +00:00
tox.ini fix tox python3 overrides 2018-06-08 14:23:33 +08:00

README.md

Team and repository tags

Team and repository tags

vitrage

Table of Contents

  1. Overview - What is the vitrage module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with vitrage
  4. Implementation - An under-the-hood peek at what the module is doing
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. Contributors - Those with commits
  8. Release Notes - Release notes for the project
  9. Repository - The project source code repository

Overview

Vitrage module is an engine for organizing, analyzing and expanding OpenStack alarms & events, yielding insights regarding the Root Cause of problems and deducing the existence of problems before they are directly detected.

Module Description

The vitrage puppet module is a thorough attempt to make Puppet capable of managing the entirety of vitrage.

Setup

What the vitrage module affects

  • Vitrage, the Root Cause Analysis engine for organizing, analyzing and expanding OpenStack alarms & events for Openstack.

Installing vitrage

vitrage is not currently in Puppet Forge, but is anticipated to be added soon.  Once that happens, you'll be able to install vitrage with:
puppet module install openstack/vitrage

Beginning with vitrage

To utilize the vitrage module's functionality you will need to declare multiple resources. The following is a modified excerpt from the openstack module. This is not an exhaustive list of all the components needed, we recommend you consult and understand the openstack module and the core openstack documentation.

Implementation

vitrage

vitrage is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.

Limitations

  • None.

Beaker-Rspec

This module has beaker-rspec tests

To run the tests on the default vagrant node:

bundle install
bundle exec rake acceptance

Development

Developer documentation for the entire puppet-openstack project.

Contributors

Release Notes

Repository