faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-25 00:03:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document response types and scaling behaviour

Browse Source
This commit is contained in:
Alex Ellis
2017-04-08 09:57:57 +01:00
committed by Alex Ellis
parent 4a0c712c0f
commit a803b677f6
1 changed files with 29 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
watchdog/README.md
View File

@ -45,7 +45,6 @@ Swarm tutorial on Healthchecks:
* [Test-drive Docker Healthcheck in 10 minutes](http://blog.alexellis.io/test-drive-healthcheck/) * [Test-drive Docker Healthcheck in 10 minutes](http://blog.alexellis.io/test-drive-healthcheck/)
**Environmental overrides:** **Environmental overrides:**
A number of environmental overrides can be added for additional flexibility and options: A number of environmental overrides can be added for additional flexibility and options:
@ -57,3 +56,32 @@ A number of environmental overrides can be added for additional flexibility and
| `write_timeout` | HTTP timeout for writing a response body from your function | | `write_timeout` | HTTP timeout for writing a response body from your function |
| `read_timeout` | HTTP timeout for reading the payload from the client caller | | `read_timeout` | HTTP timeout for reading the payload from the client caller |
| `suppress_lock` | The watchdog will attempt to write a lockfile to /tmp/ for swarm healthchecks - set this to true to disable behaviour. | | `suppress_lock` | The watchdog will attempt to write a lockfile to /tmp/ for swarm healthchecks - set this to true to disable behaviour. |
## Advanced / tuning
**Content-Type of request/response**
By default the watchdog will match the response of your function to the "Content-Type" of the client.
* If your client sends a JSON post with a Content-Type of `application/json` this will be matched automatically in the response.
* If your client sends a JSON post with a Content-Type of `text/plain` this will be matched automatically in the response too
See open issues for custom override of response ContentType.
**Tuning auto-scaling**
Auto-scaling starts at 1 replica and steps up in blocks of 5:
* 1->5
* 5->10
* 10->15
* 15->20
You can override the upper limit of auto-scaling by setting the following label on your container:
```
com.faas.max_replicas: "10"
```
If you want to disable scaling, set the `com.faas.max_replicas` value to `"1"`.