The documentation you are viewing is for Dapr v1.8 which is an older version of Dapr. For up-to-date documentation, see the latest version.
Zookeeper
Component format
To setup Zookeeper state store create a component of type state.zookeeper. 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.zookeeper
version: v1
metadata:
- name: servers
value: <REPLACE-WITH-COMMA-DELIMITED-SERVERS> # Required. Example: "zookeeper.default.svc.cluster.local:2181"
- name: sessionTimeout
value: <REPLACE-WITH-SESSION-TIMEOUT> # Required. Example: "5s"
- name: maxBufferSize
value: <REPLACE-WITH-MAX-BUFFER-SIZE> # Optional. default: "1048576"
- name: maxConnBufferSize
value: <REPLACE-WITH-MAX-CONN-BUFFER-SIZE> # Optional. default: "1048576"
- name: keyPrefixPath
value: <REPLACE-WITH-KEY-PREFIX-PATH> # Optional.
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 |
|---|---|---|---|
| servers | Y | Comma delimited list of servers | "zookeeper.default.svc.cluster.local:2181" |
| sessionTimeout | Y | The session timeout value | "5s" |
| maxBufferSize | N | The maximum size of buffer. Defaults to "1048576" |
"1048576" |
| maxConnBufferSize | N | The maximum size of connection buffer. Defaults to "1048576" |
"1048576" |
| keyPrefixPath | N | The key prefix path in Zookeeper. No default | "dapr" |
Setup Zookeeper
You can run Zookeeper locally using Docker:
docker run --name some-zookeeper --restart always -d zookeeper
You can then interact with the server using localhost:2181.
The easiest way to install Zookeeper on Kubernetes is by using the Helm chart:
helm repo add incubator http://storage.googleapis.com/kubernetes-charts-incubator
helm install zookeeper incubator/zookeeper
This installs Zookeeper into the default namespace.
To interact with Zookeeper, find the service with: kubectl get svc zookeeper.
For example, if installing using the example above, the Zookeeper host address would be:
zookeeper.default.svc.cluster.local:2181
Related links
- 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.