Skip to content

Commit

Permalink
Made some minor docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jamtur01 committed Mar 21, 2013
1 parent 8d37f4f commit 579e8b4
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 11 deletions.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2013 James Turnbull, Jeremy Carroll, Justin Lambert, Tim Sharpe

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Sensu-Puppet


Tested with Travis CI

[![Build Status](https://travis-ci.org/sensu/sensu-puppet.png)](https://travis-ci.org/sensu/sensu-puppet)

## Upgrade note
Version 0.5.0 is pretty close to 100% incompatible with previous version of the sensu-puppet module due to massive refactoring.
Version 0.5.0 and later are incompatible with previous versions of the
Sensu-Puppet module.

## Installation

$ puppet module install sensu/sensu

## Prerequisites
- redis server and connectivity to a redis database
- rabbitmq server, vhost, and credentials
- Redis server and connectivity to a Redis database
- RabbitMQ server, vhost, and credentials

### Dependencies

Expand All @@ -24,7 +24,9 @@ See Modulefile for details.

### Others

Pluginsync should be enabled. Also, you need ruby json library/gem on all your nodes.
Pluginsync should be enabled. Also, you will need the Ruby JSON library
or gem on all your nodes.

[EPEL](http://mirrors.kernel.org/fedora-epel/6/x86_64/rubygem-json-1.4.6-1.el6.x86_64.rpm)

## Basic Example
Expand Down Expand Up @@ -68,7 +70,9 @@ Pluginsync should be enabled. Also, you need ruby json library/gem on all your n
}

### Advanced Example (hiera)
This example includes the sensu class as part of a base class or role and controles sensu on each individual node via hiera.
This example includes the `sensu` class as part of a base class or role
and configures Sensu on each individual node via
[Hiera](http://docs.puppetlabs.com/#hierahiera1).

hiera.yaml

Expand Down Expand Up @@ -108,8 +112,12 @@ site.pp
}


### Inclusion of sensu monitoring in other modules
There are a few different patterns that can be used to include sensu monitoring into other modules. One pattern creates a new class that is included as part of the host or node definition and includes a standalone check, for example:
### Including Sensu monitoring in other modules

There are a few different patterns that can be used to include Sensu
monitoring into other modules. One pattern creates a new class that is
included as part of the host or node definition and includes a
standalone check, for example:

apache/manifests/monitoring/sensu.pp

Expand All @@ -122,15 +130,18 @@ apache/manifests/monitoring/sensu.pp
}
}

Rather than include a standalone check you could also include subscription information and let the sensu server schedule checks for this service as a subscriber:
You could also include subscription information and let the Sensu server
schedule checks for this service as a subscriber:

apache/manifests/monitoring/sensu.pp

class apache::monitoring::sensu {
sensu::subscription { 'apache' }
}

If you would like to automatically include the sensu monitoring class as part of your existing module with the ability to support different monitoring platforms, you could do something like:
If you would like to automatically include the Sensu monitoring class as
part of your existing module with the ability to support different
monitoring platforms, you could do something like:

apache/manifests/service.pp

Expand All @@ -144,5 +155,5 @@ $monitoring = hiera('monitoring', '')

## License

MIT
See LICENSE file.

0 comments on commit 579e8b4

Please sign in to comment.