2022-04-15 13:44:08 +00:00
---
title: "Traefik ZooKeeper Documentation"
description: "For configuration discovery in Traefik Proxy, you can store your configurations in ZooKeeper. Read the technical documentation."
---
2019-11-28 20:56:04 +00:00
# Traefik & ZooKeeper
2021-02-11 18:04:03 +00:00
A Story of KV Store & Containers
2019-11-28 20:56:04 +00:00
{: .subtitle }
Store your configuration in ZooKeeper and let Traefik do the rest!
## Routing Configuration
See the dedicated section in [routing ](../routing/providers/kv.md ).
## Provider Configuration
### `endpoints`
_Required, Default="127.0.0.1:2181"_
2022-03-21 16:32:07 +00:00
Defines how to access ZooKeeper.
2019-11-28 20:56:04 +00:00
```yaml tab="File (YAML)"
providers:
zooKeeper:
endpoints:
- "127.0.0.1:2181"
```
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.zooKeeper]
endpoints = ["127.0.0.1:2181"]
```
2019-11-28 20:56:04 +00:00
```bash tab="CLI"
--providers.zookeeper.endpoints=127.0.0.1:2181
```
### `rootKey`
_Required, Default="traefik"_
2021-02-11 18:04:03 +00:00
Defines the root key of the configuration.
2019-11-28 20:56:04 +00:00
```yaml tab="File (YAML)"
providers:
zooKeeper:
rootKey: "traefik"
```
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.zooKeeper]
rootKey = "traefik"
```
2019-11-28 20:56:04 +00:00
```bash tab="CLI"
--providers.zookeeper.rootkey=traefik
```
### `username`
_Optional, Default=""_
2021-02-11 18:04:03 +00:00
Defines a username to connect with ZooKeeper.
2019-11-28 20:56:04 +00:00
```yaml tab="File (YAML)"
providers:
zooKeeper:
# ...
2021-09-29 11:22:12 +00:00
username: "foo"
2019-11-28 20:56:04 +00:00
```
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.zooKeeper]
# ...
username = "foo"
```
2019-11-28 20:56:04 +00:00
```bash tab="CLI"
--providers.zookeeper.username=foo
```
### `password`
_Optional, Default=""_
Defines a password to connect with ZooKeeper.
```yaml tab="File (YAML)"
providers:
zooKeeper:
# ...
password: "bar"
```
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.zooKeeper]
# ...
password = "bar"
```
2019-11-28 20:56:04 +00:00
```bash tab="CLI"
--providers.zookeeper.password=foo
```
### `tls`
_Optional_
2021-12-02 14:42:06 +00:00
Defines the TLS configuration used for the secure connection to ZooKeeper.
2019-11-28 20:56:04 +00:00
2021-12-02 14:42:06 +00:00
#### `ca`
_Optional_
`ca` is the path to the certificate authority used for the secure connection to ZooKeeper,
it defaults to the system bundle.
2019-11-28 20:56:04 +00:00
```yaml tab="File (YAML)"
providers:
zooKeeper:
tls:
ca: path/to/ca.crt
```
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.zooKeeper.tls]
ca = "path/to/ca.crt"
```
2019-11-28 20:56:04 +00:00
```bash tab="CLI"
--providers.zookeeper.tls.ca=path/to/ca.crt
```
2021-12-02 14:42:06 +00:00
#### `cert`
2019-11-28 20:56:04 +00:00
2021-12-02 14:42:06 +00:00
_Optional_
`cert` is the path to the public certificate used for the secure connection to ZooKeeper.
When using this option, setting the `key` option is required.
2019-11-28 20:56:04 +00:00
```yaml tab="File (YAML)"
providers:
zooKeeper:
tls:
cert: path/to/foo.cert
key: path/to/foo.key
```
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.zooKeeper.tls]
cert = "path/to/foo.cert"
key = "path/to/foo.key"
```
2019-11-28 20:56:04 +00:00
```bash tab="CLI"
--providers.zookeeper.tls.cert=path/to/foo.cert
--providers.zookeeper.tls.key=path/to/foo.key
```
2021-12-02 14:42:06 +00:00
#### `key`
2019-11-28 20:56:04 +00:00
2021-12-02 14:42:06 +00:00
_Optional_
`key` is the path to the private key used for the secure connection to ZooKeeper.
When using this option, setting the `cert` option is required.
2019-11-28 20:56:04 +00:00
```yaml tab="File (YAML)"
providers:
zooKeeper:
tls:
cert: path/to/foo.cert
key: path/to/foo.key
```
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.zooKeeper.tls]
cert = "path/to/foo.cert"
key = "path/to/foo.key"
```
2019-11-28 20:56:04 +00:00
```bash tab="CLI"
--providers.zookeeper.tls.cert=path/to/foo.cert
--providers.zookeeper.tls.key=path/to/foo.key
```
2021-12-02 14:42:06 +00:00
#### `insecureSkipVerify`
_Optional, Default=false_
2019-11-28 20:56:04 +00:00
2021-02-11 18:04:03 +00:00
If `insecureSkipVerify` is `true` , the TLS connection to Zookeeper accepts any certificate presented by the server regardless of the hostnames it covers.
2019-11-28 20:56:04 +00:00
```yaml tab="File (YAML)"
providers:
zooKeeper:
tls:
insecureSkipVerify: true
```
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.zooKeeper.tls]
insecureSkipVerify = true
```
2019-11-28 20:56:04 +00:00
```bash tab="CLI"
--providers.zookeeper.tls.insecureSkipVerify=true
```