The API Gateway provides an external route into your functions and collects Cloud Native metrics through Prometheus. The gateway also has a UI built-in which can be used to deploy your own functions or functions from the OpenFaaS Function Store then invoke them.
The gateway will scale functions according to demand by altering the service replica count in the Docker Swarm or Kubernetes API. Custom alerts generated by AlertManager are received on the /system/alert endpoint.
- Built-in UI Portal
- Deploy functions from the Function Store or deploy your own
- Instrumentation via Prometheus
- Auto-scaling via AlertManager and Prometheus
- Scaling up from zero
- REST API available documented with Swagger
Pictured: conceptual architecture when Kubernetes is used as the orchestration provider
Providers for functions can be written using the faas-provider interface in Golang which provides the REST API for interacting with the gateway. The gateway originally interacted with Docker Swarm directly and anything else via a Function Provider - this support was moved into a separate project faas-swarm.
Swagger docs: https://github.com/openfaas/faas/tree/master/api-docs
By default the only CORS path allowed is for the Function Store which is served from the GitHub RAW CDN.
The built-in UI Portal is served through static files bound at the /ui/ path.
The UI was written in Angular 1.x and makes uses of jQuery for interactions and the Angular Material theme for visual effects and components.
View the source in the assets folder.
The Function Store is rendered through a static JSON file served by the GitHub RAW CDN. The Function Store can also be used via the OpenFaaS CLI.
See the openfaas/store repo for more.
Logs are available at the function level and can be accessed through Swarm or Kubernetes using native tooling. You can also install a Docker logging driver to aggregate your logs. By default functions will not write the request and response bodies to stdout. You can toggle this behaviour by setting
read_debug for the request and
write_debug for the response.
An "X-Call-Id" header is applied to every incoming call through the gateway and is usable for tracing and monitoring calls. We use a UUID for this string.
Within a function this is available as
The gateway can be configured through the following environment variables:
||HTTP timeout for writing a response body from your function (in seconds). Default:
||HTTP timeout for reading the payload from the client caller (in seconds). Default:
||URL of upstream functions provider - i.e. Swarm, Kubernetes, Nomad etc|
||Address of NATS service. Required for asynchronous mode|
||Port for NATS service. Requrired for asynchronous mode|
||Host to connect to Prometheus. Default:
||Port to connect to Prometheus. Default:
||Provide a DNS suffix for invoking functions directly over overlay network|
||Set a location where you have mounted
||Enables an intercepting proxy which will scale any function from 0 replicas to the desired amount|