https://github.com/jtimberman/chef-handler-growl

A simple Chef report handler using ruby_gntp to send growl notifications
https://github.com/jtimberman/chef-handler-growl

Last synced: 3 months ago
JSON representation

A simple Chef report handler using ruby_gntp to send growl notifications

• Host: GitHub
• URL: https://github.com/jtimberman/chef-handler-growl
• Owner: jtimberman
• License: apache-2.0
• Archived: true
• Created: 2012-01-03T03:31:47.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2012-08-18T18:29:26.000Z (about 12 years ago)
• Last Synced: 2024-07-31T21:13:43.918Z (3 months ago)
• Language: Ruby
• Homepage: http://rubygems.org/gems/chef-handler-growl
• Size: 104 KB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-chef - Chef Growl Handler - A simple Chef report handler using ruby_gntp to send growl notifications. (Chef handlers / Resources - Application configuration)

README

        
Description

===========

This is a simple Chef report handler that reports status of a Chef run

through Growl.

* http://wiki.opscode.com/display/chef/Exception+and+Report+Handlers

Requirements

============

Platform: Mac OS X

Growl: Tested with version 1.3.2

Uses the `ruby_gntp` library.

Usage

=====

There are two ways to use Chef Handlers.

### Method 1

You can install the RubyGem ahead of time, and configure Chef to use

them. To do so:

    gem install chef-handler-growl

Then add to the configuration (`/etc/chef/solo.rb` for chef-solo or

`/etc/chef/client.rb` for chef-client):

    require "chef/handler/growl"

    report_handlers << Chef::Handler::Growl.new

    exception_handlers << Chef::Handler::Growl.new

### Method 2

Use the

[chef_handler cookbook by Opscode](http://community.opscode.com/cookbooks/chef_handler).

Create a recipe with the following:

    # Install the `chef-handler-growl` RubyGem during the compile phase

    chef_gem "chef-handler-growl"

    # Then activate the handler with the `chef_handler` LWRP

    chef_handler "Chef::Handler::Growl" do

      source "chef/handler/growl"

      action :enable

    end

Roadmap

=======

Things I would like to add:

* rspec tests - both Chef::Handler and GNTP#notify have specs, so this

  was low priority.

* GNTP over the network capability. For example, if I have three

  virtual machines running Chef on an interval, I'd like them to send

  notification to my Mac workstation I'm using.

These are created as issues. Pull requests welcome.

License and Author

==================

Author:: Joshua Timberman 

Copyright:: Copyright (c) 2012, Joshua Timberman

License:: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.