Detailed information on the Redis configuration store component

Component format

To setup Redis configuration store create a component of type configuration.redis. See this guide on how to create and apply a configuration store configuration.

kind: Component
  name: <NAME>
  type: configuration.redis
  version: v1
  - name: redisHost
    value: <address>:6379
  - name: redisPassword
    value: **************
  - name: enableTLS
    value: <bool>

Spec metadata fields

Field Required Details Example
redisHost Y Output The Redis host address
redisPassword Y Output The Redis password
redisUsername N Output Username for Redis host. Defaults to empty. Make sure your Redis server version is 6 or above, and have created acl rule correctly.
enableTLS N Output If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to "false"
failover N Output Property to enabled failover configuration. Needs sentinelMasterName to be set. Defaults to "false"
sentinelMasterName N Output The Sentinel master name. See Redis Sentinel Documentation
redisType N Output 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".
redisDB N Output Database selected after connecting to Redis. If "redisType" is "cluster", this option is ignored. Defaults to "0".
redisMaxRetries N Output Maximum number of times to retry commands before giving up. Default is to not retry failed commands.
redisMinRetryInterval N Output Minimum backoff for Redis commands between each retry. Default is "8ms"; "-1" disables backoff.
redisMaxRetryInterval N Output Maximum backoff for Redis commands between each retry. Default is "512ms";"-1" disables backoff.
dialTimeout N Output Dial timeout for establishing new connections. Defaults to "5s".
readTimeout N Output Timeout for socket reads. If reached, Redis commands fail with a timeout instead of blocking. Defaults to "3s", "-1" for no timeout.
writeTimeout N Output Timeout for socket writes. If reached, Redis commands fail with a timeout instead of blocking. Defaults is readTimeout.
poolSize N Output Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU.
poolTimeout N Output Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second.
maxConnAge N Output Connection age at which the client retires (closes) the connection. Default is to not close aged connections.
minIdleConns N Output Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to "0".
idleCheckFrequency N Output Frequency of idle checks made by idle connections reaper. Default is "1m". "-1" disables idle connections reaper.
idleTimeout N Output 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.

Setup Redis

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

A Redis instance is automatically created as a Docker container when you run dapr init

You can use Helm to quickly create a Redis instance in our Kubernetes cluster. This approach requires Installing Helm.

  1. Install Redis into your cluster. Note that we’re explicitly setting an image tag to get a version greater than 5, which is what Dapr’ pub/sub functionality requires. If you’re intending on using Redis as just a state store (and not for pub/sub), you do not have to set the image version.

    helm repo add bitnami
    helm install redis bitnami/redis --set image.tag=6.2
  2. Run kubectl get pods to see the Redis containers now running in your cluster.

  3. Add redis-master:6379 as the redisHost in your redis.yaml file. For example:

        - name: redisHost
          value: redis-master:6379
  4. Next, get the Redis password, which is slightly different depending on the OS we’re using:

    • Windows: Run kubectl get secret --namespace default redis -o jsonpath="{.data.redis-password}" > encoded.b64, which creates a file with your encoded password. Next, run certutil -decode encoded.b64 password.txt, which will put your redis password in a text file called password.txt. Copy the password and delete the two files.

    • Linux/MacOS: Run kubectl get secret --namespace default redis -o jsonpath="{.data.redis-password}" | base64 --decode and copy the outputted password.

    Add this password as the redisPassword value in your redis.yaml file. For example:

        - name: redisPassword
          value: lhDOkwTlp0

Note: this approach requires having an Azure Subscription.

  1. Start the Azure Cache for Redis creation flow. Log in if necessary.

  2. Fill out necessary information and check the “Unblock port 6379” box, which will allow us to persist state without SSL.

  3. Click “Create” to kickoff deployment of your Redis instance.

  4. Once your instance is created, you’ll need to grab the Host name (FQDN) and your access key:

    • For the Host name: navigate to the resource’s “Overview” and copy “Host name”.
    • For your access key: navigate to “Settings” > “Access Keys” to copy and save your key.
  5. Add your key and your host to a redis.yaml file that Dapr can apply to your cluster.

    • If you’re running a sample, add the host and key to the provided redis.yaml.
    • If you’re creating a project from the ground up, create a redis.yaml file as specified in Configuration.

    Set the redisHost key to [HOST NAME FROM PREVIOUS STEP]:6379 and the redisPassword key to the key you saved earlier.

    Note: In a production-grade application, follow secret management instructions to securely manage your secrets.

NOTE: Dapr pub/sub uses Redis Streams that was introduced by Redis 5.0, which isn’t currently available on Azure Managed Redis Cache. Consequently, you can use Azure Managed Redis Cache only for state persistence.

Last modified July 19, 2024: Fixed typo in links (#4267) (32fce1d)