Reference
Reference: runtime type container
tenants[].applications[].routes[].runtime<container>.command
| Syntax | command: [<string>, ...] |
| Default | [] |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Arguments after the image; {port} is replaced by the port scalws chose.
tenants[].applications[].routes[].runtime<container>.drop_capabilities
| Syntax | drop_capabilities: true | false |
| Default | false |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Drop all Linux capabilities.
tenants[].applications[].routes[].runtime<container>.engine
| Syntax | engine: podman | docker |
| Default | podman |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Container engine: podman or docker.
tenants[].applications[].routes[].runtime<container>.engine_path
| Syntax | engine_path: <string> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Engine binary; default podman / docker from PATH.
tenants[].applications[].routes[].runtime<container>.env
| Syntax | env: {<key>: <string>, ...} |
| Default | empty |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Environment variables for the containers.
tenants[].applications[].routes[].runtime<container>.health_path
| Syntax | health_path: <string> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Path requested to decide that a container is ready and healthy.
tenants[].applications[].routes[].runtime<container>.image
| Syntax | image: <string> |
| Default | required |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Image reference, e.g. docker.io/library/nginx:1.27.
tenants[].applications[].routes[].runtime<container>.mounts
| Syntax | mounts: [{...}, ...] |
| Default | [] |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Host directories mounted into the containers.
tenants[].applications[].routes[].runtime<container>.mounts[].read_only
| Syntax | read_only: true | false |
| Default | true |
| Context | tenants[].applications[].routes[].runtime<container>.mounts[] |
| Reload | applies on reload |
Mount read-only.
tenants[].applications[].routes[].runtime<container>.mounts[].source
| Syntax | source: <string> |
| Default | required |
| Context | tenants[].applications[].routes[].runtime<container>.mounts[] |
| Reload | applies on reload |
Host path (absolute).
tenants[].applications[].routes[].runtime<container>.mounts[].target
| Syntax | target: <string> |
| Default | required |
| Context | tenants[].applications[].routes[].runtime<container>.mounts[] |
| Reload | applies on reload |
Path inside the container (absolute).
tenants[].applications[].routes[].runtime<container>.network
| Syntax | network: bridge | host |
| Default | bridge |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
bridge: publish port on a loopback port; host: share the host network.
tenants[].applications[].routes[].runtime<container>.port
| Syntax | port: <integer> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Port the application listens on inside the container (bridge networking).
tenants[].applications[].routes[].runtime<container>.pull
| Syntax | pull: missing | always | never |
| Default | missing |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
When the image is pulled: missing, always or never.
tenants[].applications[].routes[].runtime<container>.read_only
| Syntax | read_only: true | false |
| Default | false |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Read-only root filesystem (a tmpfs is mounted at /tmp).
tenants[].applications[].routes[].runtime<container>.response_timeout
| Syntax | response_timeout: <duration> (e.g. 30s) |
| Default | 60s |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Time to wait for the response headers of the application.
tenants[].applications[].routes[].runtime<container>.startup_timeout
| Syntax | startup_timeout: <duration> (e.g. 30s) |
| Default | 120s |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Time a container gets to become ready (includes pulling the image).
tenants[].applications[].routes[].runtime<container>.stop_timeout
| Syntax | stop_timeout: <duration> (e.g. 30s) |
| Default | 10s |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Time a container gets to stop before it is killed.
tenants[].applications[].routes[].runtime<container>.user
| Syntax | user: <string> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
User the container runs as (--user).
tenants[].applications[].routes[].runtime<container>.workers
| Syntax | workers: {...} |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: container) |
| Reload | applies on reload |
Number of containers (min at start; scaled between min and max).
tenants[].applications[].routes[].runtime<container>.workers.autoscale
| Syntax | autoscale: off | auto | recommend |
| Default | recommend |
| Context | tenants[].applications[].routes[].runtime<container>.workers |
| Reload | applies on reload |
off, recommend (default) or auto (ADR-0014).
tenants[].applications[].routes[].runtime<container>.workers.max
| Syntax | max: <integer> |
| Default | required |
| Context | tenants[].applications[].routes[].runtime<container>.workers |
| Reload | applies on reload |
Upper bound when the pool is scaled.
tenants[].applications[].routes[].runtime<container>.workers.min
| Syntax | min: <integer> |
| Default | required |
| Context | tenants[].applications[].routes[].runtime<container>.workers |
| Reload | applies on reload |
Processes started at the beginning and kept at least.
tenants[].applications[].routes[].runtime<container>.workers.target_concurrency
| Syntax | target_concurrency: <integer> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime<container>.workers |
| Reload | applies on reload |
Concurrent requests one worker is expected to handle well (utilisation basis).
tenants[].applications[].runtime<container>.command
| Syntax | command: [<string>, ...] |
| Default | [] |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Arguments after the image; {port} is replaced by the port scalws chose.
tenants[].applications[].runtime<container>.drop_capabilities
| Syntax | drop_capabilities: true | false |
| Default | false |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Drop all Linux capabilities.
tenants[].applications[].runtime<container>.engine
| Syntax | engine: podman | docker |
| Default | podman |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Container engine: podman or docker.
tenants[].applications[].runtime<container>.engine_path
| Syntax | engine_path: <string> |
| Default | none |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Engine binary; default podman / docker from PATH.
tenants[].applications[].runtime<container>.env
| Syntax | env: {<key>: <string>, ...} |
| Default | empty |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Environment variables for the containers.
tenants[].applications[].runtime<container>.health_path
| Syntax | health_path: <string> |
| Default | none |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Path requested to decide that a container is ready and healthy.
tenants[].applications[].runtime<container>.image
| Syntax | image: <string> |
| Default | required |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Image reference, e.g. docker.io/library/nginx:1.27.
tenants[].applications[].runtime<container>.mounts
| Syntax | mounts: [{...}, ...] |
| Default | [] |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Host directories mounted into the containers.
tenants[].applications[].runtime<container>.mounts[].read_only
| Syntax | read_only: true | false |
| Default | true |
| Context | tenants[].applications[].runtime<container>.mounts[] |
| Reload | applies on reload |
Mount read-only.
tenants[].applications[].runtime<container>.mounts[].source
| Syntax | source: <string> |
| Default | required |
| Context | tenants[].applications[].runtime<container>.mounts[] |
| Reload | applies on reload |
Host path (absolute).
tenants[].applications[].runtime<container>.mounts[].target
| Syntax | target: <string> |
| Default | required |
| Context | tenants[].applications[].runtime<container>.mounts[] |
| Reload | applies on reload |
Path inside the container (absolute).
tenants[].applications[].runtime<container>.network
| Syntax | network: bridge | host |
| Default | bridge |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
bridge: publish port on a loopback port; host: share the host network.
tenants[].applications[].runtime<container>.port
| Syntax | port: <integer> |
| Default | none |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Port the application listens on inside the container (bridge networking).
tenants[].applications[].runtime<container>.pull
| Syntax | pull: missing | always | never |
| Default | missing |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
When the image is pulled: missing, always or never.
tenants[].applications[].runtime<container>.read_only
| Syntax | read_only: true | false |
| Default | false |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Read-only root filesystem (a tmpfs is mounted at /tmp).
tenants[].applications[].runtime<container>.response_timeout
| Syntax | response_timeout: <duration> (e.g. 30s) |
| Default | 60s |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Time to wait for the response headers of the application.
tenants[].applications[].runtime<container>.startup_timeout
| Syntax | startup_timeout: <duration> (e.g. 30s) |
| Default | 120s |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Time a container gets to become ready (includes pulling the image).
tenants[].applications[].runtime<container>.stop_timeout
| Syntax | stop_timeout: <duration> (e.g. 30s) |
| Default | 10s |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Time a container gets to stop before it is killed.
tenants[].applications[].runtime<container>.user
| Syntax | user: <string> |
| Default | none |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
User the container runs as (--user).
tenants[].applications[].runtime<container>.workers
| Syntax | workers: {...} |
| Default | none |
| Context | tenants[].applications[].runtime (type: container) |
| Reload | applies on reload |
Number of containers (min at start; scaled between min and max).
tenants[].applications[].runtime<container>.workers.autoscale
| Syntax | autoscale: off | auto | recommend |
| Default | recommend |
| Context | tenants[].applications[].runtime<container>.workers |
| Reload | applies on reload |
off, recommend (default) or auto (ADR-0014).
tenants[].applications[].runtime<container>.workers.max
| Syntax | max: <integer> |
| Default | required |
| Context | tenants[].applications[].runtime<container>.workers |
| Reload | applies on reload |
Upper bound when the pool is scaled.
tenants[].applications[].runtime<container>.workers.min
| Syntax | min: <integer> |
| Default | required |
| Context | tenants[].applications[].runtime<container>.workers |
| Reload | applies on reload |
Processes started at the beginning and kept at least.
tenants[].applications[].runtime<container>.workers.target_concurrency
| Syntax | target_concurrency: <integer> |
| Default | none |
| Context | tenants[].applications[].runtime<container>.workers |
| Reload | applies on reload |
Concurrent requests one worker is expected to handle well (utilisation basis).