Page on enabling dashboard for edge

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>

Author: alexellis

docker-compose.yaml

@@ -0,0 +1,9 @@
+version: '3.8'
+services:
+  mkdocs:
+    image: squidfunk/mkdocs-material:latest
+    ports:
+      - "8000:8000"
+    volumes:
+      - .:/docs
+    restart: unless-stopped

docs/edge/dashboard.md

@@ -0,0 +1,47 @@
+# Dashboard for OpenFaaS Edge
+
+The [OpenFaaS Pro Dashboard](/openfaas-pro/dashboard) is compatible with OpenFaaS Edge.
+
+!!! note "Optional add-on"
+
+    The dashboard is included with OpenFaaS for Kubernetes, but is an optional add-on for Edge and requires an additional tier or purchase.
+
+## Enable the service
+
+The service comes pre-packaged within the default installation, but is disabled by default.
+
+Edit `/var/lib/faasd/docker-compose.yaml`:
+
+```diff
+services:
+  dashboard:
+-   deploy:
+-     replicas: 0
+```
+
+Then create a JWT signing key:
+
+```bash
+# Generate a private key
+openssl ecparam -genkey -name prime256v1 -noout -out jwt_key
+
+# Then create a public key from the private key
+openssl ec -in jwt_key -pubout -out jwt_key.pub
+```
+
+Move the keys to `/var/lib/faasd/secrets/`:
+
+```bash
+sudo mv ./jwt_key /var/lib/faasd/secrets/key
+sudo mv ./jwt_key.pub /var/lib/faasd/secrets/key.pub
+```
+
+Then restart faasd:
+
+```bash
+sudo systemctl daemon-reload
+sudo systemctl restart faasd
+```
+
+You can then access the dashboard from port 8083 on loopback on the host, or [add a TLS entry](/edge/tls) to access it from the Internet.
+

docs/edge/overview.md

@@ -1,6 +1,6 @@
 # OpenFaaS Edge Overview
 
-OpenFaaS Edge is a commercial distribution of both [OpenFaaS Standard](/docs/openfaas-pro/) and [faasd](https://github.com/openfaas/faasd) designed for redistribution of bespoke solutions to end customers.
+[OpenFaaS Edge](/deployment/edge) is a commercial distribution of both [OpenFaaS Standard](/docs/openfaas-pro/) and [faasd](https://github.com/openfaas/faasd) designed for redistribution of bespoke solutions to end customers.
 
 The handbook and reference documentation for OpenFaaS Edge are available in the [Serverless for Everyone Else eBook](https://store.openfaas.com/l/serverless-for-everyone-else?layout=profile). As a customer, you will receive a 100% discount code for the eBook.
 

mkdocs.yml

@@ -174,12 +174,13 @@ nav:
       - Grafana dashboards: ./openfaas-pro/grafana-dashboards.md
   - OpenFaaS Edge:
       - Overview: ./edge/overview.md
-      - Services: ./edge/services.md
-      - TLS: ./edge/tls.md
+      - Manage services: ./edge/services.md
+      - Configure TLS: ./edge/tls.md
+      - Enable the dashboard: ./edge/dashboard.md
       - Custom DNS: ./edge/custom-dns.md
       - Scale to Zero: ./edge/scale-to-zero.md
       - Kafka connector: ./edge/kafka-deployment.md
-      - GPU for Services: ./edge/gpus.md
+      - GPU for services: ./edge/gpus.md
   - Reference:
     - OpenFaaS YAML: ./reference/yaml.md
     - REST API: ./reference/rest-api.md