Reference

Reference: runtime type node

tenants[].applications[].routes[].runtime<node>.command

Syntaxcommand: [<string>, ...]
Default[]
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

Command started by scalws (no shell), e.g. [node, server.js]; the application listens on PORT.

tenants[].applications[].routes[].runtime<node>.env

Syntaxenv: {<key>: <string>, ...}
Defaultempty
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

Environment variables for the process.

tenants[].applications[].routes[].runtime<node>.health_path

Syntaxhealth_path: <string>
Defaultnone
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

Optional readiness path; any non-5xx answer counts as ready.

tenants[].applications[].routes[].runtime<node>.listen

Syntaxlisten: unix | tcp
Defaultunix
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

unix: a socket under runtime_dir passed as PORT; tcp: a free loopback port.

tenants[].applications[].routes[].runtime<node>.response_timeout

Syntaxresponse_timeout: <duration> (e.g. 30s)
Default60s
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

Time to wait for the response headers of the application.

tenants[].applications[].routes[].runtime<node>.startup_timeout

Syntaxstartup_timeout: <duration> (e.g. 30s)
Default30s
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

Time the process gets to become ready.

tenants[].applications[].routes[].runtime<node>.stop_timeout

Syntaxstop_timeout: <duration> (e.g. 30s)
Default10s
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

Time the process gets to exit after SIGTERM before it is killed.

tenants[].applications[].routes[].runtime<node>.upstream

Syntaxupstream: <string>
Defaultnone
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

Proxy to a Node.js process managed elsewhere instead of starting one.

tenants[].applications[].routes[].runtime<node>.workers

Syntaxworkers: {...}
Defaultnone
Contexttenants[].applications[].routes[].runtime (type: node)
Reloadapplies on reload

Number of processes (min); requests are balanced across ready ones.

tenants[].applications[].routes[].runtime<node>.workers.autoscale

Syntaxautoscale: off | auto | recommend
Defaultrecommend
Contexttenants[].applications[].routes[].runtime<node>.workers
Reloadapplies on reload

off, recommend (default) or auto (ADR-0014).

tenants[].applications[].routes[].runtime<node>.workers.max

Syntaxmax: <integer>
Defaultrequired
Contexttenants[].applications[].routes[].runtime<node>.workers
Reloadapplies on reload

Upper bound when the pool is scaled.

tenants[].applications[].routes[].runtime<node>.workers.min

Syntaxmin: <integer>
Defaultrequired
Contexttenants[].applications[].routes[].runtime<node>.workers
Reloadapplies on reload

Processes started at the beginning and kept at least.

tenants[].applications[].routes[].runtime<node>.workers.target_concurrency

Syntaxtarget_concurrency: <integer>
Defaultnone
Contexttenants[].applications[].routes[].runtime<node>.workers
Reloadapplies on reload

Concurrent requests one worker is expected to handle well (utilisation basis).

tenants[].applications[].runtime<node>.command

Syntaxcommand: [<string>, ...]
Default[]
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

Command started by scalws (no shell), e.g. [node, server.js]; the application listens on PORT.

tenants[].applications[].runtime<node>.env

Syntaxenv: {<key>: <string>, ...}
Defaultempty
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

Environment variables for the process.

tenants[].applications[].runtime<node>.health_path

Syntaxhealth_path: <string>
Defaultnone
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

Optional readiness path; any non-5xx answer counts as ready.

tenants[].applications[].runtime<node>.listen

Syntaxlisten: unix | tcp
Defaultunix
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

unix: a socket under runtime_dir passed as PORT; tcp: a free loopback port.

tenants[].applications[].runtime<node>.response_timeout

Syntaxresponse_timeout: <duration> (e.g. 30s)
Default60s
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

Time to wait for the response headers of the application.

tenants[].applications[].runtime<node>.startup_timeout

Syntaxstartup_timeout: <duration> (e.g. 30s)
Default30s
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

Time the process gets to become ready.

tenants[].applications[].runtime<node>.stop_timeout

Syntaxstop_timeout: <duration> (e.g. 30s)
Default10s
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

Time the process gets to exit after SIGTERM before it is killed.

tenants[].applications[].runtime<node>.upstream

Syntaxupstream: <string>
Defaultnone
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

Proxy to a Node.js process managed elsewhere instead of starting one.

tenants[].applications[].runtime<node>.workers

Syntaxworkers: {...}
Defaultnone
Contexttenants[].applications[].runtime (type: node)
Reloadapplies on reload

Number of processes (min); requests are balanced across ready ones.

tenants[].applications[].runtime<node>.workers.autoscale

Syntaxautoscale: off | auto | recommend
Defaultrecommend
Contexttenants[].applications[].runtime<node>.workers
Reloadapplies on reload

off, recommend (default) or auto (ADR-0014).

tenants[].applications[].runtime<node>.workers.max

Syntaxmax: <integer>
Defaultrequired
Contexttenants[].applications[].runtime<node>.workers
Reloadapplies on reload

Upper bound when the pool is scaled.

tenants[].applications[].runtime<node>.workers.min

Syntaxmin: <integer>
Defaultrequired
Contexttenants[].applications[].runtime<node>.workers
Reloadapplies on reload

Processes started at the beginning and kept at least.

tenants[].applications[].runtime<node>.workers.target_concurrency

Syntaxtarget_concurrency: <integer>
Defaultnone
Contexttenants[].applications[].runtime<node>.workers
Reloadapplies on reload

Concurrent requests one worker is expected to handle well (utilisation basis).