Etcd

Detailed information on the Etcd state store component

Component format

To setup an Etcd state store create a component of type state.etcd. See this guide on how to create and apply a state store configuration.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5. spec:
  6.   type: state.etcd
  7.   version: v1
  8.   metadata:
  9.   - name: endpoints
  10.     value: <CONNECTION STRING> # Required. Example: 192.168.0.1:2379,192.168.0.2:2379,192.168.0.3:2379
  11.   - name: keyPrefixPath
  12.     value: <KEY PREFIX STRING> # Optional. default: "". Example: "dapr"
  13.   - name: tlsEnable
  14.     value: <ENABLE TLS> # Optional. Example: "false"
  15.   - name: ca
  16.     value: <CA> # Optional. Required if tlsEnable is `true`.
  17.   - name: cert
  18.     value: <CERT> # Optional. Required if tlsEnable is `true`.
  19.   - name: key
  20.     value: <KEY> # Optional. Required if tlsEnable is `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

FieldRequiredDetailsExample
endpointsYConnection string to the Etcd cluster“192.168.0.1:2379,192.168.0.2:2379,192.168.0.3:2379”
keyPrefixPathNKey prefix path in Etcd. Default is no prefix.“dapr”
tlsEnableNWhether to enable TLS for connecting to Etcd.“false”
caNCA certificate for connecting to Etcd, PEM-encoded. Can be secretKeyRef to use a secret reference.“——-BEGIN CERTIFICATE——-\nMIIC9TCCA…”
certNTLS certificate for connecting to Etcd, PEM-encoded. Can be secretKeyRef to use a secret reference.“——-BEGIN CERTIFICATE——-\nMIIDUTCC…”
keyNTLS key for connecting to Etcd, PEM-encoded. Can be secretKeyRef to use a secret reference.“——-BEGIN PRIVATE KEY——-\nMIIEpAIB…”

Setup Etcd

You can run Etcd database locally using Docker Compose. Create a new file called docker-compose.yml and add the following contents as an example:

  1. version: '2'
  2. services:
  3.   etcd:
  4.     image: gcr.io/etcd-development/etcd:v3.4.20
  5.     ports:
  6.       - "2379:2379"
  7.     command: etcd --listen-client-urls http://0.0.0.0:2379 --advertise-client-urls http://0.0.0.0:2379
  2. Save the `docker-compose.yml` file and run the following command to start the Etcd server:

docker-compose up -d

  2. This starts the Etcd server in the background and expose the default Etcd port of `2379`. You can then interact with the server using the `etcdctl` command-line client on `localhost:12379`. For example:

etcdctl —endpoints=localhost:2379 put mykey myvalue ```

Use Helm to quickly create an Etcd instance in your Kubernetes cluster. This approach requires Installing Helm.

Follow the Bitnami instructions to get started with setting up Etcd in Kubernetes.

Last modified June 19, 2023: Merge pull request #3565 from dapr/aacrawfi/skip-secrets-close (b1763bf)