Memcached

Detailed information on the Memcached state store component

Component format

To setup Memcached state store create a component of type state.memcached. See this guide on how to create and apply a state store configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
spec:
  type: state.memcached
  version: v1
  metadata:
  - name: hosts
    value: <REPLACE-WITH-COMMA-DELIMITED-ENDPOINTS> # Required. Example: "memcached.default.svc.cluster.local:11211"
  - name: maxIdleConnections
    value: <REPLACE-WITH-MAX-IDLE-CONNECTIONS> # Optional. default: "2"
  - name: timeout
    value: <REPLACE-WITH-TIMEOUT> # Optional. default: "1000"

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
hosts	Y	Comma delimited endpoints	`"memcached.default.svc.cluster.local:11211"`
maxIdleConnections	N	The max number of idle connections. Defaults to `"2"`	`"3"`
timeout	N	The timeout for the calls in milliseconds. Defaults to `"1000"`	`"1000"`

You can run Memcached locally using Docker:

docker run --name my-memcache -d memcached

You can then interact with the server using localhost:11211.

The easiest way to install Memcached on Kubernetes is by using the Helm chart:

helm install memcached stable/memcached

This installs Memcached into the default namespace. To interact with Memcached, find the service with: kubectl get svc memcached.

For example, if installing using the example above, the Memcached host address would be:

memcached.default.svc.cluster.local:11211

Basic schema for a Dapr component
Read this guide for instructions on configuring state store components
State management building block

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified October 25, 2024: Merge pull request #4401 from evhen14/4400-document-new-annotations (18bbd6d)