Redis Streams

Detailed documentation on the Redis Streams pubsub component

Component format

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

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: redis-pubsub
  5.   namespace: default
  6. spec:
  7.   type: pubsub.redis
  8.   version: v1
  9.   metadata:
  10.   - name: redisHost
  11.     value: localhost:6379
  12.   - name: redisPassword
  13.     value: "KeFg23!"
  14.   - name: consumerID
  15.     value: "myGroup"
  16.   - name: enableTLS
  17.     value: "false"

Warning

以上示例将 Secret 明文存储。 更推荐的方式是使用 Secret 组件， here。

Spec metadata fields

字段RequiredDetailsExample
redisHostYConnection-string for the redis hostlocalhost:6379, redis-master.default.svc.cluster.local:6379
redisPasswordYPassword for Redis host. No Default. Can be secretKeyRef to use a secret reference“”, “KeFg23!”
consumerIDNThe consumer group ID“myGroup”
enableTLSNIf the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to “false”“true”, “false”

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.0.0 or later.

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.

  1. Install Redis into your cluster.

    1. helm repo add bitnami https://charts.bitnami.com/bitnami
    2. helm install redis bitnami/redis

  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, 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, 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.     - name: redisPassword
    2.       value: "lhDOkwTlp0"

AWS Redis

GCP Cloud MemoryStore

Azure Redis

Note

The Dapr CLI automatically deploys a local redis instance in self hosted mode as part of the dapr init command.

相关链接

Last modified January 1, 0001