quick-start.md

Quick Start

A Simple Use Case Using Docker

Run Elastic Stream using docker compose.

Launch Server

wget https://raw.githubusercontent.com/lizhanhui/elastic-stream/develop/dist/docker-compose/docker-compose.yaml
docker-compose up -d elastic-stream

Launch Example workload

git clone https://github.com/lizhanhui/elastic-stream.git
cd elastic-stream

# Run Rust example
cargo run --example main

# Run Java example
java -jar sdks/frontend-java/examples/target/examples-1.0-SNAPSHOT-jar-with-dependencies.jar

Install from pre-built package

Download assets

Download deb file from latest release.

# Please change the file name to match your OS architecture.
dpkg -i pd_0.2.8_amd64.deb
dpkg -i range-server_0.2.8_amd64.deb

Run

Launch Placement Driver

pd

Launch Range Server

range-server start --config etc/range-server.yaml --log etc/range-server-log.yaml

Launch Example workload

git clone https://github.com/lizhanhui/elastic-stream.git
cd elastic-stream

# Run Rust example
cargo run --example main

# Run Java example
java -jar sdks/frontend-java/examples/target/examples-1.0-SNAPSHOT-jar-with-dependencies.jar

Build from source

If there is no pre-built package for your OS or you just want to try, follow the steps below to build from source.

Install dependencies

git clone https://github.com/lizhanhui/elastic-stream.git
cd elastic-stream
sudo ./scripts/install_deps.sh

Build Placement Driver

Notice: Placement Driver use docker to build

# Install build tools
sudo apt-get update
sudo apt-get install -y make docker.io

cd pd
make
./bin/${OS}_${ARCH}/pd --version

Build Range Server

# Install nightly rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default nightly

cargo build --bin range-server --release
target/release/range-server --version

Build Rust and Java SDK

# Install Java
sudo apt-get update
sudo apt-get install -y openjdk-17-jdk maven
./sdks/build.sh