Reference
Reference: runtime type node
tenants[].applications[].routes[].runtime<node>.command
| Syntax | command: [<string>, ...] |
| Default | [] |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
Command started by scalws (no shell), e.g. [node, server.js]; the application listens on PORT.
tenants[].applications[].routes[].runtime<node>.env
| Syntax | env: {<key>: <string>, ...} |
| Default | empty |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
Environment variables for the process.
tenants[].applications[].routes[].runtime<node>.health_path
| Syntax | health_path: <string> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
Optional readiness path; any non-5xx answer counts as ready.
tenants[].applications[].routes[].runtime<node>.listen
| Syntax | listen: unix | tcp |
| Default | unix |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
unix: a socket under runtime_dir passed as PORT; tcp: a free loopback port.
tenants[].applications[].routes[].runtime<node>.response_timeout
| Syntax | response_timeout: <duration> (e.g. 30s) |
| Default | 60s |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
Time to wait for the response headers of the application.
tenants[].applications[].routes[].runtime<node>.startup_timeout
| Syntax | startup_timeout: <duration> (e.g. 30s) |
| Default | 30s |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
Time the process gets to become ready.
tenants[].applications[].routes[].runtime<node>.stop_timeout
| Syntax | stop_timeout: <duration> (e.g. 30s) |
| Default | 10s |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
Time the process gets to exit after SIGTERM before it is killed.
tenants[].applications[].routes[].runtime<node>.upstream
| Syntax | upstream: <string> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
Proxy to a Node.js process managed elsewhere instead of starting one.
tenants[].applications[].routes[].runtime<node>.workers
| Syntax | workers: {...} |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: node) |
| Reload | applies on reload |
Number of processes (min); requests are balanced across ready ones.
tenants[].applications[].routes[].runtime<node>.workers.autoscale
| Syntax | autoscale: off | auto | recommend |
| Default | recommend |
| Context | tenants[].applications[].routes[].runtime<node>.workers |
| Reload | applies on reload |
off, recommend (default) or auto (ADR-0014).
tenants[].applications[].routes[].runtime<node>.workers.max
| Syntax | max: <integer> |
| Default | required |
| Context | tenants[].applications[].routes[].runtime<node>.workers |
| Reload | applies on reload |
Upper bound when the pool is scaled.
tenants[].applications[].routes[].runtime<node>.workers.min
| Syntax | min: <integer> |
| Default | required |
| Context | tenants[].applications[].routes[].runtime<node>.workers |
| Reload | applies on reload |
Processes started at the beginning and kept at least.
tenants[].applications[].routes[].runtime<node>.workers.target_concurrency
| Syntax | target_concurrency: <integer> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime<node>.workers |
| Reload | applies on reload |
Concurrent requests one worker is expected to handle well (utilisation basis).
tenants[].applications[].runtime<node>.command
| Syntax | command: [<string>, ...] |
| Default | [] |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
Command started by scalws (no shell), e.g. [node, server.js]; the application listens on PORT.
tenants[].applications[].runtime<node>.env
| Syntax | env: {<key>: <string>, ...} |
| Default | empty |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
Environment variables for the process.
tenants[].applications[].runtime<node>.health_path
| Syntax | health_path: <string> |
| Default | none |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
Optional readiness path; any non-5xx answer counts as ready.
tenants[].applications[].runtime<node>.listen
| Syntax | listen: unix | tcp |
| Default | unix |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
unix: a socket under runtime_dir passed as PORT; tcp: a free loopback port.
tenants[].applications[].runtime<node>.response_timeout
| Syntax | response_timeout: <duration> (e.g. 30s) |
| Default | 60s |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
Time to wait for the response headers of the application.
tenants[].applications[].runtime<node>.startup_timeout
| Syntax | startup_timeout: <duration> (e.g. 30s) |
| Default | 30s |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
Time the process gets to become ready.
tenants[].applications[].runtime<node>.stop_timeout
| Syntax | stop_timeout: <duration> (e.g. 30s) |
| Default | 10s |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
Time the process gets to exit after SIGTERM before it is killed.
tenants[].applications[].runtime<node>.upstream
| Syntax | upstream: <string> |
| Default | none |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
Proxy to a Node.js process managed elsewhere instead of starting one.
tenants[].applications[].runtime<node>.workers
| Syntax | workers: {...} |
| Default | none |
| Context | tenants[].applications[].runtime (type: node) |
| Reload | applies on reload |
Number of processes (min); requests are balanced across ready ones.
tenants[].applications[].runtime<node>.workers.autoscale
| Syntax | autoscale: off | auto | recommend |
| Default | recommend |
| Context | tenants[].applications[].runtime<node>.workers |
| Reload | applies on reload |
off, recommend (default) or auto (ADR-0014).
tenants[].applications[].runtime<node>.workers.max
| Syntax | max: <integer> |
| Default | required |
| Context | tenants[].applications[].runtime<node>.workers |
| Reload | applies on reload |
Upper bound when the pool is scaled.
tenants[].applications[].runtime<node>.workers.min
| Syntax | min: <integer> |
| Default | required |
| Context | tenants[].applications[].runtime<node>.workers |
| Reload | applies on reload |
Processes started at the beginning and kept at least.
tenants[].applications[].runtime<node>.workers.target_concurrency
| Syntax | target_concurrency: <integer> |
| Default | none |
| Context | tenants[].applications[].runtime<node>.workers |
| Reload | applies on reload |
Concurrent requests one worker is expected to handle well (utilisation basis).