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

add rudimentary readme w/ env vars

Browse Source 
Signed-off-by: Elliott Beach <elliott2.71828@gmail.com>
This commit is contained in:
Elliott Beach 2017-10-21 23:59:58 -05:00 committed by Alex Ellis
parent 7b1c5bb3c3
commit faf7f31a58
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
gateway/README.md Normal file
View File

@ -0,0 +1,19 @@
# Gateway
The API Gateway provides an external route into your functions and collects Cloud Native metrics through Prometheus, as well as a UI for creating and invoking functions.
The gateway will scale functions according to demand by altering the service replica count in the Docker Swarm or Kubernetes API.
Swagger docs: https://github.com/openfaas/faas/tree/master/api-docs
**Environmental overrides:**
The gateway can be configured through the following environment variables:
| Option | Usage |
|------------------------|--------------|
| `write_timeout` | HTTP timeout for writing a response body from your function (in seconds). Default: `8` |
| `read_timeout` | HTTP timeout for reading the payload from the client caller (in seconds). Default: `8` |
| `functions_provider_url` | URL of an alternate microservice to manage functions (e.g., Kubernetes). When given, this overrides the default Docker Swarm provider. |
| `faas_nats_address` | Address of NATS service. Required for asynchronous mode. |
| `faas_nats_port` | Port for NATS service. Requrired for asynchronous mode. |
| `faas_prometheus_host` | Host to connect to Prometheus. Default: `"prometheus"`. |
| `faas_promethus_port` | Port to connect to Prometheus. Default: `9090`. |