puppet-barometer/README.md

   1 barometer
   2 =======
   3
   4 #### Table of Contents
   5
   6 1. [Overview - What is the barometer module?](#overview)
   7 2. [Module Description - What does the module do?](#module-description)
   8 3. [Setup - The basics of getting started with barometer](#setup)
   9 4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
  10 5. [Limitations - OS compatibility, etc.](#limitations)
  11 6. [Development - Guide for contributing to the module](#development)
  12 7. [Contributors - Those with commits](#contributors)
  13
  14 Overview
  15 --------
  16
  17 The barometer 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 barometer service for OpenStack.
  18
  19 Module Description
  20 ------------------
  21
  22 The barometer module is a thorough attempt to make Puppet capable of managing the entirety of barometer.  This includes manifests to provision region specific endpoint and database connections.  Types are shipped as part of the barometer module to assist in manipulation of configuration files.
  23
  24 Setup
  25 -----
  26
  27 **What the barometer module affects**
  28
  29 * [Barometer](https://wiki.opnfv.org/display/fastpath/Barometer+Home), the barometer service for OpenStack.
  30
  31 ### Installing barometer
  32
  33     barometer is not currently in Puppet Forge, but is anticipated to be added soon.  Once that happens, you'll be able to install barometer with:
  34     puppet module install openstack/barometer
  35
  36 ### Beginning with barometer
  37
  38 To utilize the barometer module's functionality you will need to declare multiple resources.
  39
  40 Implementation
  41 --------------
  42
  43 ### barometer
  44
  45 barometer is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
  46
  47 Limitations
  48 ------------
  49
  50 * All the barometer types use the CLI tools and so need to be ran on the barometer node.
  51
  52 Beaker-Rspec
  53 ------------
  54
  55 This module has beaker-rspec tests
  56
  57 To run the tests on the default vagrant node:
  58
  59 ```shell
  60 bundle install
  61 bundle exec rake acceptance
  62 ```
  63
  64 For more information on writing and running beaker-rspec tests visit the documentation:
  65
  66 * https://github.com/puppetlabs/beaker-rspec/blob/master/README.md
  67
  68 Development
  69 -----------
  70
  71 Developer documentation for the entire puppet-openstack project.
  72
  73 * http://docs.openstack.org/developer/puppet-openstack-guide/
  74
  75 Contributors
  76 ------------
  77
  78 * https://github.com/openstack/puppet-barometer/graphs/contributors