Redis

Detailed information on the Redis state store component

Create a Redis Store

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

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

Create a Dapr component

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

Create a file called redis.yaml, and paste the following:

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: statestore
  5.   namespace: default
  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.

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Apply the configuration

Kubernetes

  1. kubectl apply -f redis.yaml

Standalone

To run locally, create a components dir containing the YAML file and provide the path to the dapr run command with the flag --components-path.

Last modified February 16, 2021: Merge pull request #1235 from dapr/update-v0.11 (b4e9fbb)