Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idealista/redis_role
Ansible role to install Redis Server nodes. Single and Cluster mode available
https://github.com/idealista/redis_role
ansible ansible-role debian playbook redis redis-cluster redis-server
Last synced: 16 days ago
JSON representation
Ansible role to install Redis Server nodes. Single and Cluster mode available
- Host: GitHub
- URL: https://github.com/idealista/redis_role
- Owner: idealista
- License: apache-2.0
- Created: 2017-04-20T09:01:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-16T14:25:54.000Z (12 months ago)
- Last Synced: 2024-10-20T03:29:18.872Z (2 months ago)
- Topics: ansible, ansible-role, debian, playbook, redis, redis-cluster, redis-server
- Language: YAML
- Homepage: https://galaxy.ansible.com/idealista/redis_role/
- Size: 277 KB
- Stars: 9
- Watchers: 26
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Redis Ansible role
[](https://app.travis-ci.com/github/idealista/redis_role)
[](https://galaxy.ansible.com/idealista/redis_role)
This Ansible role installs Redis server in a Debian environment.
- [Redis Ansible role](#redis-ansible-role)
- [Getting Started](#getting-started)
- [Prerequisities](#prerequisities)
- [Installing](#installing)
- [Usage](#usage)
- [Testing](#testing)
- [Install dependencies](#install-dependencies)
- [Testing single mode](#testing-single-mode)
- [Testing cluster mode](#testing-cluster-mode)
- [Built With](#built-with)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Contributing](#contributing)
## Getting Started
These instructions will get you a copy of the role for your Ansible playbook. Once launched, it will install a [Redis](https://redis.io/) server.
### Prerequisities
Ansible 2.9.x.x version installed.
Inventory destination should be a Debian environment.
For testing purposes, [Molecule](https://molecule.readthedocs.io/) with [Docker](https://www.docker.com/) as driver.
### Installing
Create or add to your roles dependency file (e.g requirements.yml):
```
- src: idealista.redis_role
version: 4.0.3
name: redis
```
Install the role with ansible-galaxy command:
```
ansible-galaxy install -p roles -r requirements.yml -f
```
Use in a playbook:
```
- hosts: someserver
roles:
- redis
```
## Usage
ATTENTION since version 5.0.0 we have introduced authentication and it is important to use two variables:
- redis_auth which is mandatory to have a value (true/false)
- redis_password which defines the password that will be set, remember to put it in the vault so that it is not left unencrypted (it must be 30 characters, with numbers, upper and lower case)
IF THESE VARIABLES ARE NOT CORRECTLY CONFIGURED, THE ROLE INSTALLATION WILL FAIL WITH AN EXPLANATORY MESSAGE.
Look to the [defaults](defaults/main.yml) properties file to see the possible configuration properties.
**Note:** It's recommended to use [Prometheus Redis Exporter Role](https://github.com/idealista/prometheus_redis_exporter-role) if Prometheus monitoring is needed.
## Testing
### Install dependencies
```sh
$ pipenv sync
```
For more information read the [pipenv docs](https://docs.pipenv.org/).
### Testing single mode
```sh
$ pipenv run molecule test -s single
```
### Testing cluster mode
```sh
$ pipenv run molecule test -s cluster
```
## Built With
## Versioning
For the versions available, see the [tags on this repository](https://github.com/idealista/redis_role/tags).
Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.
## Authors
* **Idealista** - *Work with* - [idealista](https://github.com/idealista)
See also the list of [contributors](https://github.com/idealista/redis_role/contributors) who participated in this project.
## License
This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details.
## Contributing
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.