diff --git a/ROADMAP.md b/ROADMAP.md index 26c4d8ae7a0be4d38bee9815c035afc2e7bdd555..a69cbc9d440a5779cdcc714c090ee90e290b7686 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,6 +1,6 @@ # Roadmap -## 1. Current items +## 1. Current features ### The API Gateway @@ -15,7 +15,7 @@ Features: * Instrumentation via Prometheus metrics at GET /metrics * Bundled Prometheus stack with AlertManager * UI enhancements to create new function through a form - +* ARM support on Raspberry Pi **Incoming requests and routing** @@ -36,29 +36,48 @@ This binary fwatchdog acts as a watchdog for your function. Features: ## 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 * Function store - list of useful predefined functions -* Guide for termination through NGinx or built-in TLS termination -* Guide for basic authentication over HTTPs (set up externally through NGinx etc) -* Documentation about Alexa sample function * Supporting request parameters +* Configurable memory limits via "new function" pop-up (already supported by Docker compose stack) -* Deeper tests coverage and integration tests +Nice to have + +* Guide for termination through NGinx or built-in TLS termination +* Guide for basic authentication over HTTPs (set up externally through NGinx etc) +* Billing control for functions +* AARCH64 (64-bit ARM) port +* Raspberry Pi (armhf/armv6) support (currently available) ## 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) -### License +### Contributing -This project is licensed under the MIT License. +Here are a few guidelines for contributing: -## Contributing +* If you have found a bug please raise an issue and fill out the whole template. +* If you would like to contribute to the codebase please raise an issue to propose the change and fill out the whole template. +* If the documentation can be improved / translated etc please raise an issue to discuss. PRs for changing one or two typos aren't necessary. -Here are a few guidelines for contributing: +> Please always provide a summary of what you changed, how you did it and how it can be tested. -* If you have found a bug please raise an issue. -* 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. +### License -> Please provide a summary of what you changed, how you did it and how it can be tested. +This project is licensed under the MIT License.