diff --git a/README.md b/README.md index 934e7e9..269a0f0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # DESCRIPTION: -Installs Redis. Redis is an open source, advanced key-value store. +Installs Redis. Redis is an open source, advanced key-value store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets and sorted sets. @@ -14,21 +14,82 @@ Currently tested on Ubuntu 10.04 ONLY. # ATTRIBUTES: - ['redis']['bind'] # "127.0.0.1" - ['redis']['port'] # "6379" - ['redis']['config_path'] # "/etc/redis/redis.conf" - ['redis']['daemonize'] # "no" - ['redis']['timeout'] # "300" - ['redis']['loglevel'] # "notice" - ['redis']['password'] # nil - - ['redis']['source']['version'] # "2.4.1" - ['redis']['source']['prefix'] # "/usr/local" - ['redis']['source']['tar_url'] # "http://redis.googlecode.com/files/redis-2.4.1.tar.gz" - ['redis']['source']['tar_checksum'] # "38e02..." - ['redis']['source']['create_service'] # true - ['redis']['source']['user'] # "redis" - ['redis']['source']['group'] # "redis" + ['redis']['config_path'] # "/etc/redis/redis.conf" + ['redis']['daemonize'] # "no" + ['redis']['pidfile'] # "/var/run/redis.pid" + ['redis']['port'] # "6379" + ['redis']['bind'] # "127.0.0.1" + ['redis']['unixsocket'] # nil + ['redis']['unixsocketperm'] # nil + ['redis']['timeout'] # "300" + ['redis']['loglevel'] # "notice" + ['redis']['logfile'] # "/var/log/redis/redis-server.log" + ['redis']['syslog-enabled'] # "no" + ['redis']['syslog-ident'] # "redis" + ['redis']['syslog-facility'] # "local0" + ['redis']['databases'] # 16 + ['redis']['save'] # { 900 => 1, 300 => 10, 60 => 1000 + ['redis']['rdbcompression'] # "yes"} + ['redis']['dbfilename'] # "dump.rdb" + ['redis']['dir'] # "/var/lib/redis" + +### Replication + + ['redis']['slaveof']['ip'] # nil + ['redis']['slaveof']['port'] # nil + ['redis']['masterauth'] # nil + ['redis']['slave-serve-stale-data'] # "yes" + ['redis']['repl-ping-slave-period'] # 10 + +### Security + + ['redis']['password'] # nil + ['redis']['rename-command'] # { } + +### Limits + + ['redis']['maxclients'] # nil + ['redis']['maxmemory'] # nil + ['redis']['maxmemory-policy'] # nil + +### Append Only Mode + + ['redis']['appendonly'] # "no" + ['redis']['appendfsync'] # "everysec" (everysec, always, no) + ['redis']['no-appendfsync-on-rewrite'] # "no" + ['redis']['auto-aof-rewrite-percentage'] # 100 + ['redis']['auto-aof-rewrite-min-size'] # "64mb" + +### Slow Log + + ['redis']['slowlog-log-slower-than'] # 10000 + ['redis']['slowlog-max-len'] # 128 + +### Advanced Options + + ['redis']['hash-max-zipmap-entries'] # 512 + ['redis']['hash-max-zipmap-value'] # 64 + ['redis']['list-max-ziplist-entries'] # 512 + ['redis']['list-max-ziplist-value'] # 64 + ['redis']['set-max-intset-entries'] # 512 + ['redis']['zset-max-ziplist-entries'] # 128 + ['redis']['zset-max-ziplist-value'] # 64 + ['redis']['activerehashing'] # "yes" + ['redis']['include'] # [ ] + +### Compile From Source Options + + ['redis']['source']['version'] # "2.4.1" + ['redis']['source']['prefix'] # "/usr/local" + ['redis']['source']['tar_url'] # "http://redis.googlecode.com/files/redis-2.4.1.tar.gz" + ['redis']['source']['tar_checksum'] # "38e02..." + ['redis']['source']['create_service'] # true + ['redis']['source']['user'] # "redis" + ['redis']['source']['group'] # "redis" + +### Gem Options + + ['redis']['gem']['packages'] # "redis" # USAGE: diff --git a/attributes/default.rb b/attributes/default.rb index b1f923a..162297d 100644 --- a/attributes/default.rb +++ b/attributes/default.rb @@ -17,10 +17,60 @@ # See the License for the specific language governing permissions and # limitations under the License. -default['redis']['bind'] = "127.0.0.1" -default['redis']['port'] = "6379" -default['redis']['config_path'] = "/etc/redis/redis.conf" -default['redis']['daemonize'] = "no" -default['redis']['timeout'] = "300" -default['redis']['loglevel'] = "notice" -default['redis']['password'] = nil +# Global Options +default['redis']['config_path'] = "/etc/redis/redis.conf" +default['redis']['daemonize'] = "no" +default['redis']['pidfile'] = "/var/run/redis.pid" +default['redis']['port'] = "6379" +default['redis']['bind'] = "127.0.0.1" +default['redis']['unixsocket'] = nil +default['redis']['unixsocketperm'] = nil +default['redis']['timeout'] = "300" +default['redis']['loglevel'] = "notice" +default['redis']['logfile'] = "/var/log/redis/redis-server.log" +default['redis']['syslog-enabled'] = "no" +default['redis']['syslog-ident'] = "redis" +default['redis']['syslog-facility'] = "LOCAL0" +default['redis']['databases'] = 16 +default['redis']['save'] = {} #{ 900 => 1, 300 => 10, 60 => 1000 } +default['redis']['rdbcompression'] = "yes" +default['redis']['dbfilename'] = "dump.rdb" +default['redis']['dir'] = "/var/lib/redis" + +# Replication +default['redis']['slaveof']['ip'] = nil +default['redis']['slaveof']['port'] = nil +default['redis']['masterauth'] = nil +default['redis']['slave-serve-stale-data'] = "yes" +default['redis']['repl-ping-slave-period'] = 10 + +# Security +default['redis']['password'] = nil +default['redis']['rename-command'] = { } + +# Limits +default['redis']['maxclients'] = nil +default['redis']['maxmemory'] = nil +default['redis']['maxmemory-policy'] = nil + +# Append Only Mode +default['redis']['appendonly'] = "no" +default['redis']['appendfsync'] = "everysec" # everysec, always, no +default['redis']['no-appendfsync-on-rewrite'] = "no" +default['redis']['auto-aof-rewrite-percentage'] = 100 +default['redis']['auto-aof-rewrite-min-size'] = "64mb" + +# Slow Log +default['redis']['slowlog-log-slower-than'] = 10000 +default['redis']['slowlog-max-len'] = 128 + +# Advanced Options +default['redis']['hash-max-zipmap-entries'] = 512 +default['redis']['hash-max-zipmap-value'] = 64 +default['redis']['list-max-ziplist-entries'] = 512 +default['redis']['list-max-ziplist-value'] = 64 +default['redis']['set-max-intset-entries'] = 512 +default['redis']['zset-max-ziplist-entries'] = 128 +default['redis']['zset-max-ziplist-value'] = 64 +default['redis']['activerehashing'] = "yes" +default['redis']['include'] = [ ] diff --git a/metadata.rb b/metadata.rb index 18d9d77..f0a2fd0 100644 --- a/metadata.rb +++ b/metadata.rb @@ -3,12 +3,12 @@ license "All rights reserved" description "Installs/Configures redis" long_description IO.read(File.join(File.dirname(__FILE__), 'README.md')) -version "0.0.4" -recipe "redis", "Includes the package recipe by default." -recipe "redis::package", "Sets up a redis server." -recipe "redis::gem", "Installs redis gem for ruby development." -recipe "redis::source", "Builds redis server from sources." -recipe "redis::remove", "Removes redis server and redis gem, if installed." +version "0.0.6" +recipe "redis", "Includes the package recipe by default." +recipe "redis::package", "Sets up a redis server." +recipe "redis::gem", "Installs redis gem for ruby development." +recipe "redis::source", "Builds redis server from sources." +recipe "redis::remove", "Removes redis server and redis gem, if installed." %w{ ubuntu debian }.each do |os| supports os diff --git a/recipes/default.rb b/recipes/default.rb index 987ceee..511b2a0 100644 --- a/recipes/default.rb +++ b/recipes/default.rb @@ -18,4 +18,4 @@ # limitations under the License. # -include_recipe "redis::package" \ No newline at end of file +include_recipe "redis::package" diff --git a/recipes/gem.rb b/recipes/gem.rb index fd66d41..649e2cb 100644 --- a/recipes/gem.rb +++ b/recipes/gem.rb @@ -21,4 +21,3 @@ node['redis']['gem']['packages'].each do |pkg| gem_package pkg end - diff --git a/recipes/package.rb b/recipes/package.rb index 84a1df2..7107ff4 100644 --- a/recipes/package.rb +++ b/recipes/package.rb @@ -27,10 +27,11 @@ action :start end -template "/etc/redis/redis.conf" do +template "#{node[:redis][:config_path]}" do source "redis.conf.erb" owner "root" group "root" mode 0644 + notifies :restart, resources(:service => "redis") end diff --git a/recipes/source.rb b/recipes/source.rb index 79dff2b..e383b6a 100644 --- a/recipes/source.rb +++ b/recipes/source.rb @@ -59,11 +59,11 @@ user redis_user do gid redis_group - home "/var/lib/redis" + home node[:redis][:dir] system true end -%w{/var/run/redis.pid /var/log/redis /var/lib/redis}.each do |dir| +[File.dirname(node[:redis][:config_path]), File.dirname(node[:redis][:logfile]), node[:redis][:dir]].each do |dir| directory dir do owner redis_user group redis_group @@ -75,32 +75,27 @@ if node['redis']['source']['create_service'] node.set['redis']['daemonize'] = "yes" - execute "Install redis-server init.d script" do - command <<-COMMAND - cp #{cache_dir}/#{tar_dir}/utils/redis_init_script /etc/init.d/redis - COMMAND - - creates "/etc/init.d/redis" + service "redis" do + supports :status => false, :restart => false, :reload => false end - file "/etc/init.d/redis" do + template "/etc/init.d/redis" do + source "init.sh.erb" owner "root" group "root" mode "0755" - end - service "redis" do - supports :status => false, :restart => false, :reload => false - action :enable + notifies :restart, "service[redis]" end - directory "/etc/redis" do + directory File.dirname("#{node[:redis][:config_path]}") do owner "root" group "root" mode "0755" + recursive true end - template "/etc/redis/#{port}.conf" do + template "#{node[:redis][:config_path]}" do source "redis.conf.erb" owner "root" group "root" diff --git a/templates/default/init.sh.erb b/templates/default/init.sh.erb new file mode 100644 index 0000000..46a0c80 --- /dev/null +++ b/templates/default/init.sh.erb @@ -0,0 +1,44 @@ +#!/bin/sh +# +# Simple Redis init.d script conceived to work on Linux systems +# as it does use of the /proc filesystem. +# +# This file is managed by chef, any changes are likely to be lost. + +EXEC=/usr/local/bin/redis-server +CLIEXEC=/usr/local/bin/redis-cli + +PIDFILE="<%= node[:redis][:pidfile] %>" +REDISPORT="<%= node[:redis][:port] %>" +CONF="<%= node[:redis][:config_path] %>" + +case "$1" in + start) + if [ -f $PIDFILE ] + then + echo "$PIDFILE exists, process is already running or crashed" + else + echo "Starting Redis server..." + $EXEC $CONF + fi + ;; + stop) + if [ ! -f $PIDFILE ] + then + echo "$PIDFILE does not exist, process is not running" + else + PID=$(cat $PIDFILE) + echo "Stopping ..." + $CLIEXEC -p $REDISPORT shutdown + while [ -x /proc/${PID} ] + do + echo "Waiting for Redis to shutdown ..." + sleep 1 + done + echo "Redis stopped" + fi + ;; + *) + echo "Please use start or stop as first argument" + ;; +esac diff --git a/templates/default/redis.conf.erb b/templates/default/redis.conf.erb index 5744e65..4cfd6fe 100644 --- a/templates/default/redis.conf.erb +++ b/templates/default/redis.conf.erb @@ -1,42 +1,78 @@ # Redis configuration file example +# This configuration file is managed by chef, any changes are likely to be lost. + +# Note on units: when memory size is needed, it is possible to specifiy +# it in the usual form of 1k 5GB 4M and so forth: +# +# 1k => 1000 bytes +# 1kb => 1024 bytes +# 1m => 1000000 bytes +# 1mb => 1024*1024 bytes +# 1g => 1000000000 bytes +# 1gb => 1024*1024*1024 bytes +# +# units are case insensitive so 1GB 1Gb 1gB are all the same. # By default Redis does not run as a daemon. Use 'yes' if you need it. # Note that Redis will write a pid file in /var/run/redis.pid when daemonized. daemonize <%= node['redis']['daemonize'] %> -# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default. -# You can specify a custom pid file location here. -pidfile /var/run/redis_<%= node['redis']['port'] %>.pid +# When running daemonized, Redis writes a pid file in /var/run/redis.pid by +# default. You can specify a custom pid file location here. +pidfile <%= node['redis']['pidfile'] %> -# Accept connections on the specified port, default is 6379 +# Accept connections on the specified port, default is 6379. +# If port 0 is specified Redis will not listen on a TCP socket. port <%= node['redis']['port'] %> # If you want you can bind a single interface, if the bind option is not -# specified all the interfaces will listen for connections. +# specified all the interfaces will listen for incoming connections. # <% if node['redis']['bind'] %> bind <%= node['redis']['bind'] %> <% end %> +# Specify the path for the unix socket that will be used to listen for +# incoming connections. There is no default, so Redis will not listen +# on a unix socket when not specified. +# +<% if node['redis']['unixsocket'] %> +unixsocket <%= node['redis']['unixsocket'] %> +<% end %> +<% if node['redis']['unixsocketperm'] %> +unixsocketperm <%= node['redis']['unixsocketperm'] %> +<% end %> + # Close the connection after a client is idle for N seconds (0 to disable) timeout <%= node['redis']['timeout'] %> # Set server verbosity to 'debug' # it 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) loglevel <%= node['redis']['loglevel'] %> # Specify the log file name. Also 'stdout' can be used to force -# the demon to log on the standard output. Note that if you use standard +# Redis to log on the standard output. Note that if you use standard # output for logging but daemonize, logs will be sent to /dev/null -logfile /var/log/redis/redis-server.log +logfile <%= node['redis']['logfile'] %> + +# To enable logging to the system logger, just set 'syslog-enabled' to yes, +# and optionally update the other syslog parameters to suit your needs. +syslog-enabled <%= node['redis']['syslog-enabled'] %> + +# Specify the syslog identity. +syslog-ident <%= node['redis']['syslog-ident'] %> + +# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. +syslog-facility <%= node['redis']['syslog-facility'] %> # Set the number of databases. The default database is DB 0, you can select # a different one on a per-connection basis using SELECT where # dbid is a number between 0 and 'databases'-1 -databases 16 +databases <%= node['redis']['databases'] %> ################################ SNAPSHOTTING ################################# # @@ -51,22 +87,30 @@ databases 16 # after 900 sec (15 min) if at least 1 key changed # after 300 sec (5 min) if at least 10 keys changed # after 60 sec if at least 10000 keys changed -save 900 1 -save 300 10 -save 60 10000 +# +# Note: you can disable saving at all commenting all the "save" lines. +<% node['redis']['save'].each do |seconds,changes| %> +save <%= seconds %> <%= changes %> +<% end %> # Compress string objects using LZF when dump .rdb databases? # For default that's set to 'yes' as it's almost always a win. # If you want to save some CPU in the saving child set it to 'no' but # the dataset will likely be bigger if you have compressible values or keys. -rdbcompression yes +rdbcompression <%= node['redis']['rdbcompression'] %> # The filename where to dump the DB -dbfilename dump.rdb +dbfilename <%= node['redis']['dbfilename'] %> -# For default save/load DB in/from the working directory -# Note that you must specify a directory not a file name. -dir /var/lib/redis +# The working directory. +# +# The DB will be written inside this directory, with the filename specified +# above using the 'dbfilename' configuration directive. +# +# Also the Append Only File will be created inside this directory. +# +# Note that you must specify a directory here, not a file name. +dir <%= node['redis']['dir'] %> ################################# REPLICATION ################################# @@ -75,14 +119,48 @@ dir /var/lib/redis # so for example it is possible to configure the slave to save the DB with a # different interval, or to listen to another port, and so on. # -# slaveof +<% if node['redis']['slaveof']['ip'] && node['redis']['slaveof']['port'] %> +slaveof <%= node['redis']['slaveof']['ip'] %> <%= node['redis']['slaveof']['port'] %> +<% end %> # If the master is password protected (using the "requirepass" configuration # directive below) it is possible to tell the slave to authenticate before # starting the replication synchronization process, otherwise the master will # refuse the slave request. # -# masterauth +<% if node['redis']['masterauth'] %> +masterauth <%= node['redis']['masterauth'] %> +<% end %> + +# When a slave lost the 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 data 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. +# +slave-serve-stale-data <%= node['redis']['slave-serve-stale-data'] %> + +# Slaves send PINGs to server in a predefined interval. It's possible to change +# this interval with the repl_ping_slave_period option. The default value is 10 +# seconds. +# +repl-ping-slave-period <%= node['redis']['repl-ping-slave-period'] %> + +# The following option sets a timeout for both Bulk transfer I/O timeout and +# master data or ping response timeout. The default value is 60 seconds. +# +# It is important to make sure that this value is greater than the value +# specified for repl-ping-slave-period otherwise a timeout will be detected +# every time there is low traffic between the master and the slave. +# +<% if node['redis']['repl-timeout'] %> +repl-timeout <%= node['redis']['repl-timeout'] %> +<% end %> ################################## SECURITY ################################### @@ -93,38 +171,105 @@ dir /var/lib/redis # This should stay commented out for backward compatibility and because most # people do not need auth (e.g. they run their own servers). # +# Warning: since Redis is pretty fast an outside user can try up to +# 150k passwords per second against a good box. This means that you should +# use a very strong password otherwise it will be very easy to break. +# <% if node['redis']['password'] %> requirepass <%= node['redis']['password'] %> <% end %> +# Command renaming. +# +# It is possilbe to change the name of dangerous commands in a shared +# environment. For instance the CONFIG command may be renamed into something +# of hard to guess so that it will be still available for internal-use +# tools but not available for general clients. +# +# Example: +# +# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 +# +# It is also possilbe to completely kill a command renaming it into +# an empty string: +# +<% node['redis']['rename-command'].each do |command,name| %> +rename-command <%= command %> <%= name %> +<% end %> + ################################### LIMITS #################################### # Set the max number of connected clients at the same time. By default there # is no limit, and it's up to the number of file descriptors the Redis process -# is able to open. The special value '0' means no limts. +# is able to open. The special value '0' means no limits. # Once the limit is reached Redis will close all the new connections sending # an error 'max number of clients reached'. # -# maxclients 128 +<% if node['redis']['maxclients'] %> +maxclients <%= node['redis']['maxclients'] %> +<% end %> # Don't use more memory than the specified amount of bytes. -# When the memory limit is reached Redis will try to remove keys with an -# EXPIRE set. It will try to start freeing keys that are going to expire -# in little time and preserve keys with a longer time to live. -# Redis will also try to remove objects from free lists if possible. +# When the memory limit is reached Redis will try to remove keys +# accordingly to the eviction policy selected (see maxmemmory-policy). # -# If all this fails, Redis will start to reply with errors to commands -# that will use more memory, like SET, LPUSH, and so on, and will continue -# to reply to most read-only commands like GET. +# If Redis can't remove keys according to the policy, or if the policy is +# set to 'noeviction', Redis will start to reply with errors to commands +# that would use more memory, like SET, LPUSH, and so on, and will continue +# to reply to read-only commands like GET. # -# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a -# 'state' server or cache, not as a real DB. When Redis is used as a real -# database the memory usage will grow over the weeks, it will be obvious if -# it is going to use too much memory in the long run, and you'll have the time -# to upgrade. With maxmemory after the limit is reached you'll start to get -# errors for write operations, and this may even lead to DB inconsistency. +# This option is usually useful when using Redis as an LRU cache, or to set +# an hard memory limit for an instance (using the 'noeviction' policy). # -# maxmemory +# WARNING: If you have slaves attached to an instance with maxmemory on, +# the size of the output buffers needed to feed the slaves are subtracted +# from the used memory count, so that network problems / resyncs will +# not trigger a loop where keys are evicted, and in turn the output +# buffer of slaves is full with DELs of keys evicted triggering the deletion +# of more keys, and so forth until the database is completely emptied. +# +# In short... if you have slaves attached it is suggested that you set a lower +# limit for maxmemory so that there is some free RAM on the system for slave +# output buffers (but this is not needed if the policy is 'noeviction'). +# +<% if node['redis']['maxmemory'] %> +maxmemory <%= node['redis']['maxmemory'] %> +<% end %> + +# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory +# is reached? You can select among five behavior: +# +# volatile-lru -> remove the key with an expire set using an LRU algorithm +# allkeys-lru -> remove any key accordingly to the LRU algorithm +# volatile-random -> remove a random key with an expire set +# allkeys->random -> remove a random key, any key +# volatile-ttl -> remove the key with the nearest expire time (minor TTL) +# noeviction -> don't expire at all, just return an error on write operations +# +# Note: with all the kind of policies, Redis will return an error on write +# operations, when there are not suitable keys for eviction. +# +# At the date of writing this commands are: set setnx setex append +# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd +# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby +# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby +# getset mset msetnx exec sort +# +# The default is: +# +<% if node['redis']['maxmemory-policy'] %> +maxmemory-policy <%= node['redis']['maxmemory-policy'] %> +<% end %> + +# LRU and minimal TTL algorithms are not precise algorithms but approximated +# algorithms (in order to save memory), so you can select as well the sample +# size to check. For instance for default Redis will check three keys and +# pick the one that was used less recently, you can change the sample size +# using the following configuration directive. +# +<% if node['redis']['maxmemory-samples'] %> +maxmemory-samples <%= node['redis']['maxmemory-samples'] %> +<% end %> ############################## APPEND ONLY MODE ############################### @@ -133,7 +278,7 @@ requirepass <%= node['redis']['password'] %> # happens this is the preferred way to run Redis. If instead you care a lot # about your data and don't want to that a single record can get lost you should # enable the append only mode: when this mode is enabled Redis will append -# every write operation received in the file appendonly.log. This file will +# every write operation received in the file appendonly.aof. This file will # be read on startup in order to rebuild the full dataset in memory. # # Note that you can have both the async dumps and the append only file if you @@ -141,15 +286,15 @@ requirepass <%= node['redis']['password'] %> # Still if append only mode is enabled Redis will load the data from the # log file at startup ignoring the dump.rdb file. # -# The name of the append only file is "appendonly.log" -# # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append # log file in background when it gets too big. +appendonly <%= node['redis']['appendonly'] %> -appendonly no +# The name of the append only file (default: "appendonly.aof") +# appendfilename appendonly.aof # The fsync() call tells the Operating System to actually write data on disk -# instead to wait for more data in the output buffer. Some OS will really flush +# instead to wait for more data in the output buffer. Some OS will really flush # data on disk, some other OS will just try to do it ASAP. # # Redis supports three different modes: @@ -158,36 +303,211 @@ appendonly no # always: fsync after every write to the append only log . Slow, Safest. # everysec: fsync only if one second passed since the last fsync. Compromise. # -# The default is "always" that's the safer of the options. It's up to you to -# understand if you can relax this to "everysec" that will fsync every second -# or to "no" that will let the operating system flush the output buffer when -# it want, for better performances (but if you can live with the idea of -# some data loss consider the default persistence mode that's snapshotting). +# The default is "everysec" that's usually the right compromise between +# speed and data safety. It's up to you to understand if you can relax this to +# "no" that will will let the operating system flush the output buffer when +# it wants, for better performances (but if you can live with the idea of +# some data loss consider the default persistence mode that's snapshotting), +# or on the contrary, use "always" that's very slow but a bit safer than +# everysec. +# +# If unsure, use "everysec". +appendfsync <%= node['redis']['appendfsync'] %> + +# When the AOF fsync policy is set to always or everysec, and a background +# saving process (a background save or AOF log background rewriting) is +# performing a lot of I/O against the disk, in some Linux configurations +# Redis may block too long on the fsync() call. Note that there is no fix for +# this currently, as even performing fsync in a different thread will block +# our synchronous write(2) call. +# +# In order to mitigate this problem it's possible to use the following option +# that will prevent fsync() from being called in the main process while a +# BGSAVE or BGREWRITEAOF is in progress. +# +# This means that while another child is saving the durability of Redis is +# the same as "appendfsync none", that in pratical terms means that it is +# possible to lost up to 30 seconds of log in the worst scenario (with the +# default Linux settings). +# +# If you have latency problems turn this to "yes". Otherwise leave it as +# "no" that is the safest pick from the point of view of durability. +no-appendfsync-on-rewrite <%= node['redis']['no-appendfsync-on-rewrite'] %> + +# Automatic rewrite of the append only file. +# Redis is able to automatically rewrite the log file implicitly calling +# BGREWRITEAOF when the AOF log size will growth by the specified percentage. +# +# This is how it works: Redis remembers the size of the AOF file after the +# latest rewrite (or if no rewrite happened since the restart, the size of +# the AOF at startup is used). +# +# This base size is compared to the current size. If the current size is +# bigger than the specified percentage, the rewrite is triggered. Also +# you need to specify a minimal size for the AOF file to be rewritten, this +# is useful to avoid rewriting the AOF file even if the percentage increase +# is reached but it is still pretty small. +# +# Specify a precentage of zero in order to disable the automatic AOF +# rewrite feature. + +auto-aof-rewrite-percentage <%= node['redis']['auto-aof-rewrite-percentage'] %> +auto-aof-rewrite-min-size <%= node['redis']['auto-aof-rewrite-min-size'] %> + +################################## SLOW LOG ################################### + +# The Redis Slow Log is a system to log queries that exceeded a specified +# execution time. The execution time does not include the I/O operations +# like talking with the client, sending the reply and so forth, +# but just the time needed to actually execute the command (this is the only +# stage of command execution where the thread is blocked and can not serve +# other requests in the meantime). +# +# You can configure the slow log with two parameters: one tells Redis +# what is the execution time, in microseconds, to exceed in order for the +# command to get logged, and the other parameter is the length of the +# slow log. When a new command is logged the oldest one is removed from the +# queue of logged commands. + +# The following time is expressed in microseconds, so 1000000 is equivalent +# to one second. Note that a negative number disables the slow log, while +# a value of zero forces the logging of every command. +slowlog-log-slower-than <%= node['redis']['slowlog-log-slower-than'] %> + +# There is no limit to this length. Just be aware that it will consume memory. +# You can reclaim memory used by the slow log with SLOWLOG RESET. +slowlog-max-len <%= node['redis']['slowlog-max-len'] %> + +################################ VIRTUAL MEMORY ############################### + +### WARNING! Virtual Memory is deprecated in Redis 2.4 +### The use of Virtual Memory is strongly discouraged. + +# Virtual Memory allows Redis to work with datasets bigger than the actual +# amount of RAM needed to hold the whole dataset in memory. +# In order to do so very used keys are taken in memory while the other keys +# are swapped into a swap file, similarly to what operating systems do +# with memory pages. +# +# To enable VM just set 'vm-enabled' to yes, and set the following three +# VM parameters accordingly to your needs. + +vm-enabled no +# vm-enabled yes + +# This is the path of the Redis swap file. As you can guess, swap files +# can't be shared by different Redis instances, so make sure to use a swap +# file for every redis process you are running. Redis will complain if the +# swap file is already in use. +# +# The best kind of storage for the Redis swap file (that's accessed at random) +# is a Solid State Disk (SSD). +# +# *** WARNING *** if you are using a shared hosting the default of putting +# the swap file under /tmp is not secure. Create a dir with access granted +# only to Redis user and configure Redis to create the swap file there. +vm-swap-file /tmp/redis.swap + +# vm-max-memory configures the VM to use at max the specified amount of +# RAM. Everything that deos not fit will be swapped on disk *if* possible, that +# is, if there is still enough contiguous space in the swap file. +# +# With vm-max-memory 0 the system will swap everything it can. Not a good +# default, just specify the max amount of RAM you can in bytes, but it's +# better to leave some margin. For instance specify an amount of RAM +# that's more or less between 60 and 80% of your free RAM. +vm-max-memory 0 + +# Redis swap files is split into pages. An object can be saved using multiple +# contiguous pages, but pages can't be shared between different objects. +# So if your page is too big, small objects swapped out on disk will waste +# a lot of space. If you page is too small, there is less space in the swap +# file (assuming you configured the same number of total swap file pages). +# +# If you use a lot of small objects, use a page size of 64 or 32 bytes. +# If you use a lot of big objects, use a bigger page size. +# If unsure, use the default :) +vm-page-size 32 + +# Number of total memory pages in the swap file. +# Given that the page table (a bitmap of free/used pages) is taken in memory, +# every 8 pages on disk will consume 1 byte of RAM. +# +# The total swap size is vm-page-size * vm-pages +# +# With the default of 32-bytes memory pages and 134217728 pages Redis will +# use a 4 GB swap file, that will use 16 MB of RAM for the page table. +# +# It's better to use the smallest acceptable value for your application, +# but the default is large in order to work in most conditions. +vm-pages 134217728 -appendfsync always -# appendfsync everysec -# appendfsync no +# Max number of VM I/O threads running at the same time. +# This threads are used to read/write data from/to swap file, since they +# also encode and decode objects from disk to memory or the reverse, a bigger +# number of threads can help with big objects even if they can't help with +# I/O itself as the physical device may not be able to couple with many +# reads/writes operations at the same time. +# +# The special value of 0 turn off threaded I/O and enables the blocking +# Virtual Memory implementation. +vm-max-threads 4 ############################### ADVANCED CONFIG ############################### -# Glue small output buffers together in order to send small replies in a -# single TCP packet. Uses a bit more CPU but most of the times it is a win -# in terms of number of queries per second. Use 'yes' if unsure. -glueoutputbuf yes - -# Use object sharing. Can save a lot of memory if you have many common -# string in your dataset, but performs lookups against the shared objects -# pool so it uses more CPU and can be a bit slower. Usually it's a good -# idea. -# -# When object sharing is enabled (shareobjects yes) you can use -# shareobjectspoolsize to control the size of the pool used in order to try -# object sharing. A bigger pool size will lead to better sharing capabilities. -# In general you want this value to be at least the double of the number of -# very common strings you have in your dataset. -# -# WARNING: object sharing is experimental, don't enable this feature -# in production before of Redis 1.0-stable. Still please try this feature in -# your development environment so that we can test it better. -# shareobjects no -# shareobjectspoolsize 1024 +# Hashes are encoded in a special way (much more memory efficient) when they +# have at max a given numer of elements, and the biggest element does not +# exceed a given threshold. You can configure this limits with the following +# configuration directives. +hash-max-zipmap-entries <%= node['redis']['hash-max-zipmap-entries'] %> +hash-max-zipmap-value <%= node['redis']['hash-max-zipmap-value'] %> + +# Similarly to hashes, small lists are also encoded in a special way in order +# to save a lot of space. The special representation is only used when +# you are under the following limits: +list-max-ziplist-entries <%= node['redis']['list-max-ziplist-entries'] %> +list-max-ziplist-value <%= node['redis']['list-max-ziplist-value'] %> + +# Sets have a special encoding in just one case: when a set is composed +# of just strings that happens to be integers in radix 10 in the range +# of 64 bit signed integers. +# The following configuration setting sets the limit in the size of the +# set in order to use this special memory saving encoding. +set-max-intset-entries <%= node['redis']['set-max-intset-entries'] %> + +# Similarly to hashes and lists, sorted sets are also specially encoded in +# order to save a lot of space. This encoding is only used when the length and +# elements of a sorted set are below the following limits: +zset-max-ziplist-entries <%= node['redis']['zset-max-ziplist-entries'] %> +zset-max-ziplist-value <%= node['redis']['zset-max-ziplist-value'] %> + +# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in +# order to help rehashing the main Redis hash table (the one mapping top-level +# keys to values). The hash table implementation redis uses (see dict.c) +# performs a lazy rehashing: the more operation you run into an hash table +# that is rhashing, the more rehashing "steps" are performed, so if the +# server is idle the rehashing is never complete and some more memory is used +# by the hash table. +# +# The default is to use this millisecond 10 times every second in order to +# active rehashing the main dictionaries, freeing memory when possible. +# +# If unsure: +# use "activerehashing no" if you have hard latency requirements and it is +# not a good thing in your environment that Redis can reply form time to time +# to queries with 2 milliseconds delay. +# +# use "activerehashing yes" if you don't have such hard requirements but +# want to free memory asap when possible. +activerehashing <%= node['redis']['activerehashing'] %> + +################################## INCLUDES ################################### + +# Include one or more other config files here. This is useful if you +# have a standard template that goes to all redis server but also need +# to customize a few per-server settings. Include files can include +# other files, so use this wisely. +# +<% node['redis']['include'].each do |file| %> +include <%= file %> +<% end %>