diff --git a/.fixtures.yml b/.fixtures.yml index 52ee5db..526b960 100644 --- a/.fixtures.yml +++ b/.fixtures.yml @@ -1,13 +1,16 @@ fixtures: repositories: apt: 'https://github.com/puppetlabs/puppetlabs-apt.git' stdlib: 'https://github.com/puppetlabs/puppetlabs-stdlib.git' epel: 'https://github.com/stahnma/puppet-module-epel.git' augeasproviders_sysctl: 'https://github.com/hercules-team/augeasproviders_sysctl.git' augeasproviders_core: 'https://github.com/hercules-team/augeasproviders_core.git' augeas_core: repo: "https://github.com/puppetlabs/puppetlabs-augeas_core" puppet_version: ">= 6.0.0" yumrepo_core: repo: "https://github.com/puppetlabs/puppetlabs-yumrepo_core" puppet_version: ">= 6.0.0" + systemd: + repo: 'https://github.com/camptocamp/puppet-systemd.git' + puppet_version: "< 6.1.0" diff --git a/README.md b/README.md index bd9441c..77fecab 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,143 @@ # Puppet Redis [![License](https://img.shields.io/github/license/voxpupuli/puppet-redis.svg)](https://github.com/voxpupuli/puppet-redis/blob/master/LICENSE) [![Build Status](https://travis-ci.org/voxpupuli/puppet-redis.png?branch=master)](https://travis-ci.org/voxpupuli/puppet-redis) [![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-redis/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-redis) [![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/redis.svg)](https://forge.puppetlabs.com/puppet/redis) [![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/redis.svg)](https://forge.puppetlabs.com/puppet/redis) [![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/redis.svg)](https://forge.puppetlabs.com/puppet/redis) [![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/redis.svg)](https://forge.puppetlabs.com/puppet/redis) ## Example usage ### Standalone ```puppet include ::redis ``` ### Master node ```puppet class { '::redis': bind => '10.0.1.1', } ``` With authentication ```puppet class { '::redis': bind => '10.0.1.1', masterauth => 'secret', } ``` ### Slave node ```puppet class { '::redis': bind => '10.0.1.2', slaveof => '10.0.1.1 6379', } ``` With authentication ```puppet class { '::redis': bind => '10.0.1.2', slaveof => '10.0.1.1 6379', masterauth => 'secret', } ``` ### Redis 3.0 Clustering ```puppet class { '::redis': bind => '10.0.1.2', appendonly => true, cluster_enabled => true, cluster_config_file => 'nodes.conf', cluster_node_timeout => 5000, } ``` +### Multiple instances + + +```puppet +$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: ```puppet 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: ```puppet class { '::redis': manage_repo => true, ppa_repo => 'ppa:rwky/redis', } ``` ### Redis Sentinel Optionally install and configuration a redis-sentinel server. With default settings: ```puppet include ::redis::sentinel ``` With adjustments: ```puppet 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. + ## `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.md) diff --git a/manifests/init.pp b/manifests/init.pp index 8d45538..0a0f525 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -1,362 +1,356 @@ # This class installs redis # # @example Default install # include redis # # @example Slave Node # class { '::redis': # bind => '10.0.1.2', # slaveof => '10.0.1.1 6379', # } # # @example Binding on multiple interfaces # class { 'redis': # bind => ['127.0.0.1', '10.0.0.1', '10.1.0.1'], # } # # @example Binding on all interfaces # class { 'redis': # bind => [], # } # # @param activerehashing # Enable/disable active rehashing. # @param aof_load_truncated # Enable/disable loading truncated AOF file # @param aof_rewrite_incremental_fsync # Enable/disable fsync for AOF file # @param appendfilename # The name of the append only file # @param appendfsync # Adjust fsync mode # @param appendonly # Enable/disable appendonly mode. # @param auto_aof_rewrite_min_size # Adjust minimum size for auto-aof-rewrite. # @param auto_aof_rewrite_percentage # Adjust percentatge for auto-aof-rewrite. # @param bind # Configure which IP address(es) to listen on. To bind on all interfaces, use an empty array. # @param config_dir # Directory containing the configuration files. # @param config_dir_mode # Adjust mode for directory containing configuration files. # @param config_file_orig # The location and name of a config file that provides the source # @param config_file # Adjust main configuration file. # @param config_file_mode # Adjust permissions for configuration files. # @param config_group # Adjust filesystem group for config files. # @param config_owner # Adjust filesystem owner for config files. # @param conf_template # Define which template to use. # @param daemonize # Have Redis run as a daemon. # @param default_install # Configure a default install of redis. # @param databases # Set the number of databases. # @param dbfilename # The filename where to dump the DB # @param extra_config_file # Optional extra config file to include # @param hash_max_ziplist_entries # Set max ziplist entries for hashes. # @param hash_max_ziplist_value # Set max ziplist values for hashes. # @param hll_sparse_max_bytes # HyperLogLog sparse representation bytes limit # @param hz # Set redis background tasks frequency # @param latency_monitor_threshold # Latency monitoring threshold in milliseconds # @param list_max_ziplist_entries # Set max ziplist entries for lists. # @param list_max_ziplist_value # Set max ziplist values for lists. # @param log_dir # Specify directory where to write log entries. # @param log_dir_mode # Adjust mode for directory containing log files. # @param log_file # Specify file where to write log entries. # @param log_level # Specify the server verbosity level. # @param manage_repo # Enable/disable upstream repository configuration. # @param manage_package # Enable/disable management of package # @param managed_by_cluster_manager # Choose if redis will be managed by a cluster manager such as pacemaker or rgmanager # @param masterauth # If the master is password protected (using the "requirepass" configuration # @param maxclients # Set the max number of connected clients at the same time. # @param maxmemory # Don't use more memory than the specified amount of bytes. # @param maxmemory_policy # How Redis will select what to remove when maxmemory is reached. # @param maxmemory_samples # Select as well the sample size to check. # @param min_slaves_max_lag # The lag in seconds # @param min_slaves_to_write # Minimum number of slaves to be in "online" state # @param no_appendfsync_on_rewrite # If you have latency problems turn this to 'true'. Otherwise leave it as # @param notify_keyspace_events # Which events to notify Pub/Sub clients about events happening # @param notify_service # You may disable service reloads when config files change if you # @param package_ensure # Default action for package. # @param package_name # Upstream package name. # @param pid_file # Where to store the pid. # @param port # Configure which port to listen on. # @param protected_mode # Whether protected mode is enabled or not. Only applicable when no bind is set. # @param ppa_repo # Specify upstream (Ubuntu) PPA entry. # @param rdbcompression # Enable/disable compression of string objects using LZF when dumping. # @param repl_backlog_size # The replication backlog size # @param repl_backlog_ttl # The number of seconds to elapse before freeing backlog buffer # @param repl_disable_tcp_nodelay # Enable/disable TCP_NODELAY on the slave socket after SYNC # @param repl_ping_slave_period # Slaves send PINGs to server in a predefined interval. It's possible # @param repl_timeout # Set the replication timeout for: # @param requirepass # Require clients to issue AUTH before processing any other commands. # @param save_db_to_disk # Set if save db to disk. # @param save_db_to_disk_interval # save the dataset every N seconds if there are at least M changes in the dataset # @param service_manage # Specify if the service should be part of the catalog. # @param service_enable # Enable/disable daemon at boot. # @param service_ensure # Specify if the server should be running. # @param service_group # Specify which group to run as. # @param service_hasrestart # Does the init script support restart? # @param service_hasstatus # Does the init script support status? # @param service_name # Specify the service name for Init or Systemd. # @param service_provider # Specify the service provider to use # @param service_user # Specify which user to run as. # @param 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. # @param slave_priority # The priority number for slave promotion by Sentinel # @param slave_read_only # You can configure a slave instance to accept writes or not. # @param 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. # @param slaveof # Use slaveof to make a Redis instance a copy of another Redis server. # @param slowlog_log_slower_than # Tells Redis what is the execution time, in microseconds, to exceed in order # for the command to get logged. # @param slowlog_max_len # Tells Redis what is the length to exceed in order for the command to get # logged. # @param 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. # @param syslog_enabled # Enable/disable logging to the system logger. # @param syslog_facility # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. # @param tcp_backlog # Sets the TCP backlog # @param tcp_keepalive # TCP keepalive. # @param timeout # Close the connection after a client is idle for N seconds (0 to disable). # @param ulimit # Limit the use of system-wide resources. # @param unixsocket # Define unix socket path # @param unixsocketperm # Define unix socket file permissions # @param workdir # The DB will be written inside this directory, with the filename specified # above using the 'dbfilename' configuration directive. # @param workdir_mode # Adjust mode for data directory. # @param zset_max_ziplist_entries # Set max entries for sorted sets. # @param zset_max_ziplist_value # Set max values for sorted sets. # @param cluster_enabled # Enables redis 3.0 cluster functionality # @param cluster_config_file # Config file for saving cluster nodes configuration. This file is never # touched by humans. Only set if cluster_enabled is true # @param cluster_node_timeout # Node timeout. Only set if cluster_enabled is true # @param cluster_slave_validity_factor # Control variable to disable promoting slave in case of disconnection from master # Only set if cluster_enabled is true # @param cluster_require_full_coverage # 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 # @param cluster_migration_barrier # 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 # @param instances # Iterate through multiple instance configurations class redis ( Boolean $activerehashing = true, Boolean $aof_load_truncated = true, Boolean $aof_rewrite_incremental_fsync = true, String[1] $appendfilename = 'appendonly.aof', Enum['no', 'always', 'everysec'] $appendfsync = 'everysec', Boolean $appendonly = false, String[1] $auto_aof_rewrite_min_size = '64mb', Integer[0] $auto_aof_rewrite_percentage = 100, Variant[Stdlib::IP::Address, Array[Stdlib::IP::Address]] $bind = ['127.0.0.1'], String[1] $output_buffer_limit_slave = '256mb 64mb 60', String[1] $output_buffer_limit_pubsub = '32mb 8mb 60', String[1] $conf_template = 'redis/redis.conf.erb', Stdlib::Absolutepath $config_dir = $redis::params::config_dir, Stdlib::Filemode $config_dir_mode = $redis::params::config_dir_mode, Stdlib::Absolutepath $config_file = $redis::params::config_file, Stdlib::Filemode $config_file_mode = '0644', Stdlib::Absolutepath $config_file_orig = $redis::params::config_file_orig, String[1] $config_group = $redis::params::config_group, String[1] $config_owner = $redis::params::config_owner, Boolean $daemonize = $redis::params::daemonize, Integer[1] $databases = 16, Boolean $default_install = true, Variant[String[1], Boolean] $dbfilename = 'dump.rdb', Optional[String] $extra_config_file = undef, Integer[0] $hash_max_ziplist_entries = 512, Integer[0] $hash_max_ziplist_value = 64, Integer[0] $hll_sparse_max_bytes = 3000, Integer[1, 500] $hz = 10, Integer[0] $latency_monitor_threshold = 0, Integer[0] $list_max_ziplist_entries = 512, Integer[0] $list_max_ziplist_value = 64, Stdlib::Absolutepath $log_dir = '/var/log/redis', Stdlib::Filemode $log_dir_mode = $redis::params::log_dir_mode, Stdlib::Absolutepath $log_file = '/var/log/redis/redis.log', Redis::LogLevel $log_level = 'notice', Boolean $manage_service_file = false, Boolean $manage_package = true, Boolean $manage_repo = false, Optional[String[1]] $masterauth = undef, Integer[1] $maxclients = 10000, $maxmemory = undef, $maxmemory_policy = undef, $maxmemory_samples = undef, Integer[0] $min_slaves_max_lag = 10, Integer[0] $min_slaves_to_write = 0, Boolean $no_appendfsync_on_rewrite = false, Optional[String[1]] $notify_keyspace_events = undef, Boolean $notify_service = true, Boolean $managed_by_cluster_manager = false, String[1] $package_ensure = 'present', String[1] $package_name = $redis::params::package_name, Stdlib::Absolutepath $pid_file = $redis::params::pid_file, Stdlib::Port $port = 6379, Boolean $protected_mode = true, Optional[String] $ppa_repo = $redis::params::ppa_repo, Boolean $rdbcompression = true, String[1] $repl_backlog_size = '1mb', Integer[0] $repl_backlog_ttl = 3600, Boolean $repl_disable_tcp_nodelay = false, Integer[1] $repl_ping_slave_period = 10, Integer[1] $repl_timeout = 60, Optional[String] $requirepass = undef, Boolean $save_db_to_disk = true, Hash $save_db_to_disk_interval = {'900' =>'1', '300' => '10', '60' => '10000'}, Boolean $service_enable = true, Stdlib::Ensure::Service $service_ensure = 'running', String[1] $service_group = 'redis', Boolean $service_hasrestart = true, Boolean $service_hasstatus = true, Boolean $service_manage = true, String[1] $service_name = $redis::params::service_name, Optional[String] $service_provider = undef, String[1] $service_user = 'redis', Integer[0] $set_max_intset_entries = 512, Integer[0] $slave_priority = 100, Boolean $slave_read_only = true, Boolean $slave_serve_stale_data = true, Optional[String[1]] $slaveof = undef, Integer[0] $slowlog_log_slower_than = 10000, Integer[0] $slowlog_max_len = 1024, Boolean $stop_writes_on_bgsave_error = true, Boolean $syslog_enabled = false, Optional[String[1]] $syslog_facility = undef, Integer[0] $tcp_backlog = 511, Integer[0] $tcp_keepalive = 0, Integer[0] $timeout = 0, Variant[Stdlib::Absolutepath, Enum['']] $unixsocket = '/var/run/redis/redis.sock', Variant[Stdlib::Filemode, Enum['']] $unixsocketperm = '0755', Integer[0] $ulimit = 65536, Stdlib::Absolutepath $workdir = $redis::params::workdir, Stdlib::Filemode $workdir_mode = '0750', Integer[0] $zset_max_ziplist_entries = 128, Integer[0] $zset_max_ziplist_value = 64, Boolean $cluster_enabled = false, String[1] $cluster_config_file = 'nodes.conf', Integer[1] $cluster_node_timeout = 5000, Integer[0] $cluster_slave_validity_factor = 0, Boolean $cluster_require_full_coverage = true, Integer[0] $cluster_migration_barrier = 1, Hash[String[1], Hash] $instances = {}, ) inherits redis::params { contain redis::preinstall contain redis::install contain redis::config contain redis::service $instances.each | String $key, Hash $values | { redis::instance { $key: * => $values, } } Class['redis::preinstall'] -> Class['redis::install'] -> Class['redis::config'] if $redis::notify_service { Class['redis::config'] ~> Class['redis::service'] } - exec { 'systemd-reload-redis': - command => 'systemctl daemon-reload', - refreshonly => true, - path => '/bin:/usr/bin:/usr/local/bin', - } - } diff --git a/manifests/instance.pp b/manifests/instance.pp index 6b69424..01ad523 100644 --- a/manifests/instance.pp +++ b/manifests/instance.pp @@ -1,404 +1,409 @@ # This is an defined type to allow the configuration of # multiple redis instances on one machine without conflicts # # @summary Allows the configuration of multiple redis configurations on one machine # # @example # redis::instance {'6380': # port => 6380, # } # # @param activerehashing # Enable/disable active rehashing. # @param aof_load_truncated # Enable/disable loading truncated AOF file # @param aof_rewrite_incremental_fsync # Enable/disable fsync for AOF file # @param appendfilename # The name of the append only file # @param appendfsync # Adjust fsync mode. Valid options: always, everysec, no. # @param appendonly # Enable/disable appendonly mode. # @param auto_aof_rewrite_min_size # Adjust minimum size for auto-aof-rewrite. # @param auto_aof_rewrite_percentage # Adjust percentatge for auto-aof-rewrite. # @param bind # Configure which IP address(es) to listen on. To bind on all interfaces, use an empty array. # @param config_file_orig # The location and name of a config file that provides the source # @param config_file # Adjust main configuration file. # @param config_file_mode # Adjust permissions for configuration files. # @param config_group # Adjust filesystem group for config files. # @param config_owner # Adjust filesystem owner for config files. # @param conf_template # Define which template to use. # @param daemonize # Have Redis run as a daemon. # @param databases # Set the number of databases. # @param dbfilename # The filename where to dump the DB # @param extra_config_file # Optional extra config file to include # @param hash_max_ziplist_entries # Set max ziplist entries for hashes. # @param hash_max_ziplist_value # Set max ziplist values for hashes. # @param hll_sparse_max_bytes # HyperLogLog sparse representation bytes limit # @param hz # Set redis background tasks frequency # @param latency_monitor_threshold # Latency monitoring threshold in milliseconds # @param list_max_ziplist_entries # Set max ziplist entries for lists. # @param list_max_ziplist_value # Set max ziplist values for lists. # @param log_dir # Specify directory where to write log entries. # @param log_dir_mode # Adjust mode for directory containing log files. # @param log_file # Specify file where to write log entries. # @param log_level # Specify the server verbosity level. # @param masterauth # If the master is password protected (using the "requirepass" configuration # @param maxclients # Set the max number of connected clients at the same time. # @param maxmemory # Don't use more memory than the specified amount of bytes. # @param maxmemory_policy # How Redis will select what to remove when maxmemory is reached. # @param maxmemory_samples # Select as well the sample size to check. # @param min_slaves_max_lag # The lag in seconds # @param min_slaves_to_write # Minimum number of slaves to be in "online" state # @param no_appendfsync_on_rewrite # If you have latency problems turn this to 'true'. Otherwise leave it as # @param notify_keyspace_events # Which events to notify Pub/Sub clients about events happening # @param pid_file # Where to store the pid. # @param port # Configure which port to listen on. # @param protected_mode # Whether protected mode is enabled or not. Only applicable when no bind is set. # @param rdbcompression # Enable/disable compression of string objects using LZF when dumping. # @param repl_backlog_size # The replication backlog size # @param repl_backlog_ttl # The number of seconds to elapse before freeing backlog buffer # @param repl_disable_tcp_nodelay # Enable/disable TCP_NODELAY on the slave socket after SYNC # @param repl_ping_slave_period # Slaves send PINGs to server in a predefined interval. It's possible # @param repl_timeout # Set the replication timeout for: # @param requirepass # Require clients to issue AUTH before processing any other # commands. # @param save_db_to_disk # Set if save db to disk. # @param save_db_to_disk_interval # save the dataset every N seconds if there are at least M changes in the dataset # @param service_name # The service name for this instance # @param service_enable # Enable/disable daemon at boot. # @param service_ensure # Specify if the server should be running. # @param service_group # Specify which group to run as. # @param service_hasrestart # Does the init script support restart? # @param service_hasstatus # Does the init script support status? # @param service_user # Specify which user to run as. # @param 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. # @param slave_priority # The priority number for slave promotion by Sentinel # @param slave_read_only # You can configure a slave instance to accept writes or not. # @param 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. # @param slaveof # Use slaveof to make a Redis instance a copy of another Redis server. # @param slowlog_log_slower_than # Tells Redis what is the execution time, in microseconds, to exceed in order # for the command to get logged. # @param slowlog_max_len # Tells Redis what is the length to exceed in order for the command # to get logged. # @param 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. # @param syslog_enabled # Enable/disable logging to the system logger. # @param syslog_facility # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. # @param tcp_backlog # Sets the TCP backlog # @param tcp_keepalive # TCP keepalive. # @param timeout # Close the connection after a client is idle for N seconds (0 to disable). # @param ulimit # Limit the use of system-wide resources. # @param unixsocket # Define unix socket path # @param unixsocketperm # Define unix socket file permissions # @param workdir # The DB will be written inside this directory, with the filename specified # above using the 'dbfilename' configuration directive. # @param workdir_mode # Adjust mode for data directory. # @param zset_max_ziplist_entries # Set max entries for sorted sets. # @param zset_max_ziplist_value # Set max values for sorted sets. # @param cluster_enabled # Enables redis 3.0 cluster functionality # @param cluster_config_file # Config file for saving cluster nodes configuration. This file is never # touched by humans. Only set if cluster_enabled is true # @param cluster_node_timeout # Node timeout. Only set if cluster_enabled is true # @param cluster_slave_validity_factor # Control variable to disable promoting slave in case of disconnection from # master Only set if cluster_enabled is true # @param cluster_require_full_coverage # 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 # @param cluster_migration_barrier # 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 define redis::instance ( Boolean $activerehashing = $redis::activerehashing, Boolean $aof_load_truncated = $redis::aof_load_truncated, Boolean $aof_rewrite_incremental_fsync = $redis::aof_rewrite_incremental_fsync, String[1] $appendfilename = $redis::appendfilename, Enum['no', 'always', 'everysec'] $appendfsync = $redis::appendfsync, Boolean $appendonly = $redis::appendonly, String[1] $auto_aof_rewrite_min_size = $redis::auto_aof_rewrite_min_size, Integer[0] $auto_aof_rewrite_percentage = $redis::auto_aof_rewrite_percentage, Variant[Stdlib::IP::Address, Array[Stdlib::IP::Address]] $bind = $redis::bind, String[1] $output_buffer_limit_slave = $redis::output_buffer_limit_slave, String[1] $output_buffer_limit_pubsub = $redis::output_buffer_limit_pubsub, String[1] $conf_template = $redis::conf_template, Stdlib::Absolutepath $config_file = $redis::config_file, Stdlib::Filemode $config_file_mode = $redis::config_file_mode, Stdlib::Absolutepath $config_file_orig = $redis::config_file_orig, String[1] $config_group = $redis::config_group, String[1] $config_owner = $redis::config_owner, Boolean $daemonize = true, Integer[1] $databases = $redis::databases, Variant[String[1], Boolean] $dbfilename = $redis::dbfilename, Optional[String] $extra_config_file = $redis::extra_config_file, Integer[0] $hash_max_ziplist_entries = $redis::hash_max_ziplist_entries, Integer[0] $hash_max_ziplist_value = $redis::hash_max_ziplist_value, Integer[0] $hll_sparse_max_bytes = $redis::hll_sparse_max_bytes, Integer[1, 500] $hz = $redis::hz, Integer[0] $latency_monitor_threshold = $redis::latency_monitor_threshold, Integer[0] $list_max_ziplist_entries = $redis::list_max_ziplist_entries, Integer[0] $list_max_ziplist_value = $redis::list_max_ziplist_value, Stdlib::Absolutepath $log_dir = $redis::log_dir, Stdlib::Filemode $log_dir_mode = $redis::log_dir_mode, Redis::LogLevel $log_level = $redis::log_level, String[1] $minimum_version = $redis::minimum_version, Optional[String[1]] $masterauth = $redis::masterauth, Integer[1] $maxclients = $redis::maxclients, $maxmemory = $redis::maxmemory, $maxmemory_policy = $redis::maxmemory_policy, $maxmemory_samples = $redis::maxmemory_samples, Integer[0] $min_slaves_max_lag = $redis::min_slaves_max_lag, Integer[0] $min_slaves_to_write = $redis::min_slaves_to_write, Boolean $no_appendfsync_on_rewrite = $redis::no_appendfsync_on_rewrite, Optional[String[1]] $notify_keyspace_events = $redis::notify_keyspace_events, Boolean $managed_by_cluster_manager = $redis::managed_by_cluster_manager, String[1] $package_ensure = $redis::package_ensure, Stdlib::Port $port = $redis::port, Boolean $protected_mode = $redis::protected_mode, Boolean $rdbcompression = $redis::rdbcompression, String[1] $repl_backlog_size = $redis::repl_backlog_size, Integer[0] $repl_backlog_ttl = $redis::repl_backlog_ttl, Boolean $repl_disable_tcp_nodelay = $redis::repl_disable_tcp_nodelay, Integer[1] $repl_ping_slave_period = $redis::repl_ping_slave_period, Integer[1] $repl_timeout = $redis::repl_timeout, Optional[String] $requirepass = $redis::requirepass, Boolean $save_db_to_disk = $redis::save_db_to_disk, Hash $save_db_to_disk_interval = $redis::save_db_to_disk_interval, String[1] $service_user = $redis::service_user, Integer[0] $set_max_intset_entries = $redis::set_max_intset_entries, Integer[0] $slave_priority = $redis::slave_priority, Boolean $slave_read_only = $redis::slave_read_only, Boolean $slave_serve_stale_data = $redis::slave_serve_stale_data, Optional[String[1]] $slaveof = $redis::slaveof, Integer[0] $slowlog_log_slower_than = $redis::slowlog_log_slower_than, Integer[0] $slowlog_max_len = $redis::slowlog_max_len, Boolean $stop_writes_on_bgsave_error = $redis::stop_writes_on_bgsave_error, Boolean $syslog_enabled = $redis::syslog_enabled, Optional[String[1]] $syslog_facility = $redis::syslog_facility, Integer[0] $tcp_backlog = $redis::tcp_backlog, Integer[0] $tcp_keepalive = $redis::tcp_keepalive, Integer[0] $timeout = $redis::timeout, Variant[Stdlib::Filemode , Enum['']] $unixsocketperm = $redis::unixsocketperm, Integer[0] $ulimit = $redis::ulimit, Stdlib::Filemode $workdir_mode = $redis::workdir_mode, Integer[0] $zset_max_ziplist_entries = $redis::zset_max_ziplist_entries, Integer[0] $zset_max_ziplist_value = $redis::zset_max_ziplist_value, Boolean $cluster_enabled = $redis::cluster_enabled, String[1] $cluster_config_file = $redis::cluster_config_file, Integer[1] $cluster_node_timeout = $redis::cluster_node_timeout, Integer[0] $cluster_slave_validity_factor = $redis::cluster_slave_validity_factor, Boolean $cluster_require_full_coverage = $redis::cluster_require_full_coverage, Integer[0] $cluster_migration_barrier = $redis::cluster_migration_barrier, String[1] $service_name = "redis-server-${name}", Stdlib::Ensure::Service $service_ensure = $redis::service_ensure, Boolean $service_enable = $redis::service_enable, String[1] $service_group = $redis::service_group, Boolean $service_hasrestart = $redis::service_hasrestart, Boolean $service_hasstatus = $redis::service_hasstatus, Boolean $manage_service_file = true, Optional[Stdlib::Absolutepath] $log_file = undef, Stdlib::Absolutepath $pid_file = "/var/run/redis/redis-server-${name}.pid", Variant[Stdlib::Absolutepath, Enum['']] $unixsocket = "/var/run/redis/redis-server-${name}.sock", Stdlib::Absolutepath $workdir = "${redis::workdir}/redis-server-${name}", ) { - if $title == 'default' { $redis_file_name_orig = $config_file_orig $redis_file_name = $config_file } else { $redis_file_name_orig = sprintf('%s/%s.%s', dirname($config_file_orig), $service_name, 'conf.puppet') $redis_file_name = sprintf('%s/%s.%s', dirname($config_file), $service_name, 'conf') } if $log_dir != $redis::log_dir { file { $log_dir: ensure => directory, group => $service_group, mode => $log_dir_mode, owner => $service_user, } } $_real_log_file = $log_file ? { undef => "${log_dir}/redis-server-${name}.log", default => $log_file, } if $workdir != $redis::workdir { file { $workdir: ensure => directory, group => $service_group, mode => $workdir_mode, owner => $service_user, } } if $manage_service_file { $service_provider_lookup = pick(getvar('service_provider'), false) if $service_provider_lookup == 'systemd' { file { "/etc/systemd/system/${service_name}.service": ensure => file, owner => 'root', group => 'root', mode => '0644', content => template('redis/service_templates/redis.service.erb'), } - ~> Exec['systemd-reload-redis'] + + # Only necessary for Puppet < 6.1.0, + # See https://github.com/puppetlabs/puppet/commit/f8d5c60ddb130c6429ff12736bfdb4ae669a9fd4 + if versioncmp($facts['puppetversion'],'6.1.0') < 0 { + include systemd::systemctl::daemon_reload + File["/etc/systemd/system/${service_name}.service"] ~> Class['systemd::systemctl::daemon_reload'] + } if $title != 'default' { service { $service_name: ensure => $service_ensure, enable => $service_enable, hasrestart => $service_hasrestart, hasstatus => $service_hasstatus, subscribe => [ File["/etc/systemd/system/${service_name}.service"], Exec["cp -p ${redis_file_name_orig} ${redis_file_name}"], ], } } } else { file { "/etc/init.d/${service_name}": ensure => file, mode => '0755', content => template("redis/service_templates/redis.${facts['os']['family']}.erb"), } if $title != 'default' { service { $service_name: ensure => $service_ensure, enable => $service_enable, hasrestart => $service_hasrestart, hasstatus => $service_hasstatus, subscribe => [ File["/etc/init.d/${service_name}"], Exec["cp -p ${redis_file_name_orig} ${redis_file_name}"], ], } } } } File { owner => $config_owner, group => $config_group, mode => $config_file_mode, } file {$redis_file_name_orig: ensure => file, } exec {"cp -p ${redis_file_name_orig} ${redis_file_name}": path => '/usr/bin:/bin', subscribe => File[$redis_file_name_orig], refreshonly => true, } $bind_arr = [$bind].flatten if $package_ensure =~ /^([0-9]+:)?[0-9]+\.[0-9]/ { if ':' in $package_ensure { $_redis_version_real = split($package_ensure, ':') $redis_version_real = $_redis_version_real[1] } else { $redis_version_real = $package_ensure } } else { $redis_version_real = pick(getvar('redis_server_version'), $minimum_version) } $supports_protected_mode = !$redis_version_real or versioncmp($redis_version_real, '3.2.0') >= 0 File[$redis_file_name_orig] { content => template($conf_template) } } diff --git a/manifests/ulimit.pp b/manifests/ulimit.pp index dc48da9..f7fa88f 100644 --- a/manifests/ulimit.pp +++ b/manifests/ulimit.pp @@ -1,75 +1,78 @@ # 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 not required as it's a # private class only referencable from # the redis module, where the variables # would already be defined # # @example # contain redis::ulimit # # @author - Peter Souter # # @api private class redis::ulimit { assert_private('The redis::ulimit class is only to be called from the redis::config class') $service_provider_lookup = pick(getvar('service_provider'), false) if $redis::managed_by_cluster_manager { file { '/etc/security/limits.d/redis.conf': ensure => 'file', owner => 'root', group => 'root', mode => '0644', content => "redis soft nofile ${redis::ulimit}\nredis hard nofile ${redis::ulimit}\n", } } if $service_provider_lookup == 'systemd' { file { "/etc/systemd/system/${redis::service_name}.service.d/": ensure => 'directory', owner => 'root', group => 'root', selinux_ignore_defaults => true, } file { "/etc/systemd/system/${redis::service_name}.service.d/limit.conf": ensure => file, owner => 'root', group => 'root', mode => '0444', } augeas { 'Systemd redis ulimit' : incl => "/etc/systemd/system/${redis::service_name}.service.d/limit.conf", lens => 'Systemd.lns', changes => [ "defnode nofile Service/LimitNOFILE \"\"", "set \$nofile/value \"${redis::ulimit}\"", ], - notify => [ - Exec['systemd-reload-redis'], - ], + } + # Only necessary for Puppet < 6.1.0, + # See https://github.com/puppetlabs/puppet/commit/f8d5c60ddb130c6429ff12736bfdb4ae669a9fd4 + if versioncmp($facts['puppetversion'],'6.1.0') < 0 { + include systemd::systemctl::daemon_reload + Augeas['Systemd redis ulimit'] ~> Class['systemd::systemctl::daemon_reload'] } } else { case $facts['os']['family'] { 'Debian': { augeas { 'redis ulimit': context => '/files/etc/default/redis-server', changes => "set ULIMIT ${redis::ulimit}", } } 'RedHat': { augeas { 'redis ulimit': context => '/files/etc/sysconfig/redis', changes => "set ULIMIT ${redis::ulimit}", } } default: { warning("Not sure how to set ULIMIT on non-systemd OSFamily ${facts['os']['family']}, PR's welcome") } } } } diff --git a/spec/acceptance/suites/default/redis_multi_instances_one_host_spec.rb b/spec/acceptance/suites/default/redis_multi_instances_one_host_spec.rb index f727621..9d01b46 100644 --- a/spec/acceptance/suites/default/redis_multi_instances_one_host_spec.rb +++ b/spec/acceptance/suites/default/redis_multi_instances_one_host_spec.rb @@ -1,62 +1,77 @@ require 'spec_helper_acceptance' -describe 'redis::instance' do +describe 'redis::instance example' do + instances = [6379, 6380, 6381, 6382] case fact('osfamily') when 'Debian' config_path = '/etc/redis' redis_name = 'redis-server' else - redis_name = 'redis' config_path = '/etc' + redis_name = 'redis' end it 'runs successfully' do pp = <<-EOS - class { 'redis': + $listening_ports = #{instances} + + class { '::redis': default_install => false, + service_enable => false, + service_ensure => 'stopped', } - redis::instance {'redis1': - port => 7777, + $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'], + } } - redis::instance {'redis2': - port => 8888, - } EOS # Apply twice to ensure no errors the second time. apply_manifest(pp, catch_failures: true) apply_manifest(pp, catch_changes: true) end describe package(redis_name) do it { is_expected.to be_installed } end - describe service('redis-server-redis1') do - it { is_expected.to be_running } + describe service(redis_name) do + it { is_expected.not_to be_enabled } + it { is_expected.not_to be_running } end - describe service('redis-server-redis2') do - it { is_expected.to be_running } - end + instances.each do |instance| + describe file("/etc/systemd/system/redis-server-#{instance}.service"), if: (fact('service_provider') == 'systemd') do + its(:content) { is_expected.to match %r{redis-server-#{instance}.conf} } + end - describe file("#{config_path}/redis-server-redis1.conf") do - its(:content) { is_expected.to match %r{port 7777} } - end + describe service("redis-server-#{instance}") do + it { is_expected.to be_enabled } + end - describe file("#{config_path}/redis-server-redis2.conf") do - its(:content) { is_expected.to match %r{port 8888} } - end + describe service("redis-server-#{instance}") do + it { is_expected.to be_running } + end - context 'redis should respond to ping command' do - describe command('redis-cli -h 127.0.0.1 -p 7777 ping') do - its(:stdout) { is_expected.to match %r{PONG} } + describe file("#{config_path}/redis-server-#{instance}.conf") do + its(:content) { is_expected.to match %r{port #{instance}} } end - describe command('redis-cli -h 127.0.0.1 -p 8888 ping') do - its(:stdout) { is_expected.to match %r{PONG} } + context "redis instance #{instance} should respond to ping command" do + describe command("redis-cli -h #{fact('networking.ip')} -p #{instance} ping") do + its(:stdout) { is_expected.to match %r{PONG} } + end end end end diff --git a/spec/classes/redis_spec.rb b/spec/classes/redis_spec.rb index eb7e0f7..0bec532 100644 --- a/spec/classes/redis_spec.rb +++ b/spec/classes/redis_spec.rb @@ -1,1367 +1,1415 @@ require 'spec_helper' describe 'redis' do let(:service_file) { redis_service_file(service_provider: facts['service_provider']) } let(:package_name) { manifest_vars[:package_name] } let(:service_name) { manifest_vars[:service_name] } + let(:config_file) { manifest_vars[:config_file] } let(:config_file_orig) { manifest_vars[:config_file_orig] } on_supported_os.each do |os, facts| context "on #{os}" do let(:facts) { facts } + if facts[:operatingsystem] == 'Ubuntu' && facts[:operatingsystemmajrelease] == '16.04' + let(:systemd) { '' } + let(:servicetype) { 'forking' } + else + let(:systemd) { ' --supervised systemd' } + let(:servicetype) { 'notify' } + end + describe 'without parameters' do it { is_expected.to compile.with_all_deps } it { is_expected.to create_class('redis') } it { is_expected.to contain_class('redis::preinstall') } it { is_expected.to contain_class('redis::install') } it { is_expected.to contain_class('redis::config') } it { is_expected.to contain_class('redis::service') } it { is_expected.to contain_package(package_name).with_ensure('present') } it do is_expected.to contain_file(config_file_orig). with_ensure('file'). without_content(%r{undef}) if facts[:osfamily] == 'FreeBSD' is_expected.to contain_file(config_file_orig). with_content(%r{dir /var/db/redis}). with_content(%r{pidfile /var/run/redis/redis\.pid}) end end it do is_expected.to contain_service(service_name).with( 'ensure' => 'running', 'enable' => 'true', 'hasrestart' => 'true', 'hasstatus' => 'true' ) end context 'with SCL', if: facts[:osfamily] == 'RedHat' do let(:pre_condition) do <<-PUPPET class { 'redis::globals': scl => 'rh-redis5', } PUPPET end it { is_expected.to compile.with_all_deps } it do is_expected.to create_class('redis'). with_package_name('rh-redis5-redis'). with_config_file('/etc/opt/rh/rh-redis5/redis.conf'). with_service_name('rh-redis5-redis') end context 'manage_repo => true', if: facts[:operatingsystem] == 'CentOS' do let(:params) { { manage_repo: true } } it { is_expected.to compile.with_all_deps } it { is_expected.to contain_package('centos-release-scl-rh') } end end end context 'with managed_by_cluster_manager true' do let(:params) { { managed_by_cluster_manager: true } } it { is_expected.to compile.with_all_deps } it do is_expected.to contain_file('/etc/security/limits.d/redis.conf').with( 'ensure' => 'file', 'owner' => 'root', 'group' => 'root', 'mode' => '0644', 'content' => "redis soft nofile 65536\nredis hard nofile 65536\n" ) end context 'when not managing service' do let(:params) { super().merge(service_manage: false, notify_service: false) } it { is_expected.to compile.with_all_deps } it do is_expected.to contain_file('/etc/security/limits.d/redis.conf').with( 'ensure' => 'file', 'owner' => 'root', 'group' => 'root', 'mode' => '0644', 'content' => "redis soft nofile 65536\nredis hard nofile 65536\n" ) end end end context 'with ulimit' do let(:params) { { ulimit: 7777 } } it { is_expected.to compile.with_all_deps } it do if facts['service_provider'] == 'systemd' is_expected.to contain_file("/etc/systemd/system/#{service_name}.service.d/limit.conf"). with_ensure('file'). with_owner('root'). with_group('root'). with_mode('0444') - is_expected.to contain_augeas('Systemd redis ulimit'). - with_incl("/etc/systemd/system/#{service_name}.service.d/limit.conf"). - with_lens('Systemd.lns'). - with_changes(['defnode nofile Service/LimitNOFILE ""', 'set $nofile/value "7777"']). - that_notifies('Exec[systemd-reload-redis]') + # Only necessary for Puppet < 6.1.0, + # See https://github.com/puppetlabs/puppet/commit/f8d5c60ddb130c6429ff12736bfdb4ae669a9fd4 + if Puppet.version < '6.1' + is_expected.to contain_augeas('Systemd redis ulimit'). + with_incl("/etc/systemd/system/#{service_name}.service.d/limit.conf"). + with_lens('Systemd.lns'). + with_changes(['defnode nofile Service/LimitNOFILE ""', 'set $nofile/value "7777"']). + that_notifies('Class[systemd::systemctl::daemon_reload]') + else + is_expected.to contain_augeas('Systemd redis ulimit'). + with_incl("/etc/systemd/system/#{service_name}.service.d/limit.conf"). + with_lens('Systemd.lns'). + with_changes(['defnode nofile Service/LimitNOFILE ""', 'set $nofile/value "7777"']) + end else is_expected.not_to contain_file('/etc/systemd/system/redis-server.service.d/limit.conf') is_expected.not_to contain_augeas('Systemd redis ulimit') if %w[Debian RedHat].include?(facts[:osfamily]) ulimit_context = case facts[:osfamily] when 'Debian' '/files/etc/default/redis-server' when 'RedHat' '/files/etc/sysconfig/redis' end if ulimit_context is_expected.to contain_augeas('redis ulimit'). with_changes('set ULIMIT 7777'). with_context(ulimit_context) else is_expected.not_to contain_augeas('redis ulimit') end end end end end describe 'with parameter activerehashing' do let(:params) do { activerehashing: true } end it { is_expected.to contain_file(config_file_orig).with_content(%r{activerehashing.*yes}) } end describe 'with parameter aof_load_truncated' do let(:params) do { aof_load_truncated: true } end it { is_expected.to contain_file(config_file_orig).with_content(%r{aof-load-truncated.*yes}) } end describe 'with parameter aof_rewrite_incremental_fsync' do let(:params) do { aof_rewrite_incremental_fsync: true } end it { is_expected.to contain_file(config_file_orig).with_content(%r{aof-rewrite-incremental-fsync.*yes}) } end describe 'with parameter appendfilename' do let(:params) do { appendfilename: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with_content(%r{appendfilename.*_VALUE_}) } end describe 'with parameter appendfsync' do let(:params) do { appendfsync: 'no' } end it { is_expected.to contain_file(config_file_orig).with_content(%r{^appendfsync no$}) } end describe 'with parameter appendonly' do let(:params) do { appendonly: true } end it { is_expected.to contain_file(config_file_orig).with_content(%r{appendonly.*yes}) } end describe 'with parameter auto_aof_rewrite_min_size' do let(:params) do { auto_aof_rewrite_min_size: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with_content(%r{auto-aof-rewrite-min-size.*_VALUE_}) } end describe 'with parameter auto_aof_rewrite_percentage' do let(:params) do { auto_aof_rewrite_percentage: 75 } end it { is_expected.to contain_file(config_file_orig).with_content(%r{auto-aof-rewrite-percentage 75}) } end describe 'parameter bind' do context 'by default' do it 'binds to localhost' do is_expected.to contain_file(config_file_orig).with_content(%r{bind 127\.0\.0\.1$}) end end context 'with a single IP address' do let(:params) { { bind: '10.0.0.1' } } it { is_expected.to contain_file(config_file_orig).with_content(%r{bind 10\.0\.0\.1$}) } end context 'with array of IP addresses' do let(:params) do { bind: ['127.0.0.1', '::1'] } end it { is_expected.to contain_file(config_file_orig).with_content(%r{bind 127\.0\.0\.1 ::1}) } end context 'with empty array' do let(:params) { { bind: [] } } it { is_expected.not_to contain_file(config_file_orig).with_content(%r{^bind}) } end end describe 'with parameter output_buffer_limit_slave' do let(:params) do { output_buffer_limit_slave: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with_content(%r{client-output-buffer-limit slave.*_VALUE_}) } end describe 'with parameter output_buffer_limit_pubsub' do let(:params) do { output_buffer_limit_pubsub: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with_content(%r{client-output-buffer-limit pubsub.*_VALUE_}) } end describe 'with parameter: config_dir' do let(:params) { { config_dir: '/etc/config_dir' } } it { is_expected.to contain_file('/etc/config_dir').with_ensure('directory') } end describe 'with parameter: config_dir_mode' do let(:params) { { config_dir_mode: '0700' } } it { is_expected.to contain_file('/etc/redis').with_mode('0700') } end describe 'with parameter: log_dir_mode' do let(:params) { { log_dir_mode: '0660' } } it { is_expected.to contain_file('/var/log/redis').with_mode('0660') } end describe 'with parameter: config_file_orig' do let(:params) { { config_file_orig: '/path/to/orig' } } it { is_expected.to contain_file('/path/to/orig') } end describe 'with parameter: config_file_mode' do let(:params) { { config_file_mode: '0600' } } it { is_expected.to contain_file(config_file_orig).with_mode('0600') } end describe 'with parameter: config_group' do let(:params) { { config_group: '_VALUE_' } } it { is_expected.to contain_file('/etc/redis').with_group('_VALUE_') } end describe 'with parameter: config_owner' do let(:params) { { config_owner: '_VALUE_' } } it { is_expected.to contain_file('/etc/redis').with_owner('_VALUE_') } end describe 'with parameter daemonize' do let(:params) do { daemonize: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{daemonize.*yes} ) } end describe 'with parameter databases' do let(:params) do { databases: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{databases 42} ) } end describe 'with parameter dbfilename' do let(:params) do { dbfilename: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{dbfilename.*_VALUE_} ) } end describe 'without parameter dbfilename' do let(:params) do { dbfilename: false } end it { is_expected.to contain_file(config_file_orig).without_content(%r{^dbfilename}) } end describe 'with parameter hash_max_ziplist_entries' do let(:params) do { hash_max_ziplist_entries: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{hash-max-ziplist-entries 42} ) } end describe 'with parameter hash_max_ziplist_value' do let(:params) do { hash_max_ziplist_value: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{hash-max-ziplist-value 42} ) } end # TODO: Only present in 3.0 describe 'with parameter list_max_ziplist_entries' do let(:params) do { list_max_ziplist_entries: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{list-max-ziplist-entries 42} ) } end describe 'with parameter list_max_ziplist_value' do let(:params) do { list_max_ziplist_value: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{list-max-ziplist-value 42} ) } end describe 'with parameter log_dir' do let(:params) do { log_dir: '/var/log/redis' } end it { is_expected.to contain_file('/var/log/redis').with( 'ensure' => 'directory' ) } end describe 'with parameter log_file' do let(:params) do { log_file: '/var/log/redis/redis.log' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^logfile /var/log/redis/redis\.log$} ) } end describe 'with parameter log_level' do let(:params) do { log_level: 'debug' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^loglevel debug$} ) } end describe 'with parameter: manage_repo' do let(:params) { { manage_repo: true } } case facts[:operatingsystem] when 'Debian' context 'on Debian' do it do is_expected.to create_apt__source('dotdeb').with(location: 'http://packages.dotdeb.org/', repos: 'all', key: { 'id' => '6572BBEF1B5FF28B28B706837E3F070089DF5277', 'source' => 'http://www.dotdeb.org/dotdeb.gpg' }, include: { 'src' => true }) end end when 'Ubuntu' it { is_expected.to contain_apt__ppa('ppa:chris-lea/redis-server') } when 'RedHat', 'CentOS', 'Scientific', 'OEL', 'Amazon' it { is_expected.to contain_class('epel') } end end describe 'with parameter unixsocket' do describe '/tmp/redis.sock' do let(:params) { { unixsocket: '/tmp/redis.sock' } } it { is_expected.to contain_file(config_file_orig).with_content(%r{^unixsocket /tmp/redis\.sock$}) } end describe 'empty string' do let(:params) { { unixsocket: '' } } it { is_expected.to contain_file(config_file_orig).without_content(%r{^unixsocket }) } end end describe 'with parameter unixsocketperm' do describe '777' do let(:params) { { unixsocketperm: '777' } } it { is_expected.to contain_file(config_file_orig).with_content(%r{^unixsocketperm 777$}) } end describe 'empty string' do let(:params) { { unixsocketperm: '' } } it { is_expected.to contain_file(config_file_orig).without_content(%r{^unixsocketperm }) } end end describe 'with parameter masterauth' do let(:params) do { masterauth: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{masterauth.*_VALUE_} ) } end describe 'with parameter maxclients' do let(:params) do { maxclients: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^maxclients 42$} ) } end describe 'with parameter maxmemory' do let(:params) do { maxmemory: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{maxmemory.*_VALUE_} ) } end describe 'with parameter maxmemory_policy' do let(:params) do { maxmemory_policy: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{maxmemory-policy.*_VALUE_} ) } end describe 'with parameter maxmemory_samples' do let(:params) do { maxmemory_samples: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{maxmemory-samples.*_VALUE_} ) } end describe 'with parameter min_slaves_max_lag' do let(:params) do { min_slaves_max_lag: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^min-slaves-max-lag 42$} ) } end describe 'with parameter min_slaves_to_write' do let(:params) do { min_slaves_to_write: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^min-slaves-to-write 42$} ) } end describe 'with parameter notify_keyspace_events' do let(:params) do { notify_keyspace_events: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{notify-keyspace-events.*_VALUE_} ) } end describe 'with parameter notify_service' do let(:params) do { notify_service: true } end it { is_expected.to contain_file(config_file_orig).that_notifies("Service[#{service_name}]") } end describe 'with parameter no_appendfsync_on_rewrite' do let(:params) do { no_appendfsync_on_rewrite: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{no-appendfsync-on-rewrite.*yes} ) } end describe 'with parameter: package_ensure' do let(:params) { { package_ensure: '_VALUE_' } } it { is_expected.to contain_package(package_name).with( 'ensure' => '_VALUE_' ) } end describe 'with parameter: package_name' do let(:params) { { package_name: '_VALUE_' } } it { is_expected.to contain_package('_VALUE_') } end describe 'with parameter pid_file' do let(:params) do { pid_file: '/path/to/redis.pid' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^pidfile /path/to/redis.pid$} ) } end describe 'with parameter port' do let(:params) do { port: 6666 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^port 6666$} ) } end describe 'with parameter protected-mode' do let(:params) do { protected_mode: false } end it do if facts[:operatingsystem] == 'Ubuntu' && facts[:operatingsystemmajrelease] == '16.04' is_expected.not_to contain_file(config_file_orig).with_content(%r{protected-mode}) else is_expected.to contain_file(config_file_orig).with_content(%r{^protected-mode no$}) end end end describe 'with parameter hll_sparse_max_bytes' do let(:params) do { hll_sparse_max_bytes: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^hll-sparse-max-bytes 42$} ) } end describe 'with parameter hz' do let(:params) do { hz: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^hz 42$} ) } end describe 'with parameter latency_monitor_threshold' do let(:params) do { latency_monitor_threshold: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^latency-monitor-threshold 42$} ) } end describe 'with parameter rdbcompression' do let(:params) do { rdbcompression: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{rdbcompression.*yes} ) } end describe 'with parameter repl_backlog_size' do let(:params) do { repl_backlog_size: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{repl-backlog-size.*_VALUE_} ) } end describe 'with parameter repl_backlog_ttl' do let(:params) do { repl_backlog_ttl: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^repl-backlog-ttl 42$} ) } end describe 'with parameter repl_disable_tcp_nodelay' do let(:params) do { repl_disable_tcp_nodelay: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{repl-disable-tcp-nodelay.*yes} ) } end describe 'with parameter repl_ping_slave_period' do let(:params) do { repl_ping_slave_period: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^repl-ping-slave-period 42} ) } end describe 'with parameter repl_timeout' do let(:params) do { repl_timeout: 1 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{repl-timeout.*1} ) } end describe 'with parameter requirepass' do let(:params) do { requirepass: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{requirepass.*_VALUE_} ) } end describe 'with parameter save_db_to_disk' do context 'true' do let(:params) do { save_db_to_disk: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^save} ) } end context 'false' do let(:params) do { save_db_to_disk: false } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^(?!save)} ) } end end describe 'with parameter save_db_to_disk_interval' do context 'with save_db_to_disk true' do context 'default' do let(:params) do { save_db_to_disk: true } end it { is_expected.to contain_file(config_file_orig).with('content' => %r{save 900 1}) } it { is_expected.to contain_file(config_file_orig).with('content' => %r{save 300 10}) } it { is_expected.to contain_file(config_file_orig).with('content' => %r{save 60 10000}) } end context 'default' do let(:params) do { save_db_to_disk: true, save_db_to_disk_interval: { '900' => '2', '300' => '11', '60' => '10011' } } end it { is_expected.to contain_file(config_file_orig).with('content' => %r{save 900 2}) } it { is_expected.to contain_file(config_file_orig).with('content' => %r{save 300 11}) } it { is_expected.to contain_file(config_file_orig).with('content' => %r{save 60 10011}) } end end context 'with save_db_to_disk false' do context 'default' do let(:params) do { save_db_to_disk: false } end it { is_expected.to contain_file(config_file_orig).without('content' => %r{save 900 1}) } it { is_expected.to contain_file(config_file_orig).without('content' => %r{save 300 10}) } it { is_expected.to contain_file(config_file_orig).without('content' => %r{save 60 10000}) } end end end describe 'with parameter: service_manage (set to false)' do let(:params) { { service_manage: false } } it { is_expected.not_to contain_service(package_name) } end describe 'with parameter: service_enable' do let(:params) { { service_enable: true } } it { is_expected.to contain_service(package_name).with_enable(true) } end describe 'with parameter: service_ensure' do let(:params) { { service_ensure: 'stopped' } } it { is_expected.to contain_service(package_name).with_ensure('stopped') } end describe 'with parameter: service_group' do let(:params) { { service_group: '_VALUE_' } } it { is_expected.to contain_file('/var/log/redis').with_group('_VALUE_') } end describe 'with parameter: service_hasrestart' do let(:params) { { service_hasrestart: true } } it { is_expected.to contain_service(package_name).with_hasrestart(true) } end describe 'with parameter: service_hasstatus' do let(:params) { { service_hasstatus: true } } it { is_expected.to contain_service(package_name).with_hasstatus(true) } end describe 'with parameter: service_name' do let(:params) { { service_name: '_VALUE_' } } it { is_expected.to contain_service('_VALUE_').with_name('_VALUE_') } end describe 'with parameter: service_user' do let(:params) { { service_user: '_VALUE_' } } it { is_expected.to contain_file('/var/log/redis').with_owner('_VALUE_') } end describe 'with parameter set_max_intset_entries' do let(:params) do { set_max_intset_entries: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^set-max-intset-entries 42$} ) } end describe 'with parameter slave_priority' do let(:params) do { slave_priority: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^slave-priority 42$} ) } end describe 'with parameter slave_read_only' do let(:params) do { slave_read_only: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{slave-read-only.*yes} ) } end describe 'with parameter slave_serve_stale_data' do let(:params) do { slave_serve_stale_data: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{slave-serve-stale-data.*yes} ) } end describe 'with parameter: slaveof' do context 'binding to localhost' do let(:params) do { bind: '127.0.0.1', slaveof: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^slaveof _VALUE_} ) } end context 'binding to external ip' do let(:params) do { bind: '10.0.0.1', slaveof: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^slaveof _VALUE_} ) } end end describe 'with parameter slowlog_log_slower_than' do let(:params) do { slowlog_log_slower_than: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^slowlog-log-slower-than 42$} ) } end describe 'with parameter slowlog_max_len' do let(:params) do { slowlog_max_len: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^slowlog-max-len 42$} ) } end describe 'with parameter stop_writes_on_bgsave_error' do let(:params) do { stop_writes_on_bgsave_error: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{stop-writes-on-bgsave-error.*yes} ) } end describe 'with parameter syslog_enabled' do let(:params) do { syslog_enabled: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{syslog-enabled yes} ) } end describe 'with parameter syslog_facility' do let(:params) do { syslog_enabled: true, syslog_facility: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{syslog-facility.*_VALUE_} ) } end describe 'with parameter tcp_backlog' do let(:params) do { tcp_backlog: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^tcp-backlog 42$} ) } end describe 'with parameter tcp_keepalive' do let(:params) do { tcp_keepalive: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^tcp-keepalive 42$} ) } end describe 'with parameter timeout' do let(:params) do { timeout: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^timeout 42$} ) } end describe 'with parameter workdir' do let(:params) do { workdir: '/var/workdir' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{^dir /var/workdir$} ) } end describe 'with parameter zset_max_ziplist_entries' do let(:params) do { zset_max_ziplist_entries: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{zset-max-ziplist-entries 42} ) } end describe 'with parameter zset_max_ziplist_value' do let(:params) do { zset_max_ziplist_value: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{zset-max-ziplist-value 42} ) } end describe 'with parameter cluster_enabled-false' do let(:params) do { cluster_enabled: false } end it { is_expected.not_to contain_file(config_file_orig).with( 'content' => %r{cluster-enabled} ) } end describe 'with parameter cluster_enabled-true' do let(:params) do { cluster_enabled: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{cluster-enabled.*yes} ) } end describe 'with parameter cluster_config_file' do let(:params) do { cluster_enabled: true, cluster_config_file: '_VALUE_' } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{cluster-config-file.*_VALUE_} ) } end describe 'with parameter cluster_config_file' do let(:params) do { cluster_enabled: true, cluster_node_timeout: 42 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{cluster-node-timeout 42} ) } end describe 'with parameter cluster_config_file' do let(:params) do { cluster_enabled: true, cluster_slave_validity_factor: 1 } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{cluster-slave-validity-factor.*1} ) } end describe 'with parameter cluster_config_file' do let(:params) do { cluster_enabled: true, cluster_require_full_coverage: true } end it { is_expected.to contain_file(config_file_orig).with( 'content' => %r{cluster-require-full-coverage.*yes} ) } end describe 'with parameter cluster_config_file' do let(:params) do { cluster_enabled: true, cluster_require_full_coverage: false } end it { is_expected.to contain_file(config_file_orig).with_content(%r{cluster-require-full-coverage.*no}) } end describe 'with parameter cluster_config_file' do let(:params) do { cluster_enabled: true, cluster_migration_barrier: 1 } end it { is_expected.to contain_file(config_file_orig).with_content(%r{cluster-migration-barrier.*1}) } end describe 'with parameter manage_service_file' do let(:params) do { manage_service_file: true } end it { is_expected.to contain_file(service_file) } + + it do + content = <<-END.gsub(%r{^\s+\|}, '') + |[Unit] + |Description=Redis Advanced key-value store for instance default + |After=network.target + |After=network-online.target + |Wants=network-online.target + | + |[Service] + |RuntimeDirectory=redis + |RuntimeDirectoryMode=2755 + |Type=#{servicetype} + |ExecStart=/usr/bin/redis-server #{config_file}#{systemd} + |ExecStop=/usr/bin/redis-server -p 6379 shutdown + |Restart=always + |User=redis + |Group=redis + |LimitNOFILE=65536 + | + |[Install] + |WantedBy=multi-user.target + END + + if facts['service_provider'] == 'systemd' + is_expected.to contain_file(service_file).with_content(content) + else + is_expected.to contain_file(service_file).with_content(%r{Required-Start:}) + end + end end describe 'with parameter manage_service_file' do let(:params) do { manage_service_file: false } end it { is_expected.not_to contain_file(service_file) } end context 'when $::redis_server_version fact is not present' do let(:facts) { super().merge(redis_server_version: nil) } context 'when package_ensure is version (3.2.1)' do let(:params) { { package_ensure: '3.2.1' } } it { is_expected.to contain_file(config_file_orig).with_content(%r{^protected-mode}) } end context 'when package_ensure is a newer version(4.0-rc3) (older features enabled)' do let(:params) { { package_ensure: '4.0-rc3' } } it { is_expected.to contain_file(config_file_orig).with_content(%r{^protected-mode}) } end end context 'when $::redis_server_version fact is present but a newer version (older features enabled)' do let(:facts) { super().merge(redis_server_version: '3.2.1') } it { is_expected.to contain_file(config_file_orig).with_content(%r{^protected-mode}) } end end end end diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb index fcc7d0a..8ef29a3 100644 --- a/spec/spec_helper_acceptance.rb +++ b/spec/spec_helper_acceptance.rb @@ -1,24 +1,25 @@ require 'beaker-rspec' require 'beaker/puppet_install_helper' require 'beaker/module_install_helper' run_puppet_install_helper unless ENV['BEAKER_provision'] == 'no' install_module_on(hosts) install_module_dependencies_on(hosts) +install_module_from_forge('camptocamp/systemd', '>= 2.0.0 < 3.0.0') RSpec.configure do |c| # Readable test descriptions c.formatter = :documentation c.before :suite do hosts.each do |host| case fact_on(host, 'operatingsystem') when 'CentOS' host.install_package('epel-release') when 'Ubuntu' host.install_package('software-properties-common') end host.install_package('puppet-bolt') end end end diff --git a/templates/service_templates/redis.service.erb b/templates/service_templates/redis.service.erb index 1567e21..63b71c4 100644 --- a/templates/service_templates/redis.service.erb +++ b/templates/service_templates/redis.service.erb @@ -1,17 +1,25 @@ [Unit] -Description=Advanced key-value store for <%= @title %> +Description=Redis Advanced key-value store for instance <%= @title %> After=network.target +After=network-online.target +Wants=network-online.target [Service] RuntimeDirectory=redis RuntimeDirectoryMode=2755 +<%# Redis on Xenial is too old for systemd integration -%> +<% if @facts['os']['name'] == 'Ubuntu' and @facts['os']['release']['major'] == '16.04' -%> Type=forking ExecStart=/usr/bin/redis-server <%= @redis_file_name %> +<% else -%> +Type=notify +ExecStart=/usr/bin/redis-server <%= @redis_file_name %> --supervised systemd +<% end -%> ExecStop=/usr/bin/redis-server -p <%= @port %> shutdown -TimeoutStopSec=0 Restart=always User=<%= @service_user %> Group=<%= @service_user %> +LimitNOFILE=<%= @ulimit %> [Install] WantedBy=multi-user.target