Configuration store component specs on Dapr Docs

Azure App Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up an Azure App Configuration configuration store, create a component of type configuration.azure.appconfig.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: configuration.azure.appconfig
 version: v1
 metadata:
 - name: host # host should be used when Azure Authentication mechanism is used.
 value: <HOST>
 - name: connectionString # connectionString should not be used when Azure Authentication mechanism is used.
 value: <CONNECTIONSTRING>
 - name: maxRetries
 value: # Optional
 - name: retryDelay
 value: # Optional
 - name: maxRetryDelay
 value: # Optional
 - name: azureEnvironment # Optional, defaults to AZUREPUBLICCLOUD
 value: "AZUREPUBLICCLOUD"
 # See authentication section below for all options
 - name: azureTenantId # Optional
 value: "[your_service_principal_tenant_id]"
 - name: azureClientId # Optional
 value: "[your_service_principal_app_id]"
 - name: azureCertificateFile # Optional
 value : "[pfx_certificate_file_fully_qualified_local_path]"
 - name: subscribePollInterval # Optional
 value: #Optional [Expected format example - 24h]

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
connectionString	Y*	Connection String for the Azure App Configuration instance. No Default. Can be `secretKeyRef` to use a secret reference. Mutually exclusive with host field. Not to be used when Azure Authentication is used	`Endpoint=https://foo.azconfig.io;Id=osOX-l9-s0:sig;Secret=00000000000000000000000000000000000000000000`
host	N*	Endpoint for the Azure App Configuration instance. No Default. Mutually exclusive with connectionString field. To be used when Azure Authentication is used	`https://dapr.azconfig.io`
maxRetries	N	Maximum number of retries before giving up. Defaults to `3`	`5`, `10`
retryDelay	N	RetryDelay specifies the initial amount of delay to use before retrying an operation. The delay increases exponentially with each retry up to the maximum specified by MaxRetryDelay. Defaults to `4` seconds; `"-1"` disables delay between retries.	`4s`
maxRetryDelay	N	MaxRetryDelay specifies the maximum delay allowed before retrying an operation. Typically the value is greater than or equal to the value specified in RetryDelay. Defaults to `120` seconds; `"-1"` disables the limit	`120s`
subscribePollInterval	N	subscribePollInterval specifies the poll interval in nanoseconds for polling the subscribed keys for any changes. This will be updated in the future to Go Time format. Default polling interval is set to `24` hours.	`24h`

Note: either host or connectionString must be specified.

Kubernetes ConfigMap

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up a Kubernetes ConfigMap configuration store, create a component of type configuration.kubernetes. See this guide on how to create and apply a configuration store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: configuration.kubernetes
 version: v1
 metadata:
 - name: configMapName
 value: "<CONFIGMAP_NAME>"
 # Optional: path to kubeconfig (only needed when running outside the cluster)
 #- name: kubeconfigPath
 # value: "/path/to/kubeconfig"
 # Optional: informer resync period
 #- name: resyncPeriod
 # value: "0"

Spec metadata fields

Field	Required	Details	Example
`configMapName`	Y	The name of the Kubernetes ConfigMap to use as the configuration source. Must be a valid RFC 1123 DNS label name.	`"my-app-config"`
`kubeconfigPath`	N	Path to a kubeconfig file. When running inside a Kubernetes cluster (the typical case), this is not needed. When running outside the cluster, it falls back to the `KUBECONFIG` environment variable, then to `~/.kube/config`.	`"/path/to/kubeconfig"`
`resyncPeriod`	N	How often the informer fully re-syncs the ConfigMap state from the API server as a consistency safety net, independent of watch events. Set to `"0"` (default) to disable periodic resync and rely solely on watch events.	`"10m"`

Set up a Kubernetes ConfigMap as Configuration Store

The Kubernetes ConfigMap configuration store requires no external infrastructure beyond the Kubernetes cluster itself.

PostgreSQL

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up an PostgreSQL configuration store, create a component of type configuration.postgresql

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: configuration.postgresql
 version: v1
 metadata:
 # Connection string
 - name: connectionString
 value: "host=localhost user=postgres password=example port=5432 connect_timeout=10 database=config"
 # Name of the table which holds configuration information
 - name: table
 value: "[your_configuration_table_name]" 
 # Individual connection parameters - can be used instead to override connectionString parameters
 #- name: host
 # value: "localhost"
 #- name: hostaddr
 # value: "127.0.0.1"
 #- name: port
 # value: "5432"
 #- name: database
 # value: "my_db"
 #- name: user
 # value: "postgres"
 #- name: password
 # value: "example"
 #- name: sslRootCert
 # value: "/path/to/ca.crt"
 # Timeout for database operations, in seconds (optional)
 #- name: timeoutInSeconds
 # value: 20
 # Name of the table where to store the state (optional)
 #- name: tableName
 # value: "state"
 # Name of the table where to store metadata used by Dapr (optional)
 #- name: metadataTableName
 # value: "dapr_metadata"
 # Cleanup interval in seconds, to remove expired rows (optional)
 #- name: cleanupIntervalInSeconds
 # value: 3600
 # Maximum number of connections pooled by this component (optional)
 #- name: maxConns
 # value: 0
 # Max idle time for connections before they're closed (optional)
 #- name: connectionMaxIdleTime
 # value: 0
 # Controls the default mode for executing queries. (optional)
 #- name: queryExecMode
 # value: ""
 # Uncomment this if you wish to use PostgreSQL as a state store for actors (optional)
 #- name: actorStateStore
 # value: "true"

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

Authenticate using a connection string

The following metadata options are required to authenticate using a PostgreSQL connection string.

Redis

Mon, 01 Jan 0001 00:00:00 +0000

Component format

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

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: configuration.redis
 version: v1
 metadata:
 - name: redisHost
 value: <address>:6379
 - name: redisPassword
 value: **************
 - name: useEntraID
 value: "true"
 - name: enableTLS
 value: <bool>

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	Output	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.
redisPassword	N	Output	The Redis password
redisUsername	N	Output	Username for Redis host. Defaults to empty. Make sure your Redis server version is 6 or above, and have created acl rule correctly.
enableTLS	N	Output	If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"`
clientCert	N	Output	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
clientKey	N	Output	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
failover	N	Output	Property to enable failover configuration. Needs sentinelMasterName to be set. When enabled, redisHost should contain the sentinel addresses. Defaults to `"false"`
sentinelMasterName	N	Output	The Sentinel master name. See Redis Sentinel Documentation
sentinelUsername	N	Output	Username for Redis Sentinel. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled
sentinelPassword	N	Output	Password for Redis Sentinel. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled
redisType	N	Output	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"`.
redisDB	N	Output	Database selected after connecting to Redis. If `"redisType"` is `"cluster"`, this option is ignored. Defaults to `"0"`.
redisMaxRetries	N	Output	Maximum number of times to retry commands before giving up. Default is to not retry failed commands.
redisMinRetryInterval	N	Output	Minimum backoff for Redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff.
redisMaxRetryInterval	N	Output	Maximum backoff for Redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff.
dialTimeout	N	Output	Dial timeout for establishing new connections. Defaults to `"5s"`.
readTimeout	N	Output	Timeout for socket reads. If reached, Redis commands fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout.
writeTimeout	N	Output	Timeout for socket writes. If reached, Redis commands fail with a timeout instead of blocking. Defaults is readTimeout.
poolSize	N	Output	Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU.
poolTimeout	N	Output	Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second.
maxConnAge	N	Output	Connection age at which the client retires (closes) the connection. Default is to not close aged connections.
minIdleConns	N	Output	Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`.
idleCheckFrequency	N	Output	Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper.
idleTimeout	N	Output	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.

Setup Redis

Dapr can use any Redis instance: containerized, running on your local dev machine, or a managed cloud service.