From 6b13cbf547a62bfc20b0e3fd9f977d851c4533db Mon Sep 17 00:00:00 2001 From: Vishesh Date: Sun, 4 Oct 2020 17:54:17 +0530 Subject: [PATCH] Update docs for redis --- docs/sources/configuration/_index.md | 29 +++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/docs/sources/configuration/_index.md b/docs/sources/configuration/_index.md index 055f50a38305..3909b8c772fa 100644 --- a/docs/sources/configuration/_index.md +++ b/docs/sources/configuration/_index.md @@ -1408,10 +1408,15 @@ memcached_client: [consistent_hash: ] redis: - # Redis service endpoint to use when caching chunks. If empty, no redis will be used. + # Redis Server endpoint to use for caching. A comma-separated list of endpoints + # for Redis Cluster or Redis Sentinel. If empty, no redis will be used. # CLI flag: -.redis.endpoint [endpoint: ] + # Redis Sentinel master name. An empty string for Redis Server or Redis Cluster. + # CLI flag: -.redis.master-name + [master_name: ] + # Maximum time to wait before giving up on redis requests. # CLI flag: -.redis.timeout [timeout: | default = 100ms] @@ -1420,13 +1425,13 @@ redis: # CLI flag: -.redis.expiration [expiration: | default = 0s] - # Maximum number of idle connections in pool. - # CLI flag: -.redis.max-idle-conns - [max_idle_conns: | default = 80] + # Database index. + # CLI flag: -.redis.db + [db: ] - # Maximum number of active connections in pool. - # CLI flag: -.redis.max-active-conns - [max_active_conns: | default = 0] + # Maximum number of connections in the pool. + # CLI flag: -.redis.pool-size + [pool_size: | default = 0] # Password to use when connecting to redis. # CLI flag: -.redis.password @@ -1436,6 +1441,16 @@ redis: # CLI flag: -.redis.enable-tls [enable_tls: | default = false] + # Close connections after remaining idle for this duration. + # If the value is zero, then idle connections are not closed. + # CLI flag: -.redis.idle-timeout + [idle_timeout: | default = 0s] + + # Close connections older than this duration. If the value is zero, then + # the pool does not close connections based on age. + # CLI flag: -.redis.max-connection-age + [max_connection_age: | default = 0s] + fifocache: # Maximum memory size of the cache in bytes. A unit suffix (KB, MB, GB) may be # applied.