Redis Streams
Component format
To set up Redis Streams pub/sub, create a component of type pubsub.redis. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: redis-pubsub
spec:
type: pubsub.redis
version: v1
metadata:
- name: redisHost
value: localhost:6379
- name: redisPassword
value: "KeFg23!"
- name: consumerID
value: "channel1"
- name: useEntraID
value: "true"
- name: enableTLS
value: "false"
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 |
| 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" |
| consumerID | N | The consumer group ID. | Can be set to string value (such as "channel1" in the example above) or string format value (such as "{podName}", etc.). See all of template tags you can use in your component metadata. |
| useEntraID | N | Implements EntraID support for Azure Cache for Redis. Before enabling this:
| "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" |
| clientCert | N | The 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 | "----BEGIN CERTIFICATE-----\nMIIC..." |
| clientKey | N | The content of the client private key, used in conjunction with clientCert for authentication. It is recommended to use a secret store as described here | "----BEGIN PRIVATE KEY-----\nMIIE..." |
| redeliverInterval | N | The interval between checking for pending messages to redeliver. Can use either be Go duration string (for example “ms”, “s”, “m”) or milliseconds number. Defaults to "60s". "0" disables redelivery. | "30s", "5000" |
| processingTimeout | N | The amount time that a message must be pending before attempting to redeliver it. Can use either be Go duration string ( for example “ms”, “s”, “m”) or milliseconds number. Defaults to "15s". "0" disables redelivery. | "60s", "600000" |
| queueDepth | N | The size of the message queue for processing. Defaults to "100". | "1000" |
| concurrency | N | The number of concurrent workers that are processing messages. Defaults to "10". | "15" |
| 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 | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | "5" |
| redisMinRetryInterval | N | Minimum backoff for redis commands between each retry. Default is "8ms"; "-1" disables backoff. | "8ms" |
| redisMaxRetryInterval | N | Maximum backoff for redis commands between each retry. Default is "512ms";"-1" disables backoff. | "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" |
| 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" |
| sentinelUsername | N | Username for Redis Sentinel. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled | "username" |
| sentinelPassword | N | Password for Redis Sentinel. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled | "password" |
| maxLenApprox | N | Maximum number of items inside a stream.The old entries are automatically evicted when the specified length is reached, so that the stream is left at a constant size. Defaults to unlimited. | "10000" |
| streamTTL | N | TTL duration for stream entries. Entries older than this duration will be evicted. This is an approximate value, as it’s implemented using Redis stream’s MINID trimming with the ‘~’ modifier. The actual retention may include slightly more entries than strictly defined by the TTL, as Redis optimizes the trimming operation for efficiency by potentially keeping some additional entries. | "30d" |
Create a Redis instance
Dapr can use any Redis instance - containerized, running on your local dev machine, or a managed cloud service, provided the version of Redis is 5.x or 6.x.
The Dapr CLI will automatically create and setup a Redis Streams instance for you.
The Redis instance will be installed via Docker when you run dapr init, and the component file will be created in default directory. ($HOME/.dapr/components directory (Mac/Linux) or %USERPROFILE%\.dapr\components on Windows).
You can use Helm to quickly create a Redis instance in our Kubernetes cluster. This approach requires Installing Helm.
Install Redis into your cluster.
helm repo add bitnami https://charts.bitnami.com/bitnami helm install redis bitnami/redis --set image.tag=6.2Run
kubectl get podsto see the Redis containers now running in your cluster.Add
redis-master:6379as theredisHostin your redis.yaml file. For example:metadata: - name: redisHost value: redis-master:6379Next, we’ll get our 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 will create a file with your encoded password. Next, runcertutil -decode encoded.b64 password.txt, which will put your redis password in a text file calledpassword.txt. Copy the password and delete the two files.Linux/MacOS: Run
kubectl get secret --namespace default redis -o jsonpath="{.data.redis-password}" | base64 --decodeand copy the outputted password.
Add this password as the
redisPasswordvalue in your redis.yaml file. For example:- name: redisPassword value: "lhDOkwTlp0"
Create an Azure Cache for Redis instance using the official Microsoft documentation.
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.
- For the Host name:
Add your key and your host name to a
redis.yamlfile 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.yamlfile as specified in the Component format section.
- If you’re running a sample, add the host and key to the provided
Set the
redisHostkey to[HOST NAME FROM PREVIOUS STEP]:6379and theredisPasswordkey to the key you saved earlier.Note: In a production-grade application, follow secret management instructions to securely manage your secrets.
Enable EntraID support:
- Enable Entra ID authentication on your Azure Redis server. This may takes a few minutes.
- Set
useEntraIDto"true"to implement EntraID support for Azure Cache for Redis.
Set
enableTLSto"true"to support TLS.
Note:
useEntraIDassumes 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 theazureClientIDproperty.
Note
The Dapr CLI automatically deploys a local redis instance in self hosted mode as part of thedapr init command.Redis Sentinel configuration
When using Redis Sentinel for high availability, set redisType to "node", enable failover mode with failover: "true", and provide the sentinel master name. Multiple sentinel addresses can be specified as a comma-separated list in the redisHost field for redundancy.
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: redis-pubsub
spec:
type: pubsub.redis
version: v1
metadata:
- name: redisHost
value: "sentinel1:26379,sentinel2:26379,sentinel3:26379"
- name: redisType
value: "node"
- name: failover
value: "true"
- name: sentinelMasterName
value: "mymaster"
```
Related links
- Basic schema for a Dapr component
- Read this guide for instructions on configuring pub/sub components
- Pub/Sub building block