alihan/fn-serverless
1
0
Fork 0
mirror of https://github.com/fnproject/fn.git synced 2022-10-28 21:29:17 +03:00
Code Issues Packages Projects Releases Wiki Activity

fn: update route documentation for tmpfs_size (#1104)

Browse Source
This commit is contained in:
Tolga Ceylan
2018-06-29 18:26:57 -07:00
committed by GitHub
parent 3bc39175de
commit d0365bd2c9
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/operating/routes.md
View File

@@ -8,7 +8,7 @@ the required memory as well as CPU limits for each function.
## Route level configuration
When creating a route, you can configure it to tweak its behavior, the possible
choices are: `memory`, `cpus`, `type` and `config`.
choices are: `memory`, `cpus`, `type`, `config` and `tmpfs_size`.
`memory` is number of usable MiB for this function. If during the execution it
exceeds this maximum threshold, it will halt and return an error in the logs. It
@@ -27,6 +27,10 @@ Default: `sync`.
`config` is a map of values passed to the route runtime in the form of
environment variables.
`tmpfs_size` is number of usable MiB allocated for /tmp for non-persistent storage
per function. It expects to be an integer. If set to `0` the size is not set and
limits are applied based on available system memory by the kernel. Default: `0`.
Note: Route level configuration overrides app level configuration.
TODO: link to swagger doc on swaggerhub after it's updated.