docs/howto/setup-state-store

Setup a Dapr state store

Dapr integrates with existing databases to provide apps with state management capabilities for CRUD operations, transactions and more. Currently, Dapr supports the configuration of one state store per cluster.

State stores are extensible and can be found in the components-contrib repo.

A state store in Dapr is described using a Component file:

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: statestore
  namespace: default
spec:
  type: state.<DATABASE>
  metadata:
  - name: <KEY>
    value: <VALUE>
  - name: <KEY>
    value: <VALUE>
...

The type of database is determined by the type field, and things like connection strings and other metadata are put in the .metadata section. Even though you can put plain text secrets in there, it is recommended you use a secret store.

Running locally

When running locally with the Dapr CLI, a component file for a Redis state store will be automatically created in a components directory in your current working directory.

You can make changes to this file the way you see fit, whether to change connection values or replace it with a different store.

Running in Kubernetes

Dapr uses a Kubernetes Operator to update the sidecars running in the cluster with different components. To setup a state store in Kubernetes, use kubectl to apply the component file:

kubectl apply -f statestore.yaml

Related Topics

• State management concepts
• State management API specification

Reference

• Setup Aerospike
• Setup Cassandra
• Setup Cloudstate
• Setup Couchbase
• Setup etcd
• Setup Hashicorp Consul
• Setup Hazelcast
• Setup Memcached
• Setup MongoDB
• Setup PostgreSQL
• Setup Redis
• Setup Zookeeper
• Setup Azure CosmosDB
• Setup Azure SQL Server
• Setup Azure Table Storage
• Setup Azure Blob Storage
• Setup Google Cloud Firestore (Datastore mode)
• Supported State Stores