Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geerlingguy/ansible-role-redis
Ansible Role - Redis
https://github.com/geerlingguy/ansible-role-redis
ansible cache key-value memcached redis role
Last synced: 2 days ago
JSON representation
Ansible Role - Redis
- Host: GitHub
- URL: https://github.com/geerlingguy/ansible-role-redis
- Owner: geerlingguy
- License: mit
- Created: 2014-03-06T16:47:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T18:10:44.000Z (3 months ago)
- Last Synced: 2024-10-10T04:06:31.269Z (25 days ago)
- Topics: ansible, cache, key-value, memcached, redis, role
- Language: Jinja
- Homepage: https://galaxy.ansible.com/geerlingguy/redis/
- Size: 51.8 KB
- Stars: 253
- Watchers: 12
- Forks: 196
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-list-ansible - ansible-role-redis - Redis (role)
README
# Ansible Role: Redis
[](https://github.com/geerlingguy/ansible-role-php-redis/actions/workflows/ci.yml)
Installs [Redis](http://redis.io/) on Linux.
## Requirements
On RedHat-based distributions, requires the EPEL repository (you can simply add the role `geerlingguy.repo-epel` to install ensure EPEL is available).
## Role Variables
```yaml
redis_enablerepo: epel
```
(Used only on RHEL/CentOS) The repository to use for Redis installation.
Available variables are listed below, along with default values (see `defaults/main.yml`):
```yaml
redis_port: 6379
redis_bind_interface: 127.0.0.1
```
Port and interface on which Redis will listen. Set the interface to `0.0.0.0` to listen on all interfaces.
```yaml
redis_unixsocket: ''
```
If set, Redis will also listen on a local Unix socket.
```yaml
redis_timeout: 300
```
Close a connection after a client is idle `N` seconds. Set to `0` to disable timeout.
```yaml
redis_loglevel: "notice"
redis_logfile: /var/log/redis/redis-server.log
```
Log level and log location (valid levels are `debug`, `verbose`, `notice`, and `warning`).
```yaml
redis_databases: 16
```
The number of Redis databases.
```yaml
# Set to an empty set to disable persistence (saving the DB to disk).
redis_save:
- 900 1
- 300 10
- 60 10000
```
Snapshotting configuration; setting values in this list will save the database to disk if the given number of seconds (e.g. `900`) and the given number of write operations (e.g. `1`) have occurred.
```yaml
redis_rdbcompression: "yes"
redis_dbfilename: dump.rdb
redis_dbdir: /var/lib/redis
```
Database compression and location configuration.
```yaml
redis_maxmemory: 0
```
Limit memory usage to the specified amount of bytes. Leave at 0 for unlimited.
```yaml
redis_maxmemory_policy: "noeviction"
```
The method to use to keep memory usage below the limit, if specified. See [Using Redis as an LRU cache](http://redis.io/topics/lru-cache).
```yaml
redis_maxmemory_samples: 5
```
Number of samples to use to approximate LRU. See [Using Redis as an LRU cache](http://redis.io/topics/lru-cache).
```yaml
redis_appendonly: "no"
```
The appendonly option, if enabled, affords better data durability guarantees, at the cost of slightly slower performance.
```yaml
redis_appendfsync: "everysec"
```
Valid values are `always` (slower, safest), `everysec` (happy medium), or `no` (let the filesystem flush data when it wants, most risky).
```yaml
# Add extra include files for local configuration/overrides.
redis_includes: []
```
Add extra include file paths to this list to include more/localized Redis configuration.
The redis package name for installation via the system package manager. Defaults to `redis-server` on Debian and `redis` on RHEL.
```yaml
redis_package_name: "redis-server"
```
(Default for RHEL shown) The redis package name for installation via the system package manager. Defaults to `redis-server` on Debian and `redis` on RHEL.
```yaml
redis_requirepass: ""
```
Set a password to require authentication to Redis. You can generate a strong password using `echo "my_password_here" | sha256sum`.
```yaml
redis_disabled_commands: []
```
For extra security, you can disable certain Redis commands (this is especially important if Redis is publicly accessible). For example:
```yaml
redis_disabled_commands:
- FLUSHDB
- FLUSHALL
- KEYS
- PEXPIRE
- DEL
- CONFIG
- SHUTDOWN
```
```yaml
redis_extra_config: |-
# Extra redis configuration lines can be added here.
```
Extra Redis configuration lines that will be appended to the end of the `redis.conf` file.
## Dependencies
None.
## Example Playbook
```yaml
- hosts: all
roles:
- role: geerlingguy.redis
```
## License
MIT / BSD
## Author Information
This role was created in 2014 by [Jeff Geerling](https://www.jeffgeerling.com/), author of [Ansible for DevOps](https://www.ansiblefordevops.com/).