Puppet Class: redis

Inherits:
redis::params
Defined in:
manifests/init.pp

Overview

This class installs redis

Examples:

Default install

include redis

Slave Node

class { '::redis':
  bind    => '10.0.1.2',
  slaveof => '10.0.1.1 6379',
}

Parameters:

  • activerehashing (String) (defaults to: $::redis::params::activerehashing) —

    Enable/disable active rehashing.

  • aof_load_truncated (String) (defaults to: $::redis::params::aof_load_truncated) —

    Enable/disable loading truncated AOF file

  • aof_rewrite_incremental_fsync (String) (defaults to: $::redis::params::aof_rewrite_incremental_fsync) —

    Enable/disable fsync for AOF file

  • appendfilename (String) (defaults to: $::redis::params::appendfilename) —

    The name of the append only file

  • appendfsync (String) (defaults to: $::redis::params::appendfsync) —

    Adjust fsync mode. Valid options: always, everysec, no. Default: everysec

  • appendonly (String) (defaults to: $::redis::params::appendonly) —

    Enable/disable appendonly mode.

  • auto_aof_rewrite_min_size (String) (defaults to: $::redis::params::auto_aof_rewrite_min_size) —

    Adjust minimum size for auto-aof-rewrite.

  • auto_aof_rewrite_percentage (String) (defaults to: $::redis::params::auto_aof_rewrite_percentage) —

    Adjust percentatge for auto-aof-rewrite.

  • bind (String) (defaults to: $::redis::params::bind) —

    Configure which IP address to listen on.

  • config_dir (String) (defaults to: $::redis::params::config_dir) —

    Directory containing the configuration files.

  • config_dir_mode (String) (defaults to: $::redis::params::config_dir_mode) —

    Adjust mode for directory containing configuration files.

  • config_file_orig (String) (defaults to: $::redis::params::config_file_orig) —

    The location and name of a config file that provides the source

  • config_file (String) (defaults to: $::redis::params::config_file) —

    Adjust main configuration file.

  • config_file_mode (String) (defaults to: $::redis::params::config_file_mode) —

    Adjust permissions for configuration files.

  • config_group (String) (defaults to: $::redis::params::config_group) —

    Adjust filesystem group for config files.

  • config_owner (String) (defaults to: $::redis::params::config_owner) —

    Adjust filesystem owner for config files.

  • conf_template (String) (defaults to: $::redis::params::conf_template) —

    Define which template to use.

  • daemonize (String) (defaults to: $::redis::params::daemonize) —

    Have Redis run as a daemon.

  • default_install (String) (defaults to: $::redis::params::default_install) —

    Configure a default install of redis

  • databases (String) (defaults to: $::redis::params::databases) —

    Set the number of databases.

  • dbfilename (String) (defaults to: $::redis::params::dbfilename) —

    The filename where to dump the DB

  • extra_config_file (String) (defaults to: $::redis::params::extra_config_file) —

    Description

  • hash_max_ziplist_entries (String) (defaults to: $::redis::params::hash_max_ziplist_entries) —

    Set max ziplist entries for hashes.

  • hash_max_ziplist_value (String) (defaults to: $::redis::params::hash_max_ziplist_value) —

    Set max ziplist values for hashes.

  • hll_sparse_max_bytes (String) (defaults to: $::redis::params::hll_sparse_max_bytes) —

    HyperLogLog sparse representation bytes limit

  • hz (String) (defaults to: $::redis::params::hz) —

    Set redis background tasks frequency

  • latency_monitor_threshold (String) (defaults to: $::redis::params::latency_monitor_threshold) —

    Latency monitoring threshold in milliseconds

  • list_max_ziplist_entries (String) (defaults to: $::redis::params::list_max_ziplist_entries) —

    Set max ziplist entries for lists.

  • list_max_ziplist_value (String) (defaults to: $::redis::params::list_max_ziplist_value) —

    Set max ziplist values for lists.

  • log_dir (String) (defaults to: $::redis::params::log_dir) —

    Specify directory where to write log entries.

  • log_dir_mode (String) (defaults to: $::redis::params::log_dir_mode) —

    Adjust mode for directory containing log files.

  • log_file (String) (defaults to: $::redis::params::log_file) —

    Specify file where to write log entries.

  • log_level (String) (defaults to: $::redis::params::log_level) —

    Specify the server verbosity level.

  • manage_repo (String) (defaults to: $::redis::params::manage_repo) —

    Enable/disable upstream repository configuration.

  • manage_package (String) (defaults to: $::redis::params::manage_package) —

    Enable/disable management of package

  • managed_by_cluster_manager (String) (defaults to: $::redis::params::managed_by_cluster_manager) —

    Choose if redis will be managed by a cluster manager such as pacemaker or rgmanager

  • masterauth (String) (defaults to: $::redis::params::masterauth) —

    If the master is password protected (using the “requirepass” configuration

  • maxclients (String) (defaults to: $::redis::params::maxclients) —

    Set the max number of connected clients at the same time.

  • maxmemory (String) (defaults to: $::redis::params::maxmemory) —

    Don’t use more memory than the specified amount of bytes.

  • maxmemory_policy (String) (defaults to: $::redis::params::maxmemory_policy) —

    How Redis will select what to remove when maxmemory is reached.

  • maxmemory_samples (String) (defaults to: $::redis::params::maxmemory_samples) —

    Select as well the sample size to check.

  • min_slaves_max_lag (String) (defaults to: $::redis::params::min_slaves_max_lag) —

    The lag in seconds

  • min_slaves_to_write (String) (defaults to: $::redis::params::min_slaves_to_write) —

    Minimum number of slaves to be in “online” state

  • no_appendfsync_on_rewrite (String) (defaults to: $::redis::params::no_appendfsync_on_rewrite) —

    If you have latency problems turn this to ‘true’. Otherwise leave it as

  • notify_keyspace_events (String) (defaults to: $::redis::params::notify_keyspace_events) —

    Which events to notify Pub/Sub clients about events happening

  • notify_service (String) (defaults to: $::redis::params::notify_service) —

    You may disable service reloads when config files change if you

  • package_ensure (String) (defaults to: $::redis::params::package_ensure) —

    Default action for package.

  • package_name (String) (defaults to: $::redis::params::package_name) —

    Upstream package name.

  • pid_file (String) (defaults to: $::redis::params::pid_file) —

    Where to store the pid.

  • port (String) (defaults to: $::redis::params::port) —

    Configure which port to listen on.

  • ppa_repo (String) (defaults to: $::redis::params::ppa_repo) —

    Specify upstream (Ubuntu) PPA entry.

  • rdbcompression (String) (defaults to: $::redis::params::rdbcompression) —

    Enable/disable compression of string objects using LZF when dumping.

  • repl_backlog_size (String) (defaults to: $::redis::params::repl_backlog_size) —

    The replication backlog size

  • repl_backlog_ttl (String) (defaults to: $::redis::params::repl_backlog_ttl) —

    The number of seconds to elapse before freeing backlog buffer

  • repl_disable_tcp_nodelay (String) (defaults to: $::redis::params::repl_disable_tcp_nodelay) —

    Enable/disable TCP_NODELAY on the slave socket after SYNC

  • repl_ping_slave_period (String) (defaults to: $::redis::params::repl_ping_slave_period) —

    Slaves send PINGs to server in a predefined interval. It’s possible

  • repl_timeout (String) (defaults to: $::redis::params::repl_timeout) —

    Set the replication timeout for:

  • requirepass (String) (defaults to: $::redis::params::requirepass) —

    Require clients to issue AUTH <PASSWORD> before processing any other commands.

  • save_db_to_disk (String) (defaults to: $::redis::params::save_db_to_disk) —

    Set if save db to disk.

  • save_db_to_disk_interval (String) (defaults to: $::redis::params::save_db_to_disk_interval) —

    save the dataset every N seconds if there are at least M changes in the dataset

  • service_manage (String) (defaults to: $::redis::params::service_manage) —

    Specify if the service should be part of the catalog.

  • service_enable (String) (defaults to: $::redis::params::service_enable) —

    Enable/disable daemon at boot.

  • service_ensure (String) (defaults to: $::redis::params::service_ensure) —

    Specify if the server should be running.

  • service_group (String) (defaults to: $::redis::params::service_group) —

    Specify which group to run as.

  • service_hasrestart (String) (defaults to: $::redis::params::service_hasrestart) —

    Does the init script support restart?

  • service_hasstatus (String) (defaults to: $::redis::params::service_hasstatus) —

    Does the init script support status?

  • service_name (String) (defaults to: $::redis::params::service_name) —

    Specify the service name for Init or Systemd.

  • service_provider (String) (defaults to: $::redis::params::service_provider) —

    Specify the service provider to use

  • service_user (String) (defaults to: $::redis::params::service_user) —

    Specify which user to run as.

  • set_max_intset_entries (String) (defaults to: $::redis::params::set_max_intset_entries) —

    The following configuration setting sets the limit in the size of the set in order to use this special memory saving encoding. Default: 512

  • slave_priority (String) (defaults to: $::redis::params::slave_priority) —

    The priority number for slave promotion by Sentinel

  • slave_read_only (String) (defaults to: $::redis::params::slave_read_only) —

    You can configure a slave instance to accept writes or not.

  • slave_serve_stale_data (String) (defaults to: $::redis::params::slave_serve_stale_data) —

    When a slave loses its connection with the master, or when the replication is still in progress, the slave can act in two different ways: 1) if slave-serve-stale-data is set to ‘yes’ (the default) the slave will

    still reply to client requests, possibly with out of date data, or the
data set may just be empty if this is the first synchronization.

    2) if slave-serve-stale-data is set to ‘no’ the slave will reply with

    an error "SYNC with master in progress" to all the kind of commands
but to INFO and SLAVEOF.

    Default: true

  • slaveof (String) (defaults to: $::redis::params::slaveof) —

    Use slaveof to make a Redis instance a copy of another Redis server.

  • slowlog_log_slower_than (String) (defaults to: $::redis::params::slowlog_log_slower_than) —

    Tells Redis what is the execution time, in microseconds, to exceed in order for the command to get logged. Default: 10000

  • slowlog_max_len (String) (defaults to: $::redis::params::slowlog_max_len) —

    Tells Redis what is the length to exceed in order for the command to get logged. Default: 1024

  • stop_writes_on_bgsave_error (String) (defaults to: $::redis::params::stop_writes_on_bgsave_error) —

    If false then Redis will continue to work as usual even if there are problems with disk, permissions, and so forth. Default: true

  • syslog_enabled (String) (defaults to: $::redis::params::syslog_enabled) —

    Enable/disable logging to the system logger.

  • syslog_facility (String) (defaults to: $::redis::params::syslog_facility) —

    Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. Default: undef

  • tcp_backlog (String) (defaults to: $::redis::params::tcp_backlog) —

    Sets the TCP backlog

  • tcp_keepalive (String) (defaults to: $::redis::params::tcp_keepalive) —

    TCP keepalive.

  • timeout (String) (defaults to: $::redis::params::timeout) —

    Close the connection after a client is idle for N seconds (0 to disable).

  • ulimit (String) (defaults to: $::redis::params::ulimit) —

    Limit the use of system-wide resources.

  • unixsocket (String) (defaults to: $::redis::params::unixsocket) —

    Define unix socket path

  • unixsocketperm (String) (defaults to: $::redis::params::unixsocketperm) —

    Define unix socket file permissions

  • workdir (String) (defaults to: $::redis::params::workdir) —

    The DB will be written inside this directory, with the filename specified above using the ‘dbfilename’ configuration directive. Default: /var/lib/redis/

  • workdir_mode (String) (defaults to: $::redis::params::workdir_mode) —

    Adjust mode for data directory.

  • zset_max_ziplist_entries (String) (defaults to: $::redis::params::zset_max_ziplist_entries) —

    Set max entries for sorted sets.

  • zset_max_ziplist_value (String) (defaults to: $::redis::params::zset_max_ziplist_value) —

    Set max values for sorted sets.

  • cluster_enabled (String) (defaults to: $::redis::params::cluster_enabled) —

    Enables redis 3.0 cluster functionality

  • cluster_config_file (String) (defaults to: $::redis::params::cluster_config_file) —

    Config file for saving cluster nodes configuration. This file is never touched by humans. Only set if cluster_enabled is true Default: nodes.conf

  • cluster_node_timeout (String) (defaults to: $::redis::params::cluster_node_timeout) —

    Node timeout Only set if cluster_enabled is true Default: 5000



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'manifests/init.pp', line 136

class redis (
  $activerehashing               = $::redis::params::activerehashing,
  $aof_load_truncated            = $::redis::params::aof_load_truncated,
  $aof_rewrite_incremental_fsync = $::redis::params::aof_rewrite_incremental_fsync,
  $appendfilename                = $::redis::params::appendfilename,
  $appendfsync                   = $::redis::params::appendfsync,
  $appendonly                    = $::redis::params::appendonly,
  $auto_aof_rewrite_min_size     = $::redis::params::auto_aof_rewrite_min_size,
  $auto_aof_rewrite_percentage   = $::redis::params::auto_aof_rewrite_percentage,
  $bind                          = $::redis::params::bind,
  $conf_template                 = $::redis::params::conf_template,
  $config_dir                    = $::redis::params::config_dir,
  $config_dir_mode               = $::redis::params::config_dir_mode,
  $config_file                   = $::redis::params::config_file,
  $config_file_mode              = $::redis::params::config_file_mode,
  $config_file_orig              = $::redis::params::config_file_orig,
  $config_group                  = $::redis::params::config_group,
  $config_owner                  = $::redis::params::config_owner,
  $daemonize                     = $::redis::params::daemonize,
  $databases                     = $::redis::params::databases,
  $default_install               = $::redis::params::default_install,
  $dbfilename                    = $::redis::params::dbfilename,
  $extra_config_file             = $::redis::params::extra_config_file,
  $hash_max_ziplist_entries      = $::redis::params::hash_max_ziplist_entries,
  $hash_max_ziplist_value        = $::redis::params::hash_max_ziplist_value,
  $hll_sparse_max_bytes          = $::redis::params::hll_sparse_max_bytes,
  $hz                            = $::redis::params::hz,
  $latency_monitor_threshold     = $::redis::params::latency_monitor_threshold,
  $list_max_ziplist_entries      = $::redis::params::list_max_ziplist_entries,
  $list_max_ziplist_value        = $::redis::params::list_max_ziplist_value,
  $log_dir                       = $::redis::params::log_dir,
  $log_dir_mode                  = $::redis::params::log_dir_mode,
  $log_file                      = $::redis::params::log_file,
  $log_level                     = $::redis::params::log_level,
  $manage_package                = $::redis::params::manage_package,
  $manage_repo                   = $::redis::params::manage_repo,
  $masterauth                    = $::redis::params::masterauth,
  $maxclients                    = $::redis::params::maxclients,
  $maxmemory                     = $::redis::params::maxmemory,
  $maxmemory_policy              = $::redis::params::maxmemory_policy,
  $maxmemory_samples             = $::redis::params::maxmemory_samples,
  $min_slaves_max_lag            = $::redis::params::min_slaves_max_lag,
  $min_slaves_to_write           = $::redis::params::min_slaves_to_write,
  $no_appendfsync_on_rewrite     = $::redis::params::no_appendfsync_on_rewrite,
  $notify_keyspace_events        = $::redis::params::notify_keyspace_events,
  $notify_service                = $::redis::params::notify_service,
  $managed_by_cluster_manager    = $::redis::params::managed_by_cluster_manager,
  $package_ensure                = $::redis::params::package_ensure,
  $package_name                  = $::redis::params::package_name,
  $pid_file                      = $::redis::params::pid_file,
  $port                          = $::redis::params::port,
  $ppa_repo                      = $::redis::params::ppa_repo,
  $rdbcompression                = $::redis::params::rdbcompression,
  $repl_backlog_size             = $::redis::params::repl_backlog_size,
  $repl_backlog_ttl              = $::redis::params::repl_backlog_ttl,
  $repl_disable_tcp_nodelay      = $::redis::params::repl_disable_tcp_nodelay,
  $repl_ping_slave_period        = $::redis::params::repl_ping_slave_period,
  $repl_timeout                  = $::redis::params::repl_timeout,
  $requirepass                   = $::redis::params::requirepass,
  $save_db_to_disk               = $::redis::params::save_db_to_disk,
  $save_db_to_disk_interval      = $::redis::params::save_db_to_disk_interval,
  $service_enable                = $::redis::params::service_enable,
  $service_ensure                = $::redis::params::service_ensure,
  $service_group                 = $::redis::params::service_group,
  $service_hasrestart            = $::redis::params::service_hasrestart,
  $service_hasstatus             = $::redis::params::service_hasstatus,
  $service_manage                = $::redis::params::service_manage,
  $service_name                  = $::redis::params::service_name,
  $service_provider              = $::redis::params::service_provider,
  $service_user                  = $::redis::params::service_user,
  $set_max_intset_entries        = $::redis::params::set_max_intset_entries,
  $slave_priority                = $::redis::params::slave_priority,
  $slave_read_only               = $::redis::params::slave_read_only,
  $slave_serve_stale_data        = $::redis::params::slave_serve_stale_data,
  $slaveof                       = $::redis::params::slaveof,
  $slowlog_log_slower_than       = $::redis::params::slowlog_log_slower_than,
  $slowlog_max_len               = $::redis::params::slowlog_max_len,
  $stop_writes_on_bgsave_error   = $::redis::params::stop_writes_on_bgsave_error,
  $syslog_enabled                = $::redis::params::syslog_enabled,
  $syslog_facility               = $::redis::params::syslog_facility,
  $tcp_backlog                   = $::redis::params::tcp_backlog,
  $tcp_keepalive                 = $::redis::params::tcp_keepalive,
  $timeout                       = $::redis::params::timeout,
  $unixsocket                    = $::redis::params::unixsocket,
  $unixsocketperm                = $::redis::params::unixsocketperm,
  $ulimit                        = $::redis::params::ulimit,
  $workdir                       = $::redis::params::workdir,
  $workdir_mode                  = $::redis::params::workdir_mode,
  $zset_max_ziplist_entries      = $::redis::params::zset_max_ziplist_entries,
  $zset_max_ziplist_value        = $::redis::params::zset_max_ziplist_value,
  $cluster_enabled               = $::redis::params::cluster_enabled,
  $cluster_config_file           = $::redis::params::cluster_config_file,
  $cluster_node_timeout          = $::redis::params::cluster_node_timeout,
) inherits redis::params {

  contain ::redis::preinstall
  contain ::redis::install
  contain ::redis::config
  contain ::redis::service

  Class['redis::preinstall']
  -> Class['redis::install']
  -> Class['redis::config']

  if $::redis::notify_service {
    Class['redis::config']
    ~> Class['redis::service']
  }

  if $::puppetversion and versioncmp($::puppetversion, '4.0.0') < 0 {
    warning("Puppet 3 is EOL as of 01/01/2017, The 3.X.X releases of the module are the last that will support Puppet 3\nFor more information, see https://github.com/arioch/puppet-redis#puppet-3-support")
  }

  # Sanity check
  if $::redis::slaveof {
    if $::redis::bind =~ /^127.0.0./ {
      fail "Replication is not possible when binding to ${::redis::bind}."
    }
  }

  exec { 'systemd-reload-redis':
    command     => 'systemctl daemon-reload',
    refreshonly => true,
    path        => '/bin:/usr/bin:/usr/local/bin',
  }

}