mirror of
https://github.com/openfaas/faas.git
synced 2025-06-27 09:13:24 +00:00
Update README files
- Removes use of "our" from CONTRIBUTING guide - Updates/adds README.md files - Commnents and typo fix in watchdog - Adds good/bad examples of commit messages Signed-off-by: Alex Ellis (VMware) <alexellis2@gmail.com>
This commit is contained in:
@ -6,11 +6,12 @@ The gateway will scale functions according to demand by altering the service rep
|
||||
|
||||
In summary:
|
||||
|
||||
* UI built-in
|
||||
* Deploy your own functions or from the Function Store
|
||||
* Built-in UI Portal
|
||||
* Deploy functions from the Function Store or deploy your own
|
||||
* Instrumentation via Prometheus
|
||||
* Auto-scaling via AlertManager
|
||||
* REST API available
|
||||
* Auto-scaling via AlertManager and Prometheus
|
||||
* Scaling up from zero
|
||||
* REST API available documented with Swagger
|
||||
|
||||

|
||||
|
||||
@ -24,6 +25,24 @@ Providers for functions can be written using the [faas-provider](https://github.
|
||||
|
||||
Swagger docs: https://github.com/openfaas/faas/tree/master/api-docs
|
||||
|
||||
## CORS
|
||||
|
||||
By default the only CORS path allowed is for the Function Store which is served from the GitHub RAW CDN.
|
||||
|
||||
## UI Portal
|
||||
|
||||
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](./assets/) folder.
|
||||
|
||||
### Function Store
|
||||
|
||||
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](https://github.com/openfaas/faas-cli).
|
||||
|
||||
See the [openfaas/store](https://github.com/openfaas/store) repo for more.
|
||||
|
||||
## Logs
|
||||
|
||||
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.
|
||||
@ -52,7 +71,7 @@ The gateway can be configured through the following environment variables:
|
||||
| `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` |
|
||||
| `direct_functions` | `true` or `false` - functions are invoked directly over overlay network without passing through provider |
|
||||
| `direct_functions` | `true` or `false` - functions are invoked directly over overlay network by DNS name without passing through the provider |
|
||||
| `direct_functions_suffix` | Provide a DNS suffix for invoking functions directly over overlay network |
|
||||
| `basic_auth` | Set to `true` or `false` to enable embedded basic auth on the /system and /ui endpoints (recommended) |
|
||||
| `secret_mount_path` | Set a location where you have mounted `basic-auth-user` and `basic-auth-password`, default: `/run/secrets/`. |
|
||||
|
Reference in New Issue
Block a user