Skip to content

Commit dc423b8

Browse files
committed
update README.md
1 parent 4ecc47d commit dc423b8

File tree

1 file changed

+82
-59
lines changed

1 file changed

+82
-59
lines changed

README.md

Lines changed: 82 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
<!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
22

3+
34
<p align="center"> <img src="https://user-images.githubusercontent.com/50652676/62451340-ba925480-b78b-11e9-99f0-13a8a9cc0afa.png" width="100" height="100"></p>
45

56
<h1 align="center">
67
Ansible Role Docker Redis
78
</h1>
89

9-
<p align="center" style="font-size: 1.2rem;">
10-
This ansible role is used to setup Redis server with docker on Debian.
10+
<p align="center" style="font-size: 1.2rem;">
11+
This ansible role is used to setup Redis server with docker on linux.
1112
</p>
1213

1314
<p align="center">
@@ -25,14 +26,16 @@
2526
<img src="https://img.shields.io/badge/ubuntu-20.x-orange?style=flat&logo=ubuntu" alt="Distribution">
2627
</a>
2728
<a href="https://www.centos.org/">
28-
<img src="https://img.shields.io/badge/centos-8.x-orange" alt="Distribution">
29+
<img src="https://img.shields.io/badge/CentOS-8-green?style=flat&logo=centos" alt="Distribution">
2930
</a>
3031
<a href="https://aws.amazon.com/amazon-linux-ami/">
31-
<img src="https://img.shields.io/badge/Amazone_linux-2-yellow?style=flat&logo=linux" alt="Distribution">
32+
<img src="https://img.shields.io/badge/Amazon_linux-2-yellow?style=flat&logo=linux" alt="Distribution">
3233
</a>
3334
<a href="https://github.com/clouddrove/ansible-role-docker-redis/actions/workflows/lint.yml">
3435
<img src="https://github.com/clouddrove/ansible-role-docker-redis/actions/workflows/lint.yml/badge.svg" alt="Actions">
3536
</a>
37+
38+
3639
</p>
3740
<p align="center">
3841

@@ -49,94 +52,114 @@
4952
</p>
5053
<hr>
5154

52-
We eat, drink, sleep and most importantly love **DevOps**. DevOps always promotes automation and standardisation. While setting up various environments like local, dev, testing, production, etc. it is critical to maintain the same environment across. This can easily be achieved using automating the environment setup & installation with the help of ansible-playbooks.
55+
56+
57+
We eat, drink, sleep and most importantly love **DevOps**. DevOps always promotes automation and standardisation. While setting up various environments like local, dev, testing, production, etc. it is critical to maintain the same environment across. This can easily be achieved using automating the environment setup & installation with the help of ansible-playbooks.
5358

5459
Smaller roles are created for each environment elements; which also include tasks & tests. These roles can then be grouped together in [ansible-playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html) to achieve the desired yet consistent results.
5560

61+
62+
5663
## Prerequisites
5764

58-
This module has a few dependencies:
65+
This module has a few dependencies:
5966

6067
- [Ansible2.9](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
6168
- [Python](https://www.python.org/downloads)
6269
- [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu)
6370

71+
72+
73+
6474
## What Includes
6575

66-
Followiing things includes in this role:
76+
Following things includes in this role:
6777

6878
- redis-cli
6979
- redis-server
7080

81+
82+
83+
84+
85+
86+
7187
## Example Playbook
7288

7389
**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/ansible-role-docker-redis/releases).
7490

91+
7592
```yaml
7693
- hosts: localhost
77-
remote_user: ubuntu
94+
remote_user: root
7895
become: true
7996
roles:
8097
- clouddrove.ansible_role_docker_redis
8198
```
8299
100+
83101
## Variables
84102
85103
```yaml
86-
redis_version: "6.2"
87-
redis_user: redis
88-
redis_group: redis
89-
mount_path: /data
90-
redis_server_opt_dir: "/opt/redis-server"
91-
redis_server_config_dir: "{{ redis_server_opt_dir }}/config"
92-
redis_server_log_dir: "/var/log/redis"
93-
redis_server_data_dir: "{{ mount_path }}/redis-server"
94-
redis_server_bind: 0.0.0.0
95-
redis_server_port: 6379
96-
redis_server_password: false
97-
redis_server_min_slaves_to_write: 0
98-
redis_server_min_slaves_max_lag: 10
99-
redis_server_tcp_backlog: 10000
100-
redis_server_tcp_keepalive: 20
101-
redis_server_maxclients: 30000
102-
redis_server_timeout: 0
103-
redis_server_slaveof: false
104-
redis_server_slave_read_only: "yes"
105-
redis_server_slave_priority: 100
106-
redis_server_repl_backlog_size: false
107-
redis_server_dir: /var/lib/redis
108-
redis_server_logfile: '"/var/log/redis/redis-server.log"'
109-
redis_server_databases: 16
110-
redis_server_loglevel: notice
111-
redis_server_slowlog_log_slower_than: 10000
112-
redis_server_slowlog_max_len: 128
113-
redis_server_maxmemory: false
114-
redis_server_maxmemory_policy: noeviction
115-
redis_server_rename_commands: []
116-
redis_server_save:
117-
- 900 1
118-
- 300 10
119-
- 60 10000
120-
redis_server_stop_writes_on_bgsave_error: "yes"
121-
redis_server_rdbcompression: "yes"
122-
redis_server_rdbchecksum: "yes"
123-
redis_server_appendonly: "no"
124-
redis_server_appendfilename: "appendonly.aof"
125-
redis_server_appendfsync: "everysec"
126-
redis_server_no_appendfsync_on_rewrite: "no"
127-
redis_server_auto_aof_rewrite_percentage: "100"
128-
redis_server_auto_aof_rewrite_min_size: "64mb"
129-
redis_server_notify_keyspace_events: '""'
104+
redis_version: "6.2"
105+
redis_user: redis
106+
redis_group: redis
107+
mount_path: /data
108+
redis_server_opt_dir: "/opt/redis-server"
109+
redis_server_config_dir: "{{ redis_server_opt_dir }}/config"
110+
redis_server_log_dir: "/var/log/redis"
111+
redis_server_data_dir: "{{ mount_path }}/redis-server"
112+
redis_server_bind: 0.0.0.0
113+
redis_server_port: 6379
114+
redis_server_password: false
115+
redis_server_min_slaves_to_write: 0
116+
redis_server_min_slaves_max_lag: 10
117+
redis_server_tcp_backlog: 10000
118+
redis_server_tcp_keepalive: 20
119+
redis_server_maxclients: 30000
120+
redis_server_timeout: 0
121+
redis_server_slaveof: false
122+
redis_server_slave_read_only: "yes"
123+
redis_server_slave_priority: 100
124+
redis_server_repl_backlog_size: false
125+
redis_server_dir: /var/lib/redis
126+
redis_server_logfile: '"/var/log/redis/redis-server.log"'
127+
redis_server_databases: 16
128+
redis_server_loglevel: notice
129+
redis_server_slowlog_log_slower_than: 10000
130+
redis_server_slowlog_max_len: 128
131+
redis_server_maxmemory: false
132+
redis_server_maxmemory_policy: noeviction
133+
redis_server_rename_commands: []
134+
redis_server_save:
135+
- 900 1
136+
- 300 10
137+
- 60 10000
138+
redis_server_stop_writes_on_bgsave_error: "yes"
139+
redis_server_rdbcompression: "yes"
140+
redis_server_rdbchecksum: "yes"
141+
redis_server_appendonly: "no"
142+
redis_server_appendfilename: "appendonly.aof"
143+
redis_server_appendfsync: "everysec"
144+
redis_server_no_appendfsync_on_rewrite: "no"
145+
redis_server_auto_aof_rewrite_percentage: "100"
146+
redis_server_auto_aof_rewrite_min_size: "64mb"
147+
redis_server_notify_keyspace_events: '""'
130148
```
131149
150+
132151
## Installation
133152
134153
```console
135154
$ ansible-galaxy install clouddrove.ansible_role_docker_redis
136155
```
137156

138-
## Feedback
139157

158+
159+
160+
161+
162+
## Feedback
140163
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/ansible-role-docker-redis/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
141164

142165
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/ansible-role-docker-redis)!
@@ -149,9 +172,9 @@ At [CloudDrove][website], we offer expert guidance, implementation support and s
149172
<hr />
150173
<p align="center">We ❤️ <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://github.com/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p>
151174

152-
[website]: https://clouddrove.com
153-
[github]: https://github.com/clouddrove
154-
[linkedin]: https://cpco.io/linkedin
155-
[twitter]: https://twitter.com/clouddrove/
156-
[email]: https://clouddrove.com/contact-us.html
157-
[terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=
175+
[website]: https://clouddrove.com
176+
[github]: https://github.com/clouddrove
177+
[linkedin]: https://cpco.io/linkedin
178+
[twitter]: https://twitter.com/clouddrove/
179+
[email]: https://clouddrove.com/contact-us.html
180+
[terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=

0 commit comments

Comments
 (0)