Merge pull request echocat#99 from echocat/develop

merge for release 2.0.0

Author: dwerder

CHANGELOG.md

@@ -1,3 +1,19 @@
+## 2016-11-15 - 2.0.0 (Feature/Bugfix release)
+
+#### Bugfixes:
+
+- Fix broken systemd part for Debian
+- Fix cluster coverage error in redis.conf template
+- Add required update-rc.d headers to debian init.d scripts
+
+#### Features:
+
+- redis and sentinel: allow turning off protected mode
+- Added  option to redis.conf: client-output-buffer-limit, as a hash
+- Added  option to redis.conf: repl_backlog_size, a simple value
+- allows for compatibility with Amazon Linux
+- Add cluster params documentation + enable cluster support
+
 ## 2016-06-24 - 1.9.0 (Feature/Bugfix release)
 
 #### Bugfixes:

Gemfile

@@ -10,15 +10,32 @@ def location_for(place, version = nil)
   end
 end
 
-gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION'] || '~> 4')
-gem 'facter', *location_for(ENV['FACTER_GEM_VERSION'] || '~> 2')
 gem 'puppetlabs_spec_helper', '>= 0.1.0', :require => false
 gem 'puppet-lint', '>= 0.3.2',            :require => false
 gem 'rspec-puppet', '>= 2.3.2',           :require => false
 gem 'rspec-puppet-facts',                 :require => false
 gem 'metadata-json-lint',                 :require => false
-gem 'rake', '< 11.0.0' # rubi <1.9 versus rake 11.0.0 workaround
+# rubi <1.9 versus rake 11.0.0 workaround
+gem 'rake', '< 11.0.0',                   :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+gem 'json', '< 2.0.0',                    :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+gem 'json_pure', '<= 2.0.1',              :require => false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
 
+gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION'])
+
+# Only explicitly specify Facter/Hiera if a version has been specified.
+# Otherwise it can lead to strange bundler behavior. If you are seeing weird
+# gem resolution behavior, try setting `DEBUG_RESOLVER` environment variable
+# to `1` and then run bundle install.
+gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) if ENV['FACTER_GEM_VERSION']
+gem 'hiera', *location_for(ENV['HIERA_GEM_VERSION']) if ENV['HIERA_GEM_VERSION']
+
+
+# Evaluate Gemfile.local if it exists
 if File.exists? "#{__FILE__}.local"
   eval(File.read("#{__FILE__}.local"), binding)
 end
+
+# Evaluate ~/.gemfile if it exists
+if File.exists?(File.join(Dir.home, '.gemfile'))
+  eval(File.read(File.join(Dir.home, '.gemfile')), binding)
+end

README.md

@@ -54,7 +54,7 @@ Most of the time you will only need `redis_version`.
   }
 ```
 To install redis from package use the following parameters.
-You will need `redis_version` and `redis_package`. 
+You will need `redis_version` and `redis_package`.
 ```puppet
   class { 'redis::install':
     redis_version  => '2.8.18-1.el6.remi',
@@ -112,12 +112,16 @@ node 'redis-master.my.domain' {
 
   redis::server {
     'master':
-      redis_memory    => '1g',
-      redis_ip        => '0.0.0.0',
-      redis_port      => 6379,
-      running         => true,
-      enabled         => true,
-      requirepass     => 'some_really_long_random_password',
+      redis_memory               => '1g',
+      redis_ip                   => '0.0.0.0',
+      redis_port                 => 6379,
+      running                    => true,
+      enabled                    => true,
+      requirepass                => 'some_really_long_random_password',
+      client_output_buffer_limit => {
+        'normal' => '0 0 0',
+        'slave'  => '500000000 300000000 60',
+      },
   }
 }
 
@@ -145,7 +149,7 @@ node 'redis-slave.my.domain' {
 Please note that right now you can only create cluster-enabled instances
 but you cannot configure a Redis Cluster only with this module. You should
 still use `redis-trib.rb` from Redis source distribution or configure it
-by hand with redis cluster commands. Moreover, the cluster mode will be enabled 
+by hand with redis cluster commands. Moreover, the cluster mode will be enabled
 only for Redis >= 3.0
 
 A simple example of a cluster-enabled instance, with a timeout of 5 seconds to
@@ -253,7 +257,7 @@ The dir to which the newly built redis binaries are copied.
 Redis system user. Default: undef (string)
 Default 'undef' results to 'root' as redis system user
 
-Some redis install packages create the redis system user by default (at 
+Some redis install packages create the redis system user by default (at
 least SLES and Ubuntu provide redis install packages).
 Normally the log directory and the pid directory are created also by
 the redis install package. Therefor, these values must be adjusted too.
@@ -266,7 +270,7 @@ Default 'undef' results to 'root' as redis system group
 
 #####`download_base`
 
-Url where to find the source tar.gz. 
+Url where to find the source tar.gz.
 Default value is 'http://download.redis.io/releases'
 
 ####Defined Type: `redis::server`
@@ -398,11 +402,17 @@ Configure Redis save snapshotting. Example: [[900, 1], [300, 10]]. Default: []
 
 Boolean. Default: `false`
 
-Configure if the redis config is overwritten by puppet followed by a restart. 
+Configure if the redis config is overwritten by puppet followed by a restart.
 Since redis automatically rewrite their config since
 version 2.8 setting this to `true` will trigger a redis restart on each puppet
 run with redis 2.8 or later.
 
+#####`client_output_buffer_limit`
+
+Hash containing 3 possible classes as keys (normal, slave, pubsub) and with the
+values set to the hard limit, soft limit and seconds.
+Default: empty
+
 #####`manage_logrotate`
 
 Configure logrotate rules for redis server. Default: true
@@ -429,6 +439,10 @@ Configure Redis slave to be in read-only mode. Default: true (boolean)
 
 Configure Redis slave replication timeout in seconds. Default: 60 (number)
 
+#####`repl_backlog_size`
+
+Configure Redis slave backlog size in bytes. Default: undef
+
 #####`repl_ping_slave_period`
 
 Configure Redis replication ping slave period in seconds. Default: 10 (number)

Rakefile

@@ -13,9 +13,7 @@ PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp", "vendor/
 
 desc "Validate manifests, templates, and ruby files in lib."
 task :validate do
-  Dir['manifests/**/*.pp'].each do |manifest|
-    sh "puppet parser validate --noop #{manifest}"
-  end
+  sh "puppet parser validate --noop #{Dir['manifests/**/*.pp'].join(" ")}"
   Dir['lib/**/*.rb'].each do |lib_file|
     sh "ruby -c #{lib_file}"
   end

manifests/sentinel.pp

@@ -15,6 +15,11 @@
 #   Path for pid file. Full pid path is <sentinel_pid_dir>/redis-sentinel_<redis_name>.pid. Default: /var/run
 # [*monitors*]
 #   Default is
+#
+# [*protected_mode*]
+#   If no password and/or no bind address is set, sentinel defaults to being reachable only
+#   on the loopback interface. Turn this behaviour off by setting protected mode to 'no'.
+#
 # {
 #   'mymaster' => {
 #     master_host             => '127.0.0.1',
@@ -50,6 +55,7 @@
   $sentinel_log_dir = '/var/log',
   $sentinel_pid_dir = '/var/run',
   $sentinel_run_dir = '/var/run/redis',
+  $protected_mode   = undef,
   $monitors         = {
     'mymaster' => {
       master_host             => '127.0.0.1',
@@ -80,6 +86,10 @@
   validate_bool($enabled)
   validate_bool($manage_logrotate)
 
+  if $protected_mode {
+    validate_re($protected_mode,['^no$', '^yes$'])
+  }
+
   $redis_install_dir = $::redis::install::redis_install_dir
   $sentinel_init_script = $::operatingsystem ? {
     /(Debian|Ubuntu)/                                          => 'redis/etc/init.d/debian_redis-sentinel.erb',
@@ -98,7 +108,7 @@
   }
 
   # startup script
-  if ($::osfamily == 'RedHat' and versioncmp($::operatingsystemmajrelease, '7') >=0) {
+  if ($::osfamily == 'RedHat' and versioncmp($::operatingsystemmajrelease, '7') >=0 and $::operatingsystem != 'Amazon') {
     $service_file = "/usr/lib/systemd/system/redis-sentinel_${sentinel_name}.service"
     exec { "systemd_service_${sentinel_name}_preset":
       command     => "/bin/systemctl preset redis-sentinel_${sentinel_name}.service",

manifests/server.pp

@@ -69,13 +69,19 @@
 #   Configure Redis slave replication timeout
 # [*repl_ping_slave_period*]
 #   Configure Redis replication ping slave period
+# [*repl_backlog_size*]
+#   Replication backlog size (in bytes or multiples). Default: undef
 # [*save*]
 #   Configure Redis save snapshotting. Example: [[900, 1], [300, 10]]. Default: []
 # [*hash_max_ziplist_entries*]
 #   Threshold for ziplist entries. Default: 512
 # [*hash_max_ziplist_value*]
 #   Threshold for ziplist value. Default: 64
 #
+# [*protected_mode*]
+#   If no password and/or no bind address is set, redis defaults to being reachable only
+#   on the loopback interface. Turn this behaviour off by setting protected mode to 'no'.
+#
 # [*redis_run_dir*]
 #
 #   Default: `/var/run/redis`
@@ -84,6 +90,11 @@
 #   the config files created by puppet will be copied to this directory and redis will be started from
 #   this copy.
 #
+# [*client_output_buffer_limit*]
+#   Hash containing 3 possible classes as keys (normal, slave, pubsub) and
+#   with the values set to the hard limit, soft limit and seconds.
+#   Default: empty
+#
 # [*manage_logrotate*]
 #   Configure logrotate rules for redis server. Default: true
 #
@@ -106,50 +117,53 @@
 #   is at least an hash slot uncovered.
 
 define redis::server (
-  $redis_name              = $name,
-  $redis_memory            = '100mb',
-  $redis_ip                = '127.0.0.1',
-  $redis_port              = 6379,
-  $redis_usesocket         = false,
-  $redis_socket            = '/tmp/redis.sock',
-  $redis_socketperm        = 755,
-  $redis_mempolicy         = 'allkeys-lru',
-  $redis_memsamples        = 3,
-  $redis_timeout           = 0,
-  $redis_nr_dbs            = 1,
-  $redis_dbfilename        = 'dump.rdb',
-  $redis_dir               = '/var/lib',
-  $redis_log_dir           = '/var/log',
-  $redis_pid_dir           = '/var/run',
-  $redis_run_dir           = '/var/run/redis',
-  $redis_loglevel          = 'notice',
-  $redis_appedfsync        = 'everysec',
-  $running                 = true,
-  $enabled                 = true,
-  $requirepass             = undef,
-  $maxclients              = undef,
-  $appendfsync_on_rewrite  = false,
-  $aof_rewrite_percentage  = 100,
-  $aof_rewrite_minsize     = 64,
-  $redis_appendfsync       = 'everysec',
-  $redis_enabled_append_file = false,
-  $redis_append_file       = undef,
-  $redis_append_enable     = false,
-  $slaveof                 = undef,
-  $masterauth              = undef,
-  $slave_serve_stale_data  = true,
-  $slave_read_only         = true,
-  $repl_timeout            = 60,
-  $repl_ping_slave_period  = 10,
-  $save                    = [],
-  $hash_max_ziplist_entries = 512,
-  $hash_max_ziplist_value  = 64,
-  $manage_logrotate        = true,
-  $cluster_enabled         = false,
+  $redis_name                    = $name,
+  $redis_memory                  = '100mb',
+  $redis_ip                      = '127.0.0.1',
+  $redis_port                    = 6379,
+  $redis_usesocket               = false,
+  $redis_socket                  = '/tmp/redis.sock',
+  $redis_socketperm              = 755,
+  $redis_mempolicy               = 'allkeys-lru',
+  $redis_memsamples              = 3,
+  $redis_timeout                 = 0,
+  $redis_nr_dbs                  = 1,
+  $redis_dbfilename              = 'dump.rdb',
+  $redis_dir                     = '/var/lib',
+  $redis_log_dir                 = '/var/log',
+  $redis_pid_dir                 = '/var/run',
+  $redis_run_dir                 = '/var/run/redis',
+  $redis_loglevel                = 'notice',
+  $redis_appedfsync              = 'everysec',
+  $running                       = true,
+  $enabled                       = true,
+  $requirepass                   = undef,
+  $maxclients                    = undef,
+  $appendfsync_on_rewrite        = false,
+  $aof_rewrite_percentage        = 100,
+  $aof_rewrite_minsize           = 64,
+  $redis_appendfsync             = 'everysec',
+  $redis_enabled_append_file     = false,
+  $redis_append_file             = undef,
+  $redis_append_enable           = false,
+  $slaveof                       = undef,
+  $masterauth                    = undef,
+  $slave_serve_stale_data        = true,
+  $slave_read_only               = true,
+  $repl_timeout                  = 60,
+  $repl_ping_slave_period        = 10,
+  $repl_backlog_size             = undef,
+  $save                          = [],
+  $hash_max_ziplist_entries      = 512,
+  $hash_max_ziplist_value        = 64,
+  $client_output_buffer_limit    = {},
+  $manage_logrotate              = true,
+  $cluster_enabled               = false,
   $cluster_node_timeout          = undef,
   $cluster_slave_validity_factor = undef,
   $cluster_migration_barrier     = undef,
   $cluster_require_full_coverage = true,
+  $protected_mode                = undef,
 ) {
   $redis_user              = $::redis::install::redis_user
   $redis_group             = $::redis::install::redis_group
@@ -175,8 +189,21 @@
   }
 
   # startup script
-  if ($::osfamily == 'RedHat' and versioncmp($::operatingsystemmajrelease, '7') >=0) {
-    $service_file = "/usr/lib/systemd/system/redis-server_${redis_name}.service"
+  case $::osfamily {
+    'RedHat': {
+      $service_file = "/usr/lib/systemd/system/redis-server_${redis_name}.service"
+      if $::operatingsystemmajrelease >= 7 { $has_systemd = true }
+    }
+    'Debian': {
+      $service_file = "/etc/systemd/system/redis-server_${redis_name}.service"
+      if $::operatingsystemmajrelease >= 8 { $has_systemd = true }
+    }
+    default:  {
+      $has_systemd = false
+    }
+  }
+
+  if $has_systemd {
     exec { "systemd_service_${redis_name}_preset":
       command     => "/bin/systemctl preset redis-server_${redis_name}.service",
       notify      => Service["redis-server_${redis_name}"],

metadata.json

@@ -30,7 +30,7 @@
     }
   ],
   "name": "dwerder-redis",
-  "version": "1.9.0",
+  "version": "2.0.0",
   "source": "https://github.com/echocat/puppet-redis.git",
   "author": "Daniel Werdermann",
   "license": "MPL-2.0",

templates/etc/init.d/debian_redis-sentinel.erb

@@ -1,12 +1,16 @@
 #!/bin/sh
 #
-# redis - this script starts and stops the redis-server daemon
-#
-# chkconfig:   - 85 15
-# description:  Redis Sentinel is a monitor for redis servers
-# processname: redis-sentinel
-# config:      /etc/redis-sentinel_<%= @sentinel_name %>.conf
-# pidfile:     <%= @sentinel_pid_dir %>/redis-sentinel_<%= @sentinel_name %>.pid
+### BEGIN INIT INFO
+# Provides:             redis-sentinel_<%= @sentinel_name %>
+# Required-Start:       $syslog $remote_fs
+# Required-Stop:        $syslog $remote_fs
+# Should-Start:         $local_fs
+# Should-Stop:          $local_fs
+# Default-Start:        2 3 4 5 
+# Default-Stop:         0 1 6 
+# Short-Description:    Redis Sentinel is a monitor for redis servers 
+# Description:          Redis Sentinel is a monitor for redis servers
+### END INIT INFO
 
 # Source function library.
 . /lib/lsb/init-functions
@@ -24,7 +28,7 @@ start() {
     local retval
 
     [ -f "$REDIS_CONF_FILE" ] || exit 6
-    [ -d <%= @sentinel_run_dir %> ] mkdir -p <%= @sentinel_run_dir %>
+    [ -d <%= @sentinel_run_dir %> ] || mkdir -p <%= @sentinel_run_dir %>
     cp -u $REDIS_CONF_FILE $RUNTIME_CONF_FILE
 
     log_daemon_msg "Starting $REDIS_NAME"
@@ -92,7 +96,7 @@ case "$1" in
         restart
         ;;
     reload)
-        rh_status_q || exit 7
+        status_q || exit 7
         reload
         ;;
     status)