Redis

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.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5. spec:
  6.   type: configuration.redis
  7.   version: v1
  8.   metadata:
  9.   - name: redisHost
  10.     value: <address>:6379
  11.   - name: redisPassword
  12.     value: **************
  13.   - name: useEntraID
  14.     value: "true"
  15.   - name: enableTLS
  16.     value: <bool>

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

FieldRequiredDetailsExample
redisHostYOutputThe Redis host address
redisPasswordNOutputThe Redis password
redisUsernameNOutputUsername for Redis host. Defaults to empty. Make sure your Redis server version is 6 or above, and have created acl rule correctly.
enableTLSNOutputIf the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to “false”
clientCertNOutputThe content of the client certificate, used for Redis instances that require client-side certificates. Must be used with clientKey and enableTLS must be set to true. It is recommended to use a secret store as described here
clientKeyNOutputThe content of the client private key, used in conjunction with clientCert for authentication. It is recommended to use a secret store as described here
failoverNOutputProperty to enabled failover configuration. Needs sentinelMasterName to be set. Defaults to “false”
sentinelMasterNameNOutputThe Sentinel master name. See Redis Sentinel Documentation
redisTypeNOutputThe 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”.
redisDBNOutputDatabase selected after connecting to Redis. If “redisType” is “cluster”, this option is ignored. Defaults to “0”.
redisMaxRetriesNOutputMaximum number of times to retry commands before giving up. Default is to not retry failed commands.
redisMinRetryIntervalNOutputMinimum backoff for Redis commands between each retry. Default is “8ms”; “-1” disables backoff.
redisMaxRetryIntervalNOutputMaximum backoff for Redis commands between each retry. Default is “512ms”;“-1” disables backoff.
dialTimeoutNOutputDial timeout for establishing new connections. Defaults to “5s”.
readTimeoutNOutputTimeout for socket reads. If reached, Redis commands fail with a timeout instead of blocking. Defaults to “3s”, “-1” for no timeout.
writeTimeoutNOutputTimeout for socket writes. If reached, Redis commands fail with a timeout instead of blocking. Defaults is readTimeout.
poolSizeNOutputMaximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU.
poolTimeoutNOutputAmount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second.
maxConnAgeNOutputConnection age at which the client retires (closes) the connection. Default is to not close aged connections.
minIdleConnsNOutputMinimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to “0”.
idleCheckFrequencyNOutputFrequency of idle checks made by idle connections reaper. Default is “1m”. “-1” disables idle connections reaper.
idleTimeoutNOutputAmount 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.

    1. helm repo add bitnami https://charts.bitnami.com/bitnami
    2. 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:

    1.     metadata:
    2.     - name: redisHost
    3.       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:

    1.     metadata:
    2.     - name: redisPassword
    3.       value: lhDOkwTlp0

AWS Redis

  1. Create an Azure Cache for Redis instance using the official Microsoft documentation.

  2. Once your instance is created, grab the Host name (FQDN) and your access key from the Azure portal.

    • For the Host name:
      • Navigate to the resource’s Overview page.
      • Copy the Host name value.
    • For your access key:
      • Navigate to Settings > Access Keys.
      • Copy and save your key.

  3. Add your key and your host name 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 the Component format section.

  4. 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.

  5. Enable EntraID support:

    • Enable Entra ID authentication on your Azure Redis server. This may takes a few minutes.
    • Set useEntraID to "true" to implement EntraID support for Azure Cache for Redis.
  6. Set enableTLS to "true" to support TLS.

Note:useEntraID assumes that either your UserPrincipal (via AzureCLICredential) or the SystemAssigned managed identity have the RedisDataOwner role permission. If a user-assigned identity is used, you need to specify the azureClientID property.

GCP Cloud MemoryStore

Last modified October 11, 2024: Fixed typo (#4389) (fe17926)