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

Update backlog

Browse Source
This commit is contained in:
Alex Ellis 2017-04-23 17:51:24 +01:00 committed by GitHub
parent eff728ee2b
commit b8da99ddb4
1 changed files with 34 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
ROADMAP.md
View File

@ -1,6 +1,6 @@
# Roadmap # Roadmap
## 1. Current items ## 1. Current features
### The API Gateway ### The API Gateway
@ -15,7 +15,7 @@ Features:
* Instrumentation via Prometheus metrics at GET /metrics * Instrumentation via Prometheus metrics at GET /metrics
* Bundled Prometheus stack with AlertManager * Bundled Prometheus stack with AlertManager
* UI enhancements to create new function through a form * UI enhancements to create new function through a form
* ARM support on Raspberry Pi
**Incoming requests and routing** **Incoming requests and routing**
@ -36,29 +36,48 @@ This binary fwatchdog acts as a watchdog for your function. Features:
## 2. Future items ## 2. Future items
Must have
* Documentation for current API
* Clearly documented TLS via reverse proxy and Lets Encrypt (Nginx, Traefik)
* Deeper tests coverage and integration tests
Should have
* Windows support for watchdog back-end - so that Windows executables can be used in a multi-OS swarm
* Native CLI for templating/building and deploying functions
* Basic auth for /system endpoints (probably via reverse proxy)
* Documentation about Alexa sample function
Could have
* Asynchronous / long-running tasks * Asynchronous / long-running tasks
* Function store - list of useful predefined functions * Function store - list of useful predefined functions
* Supporting request parameters
* Configurable memory limits via "new function" pop-up (already supported by Docker compose stack)
Nice to have
* Guide for termination through NGinx or built-in TLS termination * Guide for termination through NGinx or built-in TLS termination
* Guide for basic authentication over HTTPs (set up externally through NGinx etc) * Guide for basic authentication over HTTPs (set up externally through NGinx etc)
* Documentation about Alexa sample function * Billing control for functions
* Supporting request parameters * AARCH64 (64-bit ARM) port
* Raspberry Pi (armhf/armv6) support (currently available)
* Deeper tests coverage and integration tests
## 3. Development and Contributing ## 3. Development and Contributing
If you would like to consume the project with your own functions then you can use the public images and the supplied `docker stack` file as a template (docker-compose.yml) If you would like to consume the project with your own functions then you can use the public images and the supplied `docker stack` file as a template (docker-compose.yml)
### License ### Contributing
This project is licensed under the MIT License.
## Contributing
Here are a few guidelines for contributing: Here are a few guidelines for contributing:
* If you have found a bug please raise an issue. * If you have found a bug please raise an issue and fill out the whole template.
* If the documentation can be improved / translated etc please raise an issue to discuss. * If you would like to contribute to the codebase please raise an issue to propose the change and fill out the whole template.
* If you would like to contribute to the codebase please raise an issue to propose the change. * If the documentation can be improved / translated etc please raise an issue to discuss. PRs for changing one or two typos aren't necessary.
> Please provide a summary of what you changed, how you did it and how it can be tested. > Please always provide a summary of what you changed, how you did it and how it can be tested.
### License
This project is licensed under the MIT License.