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: improve funcfile doc (#376)

Browse Source 
* fn: improve funcfile doc

* fn: improve wording of build key

* fn: make clear max_concurrency is per node
This commit is contained in:
C Cirello
2016-12-05 17:15:20 +01:00
committed by GitHub
parent fb46fe925f
commit 470e497e7b
1 changed files with 17 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/function-file.md
View File

@@ -42,13 +42,27 @@ Default: `sync`.
function. If this function exceeds this limit during execution, it is stopped
and error message is logged. Default: `128`.
`headers` (optional) is a set of HTTP headers to be returned in the response of
this function calls.
`config` (optional) is a set of configurations to be passed onto the route
setup. These configuration options shall override application configuration
during functions execution.
`build` (optional) is an array of shell calls which are used to helping building
the image. These calls are executed before `fn` calls `docker build` and
`docker push`.
`build` (optional) is an array of local shell calls which are used to help
building the function.
## Hot containers
Hot containers support also adds two extra options to this configuration file.
`format` (optional) is one of the streaming formats covered at [function-format.md](function-format.md).
`max_concurrency` (optional) is the maximum of hot containers per node to be
started for a certain function. It defaults to one per function. If you
understand you need more processing power, make sure to raise this number.
Keep in mind that if there is not available memory to execute the configured
workload, it will fail to start new hot containers.
## Testing functions
@@ -76,4 +90,3 @@ available for local machine tests.
`env` (optional) is a map of environment variables that are injected during
tests.