CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [v4.7.0](https://github.com/sensu/sensu-puppet/tree/v4.7.0) (2020-03-20)
+
+[Full Changelog](https://github.com/sensu/sensu-puppet/compare/v4.6.0...v4.7.0)
+
+### Added
+
+- Ignore builtin sensu.io/managed\_by label [\#1228](https://github.com/sensu/sensu-puppet/pull/1228) ([treydock](https://github.com/treydock))
+
+### Merged Pull Requests
+
+- Avoid facter 4, breaks unit tests [\#1232](https://github.com/sensu/sensu-puppet/pull/1232) ([treydock](https://github.com/treydock))
+- Add example usage for LDAP [\#1231](https://github.com/sensu/sensu-puppet/pull/1231) ([ghoneycutt](https://github.com/ghoneycutt))
+- Fix acceptance tests [\#1229](https://github.com/sensu/sensu-puppet/pull/1229) ([treydock](https://github.com/treydock))
+
 ## [v4.6.0](https://github.com/sensu/sensu-puppet/tree/v4.6.0) (2020-03-07)
 
 [Full Changelog](https://github.com/sensu/sensu-puppet/compare/v4.5.1...v4.6.0)
@@ -186,7 +200,6 @@
 ### Added
 
 - Initial work at design document [\#1161](https://github.com/sensu/sensu-puppet/pull/1161) ([treydock](https://github.com/treydock))
-- Add sensu\_resources type that will handle resource purging [\#1158](https://github.com/sensu/sensu-puppet/pull/1158) ([treydock](https://github.com/treydock))
 - Add bolt tasks [\#1153](https://github.com/sensu/sensu-puppet/pull/1153) ([treydock](https://github.com/treydock))
 - Deprecate defining single asset builds [\#1140](https://github.com/sensu/sensu-puppet/pull/1140) ([treydock](https://github.com/treydock))
 
@@ -196,6 +209,7 @@
 
 ### Added
 
+- Add sensu\_resources type that will handle resource purging [\#1158](https://github.com/sensu/sensu-puppet/pull/1158) ([treydock](https://github.com/treydock))
 - Add sensu\_gem package provider [\#1156](https://github.com/sensu/sensu-puppet/pull/1156) ([treydock](https://github.com/treydock))
 - Install Windows agent via chocolatey [\#1152](https://github.com/sensu/sensu-puppet/pull/1152) ([treydock](https://github.com/treydock))
 - Add sensu\_bonsai\_asset type [\#1149](https://github.com/sensu/sensu-puppet/pull/1149) ([treydock](https://github.com/treydock))
@@ -228,12 +242,6 @@
 
 - Support PostgreSQL datastore [\#1136](https://github.com/sensu/sensu-puppet/pull/1136) ([treydock](https://github.com/treydock))
 - Increase upper bound of module dependencies [\#1134](https://github.com/sensu/sensu-puppet/pull/1134) ([treydock](https://github.com/treydock))
-- Improved Validations [\#1132](https://github.com/sensu/sensu-puppet/pull/1132) ([treydock](https://github.com/treydock))
-- Support Debian 10 [\#1128](https://github.com/sensu/sensu-puppet/pull/1128) ([treydock](https://github.com/treydock))
-
-### Fixed
-
-- Do not resolve absent sensu\_events [\#1129](https://github.com/sensu/sensu-puppet/pull/1129) ([treydock](https://github.com/treydock))
 
 ## [v3.6.0](https://github.com/sensu/sensu-puppet/tree/v3.6.0) (2019-08-16)
 

Gemfile

@@ -5,6 +5,7 @@ if puppetversion = ENV['PUPPET_GEM_VERSION']
 else
   gem 'puppet', :require => false
 end
+gem 'facter', '< 4.0', :require => false
 
 group :development, :unit_tests do
   gem 'rake'

REFERENCE.md

@@ -1195,16 +1195,19 @@ Keys:
 * client_key_file: default is `""`
 * default_upn_domain: default is `""`
 * include_nested_groups: Boolean
+
 group_search keys:
 * base_dn: required
 * attribute: default is `member`
 * name_attribute: default is `cn`
 * object_class: default is `group`
+
 user_search Keys:
 * base_dn: required
 * attribute: default is `sAMAccountName`
 * name_attribute: default is `displayName`
 * object_class: default is `person`
+
 binding keys:
 * user_dn: required
 * password: required
@@ -2719,16 +2722,19 @@ Keys:
 * client_cert_file: default is `""`
 * client_key_file: default is `""`
 * default_upn_domain: default is `""`
+
 group_search keys:
 * base_dn: required
 * attribute: default is `member`
 * name_attribute: default is `cn`
 * object_class: default is `groupOfNames`
+
 user_search Keys:
 * base_dn: required
 * attribute: default is `uid`
 * name_attribute: default is `cn`
 * object_class: default is `person`
+
 binding keys:
 * user_dn: required
 * password: required

examples/ldap.pp

@@ -0,0 +1,63 @@
+# Read more at Sensu's documentation site.
+#
+# https://docs.sensu.io/sensu-go/latest/installation/auth/#ldap-authentication
+#
+# The documentation for the puppet types are available at the following links.
+#
+# http://sensu.github.io/sensu-puppet/puppet_types/sensu_ldap_auth.html
+# http://sensu.github.io/sensu-puppet/puppet_types/sensu_role_binding.html
+#
+# Access the backend in a web browser such as
+# https:://sensu-backend.example.com:3000 and you should be able to login with
+# LDAP credentials. If you can login, but see a 404 that means that
+# sensu_ldap_auth is likely working but the access for your user is not granted
+# and you should modify the sensu_role_binding.
+#
+class { 'sensu::backend':
+  # This will turn on debugging which will make it possible to see the LDAP
+  # related Sensu logs.
+  config_hash => {
+    'debug'     => true,
+    'log-level' => 'debug',
+  },
+}
+
+$ldap_server = 'ldap.example.com'
+$ldap_bind_password = 'password'
+
+sensu_ldap_auth { 'openldap':
+  ensure  => 'present',
+  servers => [
+    {
+      'host'         => $ldap_server,
+      'port'         => 389,
+      'security'     => 'starttls',
+      'binding'      => {
+        'user_dn'  => 'cn=sensu,ou=Services,dc=ops,dc=example,dc=com',
+        'password' => $ldap_bind_password,
+      },
+      'group_search' => {
+        'base_dn'      => 'dc=ops,dc=example,dc=com',
+        'object_class' => 'posixGroup',
+        'attribute'    => 'memberUid',
+      },
+      'user_search'  => {
+        'base_dn' => 'dc=ops,dc=example,dc=com',
+      },
+    },
+  ],
+}
+
+sensu_role_binding { 'ldap-ops':
+  ensure   => 'present',
+  role_ref => {
+    'type' => 'ClusterRole',
+    'name' => 'cluster-admin',
+  },
+  subjects => [
+    {
+      'type' => 'Group',
+      'name' => 'ops',
+    },
+  ],
+}

lib/puppet/type/sensu_ad_auth.rb

@@ -66,16 +66,19 @@
     * client_key_file: default is `""`
     * default_upn_domain: default is `""`
     * include_nested_groups: Boolean
+
     group_search keys:
     * base_dn: required
     * attribute: default is `member`
     * name_attribute: default is `cn`
     * object_class: default is `group`
+
     user_search Keys:
     * base_dn: required
     * attribute: default is `sAMAccountName`
     * name_attribute: default is `displayName`
     * object_class: default is `person`
+
     binding keys:
     * user_dn: required
     * password: required

lib/puppet/type/sensu_ldap_auth.rb

@@ -65,16 +65,19 @@
     * client_cert_file: default is `""`
     * client_key_file: default is `""`
     * default_upn_domain: default is `""`
+
     group_search keys:
     * base_dn: required
     * attribute: default is `member`
     * name_attribute: default is `cn`
     * object_class: default is `groupOfNames`
+
     user_search Keys:
     * base_dn: required
     * attribute: default is `uid`
     * name_attribute: default is `cn`
     * object_class: default is `person`
+
     binding keys:
     * user_dn: required
     * password: required

lib/puppet_x/sensu/hash_property.rb

@@ -5,6 +5,22 @@ class HashProperty < Puppet::Property
         fail "#{self.name.to_s} should be a Hash" unless value.is_a? ::Hash
       end
 
+      def insync?(is)
+        ignore_labels = [
+          'sensu.io/managed_by',
+        ]
+        # Ignore some labels that are auto generated by sensuctl
+        if self.name == :labels && is.is_a?(Hash)
+          new_is = {}
+          is.each_pair do |key, value|
+            next if ignore_labels.include?(key)
+            new_is[key] = value
+          end
+          is = new_is
+        end
+        super(is)
+      end
+
       def change_to_s(currentvalue, newvalue)
         currentvalue = currentvalue.to_s if currentvalue != :absent
         newvalue = newvalue.to_s

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "sensu-sensu",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "author": "sensu",
   "summary": "A module to install the Sensu monitoring framework",
   "license": "MIT",

spec/acceptance/00_backend_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper_acceptance'
 
 describe 'sensu::backend class', unless: RSpec.configuration.sensu_cluster do
-  node = hosts_as('sensu_backend')[0]
+  node = hosts_as('sensu-backend')[0]
   context 'default' do
     it 'should work without errors' do
       pp = <<-EOS
@@ -15,7 +15,7 @@ class { 'sensu::backend':
       EOS
 
       if RSpec.configuration.sensu_use_agent
-        site_pp = "node 'sensu_backend' { #{pp} }"
+        site_pp = "node 'sensu-backend' { #{pp} }"
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
         on node, puppet("agent -t --detailed-exitcodes"), acceptable_exit_codes: [0,2]
@@ -51,7 +51,7 @@ class { 'sensu::backend':
       # There should be no changes as default resources
       # Should not result in changes
       if RSpec.configuration.sensu_use_agent
-        site_pp = "node 'sensu_backend' { #{pp} }"
+        site_pp = "node 'sensu-backend' { #{pp} }"
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
         on node, puppet("agent -t --detailed-exitcodes"), acceptable_exit_codes: [0]
@@ -74,7 +74,7 @@ class { 'sensu::backend':
       EOS
 
       if RSpec.configuration.sensu_use_agent
-        site_pp = "node 'sensu_backend' { #{pp} }"
+        site_pp = "node 'sensu-backend' { #{pp} }"
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
         on node, puppet("agent -t --detailed-exitcodes"), acceptable_exit_codes: [0,2]
@@ -104,12 +104,12 @@ class { '::sensu':
       }
       class { 'sensu::backend': }
       class { 'sensu::agent':
-        backends => ['sensu_backend:8081'],
+        backends => ['sensu-backend:8081'],
       }
       EOS
 
       if RSpec.configuration.sensu_use_agent
-        site_pp = "node 'sensu_backend' { #{pp} }"
+        site_pp = "node 'sensu-backend' { #{pp} }"
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
         on node, puppet("agent -t --detailed-exitcodes"), acceptable_exit_codes: [0,2]
@@ -144,7 +144,7 @@ class { 'sensu::backend':
       EOS
 
       if RSpec.configuration.sensu_use_agent
-        site_pp = "node 'sensu_backend' { #{pp} }"
+        site_pp = "node 'sensu-backend' { #{pp} }"
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
         on node, puppet("agent -t --detailed-exitcodes"), acceptable_exit_codes: [0,2]
@@ -170,7 +170,7 @@ class { 'sensu::backend':
       EOS
 
       if RSpec.configuration.sensu_use_agent
-        site_pp = "node 'sensu_backend' { #{pp} }"
+        site_pp = "node 'sensu-backend' { #{pp} }"
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
         on node, puppet("agent -t --detailed-exitcodes"), acceptable_exit_codes: [0,2]

spec/acceptance/01_agent_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper_acceptance'
 
 describe 'sensu::agent class', unless: RSpec.configuration.sensu_cluster do
-  node = hosts_as('sensu_agent')[0]
+  node = hosts_as('sensu-agent')[0]
   context 'default' do
     it 'should work without errors' do
       pp = <<-EOS
       class { '::sensu': }
       class { 'sensu::agent':
-        backends         => ['sensu_backend:8081'],
-        entity_name      => 'sensu_agent',
+        backends         => ['sensu-backend:8081'],
+        entity_name      => 'sensu-agent',
         subscriptions    => ['base'],
         service_env_vars => { 'SENSU_API_PORT' => '4041' },
         config_hash      => {
@@ -19,7 +19,7 @@ class { 'sensu::agent':
       EOS
 
       if RSpec.configuration.sensu_use_agent
-        site_pp = "node 'sensu_agent' { #{pp} }"
+        site_pp = "node 'sensu-agent' { #{pp} }"
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
         on node, puppet("agent -t --detailed-exitcodes"), acceptable_exit_codes: [0,2]
@@ -33,9 +33,9 @@ class { 'sensu::agent':
 
     describe file('/etc/sensu/agent.yml'), :node => node do
       expected_content = {
-        'backend-url'     => ['wss://sensu_backend:8081'],
+        'backend-url'     => ['wss://sensu-backend:8081'],
         'password'        => 'P@ssw0rd!',
-        'name'            => 'sensu_agent',
+        'name'            => 'sensu-agent',
         'subscriptions'   => ['base','linux'],
         'log-level'       => 'info',
         'trusted-ca-file' => '/etc/sensu/ssl/ca.crt',

spec/acceptance/02_backend_cluster_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper_acceptance'
 
 describe 'sensu::backend cluster class', if: RSpec.configuration.sensu_cluster do
-  node1 = hosts_with_name(hosts, 'sensu_backend1')[0]
-  node2 = hosts_with_name(hosts, 'sensu_backend2')[0]
-  node3 = hosts_with_name(hosts, 'sensu_backend3')[0]
+  node1 = hosts_with_name(hosts, 'sensu-backend1')[0]
+  node2 = hosts_with_name(hosts, 'sensu-backend2')[0]
+  node3 = hosts_with_name(hosts, 'sensu-backend3')[0]
   context 'new cluster' do
     it 'should work without errors' do
       node1_pp = <<-EOS
@@ -37,8 +37,8 @@ class { 'sensu::backend':
 
       if RSpec.configuration.sensu_use_agent
         site_pp = <<-EOS
-        node 'sensu_backend1' { #{node1_pp} }
-        node 'sensu_backend2' { #{node2_pp} }
+        node 'sensu-backend1' { #{node1_pp} }
+        node 'sensu-backend2' { #{node2_pp} }
         EOS
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
@@ -109,8 +109,8 @@ class { '::sensu::backend':
 
       if RSpec.configuration.sensu_use_agent
         site_pp = <<-EOS
-        node 'sensu_backend1' { #{pp} }
-        node 'sensu_backend3' { #{node3_pp} }
+        node 'sensu-backend1' { #{pp} }
+        node 'sensu-backend3' { #{node3_pp} }
         EOS
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
@@ -186,8 +186,8 @@ class { '::sensu::backend':
 
       if RSpec.configuration.sensu_use_agent
         site_pp = <<-EOS
-        node 'sensu_backend1' { #{node1_pp} }
-        node 'sensu_backend2' { #{node2_pp} }
+        node 'sensu-backend1' { #{node1_pp} }
+        node 'sensu-backend2' { #{node2_pp} }
         EOS
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)
@@ -259,8 +259,8 @@ class { 'sensu::backend':
 
       if RSpec.configuration.sensu_use_agent
         site_pp = <<-EOS
-        node 'sensu_backend1' { #{pp} }
-        node 'sensu_backend3' { #{node3_pp} }
+        node 'sensu-backend1' { #{pp} }
+        node 'sensu-backend3' { #{node3_pp} }
         EOS
         puppetserver = hosts_as('puppetserver')[0]
         create_remote_file(puppetserver, "/etc/puppetlabs/code/environments/production/manifests/site.pp", site_pp)