doc: add demo environment (#265)

Author: olblak

README.adoc

@@ -17,6 +17,33 @@ Insight reuse pipeline report to provide a visualization per theme such as the s
 
 __Still work in progress__
 
+== Demo
+
+The best way to discover Udash is to try it yourself. There is a docker compose example available in the demo directory.
+
+Deploy Udash with the following steps:
+
+1. Make sure you have Docker and Docker Compose installed.
+2. Run `docker compose up -d` in the directory `demo`.
+3. Configure your browser to access Udash at `http://localhost:8080`.
+4. Run `updatecli udash login "http://localhost" --experimental` to configure Updatecli to upload reports to Udash.
+5. Then you can run any updatecli command (apply/diff) to start publishing reports to Udash
+
+INFO: You may have to run `docker compose restart server` if the postgresql database
+ wasn't ready in time to receive connections when the Udash server started.
+
+Don't worry if you don't have any Updatecli manifest yet, you can still try the demo by using the Updatecli policies used by this Git repository.
+For that you need Updatecli and GitHub access token to interact with the GitHub API.
+
+You can run the following commands to configure Updatecli to use the policies defined in this repository:
+
+1. `export GITHUB_TOKEN=<your-github-token>`
+2. `export GITHUB_ACTOR=<your-github-username>`
+3. `docker login ghcr.io` to authenticate on the GitHub Container Registry for pullling Updatecli policies
+4. `updatecli compose diff --experimental` to execute Updatecli policies  defined in the file `updatecli-compose.yaml`
+
+
+
 == Architecture
 
 === Requirements

demo/docker-compose.yaml

@@ -0,0 +1,72 @@
+## How to run this example
+#
+# 1. Make sure you have Docker and Docker Compose installed.
+# 2. Run `docker compose up -d` in the directory containing this file.
+# 3. Configure your browser to access the Updatecli dashboard at `http://localhost:8080`.
+# 4. Run `updatecli udash login "http://localhost" --experimental`
+# 5. Run any updatecli command to publish reports to Udash
+#
+# INFO: You may have to run `docker compose restart server` if the postgresql database
+#  wasn't ready to receive connection
+# 
+# For example from the root of this repository, you can run:
+# 1. `export GITHUB_TOKEN=<your-github-token>`
+# 2. `export GITHUB_ACTOR=<your-github-username>`
+# 3. `docker login ghcr.io` to authenticate on the GitHub Container Registry for pullling Updatecli policies
+# 4. `updatecli compose diff --experimental` to execute Updatecli policies  defined in the file `updatecli-compose.yaml`
+
+version: '3'
+services:
+  db:
+    image: postgres:17@sha256:8d3be35b184e70d81e54cbcbd3df3c0b47f37d06482c0dd1c140db5dbcc6a808
+    restart: always
+    environment:
+      - POSTGRES_USER=udash
+      - POSTGRES_PASSWORD=password
+      - POSTGRES_DB=udash
+    ports:
+      - 5432
+
+  server:
+    image: ghcr.io/updatecli/udash:v0.10.0
+    command: server start
+    environment:
+      - GIN_MODE=release
+    volumes:
+      - "./udash/config.yaml:/home/udash/.udash/config.yaml"
+    expose:
+      - 8080
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.traefik-server.service=server"
+      - "traefik.http.services.server.loadbalancer.server.port=8080"
+      - "traefik.http.routers.traefik-server.rule=PathPrefix(`/api/`)"
+
+  front:
+    image: ghcr.io/updatecli/udash-front:v0.10.1
+    expose:
+      - 80
+    environment:
+      - VUE_APP_AUTH_ENABLED=false
+    volumes:
+      - "./udash-front/config.js:/usr/share/nginx/html/config.js"
+      - "./udash-front/config.json:/usr/share/nginx/html/config.json"
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.front.rule=PathPrefix(`/`)"
+      - "traefik.http.routers.front.service=front"
+      - "traefik.http.services.front.loadbalancer.server.port=80"
+
+  traefik:
+    image: "traefik:v3.0"
+    container_name: "traefik"
+    command:
+      - "--api.insecure=true"
+      - "--providers.docker=true"
+      - "--providers.docker.exposedbydefault=false"
+      - "--entrypoints.web.address=:80"
+    ports:
+      - "80:80"
+      - "8080:8080"
+    volumes:
+      - "/var/run/docker.sock:/var/run/docker.sock:ro"

demo/udash-front/config.js

@@ -0,0 +1,7 @@
+const config = (() => {
+  return {
+    "OAUTH_DOMAIN": "https://oauth.domain",
+    "OAUTH_CLIENTID": "client_id",
+    "OAUTH_AUDIENCE": "http://localhost:8080/api"
+  };
+})();

demo/udash-front/config.json

@@ -0,0 +1,5 @@
+{
+   "OAUTH_DOMAIN": "https://oauth.domain",
+   "OAUTH_CLIENTID": "client_id",
+   "OAUTH_AUDIENCE": "http://localhost:8080/api"
+}

demo/udash/config.yaml

@@ -0,0 +1,10 @@
+server:
+  auth:
+    mode: "none"
+  # mode: "oauth"
+  # issuer: "oauth2 provider"
+  # audience: "http://udash.localhost"
+
+database:
+  migrationdisabled: false
+  uri: postgres://udash:password@db:5432/udash?sslmode=disable