Issue 100

documentation/setup.md

@@ -129,9 +129,9 @@ The following instructions detail how to setup the Mini PC used to run the game
 
     * **Webapp** => localhost:3000/
         <br>&nbsp; ![Webapp Play Page](../images/four-tab-game-page.png)
-    * **Game Service Health** => localhost:9070/health
+    * **Game Service Health** => localhost:9080/health
         <br><br>&nbsp; ![Game Service Health](../images/four-tab-game-server-health.png)
-    * **Leaderboard Health** => localhost:9080/health
+    * **Leaderboard Health** => localhost:9070/health
         <br><br>&nbsp; ![Leaderboard Health](../images/four-tab-leaderboard-health.png)
     * **Grafana** => localhost:3010/
     * There are two dashboards: Liberty Metrics Dashboard and Space Rover Mission statistics Dashboard

gestures/openCV_implementation/src/GestureRecognitionCVv2.py

@@ -22,8 +22,8 @@
 import sys
 
 print("Starting to connect")
-#uri = "ws://192.168.0.101:9070/roversocket"
-URI = "ws://localhost:9070/roversocket"
+#uri = "ws://192.168.0.101:9080/roversocket"
+URI = "ws://localhost:9080/roversocket"
 
 
 # Asynchronously try to connect to the server

kubernetes/README.md

@@ -0,0 +1,116 @@
+# Using Kubernetes with the Space Rover
+This document covers the process of configuring the OpenLiberty Space rover to user Kubernetes to manage it's services.
+
+## Getting started with Kubernetes
+One of the easiest ways to work with Kubernetes locally is with Docker Desktop. In your Docker Desktop settings, you can enable a local Kubernetes cluster.
+
+## Building your Images for Kubernetes
+When running the Open Liberty Space Rover with Docker Compose, the service images are created in a build step within the Docker Compose file. This implies that to use the images for Kubernetes you will have to build all the images manually. You are welcome to do this by hand if you have customizations you wish to make, otherwise we recommend you use the `buildServices.bat` or `buildServices.sh` scripts to build all of the images. 
+
+Users on Mac with Apple Silicon need to enable "Use Rosetta for x86/amd64 emulation on Apple Silicon" in Docker Desktop settings and build images with the `export DOCKER_DEFAULT_PLATFORM=linux/amd64` flag set.
+
+If you decide to use the build scripts, ensure you run the script from the `kubernetes` directory.
+
+After running the scripts you should see the following to indcate that you images are created.
+```
+Your images are complete!
+You can now apply your kubernetes files.
+```
+
+## Configuring your Kubernetes Files
+By default, the Kubernetes files are configured to run from the local images you just built. Alternatively, you can place these images in a container registry such as OpenShift Container Registry.
+
+### Configure MongoDB
+Ensure that the device running the Kubernetes cluster provides an available location to allocate it's persistent volume and configure it so in the `mongo-pv.yaml` file. To do this, navigate to `services\k8s\mongo-pv.yaml` and provide an path to a folder on your device that you wish to allocate, as seen below. In addition, folder must already exist at runtime if you specify it.
+```
+hostPath:
+    # Provide the existing directory below to use as Persistent Volume.
+    path: /opt/data/mongo
+```
+
+Additionally, create a Secret for the database credentials.
+```
+kubectl create secret generic mongo-secret \
+    --from-literal=MONGO_INITDB_ROOT_USERNAME=<user> \
+    --from-literal=MONGO_INITDB_ROOT_PASSWORD=<password> 
+```
+
+## Applying you Kubernetes Files to your Cluster
+After your images are built and you have configured repo to your use case, you can apply them to your cluster. Firstly, ensure that your cluster is operating properly with the following command:
+```
+kubectl get nodes
+```
+
+You should see the following:
+```
+NAME             STATUS   ROLES           AGE   VERSION
+docker-desktop   Ready    control-plane   22h   v1.24.2
+```
+
+Next, it is time to apply the `.yaml` files by navigating to the `services` directory and executing the following command:
+```
+kubectl apply -f ./k8s
+```
+
+It takes roughly 20-30 seconds for the Kubernetes to create all the pods and the containers, so be patient. To check on their status you are able to run the following command:
+```
+kubectl get pods
+```
+
+Once all of your pods are in `Running` status and your ouput looks like the following, then you are able to move onto testing your cluster.
+```
+NAME                           READY   STATUS    RESTARTS   AGE
+client-76bc76b7b4-9qzm2        1/1     Running   0          20s
+gameservice-66857669fc-h24rr   1/1     Running   0          20s
+grafana-6d6c864f76-859hs       1/1     Running   0          20s
+leaderboard-5cd7c966c5-9jvr9   1/1     Running   0          20s
+mongo-0                        1/1     Running   0          19s
+prometheus-74799df65-4nbxl     1/1     Running   0          19s
+```
+
+To run the `mockboard` and `mockrover` services, use files in the `services/k8s/mock` with a recursive apply command:
+```
+kubectl apply -R -f ./k8s
+```
+
+## Testing your Cluster
+At this point you should be able to navigate to [Client WebApp](http://localhost:3000) to play the game!
+
+## Shutting Down your Cluster
+After you are done testing out your cluster, you are able to shut it down with the executing the following command from the `services/` directory:
+```
+kubectl delete -f ./k8s
+```
+The output should be similar to the following:
+```
+deployment.apps "client" deleted
+service "client" deleted
+deployment.apps "gameservice" deleted
+service "gameservice" deleted
+deployment.apps "grafana" deleted
+service "grafana" deleted
+deployment.apps "leaderboard" deleted
+service "leaderboard" deleted
+deployment.apps "mockboard" deleted
+service "mockboard" deleted
+deployment.apps "mockrover" deleted
+service "mockrover" deleted
+deployment.apps "mongo" deleted
+persistentvolume "mongo-data-pv" deleted
+persistentvolumeclaim "mongo-pvc-0" deleted
+service "mongo" deleted
+deployment.apps "prometheus" deleted
+service "prometheus" deleted
+```
+
+Then, you can run the following command to verify all your containers are down:
+```
+kubectl get pods
+```
+
+Which should give you the following:
+```
+No resources found in default namespace.
+```
+
+

kubernetes/buildServices.bat

@@ -0,0 +1,33 @@
+@echo off
+:: Build all the images
+
+:: client
+START /B /WAIT docker build -t space-rover/client ^
+--build-arg GAME_URL=http://localhost:9080/game ^
+--build-arg GAME_SOCKET_URL=ws://localhost:9080/roversocket ^
+--build-arg GAME_DURATION_SECONDS=120 ^
+--build-arg LEADERBOARD_URL=http://localhost:9070/mongo/leaderboard ../services/client
+
+:: gameservice
+START /B /WAIT docker build -t space-rover/gameservice ../services/game
+
+:: leaderboard
+START /B /WAIT docker build -t space-rover/leaderboard ../services/leaderboard
+
+:: mockboard (if applicable)
+START /B /WAIT docker build -t space-rover/mockboard ../services/mock/board
+
+:: mockrover (if applicable)
+START /B /WAIT docker build -t space-rover/mockrover ../services/mock/rover
+
+:: mongo
+START /B /WAIT  docker build -t space-rover/mongo ../services/leaderboard/assets
+
+:: prometheus 
+START /B /WAIT docker build -t space-rover/prometheus ../services/prometheus
+
+:: grafana
+START /B /WAIT docker build -t space-rover/grafana ../services/grafana
+
+echo Your Images are Complete!
+echo You can now apply your kubernetes files.

kubernetes/buildServices.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+# Build all the images
+# client
+docker build -t space-rover/client \
+--build-arg GAME_URL=http://localhost:9080/game \
+--build-arg GAME_SOCKET_URL=ws://localhost:9080/roversocket \
+--build-arg GAME_DURATION_SECONDS=120 \
+--build-arg LEADERBOARD_URL=http://localhost:9070/mongo/leaderboard ../services/client
+
+# gameservice
+docker build -t space-rover/gameservice ../services/game
+
+# leaderboard
+docker build -t space-rover/leaderboard ../services/leaderboard
+
+# mockboard (if applicable)
+docker build -t space-rover/mockboard ../services/mock/board
+
+# mockrover (if applicable)
+docker build -t space-rover/mockrover ../services/mock/rover
+
+# mongo
+docker build -t space-rover/mongo ../services/leaderboard/assets
+
+# prometheus 
+docker build -t space-rover/prometheus ../services/prometheus
+
+# grafana
+docker build -t space-rover/grafana ../services/grafana
+
+echo Your Images are Complete!
+echo You can now apply your kubernetes files.

services/client/.env.example

@@ -1,3 +1,3 @@
-REACT_APP_GAME_SOCKET_URL=ws://localhost:9070/roversocket
+REACT_APP_GAME_SOCKET_URL=ws://localhost:9080/roversocket
 REACT_APP_GAME_DURATION_SECONDS=300
-REACT_APP_LEADERBOARD_URL=http://localhost:9080/mongo/leaderboard
+REACT_APP_LEADERBOARD_URL=http://localhost:9070/mongo/leaderboard

services/client/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16.14-alpine AS builder
+FROM node:14.17.5 AS builder
 
 WORKDIR /usr/src/app
 

services/docker-compose-test.yml

@@ -39,19 +39,28 @@ services:
     leaderboard:
         build: ./leaderboard
         ports:
-            - "9080:9080"
+            - "9070:9080"
     gameservice:
         build: ./game
+        environment: 
+            - io.openliberty.leaderboard.hostname=leaderboard
+            - io.openliberty.leaderboard.port=9080
+            - io.openliberty.server.hostname=gameservice
+            - io.openliberty.server.port=9080
+            - io.openliberty.spacerover.ip=mockrover
+            - io.openliberty.spacerover.port=5045
+            - io.openliberty.gameboard.ip=mockboard
+            - io.openliberty.gameboard.port=5045
         ports:
-            - "9070:9080"
+            - "9080:9080"
     client:
         build:
             context: ./client
             args:
-                - GAME_URL=http://localhost:9070/game
-                - GAME_SOCKET_URL=ws://localhost:9070/roversocket
+                - GAME_URL=http://localhost:9080/game
+                - GAME_SOCKET_URL=ws://localhost:9080/roversocket
                 - GAME_DURATION_SECONDS=120
-                - LEADERBOARD_URL=http://localhost:9080/mongo/leaderboard
+                - LEADERBOARD_URL=http://localhost:9070/mongo/leaderboard
         ports:
             - "3000:80"
     mockrover:

services/docker-compose.yml

@@ -39,18 +39,27 @@ services:
     leaderboard:
         build: ./leaderboard
         ports:
-            - "9080:9080"
+            - "9070:9080"
     gameservice:
         build: ./game
+        environment:
+            - io.openliberty.leaderboard.hostname=leaderboard
+            - io.openliberty.leaderboard.port=9080
+            - io.openliberty.server.hostname=gameservice
+            - io.openliberty.server.port=9080
+            - io.openliberty.spacerover.ip=192.168.0.115
+            - io.openliberty.spacerover.port=5045
+            - io.openliberty.gameboard.ip=192.168.0.117
+            - io.openliberty.gameboard.port=5045
         ports:
-            - "9070:9080"
+            - "9080:9080"
     client:
         build:
             context: ./client
             args:
-                - GAME_URL=http://localhost:9070/game
-                - GAME_SOCKET_URL=ws://localhost:9070/roversocket
+                - GAME_URL=http://localhost:9080/game
+                - GAME_SOCKET_URL=ws://localhost:9080/roversocket
                 - GAME_DURATION_SECONDS=120
-                - LEADERBOARD_URL=http://localhost:9080/mongo/leaderboard
+                - LEADERBOARD_URL=http://localhost:9070/mongo/leaderboard
         ports:
             - "3000:80"

services/game/Dockerfile

@@ -10,7 +10,7 @@ COPY src src
 
 RUN mvn -o package -DskipTests
 
-FROM icr.io/appcafe/websphere-liberty:22.0.0.8-full-java11-openj9-ubi
+FROM icr.io/appcafe/websphere-liberty:22.0.0.12-full-java11-openj9-ubi
 
 COPY --chown=1001:0 --from=builder /usr/src/app/target/*.war /config/apps
 

services/game/src/main/webapp/META-INF/microprofile-config.properties

@@ -1,5 +1,5 @@
 io.openliberty.leaderboard.hostname=leaderboard
-io.openliberty.leaderboard.port=9080
+io.openliberty.leaderboard.port=9070
 io.openliberty.server.hostname=gameservice
 io.openliberty.server.port=9080
 
@@ -10,7 +10,7 @@ io.openliberty.gameboard.ip=192.168.0.117
 io.openliberty.gameboard.port=5045
 
 # Test
-#io.openliberty.spacerover.ip=mockrover
-#io.openliberty.spacerover.port=5045
-#io.openliberty.gameboard.ip=mockboard
-#io.openliberty.gameboard.port=5045
+# io.openliberty.spacerover.ip=mockrover
+# io.openliberty.spacerover.port=5045
+# io.openliberty.gameboard.ip=mockboard
+# io.openliberty.gameboard.port=5045

services/grafana/Dockerfile

@@ -0,0 +1,6 @@
+FROM grafana/grafana:7.3.7
+
+COPY --chown=1000:0 ./datasources.yml /etc/grafana/provisioning/datasources/datasources.yml
+COPY --chown=1000:0 ./dashboards.yml /etc/grafana/provisioning/dashboards/dashboards.yml
+COPY --chown=1000:0 ./dashboards/open-liberty_rev5.json /var/lib/grafana/dashboards/open-liberty_rev5.json
+COPY --chown=1000:0 ./dashboards/space-rover-rev1.json /var/lib/grafana/dashboards/space-rover-rev1.json

services/k8s/client-deployment.yaml

@@ -0,0 +1,27 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app.service: client
+  name: client
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.service: client
+  strategy: {}
+  template:
+    metadata:
+      labels:
+        app.service: client
+    spec:
+      containers:
+        # - image: ca.icr.io/space-rover/client-test
+        - image: space-rover/client
+          name: client
+          ports:
+            - containerPort: 80
+          resources: {}
+          # Change Pull Policy for Remote Registry
+          imagePullPolicy: Never
+status: {}

services/k8s/client-service.yaml

@@ -0,0 +1,16 @@
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app.service: client
+  name: client
+spec:
+  type: LoadBalancer 
+  ports:
+    - name: "3000"
+      port: 3000
+      targetPort: 80
+  selector:
+    app.service: client
+status:
+  loadBalancer: {}

services/k8s/gameservice-deployment.yaml

@@ -0,0 +1,28 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app.service: gameservice
+  name: gameservice
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.service: gameservice
+  strategy: {}
+  template:
+    metadata:
+      labels:
+        app.service: gameservice
+    spec:
+      containers:
+        # - image: ca.icr.io/space-rover/gameservice-test
+        - image: space-rover/gameservice
+          name: gameservice
+          ports:
+            - containerPort: 9080
+          resources: {}
+          # Change Pull Policy for Remote Registry
+          imagePullPolicy: Never
+      restartPolicy: Always
+status: {}