ZK4LW - ZooKeeper Four Letter Word

TODO Description goes here

Crates developed in this repository

zk4lw-client - Rust client library for ZooKeeper "Four Letter Word" administration commands
zk4lw-rest - Single-binary web-server that provides a RESTful API to execute 4lw commands against a ZooKeeper Server

Supported ZooKeeper versions

3.4.x
3.5.x
3.6.x

Development

Prerequisites

Rust & Cargo (rustup is recommended)
Docker Desktop, including docker-compose

Launch Zookeeper locally

You could use the provided ./compose.sh for a "batteries included" setup:

↳ ./etc/compose/compose.sh
Description:
  Spins up and shuts down ZooKeeper, using Docker Compose.
  This is useful for local development/testing.

Usage:
  compose.sh <VERSION: 3.4|3.5|3.6> <TYPE: ensemble|standalone> <ACTION: up|down> [OPTION: attach|clean]

Options:
  attach    After launch, place Docker Compose logs in foreground (only for 'up' action)
  clean     After shutdown, delete any data directory (only for 'down' action)

For example, to spin up a ZooKeeper 3.5 ensemble:

↳ ./etc/compose/compose.sh 3.5 ensemble up
# ... do your work ...
↳ ./etc/compose/compose.sh 3.5 ensemble down

Another example, to spin up a ZooKeeper 3.6 standalone:

↳ ./etc/compose/compose.sh 3.6 standalone up
# ... do your work ...
↳ ./etc/compose/compose.sh 3.6 standalone down

And so on. You get the idea.

License

Apache 2.0

Credits

Thank you to Joe Wilm for the first inspiration for this project, the crate zk-4lw.

detro/zk4lw