From 6e537d1fde62679e2f9f4618bdf3fff4ca43a1e8 Mon Sep 17 00:00:00 2001 From: "Alex Ellis (OpenFaaS Ltd)" Date: Fri, 18 Sep 2020 11:43:28 +0100 Subject: [PATCH] Add docs for compose file Signed-off-by: Alex Ellis (OpenFaaS Ltd) --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 7b029ab..e349a1e 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,26 @@ journalctl -t openfaas-fn:figlet -f & echo logs | faas-cli invoke figlet ``` +### Exposing core services + +The OpenFaaS stack is made up of several core services including NATS and Prometheus. You can expose these through the `docker-compose.yaml` file located at `/var/lib/faasd`. + +Expose the gateway to all adapters: + +```yaml + gateway: + ports: + - "8080:8080" +``` + +Expose Prometheus only to 127.0.0.1: + +```yaml + prometheus: + ports: + - "127.0.0.1:9090:9090" +``` + ## What does faasd deploy? * faasd - itself, and its [faas-provider](https://github.com/openfaas/faas-provider) for containerd - CRUD for functions and services, implements the OpenFaaS REST API