Quick start

Mon, 01 Jan 0001 00:00:00 +0000

Quick start#

The fastest way to try Candybox is the bundled Docker Compose stack. It starts the full system — ZooKeeper, 3 BookKeeper bookies, 3 Candybox nodes, and the S3 gateway (on :9711) — using the published zetaplusae/candybox image.

With Docker Compose (recommended)#

From a checkout of the repository:

docker compose up -d
docker compose run --rm cli create-box photos
echo 'hello candybox' | docker compose run --rm -T cli put photos hello.txt
docker compose run --rm cli get photos hello.txt # -> hello candybox

Tear it down with docker compose down (add -v to also wipe the data volumes).

Concepts

Mon, 01 Jan 0001 00:00:00 +0000

Concepts#

Candybox borrows the bucket/object model from S3 but gives the pieces its own names.

Vocabulary#

Term	Meaning
Box	a bucket — a named, flat namespace of keys
Candy	an object — the bytes plus metadata stored under a key
CandyKey	an object key
Syrup	a data ledger that holds object bytes
CandyLocator	the small pointer the index stores to find a Candy’s bytes inside a Syrup