Skip to content

Commit

Permalink
feat[redis cache plugin]: Add Redis connection parameters full contro…
Browse files Browse the repository at this point in the history
…l support
  • Loading branch information
pierre-claranet committed Jul 4, 2024
1 parent 6d28dd5 commit 73ac680
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions plugins/cache/redis.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
options:
_uri:
description:
- Simple format:
- A colon separated string of connection information for Redis.
- The format is V(host:port:db:password), for example V(localhost:6379:0:changeme).
- To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme).
- To use redis sentinel, use separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
- Full connection control format:
- Redis socket connection parameters as <name>=<value> pairs '&' separated.
- Example: V(host=localhost&port=6379&db=0&password=changeme&socket_keepalive=true).
- See https://redis-py2.readthedocs.io/en/latest/ for Redis connection parameters name and accepted values.
- Redis connection string, 3 possible formats.
- The simple format consist in a colon separated string of connection information for Redis.
- This first format is V(host:port:db:password), for example V(localhost:6379:0:changeme).
- To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme).
- To use redis sentinel, use second format with separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
- To specify advanced connection parameters (keep alive, etc ...), use the 3rd format.
- This last format consists in a '&' separated string of redis connection parameters as <name>=<value> pairs.
- For example V(host=localhost&port=6379&db=0&password=changeme&socket_keepalive=true).
- See https://redis-py2.readthedocs.io/en/latest/ for Redis connection parameters name and accepted values.
required: true
env:
- name: ANSIBLE_CACHE_PLUGIN_CONNECTION
Expand Down

0 comments on commit 73ac680

Please sign in to comment.