From 470e497e7bf0cc82d314f0cb78a44441f9da5a09 Mon Sep 17 00:00:00 2001 From: C Cirello Date: Mon, 5 Dec 2016 17:15:20 +0100 Subject: [PATCH] fn: improve funcfile doc (#376) * fn: improve funcfile doc * fn: improve wording of build key * fn: make clear max_concurrency is per node --- docs/function-file.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/function-file.md b/docs/function-file.md index 4f13b43b8..9899a5bcc 100644 --- a/docs/function-file.md +++ b/docs/function-file.md @@ -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. -