Reference
Reference: tenants
tenants
| Syntax | tenants: [{...}, ...] |
| Default | [] |
| Context | scalws.yaml |
| Reload | applies on reload |
Tenants (accounts) with their applications.
tenants[].name
| Syntax | name: <string> |
| Default | required |
| Context | tenants[] |
| Reload | applies on reload |
Tenant name: 1-63 characters of a-z, 0-9, -, _, starting with a letter.
tenants[].resources
| Syntax | resources: {...} |
| Default | see the fields below |
| Context | tenants[] |
| Reload | applies on reload |
Resource limits for all of the tenant’s applications together.
tenants[].resources.burst
| Syntax | burst: <integer> |
| Default | none |
| Context | tenants[].resources |
| Reload | applies on reload |
Token-bucket burst for requests_per_second (default: equal to the rate).
tenants[].resources.cpu
| Syntax | cpu: <cpu quota> (e.g. "400%") |
| Default | none |
| Context | tenants[].resources |
| Reload | applies on reload |
cpu.max, e.g. "400%" = four CPUs.
tenants[].resources.io_bandwidth
| Syntax | io_bandwidth: <size> (e.g. 16KiB) |
| Default | none |
| Context | tenants[].resources |
| Reload | applies 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
| Syntax | io_weight: <integer> |
| Default | none |
| Context | tenants[].resources |
| Reload | applies on reload |
io.weight (1-10000, default 100), best effort: needs a weight-capable I/O scheduler.
tenants[].resources.max_concurrent_requests
| Syntax | max_concurrent_requests: <integer> |
| Default | none |
| Context | tenants[].resources |
| Reload | applies on reload |
Requests of this tenant processed concurrently; excess gets 503.
tenants[].resources.memory
| Syntax | memory: <size> (e.g. 16KiB) |
| Default | none |
| Context | tenants[].resources |
| Reload | applies on reload |
memory.max.
tenants[].resources.pids
| Syntax | pids: <integer> |
| Default | none |
| Context | tenants[].resources |
| Reload | applies on reload |
pids.max.
tenants[].resources.requests_per_second
| Syntax | requests_per_second: <integer> |
| Default | none |
| Context | tenants[].resources |
| Reload | applies on reload |
Sustained request rate; excess gets 429.
tenants[].resources.swap
| Syntax | swap: <size> (e.g. 16KiB) |
| Default | none |
| Context | tenants[].resources |
| Reload | applies on reload |
memory.swap.max when memory is set; default 0 (no swap).
tenants[].user
| Syntax | user: <string> |
| Default | none |
| Context | tenants[] |
| Reload | applies on reload |
Unix account the tenant’s managed processes run as (Linux, ADR-0026).