Redis

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up the Redis lock, create a component of type lock.redis. See this guide on how to create a lock.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: lock.redis
 version: v1
 metadata:
 - name: redisHost
 value: <HOST>
 - name: redisPassword #Optional.
 value: <PASSWORD>
 - name: useEntraID
 value: <bool> # Optional. Allowed: true, false.
 - name: enableTLS
 value: <bool> # Optional. Allowed: true, false.
 - name: failover
 value: <bool> # Optional. Allowed: true, false.
 - name: sentinelMasterName
 value: <string> # Optional
 - name: maxRetries
 value: # Optional
 - name: maxRetryBackoff
 value: # Optional
 - name: redeliverInterval
 value: # Optional
 - name: processingTimeout
 value: # Optional
 - name: redisType
 value: # Optional
 - name: redisDB
 value: # Optional
 - name: redisMaxRetries
 value: # Optional
 - name: redisMinRetryInterval
 value: # Optional
 - name: redisMaxRetryInterval
 value: # Optional
 - name: dialTimeout
 value: # Optional
 - name: readTimeout
 value: # Optional
 - name: writeTimeout
 value: # Optional
 - name: poolSize
 value: # Optional
 - name: poolTimeout
 value: # Optional
 - name: maxConnAge
 value: # Optional
 - name: minIdleConns
 value: # Optional
 - name: idleCheckFrequency
 value: # Optional
 - name: idleTimeout
 value: # Optional

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets, as described here.

Spec metadata fields

Field	Required	Details	Example
redisHost	Y	Connection-string for the redis host. If `"redisType"` is `"cluster"`, it can be multiple hosts separated by commas or just a single host. When using Redis Sentinel (`"failover"` is `"true"`), multiple sentinel addresses can also be provided as comma-separated values.	`localhost:6379`, `redis-master.default.svc.cluster.local:6379`, `sentinel1:26379,sentinel2:26379,sentinel3:26379` host
redisPassword	N	Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference	`""`, `"KeFg23!"`
redisUsername	N	Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly.	`""`, `"default"`
useEntraID	N	Implements EntraID support for Azure Cache for Redis. Before enabling this: The `redisHost` name must be specified in the form of `"server:port"` TLS must be enabled Learn more about this setting under Create a Redis instance > Azure Cache for Redis	`"true"`, `"false"`
enableTLS	N	If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"`	`"true"`, `"false"`
maxRetries	N	Maximum number of retries before giving up. Defaults to `3`	`5`, `10`
maxRetryBackoff	N	Maximum backoff between each retry. Defaults to `2` seconds; `"-1"` disables backoff.	`3000000000`
failover	N	Property to enable failover configuration. Needs sentinelMasterName to be set. When enabled, redisHost should contain the sentinel addresses. Defaults to `"false"`	`"true"`, `"false"`
sentinelMasterName	N	The sentinel master name. See Redis Sentinel Documentation	`"mymaster"`
sentinelPassword	N	Password for Redis Sentinel. No Default. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled	`""`, `"KeFg23!"`
redeliverInterval	N	The interval between checking for pending messages for redelivery. Defaults to `"60s"`. `"0"` disables redelivery.	`"30s"`
processingTimeout	N	The amount of time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery.	`"30s"`
redisType	N	The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`.	`"cluster"`
redisDB	N	Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`.	`"0"`
redisMaxRetries	N	Alias for `maxRetries`. If both values are set `maxRetries` is ignored.	`"5"`
redisMinRetryInterval	N	Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff.	`"8ms"`
redisMaxRetryInterval	N	Alias for `maxRetryBackoff`. If both values are set `maxRetryBackoff` is ignored.	`"5s"`
dialTimeout	N	Dial timeout for establishing new connections. Defaults to `"5s"`.	`"5s"`
readTimeout	N	Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout.	`"3s"`
writeTimeout	N	Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout.	`"3s"`
poolSize	N	Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime (NumCPU)	`“20”
poolTimeout	N	Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second.	`"5s"`
maxConnAge	N	Connection age at which the client retires (closes) the connection. Default is to not close aged connections.	`"30m"`
minIdleConns	N	Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`.	`"2"`
idleCheckFrequency	N	Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper.	`"-1"`
idleTimeout	N	Amount of time after which the client closes idle connections. Should be less than server’s timeout. Default is `"5m"`. `"-1"` disables idle timeout check.	`"10m"`

Setup Redis

Dapr can use any Redis instance: containerized, running on your local dev machine, or a managed cloud service.

Lock component specs on Dapr Docs

Redis

Component format

Warning

Spec metadata fields

Setup Redis