CHANGELOG.md

redisio

This file is used to list changes made in each version of the redisio cookbook.

Unreleased

7.2.2 - 2024-05-03

7.2.1 - 2024-05-03

7.2.0 - 2024-04-30

• Add option to specify cluster-port

7.1.1 - 2024-04-21

• Fix default tls* attribute names

7.1.0 - 2024-04-18

• Add an option to manage all TLS related attributes

7.0.1 - 2024-04-04

7.0.0 - 2024-04-04

• Breaking: support only Redis v6+
  • Removed obsolete version checks
  • Removed option to configure Virtual Memory, deprecated in 2.4
  • Removed deprecated options list-max-ziplist-entries, list-max-ziplist-value
  • Renamed references from "slave" to "replica" across configuration attribute names to align with Redis terminology updates
  • Removed redis-package test suite, most of Linux distributions does not provide packages for Redis v6+
  • Set default Redis version to 6.2.14
• Extend CI workflow to verify multiple Redis versions
• Upgrade suidelines:
  • Ensure all Redis instances are upgraded to version 6.2.14 or higher.
  • Update configuration files to reflect the terminology change from "slave" to "replica."
  • Remove any references to deprecated options list-max-ziplist-entries and list-max-ziplist-value.
  • Test the compatibility of your Chef cookbook with Redis v6+ before deploying the upgrade.

6.7.1 - 2024-01-11

• Add includes option to sentinel configuration file.

6.7.0 - 2024-01-04

• Add aclfile option to sentinel configuration file.
• Update Github Actions

6.6.0 - 2023-11-11

• Add aclfile option to redis configuration file.

6.5.0 - 2023-10-31

• Add maxclients option to sentinel configuration file.

6.4.4 - 2023-09-28

6.4.3 - 2023-09-04

6.4.2 - 2023-07-10

6.4.1 - 2023-05-16

6.4.0 - 2023-04-26

• Simplify configure and sentinel resources, making them idempotent

6.3.7 - 2023-04-25

• Standardise files with files in sous-chefs/repo-management

6.3.6 - 2023-04-04

• Standardise files with files in sous-chefs/repo-management

6.3.5 - 2023-04-01

• Update workflows

6.3.5 - 2023-04-01

• Standardise files with files in sous-chefs/repo-management

6.3.5 - 2023-04-01

• Standardise files with files in sous-chefs/repo-management

6.3.4 - 2023-03-15

• Standardise files with files in sous-chefs/repo-management

6.3.3 - 2023-02-15

• Standardise files with files in sous-chefs/repo-management

6.3.2 - 2023-02-14

• Standardise files with files in sous-chefs/repo-management

6.3.1 - 2022-12-06

• Standardise files with files in sous-chefs/repo-management

6.3.0 - 2022-09-10

• Version check fix for some Redis default settings to support Redis v4 and above.

6.2.4 - 2022-08-13

• Fix systemd entry to ensure listening on all network interfaces (#440)

6.2.3 - 2022-08-12

• Fix grammar in README.md
• Use latest instead of current channel with dokken

6.2.2 - 2022-04-25

• Standardise files with files in sous-chefs/repo-management

6.2.1 - 2022-04-25

• Fixes configdir permissions. Similar to 451
• Deprecated .foodcritic configfile removed

6.2.0 - 2022-02-14

• Adds support for Rocky Linux

6.1.3 - 2022-02-04

• Remove references to selinux_policy cookbook

6.1.2 - 2022-02-03

• Fixes configdir permissions preventing Sentinel to update the config file

6.1.1 - 2022-02-03

• Remove delivery and move to calling RSpec directly via a reusable workflow

6.1.0 - 2021-09-15

• Add protected mode to sentinel configuration file

6.0.0 - 2021-09-09

• Set unified_mode true for Chef 17+ support
• Require Chef 15.3+ for unified_mode
• Require Chef 16 for user_ulimit resource
• Remove dependency on the ulimit cookbook
• Switch from using the selinux_policy cookbook to the selinux cookbook
  • The selinux_policy cookbook is now deprecated. The resources have been moved to the selinux cookbook

5.0.0 - 2021-09-08

• resolved cookstyle error: attributes/default.rb:74:40 refactor: Chef/Modernize/UseChefLanguageSystemdHelper

4.3.2 - 2021-08-30

• Standardise files with files in sous-chefs/repo-management

4.3.1 - 2021-06-01

• Standardise files with files in sous-chefs/repo-management

4.3.0 - 2021-05-19

• Fix disable recipe service naming for systemd

4.2.0 (2020-09-14)

• New server option 'permissions' to override default (0644) unix permissions on config file

4.1.2 (2020-09-11)

• Pull the disable_os_default recipe from the default one

4.1.1 (2020-08-14)

• Properly perform version check when needed in redis.conf template

4.1.0 (2020-05-05)

• Simplify platform check logic
• Remove the deprecated ChefSpec coverage report
• Migrate to actions for testing

4.0.0 (2019-09-19)

• Enable testing in CircleCI
• Removed build essentials cookbook dependancy
• Minimum Chef is now 14
• Removed tests for Debian 8
• Added support for chef 15
• configure recipe now sets ['redisio']['servers'] using override instead of normal in line with new chef best practices

3.0.0 (2018-11-27)

• This cookbook is now maintained by the Sous Chefs. If you're interested in helping with maintenance or learning more check out https://sous-chefs.org/ Thank you Brian Bianco for the work you've done over the years on this cookbook. We'll be sure to take good care of it.
• This cookbook now requires Chef 13 or later
• Incompatibilities with the latest selinux_policy cookbook have been resolved by using Chef's built in selinux helpers
• All Chefstyle warnings have been resolved
• Contributing.md and CODE_OF_CONDUCT.md files have been added
• The build_essential resource is now directly used so that the built in resource in Chef 14+ can be used. This increases the required build-essential cookbook to 5.0+
• Duplicate dependencies in the Berksfile have been removed
• The chefignore file has been updated to prevent more unnecessary files from being uploaded to the chef server
• Data bags are now loaded with the data_bag_item helper instead of Chef::EncryptedDataBagItem.load directly
• Testing has been updated to use Delivery Local Mode which is built into ChefDK. The legacy Rakefile, Vagrantfile, Thorfile, and Cheffile have been removed
• Platforms in Test Kitchen configurations have been updated and dokken images are now used in dokken

2.7.2 (2018-09-30)

• fixes sentinal cluster init script by providing missing LSB statements ([#374])

2.7.1 (2018-03-30)

• fixes sentinal config where announce-ip was being given the value of announce-port improperly ([#354])

2.7.0 (2018-03-28)

• enables diskless replication configuration for versions ~> 2.6 || ~> 3.0 #340
• adds chef 13 compatability #350

2.6.1 (2017-05-10)

• Restrict aof-load-truncated to redis 3+ (#343)
• Fix Redis 2.4.x config (#344)

2.6.0 (2017-05-09)

• Update 'bind' config comments (#293)
• Add disable_os_default recipe (#224)
• Use the config's ulimits if set and is > max_clients (#234)
• Add Travis config (#299)
• Fix test failures (FoodCritic and Rubocop) (#298)
• Fix TravisCI builds (#300)
• Add repl-backlog-size, repl-backlog-ttl, and aof-load-truncated options (#278)
• Add sentinel_bind to bind sentinel to different IPs (#306)
• Cleanup deprecation warnings (#301)
• Fix version detection with epoch version numbers from deb/ubuntu (#294)
• Restrict VM redis config to <= 2.4 (#322)
• Rename_commands should be checked for nil before empty (#311)
• Fixup foodcritic, rubocop, and kitchen testing (#324)
  • Note: this drops support for Chef < 11
• Add min-slaves redis options (#313)
• Allow /etc/init start after sigterm from system or user (#310)
• Check user existence with Etc, not ohai node attributes (#303)
• Various systemd-related improvements (#302)
• Update serverspec testing with correct OS's for systemd (#329)
• Add kitchen-dokken testing to Travis (#330)
• Add fedora-25 to kitchen testing and clean up kitchen config (#331)
• Fix systemd paths for sentinel service (#332)
• Add redis-package and sentinel to Travis kitchen verify (#334)
• Add breadcrumb-file creation condition as attribute (#268)
• Fix cluster options in README (#333)
• Fix systemd loader to use descriptors instead of max_clients+32 (#338)
• Add SELinux support (#305)
• Make source of redis.conf template configurable (#341)
• Support sentinel notification-script and client-reconfig-script (#342)

2.5.0 (2016-09-15)

• Ubuntu 14 added as tested platform. (#264)
• FreeBSD-10.3 support added. (#279)
  • installation from source is not supported
  • setting ulimits is not supported
• Encrypted databag support added. (#228)
• Systemd nofile limit fixed. (#228)
• Announce-ip and announce-port directives for sentinel added. (#228)
• Disabling safe_install in the install recipe allowed. (#284)
• Protected-mode added as optional (#275, #289)
• Fixes nil exception when installing sentinel on non-debian and non-rhel platforms (#288)

2.4.2 (2016-04-08)

• Created a 2.4.1 tag but somehow the metadata file wasn't updated. Instead of deleting a pushed tag, creating a new tag and updating metdatafile. Aside from the version number, this is an identical release to 2.4.1

2.4.1

• Increases default clusternodetimeout value from 5 to 5000
• Allows you to set version for package based install
• Sets UID of redis data directory if it is present
• Install resource should now only notify when an installation actually occurs
• Adds config options
  • tcpbacklog
  • rdbcompression
  • rdbchecksum
  • dbfilename
  • slavereadyonly
  • repldisabletcpnodelay
  • slavepriority
  • listmaxziplistentries
  • listmaxziplistvalue
  • hllsparsemaxbytes
• Add CentOS 7 support with systemd configs
• Fixes bug in ulimit resource guard
• Fixes bug in sentinel required parameters sanity check
• Adds --no-same-owner to untar command during install to fix NFS related issues
• Adds support for rename_commands config option
• Adds option to stop chef from managing sentinel configs after writing once
• Adds config option rename_commands
• Allow instance 'save' to be string or array
• Adds sources_url and issues_url with guards to be Chef 12 compatible
• Bumps Redis source version to 2.8.20
• Fixes cluster settings with wrong attribute names
• Monitor multiple masters with sentinel
  • Add support in sentinel resource for an array of masters to monitor, with backwards compatibility for the older attributes, fixes #73. Replaces #87.
  • Introduce a test-kitchen test for sentinel watching multiple masters.
  • Incidentally, fixes #193 as well, since it adds a master name attribute for each master.
• Fixes path for pidfile in sentinel init script
• Additional error checking and backwards compatibility for sentinel attribute keys

2.3.0 (2015-04-08)

• Add support for installing by distribution package for CentOS (#180)
• Add conditionals to check for redis 3 that was released recently (#183)
• Prevent usermod: user redis is currently logged in (#176)
• Use correct sentinel port in default sentinel instance (#157)
• Sentinel instances attribute (node['redisio']['sentinels']) should behave like Redis instances attribute (#160)
• Add Rakefile and unit tests for verifying issues fixed are actually resolved (#158)
• Fix serverspec tests to properly use sysv-init scripts on systemd distributions (#185)
• Update documentation to reflect correct current redis version used for source installs (#151)
• Update documentation to indicate that ulimit and build-essential are both dependencies (#165)
• Update documentation to reflect that uninstall recipe is no longer available
• Update documentation to reflect correct mirror in README.md, change was from 2.1.0 (#175)
• Update documentation to reflect that cookbook uses node['redisio'], not node['redis'] (#174)
• Markdown formatting improvements in the README.md (#168, #172)

2.2.4 (2014-10-04)

• Updates installed version of redis to the latest stable (2.8.17)
• Fixes backwards compatability bug with older version of redis (namely 2.6.x series) related to keyspaces

2.2.3 (2014-08-25)

• Bug Fix: Repackages the chef supermarket releaes with gnutar instead of BSD tar

2.2.2 (2014-08-22)

• Please refer to changelog for 2.0.0.
  • If moving from 1.7.x this release has many breaking changes. You will likely need to update your wrapper cookbook or role.
• Added test-kitchen and serverspec coverage for both redis and redis_sentinel
• Added cookbook testing information to readme
• Bug fix for a fix that was introduced to resolve foodcritic rule fc002
• Fix init script to use su instead of sudo for ubuntu debian fedora
• Fix sentinel_enable recipe to properly run if using default attributes
• Save property for redis config now is defined by using an array
• Small changes to default configuration options to bring in line with redis defaults.
• Added options for the following
  • tcp-keepalive

2.2.1

• Allow sentinel to control both redis and redis-sentinel configs depending on attribute redisio.sentinel.manage_config state.

2.2.0

• Adds behavior to allow the cookbook to NOT manage the redis config files as redis itself will write to them now if you are using sentinel

2.1.0

• Adds options for the following
  • lua-time-limit
  • slowlog-logs-slower-than
  • slowlog-max-len
  • notify-keyspace-events
  • client-output-buffer-limit
  • hz
  • aof-rewrite-incremental-fsync
• Removes the uninstall recipe and resource.
• Adds the ability to skip the default recipe calling install and configure by setting redisio bypass_setup attribute to true
• Adds support for redis sentinel [Thanks to rcleere, Ryan Walker]
• Splits up the install resource into separate install and configure resources [Thanks to rcleere]
• By default now calls _install_prereqs, install, and configure in the default recipe.
• Changes default version of redis to install to 2.8.5
• Now depends on the build-essential cookbook.
• Fixes issue #76 - Default settings save as empty string breaks install
• Switches mirror server from googlefiles to redis.io. If you are using version of redis before 2.6.16 you will need to override the mirror server attribute to use the old site with archived versions.
• Adds a Vagrant file!
• maxmemory will be rounded when calculated as a percentage
• Add stop-writes-on-bgsave-error config option
• Changes default log level from verbose to notice
• Adds configuration options for ziplists and active rehashing
• Adds support for passing the address attribute as an array. This is to support the redis 2.8 series which allows binding to multiple addresses
• Fixes a bug where multiple redis instances were using the same swapfile (only for version of redis 2.4 and below)
• Changes the job_control per instance attribute to a global one.
• Adds a status command to the init.d script, uses this in the initd based service for checking status

2.0.0

! THIS RELEASE HAS MANY BREAKING CHANGES ! ! Your old role file will most likely not work !

• Supports redis 2.8 and its use of the empty string for stdout in the logfile option
• Allows the user to specify required_start and required_start when using the init scripts
• Warns a user if they have syslogenabled set to yes and also have logfile set

1.7.1 (2014-02-10)

• Bumps default version of redis to 2.6.17
• Changes the redis download mirror to redis.io
• Fixes #76 - Default settings save as empty string breaks install. [Thanks to astlock]
• Fixes bug with nil file resource for logfile. [Thanks to chrismoos]

1.7.0 (2013-07-25)

• Adds support for address attribute as an array or string. This is to support the feature that will be introduced in redis 2.8

1.6.0 (2013-06-27)

• Fixes a bug when using a percentage for max memory. [Thanks to organicveggie]
• Allows installation of redis into custom directory. [Thanks to organicveggie, rcleere]
• Bumps the default installed version of redis to the new stable, 2.6.14

1.5.0 (2013-03-30)

• Forces maxmemory to a string inside of install provider so it will not explode if you pass in an int. [Thanks to sprack]
• Strips leading directory from downloaded tarball, and extracts into a newly created directory. This allows more versatility for where the package can be installed from (Github / BitBucket) [Thanks to dim]
• Adds options for Redis Cluster [Thanks to jrallison]
• Adds a call to ulimit into the init script, it was not honoring the limits set by the ulimit cookbook for some users. [Thanks to mike-yesware]

1.4.1 (2013-02-27)

• Removes left over debugging statement

1.4.0 (2013-02-27)

• ACTUALLY fixes the use of upstart and redis. Redis no longer daemonizes itself when using job_control type upstart and allows upstart to handle this
• Adds dependency on the ulimit cookbook and allows you to set the ulimits for the redis instance users.
• Adds associated node attribute for the ulimit. It defaults to the special value 0, which causes the cookbook to use maxclients + 32. 32 is the number of file descriptors redis needs itself
• You can disable the use of the ulimits by setting the node attribute for it to "false" or "nil"
• Comments out the start on by default in the upstart script. This will get uncommented by the upstart provider when the :enable action is called on it

1.3.2 (2013-02-26)

• Changes calls to Chef::ShellOut to Mixlib::ShellOut

1.3.1 (2013-02-26)

• Fixes bug in upstart script to create pid directory if it does not exist

1.3.0 (2013-02-20)

• Adds upstart support. This was a much requested feature.
• Fixes bug in uninstall resource that would have prevented it from uninstalling named servers.
• Reworks the init script to take into account the IP redis is listening on, and if it is listening on a socket.
• Adds an attribute called "shutdown_save" which will explicitly call save on redis shutdown
• Updates the README.md with a shorter and hopefully equally as useful usage section
• maxmemory attribute now allows the use of percentages. You must include a % sign after the value.
• Bumps default version of redis to install to the current stable, 2.6.10

1.2.0 (2013-02-06)

• Fixes bug related to where the template source resides when using the LWRP outside of the redisio cookbook
• Fixes bug where the version method was not properly parsing version strings in redis 2.6.x, as the version string from redis-server -v changed
• Fixes bug in default attributes for fedora default redis data directory
• Now uses chefs service resource for each redis instance instead of using a custom redisio_service resource. This cleans up many issues, including a lack of updated_by_last_action
• The use of the redisio_service resource is deprecated. Use the redis port_number instead.
• The default version of redis has been bumped to the current stable, which is 2.6.9
• Adds metadata.json to the gitignore file so that the cookbook can be submoduled.
• Adds the ability to handle non standard bind address in the init scripts stop command
• Adds attributes to allow redis to listen on a socket
• Adds an attribute to allow redis service accounts to be created as system users, defaults this to true
• Adds a per server "name" attribute that allows a server to use that instead of the port for its configuration files, service resource, and init script.
• Shifts the responsbility for handling the case of default redis instances into the install recipe due to the behavior of arrays and deep merge

1.1.0 (2012-08-21)

! Warning breaking change !: The redis pidfile directory by default has changed, if you do not STOP redis before upgrading to the new version of this cookbook, it will not be able to stop your instance properly via the redis service provider, or the init script. If this happens to you, you can always log into the server and manually send a SIGTERM to redis

• Changed the init script to run redis as the specified redis user
• Updated the default version of redis to 2.4.16
• Setup a new directory structure for redis pid files. The install provider will now nest its pid directories in base_piddir/port number/redis_port.pid.
• Added a RedisioHelper module in libraries. The recipe_eval method inside is used to wrap nested resources to allow for the proper resource update propigation. The install provider uses this.
• The init script now properly respects the configdir attribute
• Changed the redis data directories to be 775 instead of 755 (this allows multiple instances with different owners to write their data to the same shared dir so long as they are in a common group)
• Changed default for maxclients to be 10000 instead of 0. This is to account for the fact that maxclients no longer supports 0 as 'unlimited' in the 2.6 series
• Added logic to replace hash-max-ziplist-entries, hash-max-ziplist-value with hash-max-zipmap-entires, hash-max-zipmap-value when using 2.6 series
• Added the ability to log to any file, not just syslog. Please do make sure after you set your file with the logfile attribute you also set syslogenabled to 'no'

1.0.3 (2012-05-02)

• Added changelog.md
• Added a bunch more configuration options that were left out (default values left as they were before):

  • databases

  • slaveservestaledata

  • replpingslaveperiod

  • repltimeout

  • maxmemorysamples

  • noappendfsynconwrite

  • aofrewritepercentage

  • aofrewriteminsize

    It is worth nothing that since there is a configurable option for conf include files, and the fact that redis uses the most recently read configuration option... even if a new option where to show up, or and old one was not included they could be added using that pattern.

1.0.2 (2012-04-25)

• Merged in pull request from meskyanichi which improved the README.md and added a .gitignore
• Added a "safe_install" node attribute which will prevent redis from installing anything if it exists already. Defaults to true.
• Addedd a "redis_gem" recipe which will install the redis gem from ruby gems, added associated attributes. See README for me

1.0.1 (2012-04-08)

• Added some prequisite checks for RHEL based distributions
• Minor typos and formatting fixes in metadata.rb and README.md

1.0.0 (2012-04-08)

Initial Release