Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

slack_handler (9) Versions 0.4.0

Installs/Configures a Chef handler for reporting results to a Slack channel.

Berkshelf/Librarian
Policyfile
Knife
cookbook 'slack_handler', '= 0.4.0'
cookbook 'slack_handler', '= 0.4.0', :supermarket
knife cookbook site install slack_handler
knife cookbook site download slack_handler
README
Dependencies
Changelog
Quality

Description

Build Status

A cookbook for a chef_handler that sends reports and exceptions to Slack. There are two options for use: 1. Providing a team name and api_key (Uses the slackr gem) 2. Providing a hash containing incoming webhook url(s)

This cookbook was originally a fork of dcm-ops/chef-slack_handler. We have taken over maintenance of this cookbook and released it to Supermarket.

Requirements

  • The chef_handler cookbook
  • An existing Slack incoming webhook(s)

Usage 1

  1. Create a new Slack webhook (https://slack.com/services/new/incoming-webhook)
  2. Set the team and api_key attributes above on the node/environment/etc.
  3. Include this slack_handler recipe.

Usage 1 Attributes

  • node['chef_client']['handler']['slack']['team'] - Your Slack team name (<team-name>.slack.com)
  • node['chef_client']['handler']['slack']['api_key'] - The API key of your Slack incoming webhook

Optional attributes

  • node['chef_client']['handler']['slack']['channel'] - The #channel to send the results
  • node['chef_client']['handler']['slack']['username'] - The username of the Slack message
  • node['chef_client']['handler']['slack']['icon_url'] - The Slack message icon
  • node['chef_client']['handler']['slack']['icon_emoji'] - The Slack message icon defined by available :emoji:
  • node['chef_client']['handler']['slack']['detail_level'] - The level of detail in the message. Valid options are basic, elapsed and resources
  • node['chef_client']['handler']['slack']['fail_only'] - Only report when runs fail as opposed to every single occurance

NOTE: Either icon_url or icon_emoji can be used. If both are set, icon_url will take precedence.

Usage 2

  1. Create a new Slack webhook (https://slack.com/services/new/incoming-webhook)
  2. Set the attributes as specified below
  3. Include this slack_handler recipe.

Usage 2 Attributes

  • node['chef_client']['handler']['slack']['username'] = 'Chef Handler - 2963351-crowdcube_app' *
  • node['chef_client']['handler']['slack']['webhooks']['name'].push('webhook1')
  • node['chef_client']['handler']['slack']['webhooks']['webhook1']['url'] = 'https://hooks.slack.com/1/2/3'
  • node['chef_client']['handler']['slack']['webhooks']['webhook1']['fail_only'] = true
  • node['chef_client']['handler']['slack']['webhooks']['webhook1']['detail_level'] = 'elapsed'

  • node['chef_client']['handler']['slack']['webhooks']['name'].push('webhook2')

  • node['chef_client']['handler']['slack']['webhooks']['webhook2']['url'] = 'https://hooks.slack.com/1/2/4'

  • node['chef_client']['handler']['slack']['webhooks']['webhook2']['fail_only'] = false

  • node['chef_client']['handler']['slack']['webhooks']['webhook2']['detail_level'] = 'resources'

NOTE: Either icon_url or icon_emoji can be used. If both are set, icon_url will take precedence.

Credits

Borrowed everything from the logstash_handler cookbook here, who in turn borrowed quite a bit from the graphite_handler cookbook here.

License

slack_handler is provided under the Apache License 2.0. See LICENSE for details.

Changelog

v0.4.0 (2016-03-09)

  • Add CHANGELOG.md (#11)
  • Move exception from message to text attachment (#12)

v0.3.0 (2016-02-18)

  • Downgrade level of the webhook log message from warn to info

v0.2.0 (2016-02-01)

  • Add Rubocop and Foodcritic
  • Fix ruby syntax
  • Fix bug when not using webhooks
  • Add circle.yml for CircleCI
  • Webhook handler honors :icon_url attribute

v0.1.0 (2015-05-25)

  • Initial release to Supermarket at f32996d

Forked

Forked from dcm-ops/chef-slack_handler on 2015-05-18.

Foodcritic Metric
            

0.4.0 passed this metric