Redis

Detailed information on the Redis state store component

配置

To setup Redis state store create a component of type state.redis. 请参阅本指南，了解如何创建和应用状态存储配置。

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5.   namespace: <NAMESPACE>
  6. spec:
  7.   type: state.redis
  8.   version: v1
  9.   metadata:
  10.   - name: redisHost
  11.     value: <HOST>
  12.   - name: redisPassword
  13.     value: <PASSWORD>
  14.   - name: enableTLS
  15.     value: <bool> # Optional. Allowed: true, false.
  16.   - name: failover
  17.     value: <bool> # Optional. Allowed: true, false.
  18.   - name: sentinelMasterName
  19.     value: <string> # Optional
  20.   - name: maxRetries
  21.     value: # Optional
  22.   - name: maxRetryBackoff
  23.     value: # Optional Allowed: true, false.
  24.   - name: failover
  25.     value: <bool> # Optional. Allowed: true, false.
  26.   - name: sentinelMasterName
  27.     value: <string> # Optional
  28.   - name: maxRetries
  29.     value: # Optional
  30.   - name: maxRetryBackoff
  31.     value: # Optional Allowed: true, false.
  32.   - name: failover
  33.     value: <bool> # Optional. Allowed: true, false.
  34.   - name: sentinelMasterName
  35.     value: <string> # Optional
  36.   - name: maxRetries
  37.     value: # Optional
  38.   - name: maxRetryBackoff
  39.     value: # Optional

TLS: If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS true or false.

Failover: When set to true enables the failover feature. The redisHost should be the sentinel host address. See Redis Sentinel Documentation

Warning

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

If you wish to use Redis as an actor store, append the following to the yaml.

  1.   - name: actorStateStore
  2.     value: "true"

元数据字段规范

字段必填详情示例
redisHostYRedis的连接地址localhost:6379, redis-master.default.svc.cluster.local:6379
redisPasswordYRedis的密码 无默认值 可以用secretKeyRef来引用密钥。“”, “KeFg23!”
consumerIDN消费组 ID“mygroup”
enableTLSN如果Redis实例支持使用公共证书的TLS，可以配置为启用或禁用。 默认值为 “false”“true”, “false”
maxRetriesNMaximum number of retries before giving up. Defaults to 35, 10
maxRetryBackoffNMinimum backoff between each retry. Defaults to 2 seconds3000000000
failoverNProperty to enabled failover configuration. Needs sentinalMasterName to be set. 默认值为 “false”“true”, “false”
sentinelMasterNameNThe sentinel master name. See Redis Sentinel Documentation“”, “127.0.0.1:6379”
actorStateStoreN是否将此状态存储给 Actor 使用。 默认值为 “false”“true”, “false”

Setup Redis

Dapr can use any Redis instance - containerized, running on your local dev machine, or a managed cloud service. If you already have a Redis store, move on to the Configuration section.

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

We can use Helm to quickly create a Redis instance in our Kubernetes cluster. 这种方法需要安装Helm。

  1. 安装 Redis 到你的集群： 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

  2. 执行kubectl get pods来查看现在正在集群中运行的Redis容器。

  3. Add redis-master:6379 as the redisHost in your redis.yaml file. 例如:

    1.     metadata:
    2.     - name: redisHost
    3.       value: redis-master:6379

  4. Next, we’ll get the Redis password, which is slightly different depending on the OS we’re using:

    • Windows：执行kubectl get secret --namespace default redis -o jsonpath="{.data.redis-password}" > encoded.b64，这将创建一个有你的加密后密码的文件。 接下来，执行certutil -decode encoded.b64 password.txt，它将把你的redis密码放在一个名为password.txt的文本文件中。 复制密码，删除这两个文件。

    • Linux/MacOS：执行 kubectl get secret --namespace default redis -o jsonpath="{.data.redis-password}" | base64 --decode并复制输出的密码。

    Add this password as the redisPassword value in your redis.yaml file. 例如:

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

Note: this approach requires having an Azure Subscription.

  1. Open this link to start the Azure Cache for Redis creation flow. 如有必要，请登录。
  2. Fill out necessary information and check the “Unblock port 6379” box, which will allow us to persist state without SSL.
  3. 点击“创建”来启动您的 Redis 实例的部署。
  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 resources “Overview” and copy “Host name”
    • for your access key navigate to “Access Keys” under “Settings” and copy your key.
  5. Finally, we need to add our key and our host to a redis.yaml file that Dapr can apply to our cluster. If you’re running a sample, you’ll add the host and key to the provided redis.yaml. If you’re creating a project from the ground up, you’ll 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 copied in step 4. 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.

AWS Redis

GCP Cloud MemoryStore

Note

作为dapr init命令的一部分，Dapr CLI会在自托管模式下自动部署本地redis实例。

相关链接