redis-formula

Travis CI Build Status Semantic Release pre-commit

Formula to install and configure redis.

1. General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

2. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

2.1. pre-commit

pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes. First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and now pre-commit will run automatically on each git commit. :

$ bin/install-hooks
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msg

3. Special notes

None.

4. Todo

  • merge redis 2.4 and 2.6 templates to generic redis.conf.jinja

5. Available states

5.1. redis

Meta-state (This is a state that includes other states).

This state installs the Redis server solution (see https://redis.io)

5.2. redis.clean

Meta-state (This is a state that includes other states).

Stop Redis daemon and remove redis server solution.

5.3. redis.common

Install redis only

5.4. redis.server

Install redis and start up the service ( Ubuntu + RedHat based systems should work ).

For a list of all available options, look at: redis/files/redis-{version}.conf.jinja - also have a look at the pillar.example and map.jinja.

To use the new redis 3.2 template (more structured) add the following line to the pillar:

source_path: salt://redis/files/redis-3.2-ng.conf.jinja

For options that aren’t in the template (timeout, for example in redis-2.8 template), you can use extra_opts:

extra_opts:
  timeout: 10

5.5. redis.server.clean

Meta-state (This is a state that includes other states).

Stop Redis daemon and remove redis package/archive.

5.6. redis.sentinel

Install redis sentinel. Compatible with Ubuntu 14/16 and CentOS 6/7.

6. Testing

Linux testing is done with kitchen-salt.

6.1. Requirements

  • Ruby

  • Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

6.2. bin/kitchen converge

Creates the docker instance and runs the redis main states, ready for testing.

6.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

6.4. bin/kitchen destroy

Removes the docker instance.

6.5. bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

6.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.