Puppet Redis

Example usage

Standalone

include ::redis

Master node

class { '::redis':
  bind => '10.0.1.1',
}

With authentication

class { '::redis':
  bind       => '10.0.1.1',
  masterauth => 'secret',
}

Slave node

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

With authentication

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

Redis 3.0 Clustering

class { '::redis':
  bind                 => '10.0.1.2',
  appendonly           => true,
  cluster_enabled      => true,
  cluster_config_file  => 'nodes.conf',
  cluster_node_timeout => 5000,
}

Multiple instances

$listening_ports = [6379,6380,6381,6382]

class { '::redis':
  default_install => false,
  service_enable  => false,
  service_ensure  => 'stopped',
}

$listening_ports.each |$port| {
  $port_string = sprintf('%d',$port)
  redis::instance { $port_string:
    service_enable => true,
    service_ensure => 'running',
    port           => $port,
    bind           => $facts['networking']['ip'],
    dbfilename     => "${port}-dump.rdb",
    appendfilename => "${port}-appendonly.aof",
    appendfsync    => 'always',
    require        => Class['Redis'],
  }
}

Manage repositories

Disabled by default but if you really want the module to manage the required repositories you can use this snippet:

class { '::redis':
  manage_repo => true,
}

On Ubuntu, "chris-lea/redis-server" ppa repo will be added. You can change it by using ppa_repo parameter:

class { '::redis':
  manage_repo => true,
  ppa_repo    => 'ppa:rwky/redis',
}

Warning note that it requires puppetlabs/apt on Debian or Ubuntu distros. On Red Hat puppet/epel is needed unless the installation is using Software Collections. In that case will install centos-release-scl-rh from CentOS extras. For RHEL or other RHEL-derivatives this isn't managed.

Redis Sentinel

Optionally install and configuration a redis-sentinel server.

With default settings:

include ::redis::sentinel

With adjustments:

class { '::redis::sentinel':
  master_name      => 'cow',
  redis_host       => '192.168.1.5',
  failover_timeout => 30000,
}

Soft dependency

This module requires camptocamp/systemd on Puppet versions older than 6.1.0.

When managing the repo, it either needs puppetlabs/apt or puppet/epel.

redis::get() function

This function is used to get data from redis. You must have the 'redis' gem installed on your puppet master.

Functions are documented in REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• redis: This class installs redis
• redis::administration: Allows various adminstrative settings for Redis As documented in the FAQ and https://redis.io/topics/admin
• redis::globals: Set a global config for Redis
• redis::sentinel: Install redis-sentinel

Private Classes

• redis::config: This class provides configuration for Redis.
• redis::install: This class installs the application.
• redis::params: This class provides a number of parameters.
• redis::preinstall: Provides anything required by the install class, such as package repositories.
• redis::service: This class manages the Redis daemon.
• redis::ulimit: Redis class for configuring ulimit Used to DRY up the config class, and move the logic for ulimit changes all into one place. Parameters are

Defined types

• redis::instance: Allows the configuration of multiple redis configurations on one machine

Functions

• redis::get: ```

Data types

• Redis::LogLevel: Specify the server verbosity level.
• Redis::RedisUrl

Tasks

• redis_cli: Executes a redis-cli command on the target system

Classes

redis

This class installs redis

Examples

Default install

include redis

Slave Node

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

Binding on multiple interfaces

class { 'redis':
  bind => ['127.0.0.1', '10.0.0.1', '10.1.0.1'],
}

Binding on all interfaces

class { 'redis':
  bind => [],
}

Parameters

The following parameters are available in the redis class.

activerehashing

Data type: Boolean

Enable/disable active rehashing.

Default value: true

aof_load_truncated

Data type: Boolean

Enable/disable loading truncated AOF file

Default value: true

aof_rewrite_incremental_fsync

Data type: Boolean

Enable/disable fsync for AOF file

Default value: true

appendfilename

Data type: String[1]

The name of the append only file

Default value: 'appendonly.aof'

appendfsync

Data type: Enum['no', 'always', 'everysec']

Adjust fsync mode

Default value: 'everysec'

appendonly

Data type: Boolean

Enable/disable appendonly mode.

Default value: false

auto_aof_rewrite_min_size

Data type: String[1]

Adjust minimum size for auto-aof-rewrite.

Default value: '64mb'

auto_aof_rewrite_percentage

Data type: Integer[0]

Adjust percentatge for auto-aof-rewrite.

Default value: 100

bind

Data type: Variant[Stdlib::IP::Address, Array[Stdlib::IP::Address]]

Configure which IP address(es) to listen on. To bind on all interfaces, use an empty array.

Default value: ['127.0.0.1']

config_dir

Data type: Stdlib::Absolutepath

Directory containing the configuration files.

Default value: $redis::params::config_dir

config_dir_mode

Data type: Stdlib::Filemode

Adjust mode for directory containing configuration files.

Default value: $redis::params::config_dir_mode

config_file_orig

Data type: Stdlib::Absolutepath

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

Default value: $redis::params::config_file_orig

config_file

Data type: Stdlib::Absolutepath

Adjust main configuration file.

Default value: $redis::params::config_file

config_file_mode

Data type: Stdlib::Filemode

Adjust permissions for configuration files.

Default value: '0644'

config_group

Data type: String[1]

Adjust filesystem group for config files.

Default value: $redis::params::config_group

config_owner

Data type: String[1]

Adjust filesystem owner for config files.

Default value: $redis::params::config_owner

conf_template

Data type: String[1]

Define which template to use.

Default value: 'redis/redis.conf.erb'

daemonize

Data type: Boolean

Have Redis run as a daemon.

Default value: $redis::params::daemonize

default_install

Data type: Boolean

Configure a default install of redis.

Default value: true

databases

Data type: Integer[1]

Set the number of databases.

Default value: 16

dbfilename

Data type: Variant[String[1], Boolean]

The filename where to dump the DB

Default value: 'dump.rdb'

extra_config_file

Data type: Optional[String]

Optional extra config file to include

Default value: undef

hash_max_ziplist_entries

Data type: Integer[0]

Set max ziplist entries for hashes.

Default value: 512

hash_max_ziplist_value

Data type: Integer[0]

Set max ziplist values for hashes.

Default value: 64

hll_sparse_max_bytes

Data type: Integer[0]

HyperLogLog sparse representation bytes limit

Default value: 3000

hz

Data type: Integer[1, 500]

Set redis background tasks frequency

Default value: 10

latency_monitor_threshold

Data type: Integer[0]

Latency monitoring threshold in milliseconds

Default value: 0

list_max_ziplist_entries

Data type: Integer[0]

Set max ziplist entries for lists.

Default value: 512

list_max_ziplist_value

Data type: Integer[0]

Set max ziplist values for lists.

Default value: 64

log_dir

Data type: Stdlib::Absolutepath

Specify directory where to write log entries.

Default value: '/var/log/redis'

log_dir_mode

Data type: Stdlib::Filemode

Adjust mode for directory containing log files.

Default value: $redis::params::log_dir_mode

log_file

Data type: Stdlib::Absolutepath

Specify file where to write log entries.

Default value: '/var/log/redis/redis.log'

log_level

Data type: Redis::LogLevel

Specify the server verbosity level.

Default value: 'notice'

manage_repo

Data type: Boolean

Enable/disable upstream repository configuration.

Default value: false

manage_package

Data type: Boolean

Enable/disable management of package

Default value: true

managed_by_cluster_manager

Data type: Boolean

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

Default value: false

masterauth

Data type: Optional[String[1]]

If the master is password protected (using the "requirepass" configuration

Default value: undef

maxclients

Data type: Integer[1]

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

Default value: 10000

maxmemory

Data type: Any

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

Default value: undef

maxmemory_policy

Data type: Any

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

Default value: undef

maxmemory_samples

Data type: Any

Select as well the sample size to check.

Default value: undef

min_slaves_max_lag

Data type: Integer[0]

The lag in seconds

Default value: 10

min_slaves_to_write

Data type: Integer[0]

Minimum number of slaves to be in "online" state

Default value: 0

no_appendfsync_on_rewrite

Data type: Boolean

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

Default value: false

notify_keyspace_events

Data type: Optional[String[1]]

Which events to notify Pub/Sub clients about events happening

Default value: undef

notify_service

Data type: Boolean

You may disable service reloads when config files change if you

Default value: true

package_ensure

Data type: String[1]

Default action for package.

Default value: 'present'

package_name

Data type: String[1]

Upstream package name.

Default value: $redis::params::package_name

pid_file

Data type: Stdlib::Absolutepath

Where to store the pid.

Default value: $redis::params::pid_file

port

Data type: Stdlib::Port

Configure which port to listen on.

Default value: 6379

protected_mode

Data type: Boolean

Whether protected mode is enabled or not. Only applicable when no bind is set.

Default value: true

ppa_repo

Data type: Optional[String]

Specify upstream (Ubuntu) PPA entry.

Default value: $redis::params::ppa_repo

rdbcompression

Data type: Boolean

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

Default value: true

repl_backlog_size

Data type: String[1]

The replication backlog size

Default value: '1mb'

repl_backlog_ttl

Data type: Integer[0]

The number of seconds to elapse before freeing backlog buffer

Default value: 3600

repl_disable_tcp_nodelay

Data type: Boolean

Enable/disable TCP_NODELAY on the slave socket after SYNC

Default value: false

repl_ping_slave_period

Data type: Integer[1]

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

Default value: 10

repl_timeout

Data type: Integer[1]

Set the replication timeout for:

Default value: 60

requirepass

Data type: Optional[String]

Require clients to issue AUTH before processing any other commands.

Default value: undef

save_db_to_disk

Data type: Boolean

Set if save db to disk.

Default value: true

save_db_to_disk_interval

Data type: Hash

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

Default value: { '900' => '1', '300' => '10', '60' => '10000' }

service_manage

Data type: Boolean

Specify if the service should be part of the catalog.

Default value: true

service_enable

Data type: Boolean

Enable/disable daemon at boot.

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

Specify if the server should be running.

Default value: 'running'

service_group

Data type: String[1]

Specify which group to run as.

Default value: 'redis'

service_hasrestart

Data type: Boolean

Does the init script support restart?

Default value: true

service_hasstatus

Data type: Boolean

Does the init script support status?

Default value: true

service_name

Data type: String[1]

Specify the service name for Init or Systemd.

Default value: $redis::params::service_name

service_provider

Data type: Optional[String]

Specify the service provider to use

Default value: undef

service_user

Data type: String[1]

Specify which user to run as.

Default value: 'redis'

set_max_intset_entries

Data type: Integer[0]

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

Default value: 512

slave_priority

Data type: Integer[0]

The priority number for slave promotion by Sentinel

Default value: 100

slave_read_only

Data type: Boolean

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

Default value: true

slave_serve_stale_data

Data type: Boolean

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 value: true

slaveof

Data type: Optional[String[1]]

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

Default value: undef

slowlog_log_slower_than

Data type: Integer[0]

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

Default value: 10000

slowlog_max_len

Data type: Integer[0]

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

Default value: 1024

stop_writes_on_bgsave_error

Data type: Boolean

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

Default value: true

syslog_enabled

Data type: Boolean

Enable/disable logging to the system logger.

Default value: false

syslog_facility

Data type: Optional[String[1]]

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

Default value: undef

tcp_backlog

Data type: Integer[0]

Sets the TCP backlog

Default value: 511

tcp_keepalive

Data type: Integer[0]

TCP keepalive.

Default value: 0

timeout

Data type: Integer[0]

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

Default value: 0

ulimit

Data type: Integer[0]

Limit the use of system-wide resources.

Default value: 65536

unixsocket

Data type: Variant[Stdlib::Absolutepath, Enum['']]

Define unix socket path

Default value: '/var/run/redis/redis.sock'

unixsocketperm

Data type: Variant[Stdlib::Filemode, Enum['']]

Define unix socket file permissions

Default value: '0755'

workdir

Data type: Stdlib::Absolutepath

The DB will be written inside this directory, with the filename specified above using the 'dbfilename' configuration directive.

Default value: $redis::params::workdir

workdir_mode

Data type: Stdlib::Filemode

Adjust mode for data directory.

Default value: '0750'

zset_max_ziplist_entries

Data type: Integer[0]

Set max entries for sorted sets.

Default value: 128

zset_max_ziplist_value

Data type: Integer[0]

Set max values for sorted sets.

Default value: 64

cluster_enabled

Data type: Boolean

Enables redis 3.0 cluster functionality

Default value: false

cluster_config_file

Data type: String[1]

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

Default value: 'nodes.conf'

cluster_node_timeout

Data type: Integer[1]

Node timeout. Only set if cluster_enabled is true

Default value: 5000

cluster_slave_validity_factor

Data type: Integer[0]

Control variable to disable promoting slave in case of disconnection from master Only set if cluster_enabled is true

Default value: 0

cluster_require_full_coverage

Data type: Boolean

If false Redis Cluster will server queries even if requests about a subset of keys can be processed Only set if cluster_enabled is true

Default value: true

cluster_migration_barrier

Data type: Integer[0]

Minimum number of slaves master will remain connected with, for another slave to migrate to a master which is no longer covered by any slave. Only set if cluster_enabled is true

Default value: 1

instances

Data type: Hash[String[1], Hash]

Iterate through multiple instance configurations

Default value: {}

output_buffer_limit_slave

Data type: String[1]

Default value: '256mb 64mb 60'

output_buffer_limit_pubsub

Data type: String[1]

Default value: '32mb 8mb 60'

manage_service_file

Data type: Boolean

Default value: false

redis::administration

Allows various adminstrative settings for Redis As documented in the FAQ and https://redis.io/topics/admin

• See also
  • https://redis.io/topics/admin

Examples

include redis::administration

class {'redis::administration':
  disable_thp => false,
}

Parameters

The following parameters are available in the redis::administration class.

enable_overcommit_memory

Data type: Boolean

Enable the overcommit memory setting

Default value: true

disable_thp

Data type: Boolean

Disable Transparent Huge Pages

Default value: true

somaxconn

Data type: Integer[0]

Set somaxconn value

Default value: 65535

redis::globals

Set a global config for Redis

Parameters

The following parameters are available in the redis::globals class.

scl

Data type: Optional[String]

Use a specific Software CoLlection on Red Hat based systems

Default value: undef

redis::sentinel

Install redis-sentinel

Examples

Basic inclusion

include redis::sentinel

Configuring options

class {'redis::sentinel':
  down_after => 80000,
  log_file   => '/var/log/redis/sentinel.log',
}

Parameters

The following parameters are available in the redis::sentinel class.

auth_pass

Data type: Optional[String[1]]

The password to use to authenticate with the master and slaves.

Default value: undef

config_file

Data type: Stdlib::Absolutepath

The location and name of the sentinel config file.

Default value: $redis::params::sentinel_config_file

config_file_orig

Data type: Stdlib::Absolutepath

The location and name of a config file that provides the source of the sentinel config file. Two different files are needed because sentinel itself writes to its own config file and we do not want override that when puppet is run unless there are changes from the manifests.

Default value: $redis::params::sentinel_config_file_orig

config_file_mode

Data type: Stdlib::Filemode

Permissions of config file.

Default value: '0644'

conf_template

Data type: String[1]

Define which template to use.

Default value: 'redis/redis-sentinel.conf.erb'

daemonize

Data type: Boolean

Have Redis sentinel run as a daemon.

Default value: $redis::params::sentinel_daemonize

down_after

Data type: Integer[1]

Number of milliseconds the master (or any attached slave or sentinel) should be unreachable (as in, not acceptable reply to PING, continuously, for the specified period) in order to consider it in S_DOWN state.

Default value: 30000

failover_timeout

Data type: Integer[1]

Specify the failover timeout in milliseconds.

Default value: 180000

init_script

Data type: Optional[Stdlib::Absolutepath]

Specifiy the init script that will be created for sentinel.

Default value: $redis::params::sentinel_init_script

log_file

Data type: Stdlib::Absolutepath

Specify where to write log entries.

Default value: $redis::params::sentinel_log_file

log_level

Data type: Redis::LogLevel

Specify how much we should log.

Default value: 'notice'

master_name

Data type: String[1]

Specify the name of the master redis server. The valid charset is A-z 0-9 and the three characters ".-_".

Default value: 'mymaster'

redis_host

Data type: Stdlib::Host

Specify the bound host of the master redis server.

Default value: '127.0.0.1'

redis_port

Data type: Stdlib::Port

Specify the port of the master redis server.

Default value: 6379

package_name

Data type: String[1]

The name of the package that installs sentinel.

Default value: $redis::params::sentinel_package_name

package_ensure

Data type: String[1]

Do we ensure this package.

Default value: 'present'

parallel_sync

Data type: Integer[0]

How many slaves can be reconfigured at the same time to use a new master after a failover.

Default value: 1

pid_file

Data type: Stdlib::Absolutepath

If sentinel is daemonized it will write its pid at this location.

Default value: $redis::params::sentinel_pid_file

quorum

Data type: Integer[1]

Number of sentinels that must agree that a master is down to signal sdown state.

Default value: 2

sentinel_bind

Data type: Variant[Undef, Stdlib::IP::Address, Array[Stdlib::IP::Address]]

Allow optional sentinel server ip binding. Can help overcome issues arising from protect-mode added Redis 3.2

Default value: undef

sentinel_port

Data type: Stdlib::Port

The port of sentinel server.

Default value: 26379

service_group

Data type: String[1]

The group of the config file.

Default value: 'redis'

service_name

Data type: String[1]

The name of the service (for puppet to manage).

Default value: $redis::params::sentinel_service_name

service_user

Data type: String[1]

The owner of the config file.

Default value: 'redis'

service_enable

Data type: Boolean

Enable the service at boot time.

Default value: true

working_dir

Data type: Stdlib::Absolutepath

The directory into which sentinel will change to avoid mount conflicts.

Default value: $redis::params::sentinel_working_dir

notification_script

Data type: Optional[Stdlib::Absolutepath]

Path to the notification script

Default value: undef

client_reconfig_script

Data type: Optional[Stdlib::Absolutepath]

Path to the client-reconfig script

Default value: undef

init_template

Data type: String[1]

Default value: 'redis/redis-sentinel.init.erb'

service_ensure

Data type: Stdlib::Ensure::Service

Default value: 'running'

Defined types

redis::instance

This is an defined type to allow the configuration of multiple redis instances on one machine without conflicts

Examples

redis::instance {'6380':
  port => 6380,
}

Parameters

The following parameters are available in the redis::instance defined type.

activerehashing

Data type: Boolean

Enable/disable active rehashing.

Default value: $redis::activerehashing

aof_load_truncated

Data type: Boolean

Enable/disable loading truncated AOF file

Default value: $redis::aof_load_truncated

aof_rewrite_incremental_fsync

Data type: Boolean

Enable/disable fsync for AOF file

Default value: $redis::aof_rewrite_incremental_fsync

appendfilename

Data type: String[1]

The name of the append only file

Default value: $redis::appendfilename

appendfsync

Data type: Enum['no', 'always', 'everysec']

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

Default value: $redis::appendfsync

appendonly

Data type: Boolean

Enable/disable appendonly mode.

Default value: $redis::appendonly

auto_aof_rewrite_min_size

Data type: String[1]

Adjust minimum size for auto-aof-rewrite.

Default value: $redis::auto_aof_rewrite_min_size

auto_aof_rewrite_percentage

Data type: Integer[0]

Adjust percentatge for auto-aof-rewrite.

Default value: $redis::auto_aof_rewrite_percentage

bind

Data type: Variant[Stdlib::IP::Address, Array[Stdlib::IP::Address]]

Configure which IP address(es) to listen on. To bind on all interfaces, use an empty array.

Default value: $redis::bind

config_file_orig

Data type: Stdlib::Absolutepath

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

Default value: $redis::config_file_orig

config_file

Data type: Stdlib::Absolutepath

Adjust main configuration file.

Default value: $redis::config_file

config_file_mode

Data type: Stdlib::Filemode

Adjust permissions for configuration files.

Default value: $redis::config_file_mode

config_group

Data type: String[1]

Adjust filesystem group for config files.

Default value: $redis::config_group

config_owner

Data type: String[1]

Adjust filesystem owner for config files.

Default value: $redis::config_owner

conf_template

Data type: String[1]

Define which template to use.

Default value: $redis::conf_template

daemonize

Data type: Boolean

Have Redis run as a daemon.

Default value: true

databases

Data type: Integer[1]

Set the number of databases.

Default value: $redis::databases

dbfilename

Data type: Variant[String[1], Boolean]

The filename where to dump the DB

Default value: $redis::dbfilename

extra_config_file

Data type: Optional[String]

Optional extra config file to include

Default value: $redis::extra_config_file

hash_max_ziplist_entries

Data type: Integer[0]

Set max ziplist entries for hashes.

Default value: $redis::hash_max_ziplist_entries

hash_max_ziplist_value

Data type: Integer[0]

Set max ziplist values for hashes.

Default value: $redis::hash_max_ziplist_value

hll_sparse_max_bytes

Data type: Integer[0]

HyperLogLog sparse representation bytes limit

Default value: $redis::hll_sparse_max_bytes

hz

Data type: Integer[1, 500]

Set redis background tasks frequency

Default value: $redis::hz

latency_monitor_threshold

Data type: Integer[0]

Latency monitoring threshold in milliseconds

Default value: $redis::latency_monitor_threshold

list_max_ziplist_entries

Data type: Integer[0]

Set max ziplist entries for lists.

Default value: $redis::list_max_ziplist_entries

list_max_ziplist_value

Data type: Integer[0]

Set max ziplist values for lists.

Default value: $redis::list_max_ziplist_value

log_dir

Data type: Stdlib::Absolutepath

Specify directory where to write log entries.

Default value: $redis::log_dir

log_dir_mode

Data type: Stdlib::Filemode

Adjust mode for directory containing log files.

Default value: $redis::log_dir_mode

log_file

Data type: Optional[Stdlib::Absolutepath]

Specify file where to write log entries.

Default value: undef

log_level

Data type: Redis::LogLevel

Specify the server verbosity level.

Default value: $redis::log_level

masterauth

Data type: Optional[String[1]]

If the master is password protected (using the "requirepass" configuration

Default value: $redis::masterauth

maxclients

Data type: Integer[1]

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

Default value: $redis::maxclients

maxmemory

Data type: Any

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

Default value: $redis::maxmemory

maxmemory_policy

Data type: Any

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

Default value: $redis::maxmemory_policy

maxmemory_samples

Data type: Any

Select as well the sample size to check.

Default value: $redis::maxmemory_samples

min_slaves_max_lag

Data type: Integer[0]

The lag in seconds

Default value: $redis::min_slaves_max_lag

min_slaves_to_write

Data type: Integer[0]

Minimum number of slaves to be in "online" state

Default value: $redis::min_slaves_to_write

no_appendfsync_on_rewrite

Data type: Boolean

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

Default value: $redis::no_appendfsync_on_rewrite

notify_keyspace_events

Data type: Optional[String[1]]

Which events to notify Pub/Sub clients about events happening

Default value: $redis::notify_keyspace_events

pid_file

Data type: Stdlib::Absolutepath

Where to store the pid.

Default value: "/var/run/redis/redis-server-${name}.pid"

port

Data type: Stdlib::Port

Configure which port to listen on.

Default value: $redis::port

protected_mode

Data type: Boolean

Whether protected mode is enabled or not. Only applicable when no bind is set.

Default value: $redis::protected_mode

rdbcompression

Data type: Boolean

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

Default value: $redis::rdbcompression

repl_backlog_size

Data type: String[1]

The replication backlog size

Default value: $redis::repl_backlog_size

repl_backlog_ttl

Data type: Integer[0]

The number of seconds to elapse before freeing backlog buffer

Default value: $redis::repl_backlog_ttl

repl_disable_tcp_nodelay

Data type: Boolean

Enable/disable TCP_NODELAY on the slave socket after SYNC

Default value: $redis::repl_disable_tcp_nodelay

repl_ping_slave_period

Data type: Integer[1]

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

Default value: $redis::repl_ping_slave_period

repl_timeout

Data type: Integer[1]

Set the replication timeout for:

Default value: $redis::repl_timeout

requirepass

Data type: Optional[String]

Require clients to issue AUTH before processing any other commands.

Default value: $redis::requirepass

save_db_to_disk

Data type: Boolean

Set if save db to disk.

Default value: $redis::save_db_to_disk

save_db_to_disk_interval

Data type: Hash

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

Default value: $redis::save_db_to_disk_interval

service_name

Data type: String[1]

The service name for this instance

Default value: "redis-server-${name}"

service_enable

Data type: Boolean

Enable/disable daemon at boot.

Default value: $redis::service_enable

service_ensure

Data type: Stdlib::Ensure::Service

Specify if the server should be running.

Default value: $redis::service_ensure

service_group

Data type: String[1]

Specify which group to run as.

Default value: $redis::service_group

service_hasrestart

Data type: Boolean

Does the init script support restart?

Default value: $redis::service_hasrestart

service_hasstatus

Data type: Boolean

Does the init script support status?

Default value: $redis::service_hasstatus

service_user

Data type: String[1]

Specify which user to run as.

Default value: $redis::service_user

set_max_intset_entries

Data type: Integer[0]

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

Default value: $redis::set_max_intset_entries

slave_priority

Data type: Integer[0]

The priority number for slave promotion by Sentinel

Default value: $redis::slave_priority

slave_read_only

Data type: Boolean

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

Default value: $redis::slave_read_only

slave_serve_stale_data

Data type: Boolean

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 value: $redis::slave_serve_stale_data

slaveof

Data type: Optional[String[1]]

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

Default value: $redis::slaveof

slowlog_log_slower_than

Data type: Integer[0]

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

Default value: $redis::slowlog_log_slower_than

slowlog_max_len

Data type: Integer[0]

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

Default value: $redis::slowlog_max_len

stop_writes_on_bgsave_error

Data type: Boolean

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

Default value: $redis::stop_writes_on_bgsave_error

syslog_enabled

Data type: Boolean

Enable/disable logging to the system logger.

Default value: $redis::syslog_enabled

syslog_facility

Data type: Optional[String[1]]

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

Default value: $redis::syslog_facility

tcp_backlog

Data type: Integer[0]

Sets the TCP backlog

Default value: $redis::tcp_backlog

tcp_keepalive

Data type: Integer[0]

TCP keepalive.

Default value: $redis::tcp_keepalive

timeout

Data type: Integer[0]

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

Default value: $redis::timeout

ulimit

Data type: Integer[0]

Limit the use of system-wide resources.

Default value: $redis::ulimit

unixsocket

Data type: Variant[Stdlib::Absolutepath, Enum['']]

Define unix socket path

Default value: "/var/run/redis/redis-server-${name}.sock"

unixsocketperm

Data type: Variant[Stdlib::Filemode , Enum['']]

Define unix socket file permissions

Default value: $redis::unixsocketperm

workdir

Data type: Stdlib::Absolutepath

The DB will be written inside this directory, with the filename specified above using the 'dbfilename' configuration directive.

Default value: "${redis::workdir}/redis-server-${name}"

workdir_mode

Data type: Stdlib::Filemode

Adjust mode for data directory.

Default value: $redis::workdir_mode

zset_max_ziplist_entries

Data type: Integer[0]

Set max entries for sorted sets.

Default value: $redis::zset_max_ziplist_entries

zset_max_ziplist_value

Data type: Integer[0]

Set max values for sorted sets.

Default value: $redis::zset_max_ziplist_value

cluster_enabled

Data type: Boolean

Enables redis 3.0 cluster functionality

Default value: $redis::cluster_enabled

cluster_config_file

Data type: String[1]

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

Default value: $redis::cluster_config_file

cluster_node_timeout

Data type: Integer[1]

Node timeout. Only set if cluster_enabled is true

Default value: $redis::cluster_node_timeout

cluster_slave_validity_factor

Data type: Integer[0]

Control variable to disable promoting slave in case of disconnection from master Only set if cluster_enabled is true

Default value: $redis::cluster_slave_validity_factor

cluster_require_full_coverage

Data type: Boolean

If false Redis Cluster will server queries even if requests about a subset of keys can be processed Only set if cluster_enabled is true

Default value: $redis::cluster_require_full_coverage

cluster_migration_barrier

Data type: Integer[0]

Minimum number of slaves master will remain connected with, for another slave to migrate to a master which is no longer covered by any slave Only set if cluster_enabled is true

Default value: $redis::cluster_migration_barrier

output_buffer_limit_slave

Data type: String[1]

Default value: $redis::output_buffer_limit_slave

output_buffer_limit_pubsub

Data type: String[1]

Default value: $redis::output_buffer_limit_pubsub

minimum_version

Data type: String[1]

Default value: $redis::minimum_version

managed_by_cluster_manager

Data type: Boolean

Default value: $redis::managed_by_cluster_manager

package_ensure

Data type: String[1]

Default value: $redis::package_ensure

manage_service_file

Data type: Boolean

Default value: true

Functions

redis::get

Type: Ruby 4.x API

#### `redis::get(String[1] $key, Redis::RedisUrl $url, Optional[String] $default)`

Returns: Optional[String] Returns the value of the key from Redis

key

Data type: String[1]

The key to look up in redis

url

Data type: Redis::RedisUrl

The endpoint of the Redis instance

default

Data type: Optional[String]

The value to return if the key is not found or the connection to Redis fails

Data types

Redis::LogLevel

This can be one of:

• debug (a lot of information, useful for development/testing)
• verbose (many rarely useful info, but not a mess like the debug level)
• notice (moderately verbose, what you want in production probably)
• warning (only very important / critical messages are logged)

Alias of Enum['debug', 'verbose', 'notice', 'warning']

Redis::RedisUrl

The Redis::RedisUrl data type.

Alias of Pattern[/(^redis:\/\/)/]

Tasks

redis_cli

Executes a redis-cli command on the target system

Supports noop? false

Parameters

command

Data type: String[1]

The command to run, including all arguments

Changelog

All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.

v6.1.0 (2020-09-11)

Full Changelog

Implemented enhancements:

• Add Ubuntu 20.04 support #357 (mmoll)

v6.0.0 (2020-05-11)

Full Changelog

Breaking changes:

• Make apt and epel soft dependencies #358 (ekohl)

Implemented enhancements:

• Add support for RedHat/CentOS 8 #350 (yakatz)
• Add Debian 10 support #344 (ekohl)
• Finishing touches for multi-instance support #343 (fraenki)
• Set RuntimeDirectory in service template #342 (basti-nis)

Fixed bugs:

• change systemd stop command to redis-cli #355 (alexskr)
• Fix the sentinel pid file location for Ubuntu 18.04 #347 (ekohl)

Closed issues:

• Type forking causes service timeout #260

Merged pull requests:

• Use more native rspec and serverspec testing #348 (ekohl)
• Run acceptance tests with manage_repo => false #346 (ekohl)
• Update bolt testing to use modern versions #345 (ekohl)

v5.0.0 (2019-12-03)

Full Changelog

Breaking changes:

• Closer match parameter to OS defaults #336 (ekohl)
• Stricter data types #328 (ekohl)
• Drop support for Redis 2, Debian 8 and Ubuntu 14.04; add Debian 9 and Ubuntu 18.04 #326 (ekohl)

Implemented enhancements:

• Instance is not read from hiera file #329
• Add SCL support #334 (ekohl)
• Support instances inside Hiera #330 (lordbink)

Closed issues:

• Can't disable unixsocket after #331
• 2.8 version of Redis on Debian 8 errors out #246
• Unable to unset unixsocket config parameter #228
• bind $ipaddress #94
• Create nodes.conf file? #76

Merged pull requests:

• Clean up preinstall handling and use modern facts #335 (ekohl)
• Allow empty unixsocket(perm) #333 (ekohl)
• Allow privileged ports in data types #332 (ekohl)
• Fix typo in type #327 (ekohl)
• Complete the transition to puppet-strings #325 (ekohl)

v4.2.1 (2019-09-19)

Full Changelog

Fixed bugs:

• Fixing repl_ping_slave_period not being managed with params #318 (dom-nie)

Merged pull requests:

• Spelling fix #323 (tetsuo13)

v4.2.0 (2019-07-22)

Full Changelog

Implemented enhancements:

• Adding support for more redis cluster params #316 (dom-nie)

Closed issues:

• Fix systemd service filename #310
• Fix manage_service_file variable #308

Merged pull requests:

• Allow puppetlabs/stdlib 6.x #314 (alexjfisher)
• Fix manage_service_file variable #309 (CallumBanbery)

v4.1.0 (2019-05-02)

Full Changelog

Implemented enhancements:

• Add service_enable parameter to sentinel.pp #307 (rschemm)

Closed issues:

• Please release v3.3.2 due to Ubuntu 18.04 / systemd fix. #283

Merged pull requests:

• Allow puppetlabs/apt 7.x #312 (dhoppe)

v4.0.0 (2019-03-12)

Full Changelog

This is the first release since the module was migrated to the Vox Pupuli puppet namespace.

Breaking changes:

• Support binding to all interfaces #302 (alexjfisher)
• Drop support for puppet 3 and 4 #297 (alexjfisher)
• Convert redisget to redis::get API v4 function #293 (alexjfisher)

Implemented enhancements:

• Bind the service on all available interface #60
• Add some parameter validation using data types #303 (alexjfisher)
• Initial rhel 8 support #284 (mbaldessari)

Closed issues:

• Transparent Huge Pages (THP) Not Disabled on RHEL #278
• Looking for maintainer [Help needed] #277
• Travis Credential issues... still :( #267
• Outdated dependency puppetlabs-apt \< 3.0.0 #264
• cannot bind ipv4 and ipv6 #257
• Deprecate Puppet 3.X Support #152
• Get acceptance tests running again #292
• Convert function to API v4 ruby function #291

Merged pull requests:

• Re-enable and fix acceptance tests. (Don't manage /var/run/redis on Debian systems) #299 (alexjfisher)
• Update metadata.json for Vox Pupuli migration #298 (alexjfisher)
• Update apt and stdlib dependencies #296 (alexjfisher)
• Fix github license detection #295 (alexjfisher)
• Add badges to README #294 (alexjfisher)
• Fix tests and initial Voxpupuli modulesync #290 (alexjfisher)
• Lint and rubocop (autofixes only) #289 (alexjfisher)

v3.3.1 (2018-09-13)

Full Changelog

Closed issues:

• Ulimit configuration broken for systemd #268

v3.3.0 (2018-06-19)

Full Changelog

Closed issues:

• output_buffer_limit_pubsub and output_buffer_limit_slave #263
• Can't release - Require Forge Credential Refresh #262
• Module v3.2.0 not published to forge #255
• Inconsistent sentinel_package_name handling on Debian #253
• No pidfile for sentinel #238
• puppet-redis requires outdated puppetlabs-apt module #232
• Can't use as slave bound to localhost #229
• [Feature Request] Redis::Instance - Set default unixsocket #226
• Travis Forge Password Changed #216

Merged pull requests:

• Adds logic for installing redid-sentinel package #254 (petems)
• Update redis mode on wheezy #252 (petems)
• Fix spec for sentinel #251 (petems)
• get rid of getvar_emptystring function #249 (vicinus)
• Added log_level to sentinel. #248 (hp197)
• Adds redis_cli task #245 (petems)
• Bump Puppet version for acceptance to 4.10.8 #244 (petems)
• protected-mode configuration option (Redis 3.2+) #243 (Dan70402)
• Switch to using simp-beaker suites #241 (petems)
• Bumped apt version dependency to version \< 5.0.0 #237 (c4m4)
• Updates for EL6 #236 (petems)
• Pin version of redis gem #235 (petems)
• Added configuration options for client-output-buffer-limit #233 (Mike-Petersen)
• Allow slaveof when binding to localhost #231 (joshuaspence)
• Fix issues with missing locale for Debian box #224 (petems)
• Instance service improvements #222 (kwevers)
• Make sure the service is en/disabled per user request #221 (kwevers)
• Split Redis instance socket files #220 (kwevers)
• Split Redis workdir #219 (kwevers)
• fix package_ensure version on ubuntu when it is in the 3:3.2.1 format #218 (sp-joseluis-ledesma)
• Split the redis instance logfiles by default #217 (kwevers)
• Use package_ensure if it specifies a version instead of the minimum_version #215 (sp-joseluis-ledesma)

v3.2.0 (2017-07-11)

Full Changelog

Implemented enhancements:

• Cluster Support #62

Closed issues:

• redis_server_version fact fails to parse output #210
• Support for multi-instances per host #113

Merged pull requests:

• updated redis systemd unit file for better use with instances #214 (bostrowski13)
• Updates docker images for CentOS 6 and 7 #213 (petems)
• Update EPEL module #212 (petems)
• Refactor redisget() method #211 (petems)
• Update docs for puppet-strings #206 (petems)
• Add redis::instance defined type #200 (petems)
• Adding note about Puppet 3 support #153 (petems)

v3.1.1 (2017-05-19)

Full Changelog

v3.1.0 (2017-05-19)

Full Changelog

Implemented enhancements:

• Releasing v3.0.1 #205
• Please cut a release #201
• Deployment to Forge #185

Fixed bugs:

• Sort problem in v1.2.4 template #195

Merged pull requests:

• Add an optional third parameter to redisget() to specify a default value #209 (petems)
• Updates docs for puppet functions #208 (petems)
• Add switch to manage File[/var/run/redis] #204 (petems)
• Ignore selinux default context for /etc/systemd/system/redis.service.d #202 (amoralej)
• Make TravisCI push to the Forge #191 (arioch)

v3.0.0 (2017-05-11)

Full Changelog

Implemented enhancements:

• Ubuntu 16.04 support? #146
• [Whishlist] Extend ulimit parameter to support limits.conf and systemd #130
• Add overcommit.pp to deal with Can't save in background: fork: Cannot allocate memory ? #105

Fixed bugs:

• The fix for issue #192 broke service_managed false #197
• Ubuntu 16.04 changed sentinel config filename #175
• sentinel support broken? #166
• Ownership problem with Ubuntu redis-server #150
• Parameters not valid for older Redis in config #111

Merged pull requests:

• Update sort to specify key #199 (petems)
• Adds tests for when Redis service is unmanaged #198 (petems)
• Changing Travis back to Trusty #194 (petems)
• Remove service notification #193 (petems)
• Improves ulimit configuration #192 (petems)
• Updates metadata supported versions #190 (petems)
• Adds tests for Ubuntu 1404 and Trusty package #189 (petems)
• Adds redis::administration class #188 (petems)
• Adds logic for managing redis-sentinel package #187 (petems)
• Bump to version 3.0.0 #186 (petems)
• Moves location of redis-sentinel file #184 (petems)
• (testing) Simplify command run by TravisCI #183 (ghoneycutt)
• Style #182 (ghoneycutt)
• Adds acceptance tests for the redisget() function #181 (petems)
• Add redisget() #179 (ghoneycutt)
• Fixes ordering of Apt repos #178 (petems)
• Add 2.4.10 config file for CentOS 6 #177 (petems)
• Refactoring common code patterns #174 (petems)
• Changes permission on /var/run/ directory #173 (petems)
• Bump Beaker Ruby versions #172 (petems)
• Fixes sentinel installation on Debian flavours #171 (petems)
• Adds vagrant beaker images #170 (petems)
• Adds acceptance test for master/slave testing #168 (petems)
• Renames spec file #165 (petems)
• Adds specific versions to fixtures #164 (petems)
• Changes for RHEL-ish specific configuration #162 (petems)
• Changes CentOS Docker images #160 (petems)
• Updates fact for CentOS 6 #159 (petems)
• Fixes lint arrow errors #158 (petems)
• README lint #155 (matonb)
• Archlinux: Added tests and update config_dir parameter #149 (bartjanssens92)
• Add CHANGELOG #148 (petems)
• Added Archlinux as supported OS #147 (bartjanssens92)

1.2.4 (2016-12-05)

Full Changelog

Implemented enhancements:

• Speed up Travis #118

Fixed bugs:

• Wrong redis.conf after c45049986a7fcb1c9a0591de123c6bf97c761355 #142
• powerstack.org - No longer hosted #103

Closed issues:

• redis.conf under /etc/redis.conf #81
• Add socket option #79
• preinstall.pp fails on CEntOS 6.5 and Puppet Enterprise 2.7. #72
• How do I change from powerstack.org repo if I need to? Should I just edit manifests/preinstall.pp? #68
• puppet-redis || every time when puppet runs, the service restarts #59
• 'manage_repo => true' causes run to fail because add-apt-repository command isn't available #49

Merged pull requests:

• For folks that do not use redis to cache to disk #144 (petems)
• Revert "Changes templates to use scope" #143 (petems)
• Update sentinel.pp #141 (xprntl)
• Manage workdir and permissions #138 (petems)
• Adds minimum versions parameters #137 (petems)
• Adds redis-server version fact #136 (petems)
• adding /var/run/redis for Debian based hosts #135 (petems)
• Refactor unit tests #134 (petems)
• Update acceptance tests #133 (petems)
• Speed up Travis even more #125 (petems)
• Add fast finish to Travis #124 (petems)
• Changes package installation #123 (petems)
• Fix Beaker settings #122 (petems)
• Fixes gpg key for DotDeb #121 (petems)
• Sent bind address rebase #120 (petems)
• Changes templates to use scope #119 (petems)
• Add save interval squash #117 (petems)
• FreeBSD fixes #116 (petems)
• Consolidate travis and testing #115 (petems)
• Fix specs #114 (Phil-Friderici)
• Remove single quotes around variable #101 (rorybrowne)

1.2.3 (2016-09-19)

Full Changelog

Merged pull requests:

• Adds spec for unixsocket and perms #99 (petems)
• Added the ability to configure Unix socket binding #97 (gcelestine)
• Lint and English cleanup in the redis.conf #93 (ryayon)
• Added more configuration options to redis.conf #90 (hanej)
• Make notification of service optional #89 (michaeltchapman)

1.2.2 (2016-03-17)

Full Changelog

Closed issues:

• Error 400 on SERVER: Puppet::Parser::AST::Resource failed with error ArgumentError: Invalid resource type redis #86
• Potential bug: 64min should read 64mb #73
• Typo on sentinel.pp on if defined #69
• Does't configure EPEL repository on CentOS 7 #61

1.2.1 (2015-12-09)

Full Changelog

Merged pull requests:

• Fix puppet-redis for Redis \< 3 #77 (EmilienM)

1.2.0 (2015-12-03)

Full Changelog

Closed issues:

• $daemonize is defaulted to 'false' on Redhat OS, which causes service command to hang #64
• Redis service start fail on Debian stable (Wheezy 7.0) #52

Merged pull requests:

• Redis Cluster 3.0 Feature #71 (claudio-walser)
• Fix Support for EL7 and Puppet 4 #66 (trlinkin)
• Add a option to override the service provider #63 (nerzhul)
• add support for hz option #50 (nerzhul)

1.1.3 (2015-08-19)

Full Changelog

Closed issues:

• Unable to bring in as a dependency #47

Merged pull requests:

• Bump puppetlabs-stdlib version spec #48 (gblair)

1.1.2 (2015-08-06)

Full Changelog

Closed issues:

• Error on CentOS 7 when manage_repo: true #44

1.1.1 (2015-08-04)

Full Changelog

Closed issues:

• Commit edd7cb55931fe0336bfee475c738ac4b91308f98 seems to be pasting undef params into redis.conf #41

Merged pull requests:

• Save db to disk #46 (adrian-balcan-ygt)
• Use puppetlabs_spec_helper for testing #45 (jlyheden)
• copy variables used in template to local scope #42 (eoly)

1.1.0 (2015-06-22)

Full Changelog

Merged pull requests:

• access out-of-scope variables via the scope.lookupvar method #40 (eoly)

1.0.7 (2015-06-02)

Full Changelog

Fixed bugs:

• Sentinel init/upstart file doesn't exist #18

Closed issues:

• Default config_owner of redis #39
• Duplicate decleration Package[redis] when both include redis and redis::sentinel #36
• Does not work with Debian 7.8 with redis version 2.4.14-1 #24

Merged pull requests:

• Fixed duplicate declaration of package #38 (raiblue)
• fix issue with params.pp with strict_variables enabled #35 (eoly)
• Enable to not manage the Redis service #34 (Spredzy)
• Suse conf file fix #33 (christofhaerens)
• added Suse osfamily #32 (christofhaerens)

1.0.6 (2015-05-05)

Full Changelog

1.0.5 (2015-03-30)

Full Changelog

1.0.4 (2015-01-19)

Full Changelog

1.0.3 (2015-01-05)

Full Changelog

Implemented enhancements:

• Feature Request: support for redis-sentinel #13

1.0.2 (2014-12-17)

Full Changelog

1.0.1 (2014-10-22)

Full Changelog

1.0.0 (2014-10-22)

Full Changelog

0.0.10 (2014-08-29)

Full Changelog

0.0.9 (2014-08-29)

Full Changelog

Closed issues:

• Amazon AMI Installation/Initialization Issue #11

0.0.8 (2014-03-27)

Full Changelog

Closed issues:

• Default bind on public interface #6
• Install a specific version #4

0.0.7 (2014-01-13)

Full Changelog

0.0.6 (2013-08-07)

Full Changelog

Merged pull requests:

• add ubuntu ppa repo support #3 (nagas)

0.0.5 (2013-07-22)

Full Changelog

Closed issues:

• Redis config 2.6 not compatible with EPELs 2.4 on Centos6 #2

0.0.4 (2013-07-17)

Full Changelog

Closed issues:

• Default config path wrong for RedHat #1

0.0.3 (2013-07-08)

Full Changelog

0.0.2 (2013-06-19)

Full Changelog

0.0.1 (2013-06-19)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator