Walleye docs

Configuration

Every setting is an environment variable. There is no configuration file to write, and the node refuses to start rather than guessing at anything it needs.

Storage, and the only thing that is required

VariableMeaning
WALLEYE_BUCKETBucket name, optionally bucket/prefix. Becomes an s3:// URI.
WALLEYE_ROOT_URIA full URI instead, s3://… or file://…. Takes precedence.

One of the two must be set. file:// is for a local trial, since everything lives on that one disk.

Credentials come from the usual AWS environment: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_ENDPOINT for anything that is not AWS itself, and AWS_REGION.

Listening

VariableDefaultMeaning
WALLEYE_PORT8080Port to listen on.
WALLEYE_BIND[::]Address to bind. The default is dual-stack.
WALLEYE_TOKENgeneratedThe deployment token, at least 16 characters.

The bind default reaches IPv6-only private networks and maps IPv4 clients in. On a host with no IPv6 at all the node falls back to the same port on 0.0.0.0 rather than refusing to start.

A generated token is printed to standard error once, at startup. That is fine for a local trial and wrong for anything else, because it lands in whatever collects your logs.

Resources

VariableDefaultMeaning
WALLEYE_DIR./walleye-cacheWhere the NVMe cache lives.
WALLEYE_RAM_GB1Memory for the whole process, not just the cache.
WALLEYE_NVME_GB8Disk for the cache and the replication log together.

Both are whole-machine numbers. See budgets for what the node holds back from them.

Cluster

VariableMeaning
WALLEYE_MEMBERSid=http://host:8080,id=http://host:8080,…
WALLEYE_NODE_IDWhich member in that list this process is. Required with WALLEYE_MEMBERS.
WALLEYE_BITR_URLThe local replica gateway. Setting it turns on quorum durability.

Membership is static. A stream’s owner is its rendezvous winner over that list, so the same list on every node means ownership never moves on restart.

Workers

Only relevant if you write workers, which the examples use. All optional.

VariableDefaultMeaning
WALLEYE_WORKER_HEAP_MB128Heap per worker, unless the view names its own.
WALLEYE_WORKER_SECONDS15Deadline per batch, unless the view names its own.
WALLEYE_WORKER_FETCH_ALLOWemptyHosts a worker may call, comma separated. Empty means none.
WALLEYE_VIEW_IDLE_SECONDS30How long the pipeline driver waits when nothing moved.

WALLEYE_WORKER_FETCH_ALLOW is empty on purpose. A worker that can call anywhere can send your rows anywhere, so reaching out is a decision you make rather than something a worker can assume. An entry covers its subdomains.

Classification

Only relevant if you use classify, decide, rate or holds in SQL.

VariableDefaultMeaning
TYPESAFE_API_KEYnoneWithout it those functions fail saying so.
TYPESAFE_URLthe public endpoint
TYPESAFE_MODELjev-latest
TYPESAFE_CONCURRENCY16Requests in flight.