Waterwheel

Waterwheel is a job scheduler similar to Airflow but with a very different design.

For more information see here.

To get started with a basic deployment see here.

Developing Locally

Waterwheel is built with Rust and Cargo. Command automation uses Just.

Create a .env file with the mandatory config settings:

# docker compose will use this when creating the database:
POSTGRES_PASSWORD=password

WATERWHEEL_DB_URL=postgres://postgres:${POSTGRES_PASSWORD}@localhost/
WATERWHEEL_SERVER_ADDR=http://localhost:8080/
WATERWHEEL_HMAC_SECRET=shared secret
WATERWHEEL_NO_AUTHZ=true

Now launch the services (Postgres and RabbitMQ):

just up

The web interface is built with npm and webpack (and nvm for installing node). This will run webpack in watch mode, so it recompiles when you edit any files.

cd ui
nvm use
npm install
npm run watch

In two separate terminals build and launch Waterwheel server and worker:

# run the server
cargo run server

# in a separate terminal
cargo run worker

Building a Release binary

The release binary embeds the UI, so you need to build it first:

cd ui
nvm use
npm run build

cd ..
cargo build --release

stat ./target/release/waterwheel

Other commands are available in the Justfile. Run just help for a list.