diff --git a/gateway/README.md b/gateway/README.md new file mode 100644 index 00000000..bef79fd6 --- /dev/null +++ b/gateway/README.md @@ -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`. |