├── .gitignore ├── puppet-slack.png ├── templates └── slack.yaml.erb ├── CHANGELOG ├── Modulefile ├── .travis.yml ├── Gemfile ├── metadata.json ├── Rakefile ├── lib └── puppet │ └── reports │ └── slack.rb ├── manifests └── init.pp ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | pkg/* 2 | Gemfile.lock 3 | .vagrant/ 4 | -------------------------------------------------------------------------------- /puppet-slack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fsalum/puppet-slack/HEAD/puppet-slack.png -------------------------------------------------------------------------------- /templates/slack.yaml.erb: -------------------------------------------------------------------------------- 1 | --- 2 | :slack_token: '<%= @slack_token %>' 3 | :slack_channel: '<%= @slack_channel %>' 4 | :slack_botname: '<%= @slack_botname %>' 5 | :slack_iconurl: '<%= @slack_iconurl %>' 6 | :slack_url: '<%= @slack_url %>' 7 | -------------------------------------------------------------------------------- /CHANGELOG: -------------------------------------------------------------------------------- 1 | ## fsalum-slack changelog 2 | 3 | Release notes for the fsalum-slack module. 4 | 5 | ------------------------------------------ 6 | 7 | #### 0.0.2 - 2014-10-25 8 | 9 | * PR #1 - Changes to make module useable with puppet enterprise (@despairblue) 10 | * PR #2 - Update README.md (@s33dunda) 11 | * PR #6 - Added support for puppetserver and also redhat & debian os families. (@Conzar) 12 | 13 | #### 0.0.1 - 2014-05-30 14 | 15 | * Initial Forge release 16 | -------------------------------------------------------------------------------- /Modulefile: -------------------------------------------------------------------------------- 1 | name 'fsalum-slack' 2 | version '0.0.2' 3 | source 'git://github.com/fsalum/puppet-slack.git' 4 | author 'Felipe Salum' 5 | license 'Apache 2.0' 6 | project_page 'https://github.com/fsalum/puppet-slack' 7 | summary 'Slack.com integration for Puppet report processor' 8 | description 'Puppet report processor for sending notifications of puppet runs to Slack Messaging.' 9 | 10 | ## Add dependencies, if any: 11 | dependency 'conzar/check_run', '>= 0.2.3' 12 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | language: ruby 3 | bundler_args: --without development 4 | script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'" 5 | matrix: 6 | fast_finish: true 7 | include: 8 | - rvm: 1.8.7 9 | env: PUPPET_GEM_VERSION="~> 2.7.0" FACTER_GEM_VERSION="~> 1.6.0" 10 | - rvm: 1.8.7 11 | env: PUPPET_GEM_VERSION="~> 2.7.0" FACTER_GEM_VERSION="~> 1.7.0" 12 | - rvm: 1.9.3 13 | env: PUPPET_GEM_VERSION="~> 3.0" 14 | - rvm: 2.0.0 15 | env: PUPPET_GEM_VERSION="~> 3.0" 16 | notifications: 17 | email: false 18 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source ENV['GEM_SOURCE'] || "https://rubygems.org" 2 | 3 | group :development, :test do 4 | gem 'rake', :require => false 5 | gem 'rspec-puppet', :require => false 6 | gem 'puppetlabs_spec_helper', :require => false 7 | gem 'serverspec', :require => false 8 | gem 'puppet-lint', :require => false 9 | gem 'beaker', :require => false 10 | gem 'beaker-rspec', :require => false 11 | gem 'pry', :require => false 12 | gem 'simplecov', :require => false 13 | end 14 | 15 | if facterversion = ENV['FACTER_GEM_VERSION'] 16 | gem 'facter', facterversion, :require => false 17 | else 18 | gem 'facter', :require => false 19 | end 20 | 21 | if puppetversion = ENV['PUPPET_GEM_VERSION'] 22 | gem 'puppet', puppetversion, :require => false 23 | else 24 | gem 'puppet', :require => false 25 | end 26 | 27 | # vim:ft=ruby 28 | -------------------------------------------------------------------------------- /metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fsalum-slack", 3 | "version": "0.0.2", 4 | "source": "git://github.com/fsalum/puppet-slack.git", 5 | "author": "Felipe Salum", 6 | "license": "Apache 2.0", 7 | "summary": "Slack.com integration for Puppet report processor", 8 | "project_page": "https://github.com/fsalum/puppet-slack", 9 | "issues_url": "https://github.com/fsalum/puppet-slack/issues", 10 | "tags": ["slack", "chat", "messaging", "communication"], 11 | "requirements": [], 12 | "operatingsystem_support": [ 13 | { "operatingsystem":"Centos", 14 | "operatingsystemrelease":[ "5.0", "6.0" ] }, 15 | { "operatingsystem": "Ubuntu", 16 | "operatingsystemrelease": [ "12.04", "14.04" ] } 17 | ], 18 | "requirements": [ 19 | { "name": "pe", 20 | "version_requirement": "3.x" }, 21 | { "name": "puppet", 22 | "version_requirement": "3.x" } 23 | ], 24 | "dependencies": [ 25 | { 26 | "name": "conzar/check_run", 27 | "version_requirement": ">= 0.2.3" 28 | } 29 | ] 30 | } 31 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | require 'puppetlabs_spec_helper/rake_tasks' 3 | require 'puppet-lint/tasks/puppet-lint' 4 | PuppetLint.configuration.fail_on_warnings 5 | PuppetLint.configuration.send('relative') 6 | PuppetLint.configuration.send('disable_80chars') 7 | PuppetLint.configuration.send('disable_class_inherits_from_params_class') 8 | PuppetLint.configuration.send('disable_class_parameter_defaults') 9 | PuppetLint.configuration.send('disable_documentation') 10 | PuppetLint.configuration.send('disable_single_quote_string_with_variables') 11 | PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp"] 12 | 13 | desc "Validate manifests, templates, and ruby files in lib." 14 | task :validate do 15 | Dir['manifests/**/*.pp'].each do |manifest| 16 | sh "puppet parser validate --noop #{manifest}" 17 | end 18 | Dir['lib/**/*.rb'].each do |lib_file| 19 | sh "ruby -c #{lib_file}" 20 | end 21 | Dir['templates/**/*.erb'].each do |template| 22 | sh "erb -P -x -T '-' #{template} | ruby -c" 23 | end 24 | end 25 | -------------------------------------------------------------------------------- /lib/puppet/reports/slack.rb: -------------------------------------------------------------------------------- 1 | require 'puppet' 2 | require 'yaml' 3 | require 'faraday' 4 | 5 | Puppet::Reports.register_report(:slack) do 6 | 7 | desc <<-DESC 8 | Send notification of puppet run reports to Slack Messaging. 9 | DESC 10 | 11 | @configfile = File.join(File.dirname(Puppet.settings[:config]), "slack.yaml") 12 | raise(Puppet::ParseError, "Slack report config file #{@configfile} not readable") unless File.exist?(@configfile) 13 | @config = YAML.load_file(@configfile) 14 | SLACK_TOKEN = @config[:slack_token] 15 | SLACK_CHANNEL = @config[:slack_channel] 16 | SLACK_BOTNAME = @config[:slack_botname] 17 | SLACK_ICONURL = @config[:slack_iconurl] 18 | SLACK_URL = @config[:slack_url] 19 | 20 | def process 21 | if self.status == "failed" or self.status == "changed" 22 | Puppet.debug "Sending status for #{self.host} to Slack." 23 | conn = Faraday.new(:url => "#{SLACK_URL}") do |faraday| 24 | faraday.request :url_encoded 25 | faraday.adapter Faraday.default_adapter 26 | end 27 | 28 | conn.post do |req| 29 | req.url "/services/hooks/incoming-webhook?token=#{SLACK_TOKEN}" 30 | req.body = "{\"channel\":\"#{SLACK_CHANNEL}\",\"username\":\"#{SLACK_BOTNAME}\", \"icon_url\":\"#{SLACK_ICONURL}\",\"text\":\"> Puppet run for #{self.host} `#{self.status}` at #{Time.now.asctime}\"}" 31 | end 32 | end 33 | end 34 | end 35 | -------------------------------------------------------------------------------- /manifests/init.pp: -------------------------------------------------------------------------------- 1 | # Report processor integration with Slack.com 2 | class slack ( 3 | $slack_token = undef, 4 | $slack_url = undef, 5 | $slack_iconurl = 'http://puppetlabs.com/wp-content/uploads/2010/12/PL_logo_vertical_RGB_lg.png', 6 | $slack_channel = '#puppet', 7 | $slack_botname = 'puppet', 8 | $slack_puppet_reports = undef, 9 | $slack_puppet_dir = '/etc/puppet', 10 | $is_puppetmaster = true, 11 | ) { 12 | 13 | anchor {'slack::begin':} 14 | 15 | if $is_puppetmaster == true { 16 | package { 'faraday': 17 | ensure => installed, 18 | provider => gem, 19 | require => Anchor['slack::begin'], 20 | before => File["${slack_puppet_dir}/slack.yaml"], 21 | } 22 | }else { 23 | include check_run 24 | case $::osfamily { 25 | 'redhat','debian': { 26 | check_run::task { 'task_faraday_gem_install': 27 | exec_command => '/usr/bin/puppetserver gem install faraday', 28 | require => Anchor['slack::begin'], 29 | before => File["${slack_puppet_dir}/slack.yaml"], 30 | } 31 | } 32 | default: { 33 | fail("Unsupported osfamily ${::osfamily}") 34 | } 35 | } 36 | } 37 | 38 | file { "${slack_puppet_dir}/slack.yaml": 39 | owner => root, 40 | group => root, 41 | mode => '0644', 42 | content => template('slack/slack.yaml.erb'), 43 | } 44 | 45 | if $slack_puppet_reports { 46 | ini_setting { 'slack_puppet_reports': 47 | ensure => present, 48 | path => "${slack_puppet_dir}/puppet.conf", 49 | section => 'master', 50 | setting => 'reports', 51 | value => $slack_puppet_reports, 52 | require => File [ "${slack_puppet_dir}/slack.yaml"], 53 | before => Anchor['slack::end'], 54 | } 55 | } 56 | anchor{'slack::end': 57 | require => File [ "${slack_puppet_dir}/slack.yaml"], 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # puppet-slack 2 | [![puppet-slack](https://img.shields.io/puppetforge/v/fsalum/slack.svg)](https://forge.puppetlabs.com/fsalum/slack) [![Build Status](https://travis-ci.org/fsalum/puppet-slack.svg?branch=master)](https://travis-ci.org/fsalum/puppet-slack) 3 | 4 | ## Description 5 | 6 | A Puppet report handler for sending notifications of puppet runs to 7 | [Slack Messaging](https://slack.com). 8 | 9 | ## Installation & Usage 10 | 11 | 1. Install puppet-slack as a module in your Puppet master's module path. 12 | 13 | 1. You will need to create a Slack Incoming WebHooks integration at [slack.com](https://slack.com) 14 | 15 | 1. Add the class to the puppet master node: 16 | 17 | class { 'slack': 18 | slack_url => 'YOUR_SLACK_URL', 19 | slack_token => 'INCOMING_WEBHOOK_TOKEN', 20 | slack_channel => '#puppet', 21 | slack_botname => 'puppet', 22 | slack_iconurl => 'http://puppetlabs.com/wp-content/uploads/2010/12/PL_logo_vertical_RGB_lg.jpg', 23 | slack_puppet_reports => 'store,http,slack', 24 | is_puppetmaster => true, 25 | } 26 | you might also want to set `slack_puppet_dir => '/etc/puppetlabs/puppet'` if you use puppet enterprise. 27 | 28 | 1. Run the Puppet client and sync the report as a plugin 29 | 30 | ### Class: `slack` 31 | The slack module sets up the puppetmaster or puppetserver for slack integration. 32 | 33 | **Parameters within `slack`:** 34 | 35 | #####`slack_url` 36 | 37 | The base url to your slack page. Required. 38 | Example: 'https://yourcompany.slack.com' 39 | 40 | #####`slack_token` 41 | 42 | The secret webhook. Required. 43 | 44 | #####`slack_channel` 45 | 46 | The channel where puppet messages will be sent. 47 | Default: '#puppet' 48 | 49 | #####`slack_botname` 50 | 51 | The name of the slack bot 52 | Default: 'puppet' 53 | 54 | #####`slack_iconurl` 55 | 56 | The icon to show next to the puppet message. 57 | Default: 'http://puppetlabs.com/wp-content/uploads/2010/12/PL_logo_vertical_RGB_lg.jpg', 58 | 59 | #####`slack_puppet_reports` 60 | 61 | Manages the puppet report in the puppet.conf. If left undef, this module will not modify the puppet.conf. 62 | Example: 'store,http,slack' 63 | 64 | #####`is_puppetmaster` 65 | 66 | The default is 'true' which means slack will manage the installation for a puppetmaster. 67 | Set to 'false' to use the [new PuppetServer](https://github.com/puppetlabs/puppet-server). 68 | 69 | ## Screenshot 70 | 71 | ![image](https://raw.githubusercontent.com/fsalum/puppet-slack/master/puppet-slack.png) 72 | 73 | ## Tested 74 | 75 | The following operating systems were tested: 76 | * Centos 6.5 77 | * Ubuntu 14.04 78 | 79 | ## Author 80 | 81 | Felipe Salum 82 | 83 | ## Copyright and License 84 | 85 | Copyright (C) 2012 Felipe Salum 86 | 87 | Felipe Salum can be contacted at: fsalum@gmail.com 88 | 89 | Licensed under the Apache License, Version 2.0 (the "License"); 90 | you may not use this file except in compliance with the License. 91 | You may obtain a copy of the License at 92 | 93 | http://www.apache.org/licenses/LICENSE-2.0 94 | 95 | Unless required by applicable law or agreed to in writing, software 96 | distributed under the License is distributed on an "AS IS" BASIS, 97 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 98 | See the License for the specific language governing permissions and 99 | limitations under the License. 100 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {2014} {Felipe Salum} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------