https://github.com/hifis-net/ansible-role-redis

:warning: PLEASE NOTE: This role has been migrated to our hifis.toolkit collection. :warning: Ansible role for setting up a highly available Redis cluster.
https://github.com/hifis-net/ansible-role-redis

ansible ansible-galaxy ansible-role hifis redis redis-cluster redis-role

Last synced: 9 days ago
JSON representation

:warning: PLEASE NOTE: This role has been migrated to our hifis.toolkit collection. :warning: Ansible role for setting up a highly available Redis cluster.

• Host: GitHub
• URL: https://github.com/hifis-net/ansible-role-redis
• Owner: hifis-net
• License: other
• Created: 2021-04-22T12:50:39.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-23T09:17:16.000Z (6 months ago)
• Last Synced: 2024-05-23T09:47:21.941Z (6 months ago)
• Topics: ansible, ansible-galaxy, ansible-role, hifis, redis, redis-cluster, redis-role
• Language: Jinja
• Homepage: https://galaxy.ansible.com/hifis/toolkit
• Size: 607 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Citation: CITATION.cff
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


# Redis Ansible Role

:warning: **This project is archived!** :warning:

This role has been migrated to our `hifis.toolkit` collection:

- 

- 

[![CI Status](https://github.com/hifis-net/ansible-role-redis/actions/workflows/ci.yml/badge.svg)](https://github.com/hifis-net/ansible-role-redis/actions/workflows/ci.yml)

[![Ansible Role: hifis.redis](https://img.shields.io/badge/role-hifis.redis-blue)](https://galaxy.ansible.com/ui/standalone/roles/hifis/redis/)

[![Ansible Role Downloads](https://img.shields.io/ansible/role/d/hifis/redis)](https://galaxy.ansible.com/ui/standalone/roles/hifis/redis/)

[![Apache-2.0 Licensed](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/hifis-net/ansible-role-redis/blob/main/LICENSES/Apache-2.0.txt)

[![Latest release](https://img.shields.io/github/v/release/hifis-net/ansible-role-redis)](https://github.com/hifis-net/ansible-role-redis/releases)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8366541.svg)](https://doi.org/10.5281/zenodo.8366541)

A role to set up Redis instances to be used as caching servers in a high

availability and scalability context.

Currently [supported platforms](meta/main.yml) are:

- Ubuntu 20.04 LTS

- Ubuntu 22.04 LTS

## Requirements

None.

## Role Variables

The Redis version to install:

```yaml

redis_version: '7.2.1'

```

Specifies whether the current node is `master`, or a `replica` instance:

```yaml

redis_instance_type: 'master'

```

The IP address to bind Redis to:

```yaml

redis_instance_ip: "127.0.0.1"

```

The Redis Master instance IP address:

```yaml

redis_master_instance_ip: "{{ redis_instance_ip if redis_instance_type == 'master' else None }}"

```

The name of the Redis cluster monitored by Sentinel:

```yaml

redis_cluster_name: 'redis-cluster'

```

Password used to authenticate in the Redis cluster:

```yaml

redis_password: 'changeme'

```

List of dependent packages required by Redis Server:

```yaml

redis_dependencies:

  - 'build-essential'

```

URL from which Redis Server can be downloaded:

```yaml

redis_download_url: "https://download.redis.io/releases/redis-{{ redis_version }}.tar.gz"

```

File path to the Redis Server binary:

```yaml

redis_bin: '/usr/local/bin/redis-server'

```

File path to the directory in which Redis Server is build:

```yaml

redis_build_dir: '/usr/local/src/redis-{{ redis_version }}'

```

Directory into which Redis service files are copied:

```yaml

redis_systemd_dir: '/etc/systemd/system'

```

Redis Server service file path:

```yaml

redis_server_service_file: '{{ redis_systemd_dir }}/redis-server.service'

```

Redis Sentinel service file path:

```yaml

redis_sentinel_service_file: '{{ redis_systemd_dir }}/redis-sentinel.service'

```

Password for Redis Sentinel. This is unset by default.

```yaml

redis_sentinel_password: 'changeme'

```

Redis configuration directory path:

```yaml

redis_configuration_dir: '/etc/redis'

```

Path to Redis Server configuration file:

```yaml

redis_server_configuration_file: '{{ redis_configuration_dir }}/redis.conf'

```

Path to Redis Sentinel configuration file:

```yaml

redis_sentinel_configuration_file: '{{ redis_configuration_dir }}/sentinel.conf'

```

Redis library directory:

```yaml

redis_lib_dir: '/var/lib/redis'

```

Redis logging directory:

```yaml

redis_log_dir: '/var/log/redis'

```

Path to Redis Server log file:

```yaml

redis_server_log_file_path: "{{ redis_log_dir }}/redis-server.log"

```

Path to Redis Sentinel log file:

```yaml

redis_sentinel_log_file_path: "{{ redis_log_dir }}/redis-sentinel.log"

```

Redis log level, can be one of: `debug`, `verbose`, `notice`, `warning`:

```yaml

redis_log_level: 'notice'

```

Sentinel log level, can be one of: `debug`, `verbose`, `notice`, `warning`:

```yaml

sentinel_log_level: 'notice'

```

Enable/disable Redis Server protected mode:

```yaml

redis_protected_mode: 'yes'

```

Enable/disable Redis Sentinel protected mode:

```yaml

sentinel_protected_mode: 'yes'

```

Redis username:

```yaml

redis_user: 'redis'

```

Redis group name:

```yaml

redis_group: 'redis'

```

Redis Server service name:

```yaml

redis_server_service_name: 'redis-server'

```

Redis Sentinel service name:

```yaml

redis_sentinel_service_name: 'redis-sentinel'

```

## Dependencies

None.

## Example Playbook

```yaml

- hosts: servers

  roles:

    - role: hifis.redis

```

## License

[Apache-2.0](LICENSES/Apache-2.0.txt)

## Author Information

[HIFIS Software Team](https://software.hifis.net)