Reference

Reference: tenants

tenants

Syntaxtenants: [{...}, ...]
Default[]
Contextscalws.yaml
Reloadapplies on reload

Tenants (accounts) with their applications.

tenants[].name

Syntaxname: <string>
Defaultrequired
Contexttenants[]
Reloadapplies on reload

Tenant name: 1-63 characters of a-z, 0-9, -, _, starting with a letter.

tenants[].resources

Syntaxresources: {...}
Defaultsee the fields below
Contexttenants[]
Reloadapplies on reload

Resource limits for all of the tenant’s applications together.

tenants[].resources.burst

Syntaxburst: <integer>
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

Token-bucket burst for requests_per_second (default: equal to the rate).

tenants[].resources.cpu

Syntaxcpu: <cpu quota> (e.g. "400%")
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

cpu.max, e.g. "400%" = four CPUs.

tenants[].resources.io_bandwidth

Syntaxio_bandwidth: <size> (e.g. 16KiB)
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

io.max: read and write bytes per second each, on every disk holding the tenant’s application roots, e.g. "20MiB".

tenants[].resources.io_weight

Syntaxio_weight: <integer>
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

io.weight (1-10000, default 100), best effort: needs a weight-capable I/O scheduler.

tenants[].resources.max_concurrent_requests

Syntaxmax_concurrent_requests: <integer>
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

Requests of this tenant processed concurrently; excess gets 503.

tenants[].resources.memory

Syntaxmemory: <size> (e.g. 16KiB)
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

memory.max.

tenants[].resources.pids

Syntaxpids: <integer>
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

pids.max.

tenants[].resources.requests_per_second

Syntaxrequests_per_second: <integer>
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

Sustained request rate; excess gets 429.

tenants[].resources.swap

Syntaxswap: <size> (e.g. 16KiB)
Defaultnone
Contexttenants[].resources
Reloadapplies on reload

memory.swap.max when memory is set; default 0 (no swap).

tenants[].user

Syntaxuser: <string>
Defaultnone
Contexttenants[]
Reloadapplies on reload

Unix account the tenant’s managed processes run as (Linux, ADR-0026).