druid/docs/content/ZooKeeper.md

83 lines
3.3 KiB
Markdown
Raw Normal View History

---
2013-09-26 19:22:28 -04:00
layout: doc_page
---
2013-09-13 18:20:39 -04:00
Druid uses ZooKeeper (ZK) for management of current cluster state. The operations that happen over ZK are
2013-09-16 19:01:14 -04:00
1. [Master](Master.html) leader election
2. Segment "publishing" protocol from [Compute](Compute.html) and [Realtime](Realtime.html)
2013-09-16 19:01:14 -04:00
3. Segment load/drop protocol between [Master](Master.html) and [Compute](Compute.html)
2013-09-13 18:20:39 -04:00
### Property Configuration
ZooKeeper paths are set via the `runtime.properties` configuration file. Druid will automatically create paths that do not exist, so typos in config files is a very easy way to become split-brained.
There is a prefix path that is required and can be used as the only (well, kinda, see the note below) path-related zookeeper configuration parameter (everything else will be a default based on the prefix):
2013-09-13 18:20:39 -04:00
```
druid.zk.paths.base
```
2013-09-13 18:20:39 -04:00
You can also override each individual path (defaults are shown below):
2013-09-13 18:20:39 -04:00
```
druid.zk.paths.propertiesPath=${druid.zk.paths.base}/properties
druid.zk.paths.announcementsPath=${druid.zk.paths.base}/announcements
druid.zk.paths.servedSegmentsPath=${druid.zk.paths.base}/servedSegments
druid.zk.paths.loadQueuePath=${druid.zk.paths.base}/loadQueue
druid.zk.paths.masterPath=${druid.zk.paths.base}/master
druid.zk.paths.indexer.announcementsPath=${druid.zk.paths.base}/indexer/announcements
druid.zk.paths.indexer.tasksPath=${druid.zk.paths.base}/indexer/tasks
druid.zk.paths.indexer.statusPath=${druid.zk.paths.base}/indexer/status
druid.zk.paths.indexer.leaderLatchPath=${druid.zk.paths.base}/indexer/leaderLatchPath
```
2013-09-13 18:20:39 -04:00
NOTE: We also use Curators service discovery module to expose some services via zookeeper. This also uses a zookeeper path, but this path is **not** affected by `druid.zk.paths.base` and **must** be specified separately. This property is
```
druid.zk.paths.discoveryPath
```
2013-09-13 18:20:39 -04:00
### Master Leader Election
We use the Curator LeadershipLatch recipe to do leader election at path
```
${druid.zk.paths.masterPath}/_MASTER
```
2013-09-13 18:20:39 -04:00
### Segment "publishing" protocol from Compute and Realtime
2013-09-13 18:20:39 -04:00
The `announcementsPath` and `servedSegmentsPath` are used for this.
2013-09-16 19:01:14 -04:00
All [Compute](Compute.html) and [Realtime](Realtime.html) nodes publish themselves on the `announcementsPath`, specifically, they will create an ephemeral znode at
2013-09-13 18:20:39 -04:00
```
${druid.zk.paths.announcementsPath}/${druid.host}
```
2013-09-13 18:20:39 -04:00
Which signifies that they exist. They will also subsequently create a permanent znode at
```
${druid.zk.paths.servedSegmentsPath}/${druid.host}
```
2013-09-13 18:20:39 -04:00
And as they load up segments, they will attach ephemeral znodes that look like
```
${druid.zk.paths.servedSegmentsPath}/${druid.host}/_segment_identifier_
```
2013-09-13 18:20:39 -04:00
2013-09-16 19:01:14 -04:00
Nodes like the [Master](Master.html) and [Broker](Broker.html) can then watch these paths to see which nodes are currently serving which segments.
2013-09-13 18:20:39 -04:00
### Segment load/drop protocol between Master and Compute
The `loadQueuePath` is used for this.
2013-09-16 19:01:14 -04:00
When the [Master](Master.html) decides that a [Compute](Compute.html) node should load or drop a segment, it writes an ephemeral znode to
2013-09-13 18:20:39 -04:00
```
${druid.zk.paths.loadQueuePath}/_host_of_compute_node/_segment_identifier
```
2013-09-13 18:20:39 -04:00
This node will contain a payload that indicates to the Compute node what it should do with the given segment. When the Compute node is done with the work, it will delete the znode in order to signify to the Master that it is complete.