https://github.com/detro/zk4lw
ZooKeeper (ZK) Four Letter Word (4LW) commands
https://github.com/detro/zk4lw
Last synced: over 1 year ago
JSON representation
ZooKeeper (ZK) Four Letter Word (4LW) commands
- Host: GitHub
- URL: https://github.com/detro/zk4lw
- Owner: detro
- License: apache-2.0
- Created: 2020-05-02T16:29:21.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-23T08:56:32.000Z (almost 4 years ago)
- Last Synced: 2025-02-23T11:04:14.551Z (over 1 year ago)
- Language: Rust
- Size: 61.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZK4LW - ZooKeeper Four Letter Word
TODO Description goes here
## Crates developed in this repository
* `zk4lw-client` - Rust client library for ZooKeeper ["Four Letter Word"](https://zookeeper.apache.org/doc/r3.5.7/zookeeperAdmin.html#sc_4lw) 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](https://rustup.rs/) is recommended)
* [Docker Desktop](https://www.docker.com/products/docker-desktop), including [`docker-compose`](https://docs.docker.com/compose/)
### Launch Zookeeper locally
You could use the provided `./compose.sh` for a "batteries included" setup:
```shell
↳ ./etc/compose/compose.sh
Description:
Spins up and shuts down ZooKeeper, using Docker Compose.
This is useful for local development/testing.
Usage:
compose.sh [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:
```shell
↳ ./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:
```shell
↳ ./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](./LICENSE)
## Credits
Thank you to [Joe Wilm](https://github.com/jwilm) for the first inspiration for this project, the crate [zk-4lw](https://crates.io/crates/zk-4lw).