Fix kubernetes deployment

.github/workflows/ci-main.yml

@@ -17,4 +17,10 @@ jobs:
       - e2e-tests
       - backend-tests
     uses: ./.github/workflows/docker.yml
-# TODO: add deployment as step
+  deploy-to-kubernetes:
+    needs:
+      - build-publish-images
+    uses: ./.github/workflows/helm.yml
+    secrets:
+      KUBECONF: ${{ secrets.KUBECONF }}
+  # TODO: maybe add deploy to aws step

.github/workflows/ci-pull-request.yml

@@ -15,4 +15,4 @@ jobs:
     needs:
       - e2e-tests
       - backend-tests
-    uses: ./.github/workflows/docker.yml
+    uses: ./.github/workflows/docker.yml

.github/workflows/docker.yml

@@ -30,45 +30,55 @@ jobs:
         with:
           context: ./client
           push: true
-          tags: ghcr.io/aet-devops25/team-the-merge-doctors/client:latest
+          tags: ghcr.io/aet-devops25/team-the-merge-doctors/client:${{ github.sha }}
+
+      - name: Build & push Client image (Kubernetes Production)
+        uses: docker/build-push-action@v4
+        with:
+          context: ./client
+          push: true
+          tags: ghcr.io/aet-devops25/team-the-merge-doctors/client-kubernetes-production:${{ github.sha }}
+          build-args: |
+            NODE_ENV=production-kubernetes
 
       - name: Build & push GenAI image
         uses: docker/build-push-action@v4
         with:
           context: ./genai
           push: true
-          tags: ghcr.io/aet-devops25/team-the-merge-doctors/genai:latest
+          tags: ghcr.io/aet-devops25/team-the-merge-doctors/genai:${{ github.sha }}
 
       - name: Build & push Ollama image
         uses: docker/build-push-action@v4
         with:
           context: ./genai/ollama
           push: true
-          tags: ghcr.io/aet-devops25/team-the-merge-doctors/ollama:latest
+          tags: ghcr.io/aet-devops25/team-the-merge-doctors/ollama:${{ github.sha }}
 
       - name: Build & push User Service image
         uses: docker/build-push-action@v4
         with:
           context: ./server/userservice
           push: true
-          tags: ghcr.io/aet-devops25/team-the-merge-doctors/server/user-service:latest
+          tags: ghcr.io/aet-devops25/team-the-merge-doctors/server/user-service:${{ github.sha }}
 
       - name: Build & push Mentorship Service image
         uses: docker/build-push-action@v4
         with:
           context: ./server/mentorshipservice
           push: true
-          tags: ghcr.io/aet-devops25/team-the-merge-doctors/server/mentorship-service:latest
+          tags: ghcr.io/aet-devops25/team-the-merge-doctors/server/mentorship-service:${{ github.sha }}
 
       - name: Build & push Rating Service image
         uses: docker/build-push-action@v4
         with:
           context: ./server/ratingservice
           push: true
-          tags: ghcr.io/aet-devops25/team-the-merge-doctors/server/rating-service:latest
+          tags: ghcr.io/aet-devops25/team-the-merge-doctors/server/rating-service:${{ github.sha }}
+
       - name: Build & push Gateway Service image
         uses: docker/build-push-action@v4
         with:
           context: ./server/gateway
           push: true
-          tags: ghcr.io/aet-devops25/team-the-merge-doctors/server/gateway-service:latest
+          tags: ghcr.io/aet-devops25/team-the-merge-doctors/server/gateway-service:${{ github.sha }}

.github/workflows/e2e-tests.yml

@@ -19,10 +19,6 @@ jobs:
       - uses: docker/setup-compose-action@v1
         name: Setup Docker
 
-      - name: Setup .env
-        run: |
-          cp docker/backend_config_files/.env.template docker/backend_config_files/.env
-
       - name: Generate JWT Key
         run: |
           ./docker/backend_config_files/jwk-key-generator.sh

.github/workflows/helm.yml

@@ -1,10 +1,10 @@
-name: Manual k8s (Helm) deployment
+name: k8s (Helm) deployment
 
 on:
-  workflow_dispatch:
-    inputs:
-      open_api_key:
-        description: "Your Open API key"
+  workflow_call:
+    secrets:
+      KUBECONF:
+        description: "Base64‑encoded kubeconfig file"
         required: true
 
 jobs:
@@ -15,10 +15,10 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up kubectl
-        uses: azure/setup-kubectl@v3
+        uses: azure/setup-kubectl@v4
 
       - name: Set up Helm
-        uses: azure/setup-helm@v3
+        uses: azure/setup-helm@v4
 
       - name: Log in to GHCR
         uses: docker/login-action@v2
@@ -29,22 +29,25 @@ jobs:
 
       - name: Set up kubeconfig
         run: |
-          mkdir $HOME/.kube
-          printf '%s' "${{ secrets.STUDENTKUBECONFIG }}" > $HOME/.kube/config
-          chmod 600 $HOME/.kube/config
+          mkdir -p ~/.kube
+          echo "${{ secrets.KUBECONF }}" | base64 --decode > ~/.kube/config
+          chmod 600 ~/.kube/config
+          echo "KUBECONF=~/.kube/config" >> $GITHUB_ENV
 
-      - name: Debug kubeconfig
-        run: |
-          kubectl config get-contexts
-          cat $HOME/.kube/config
-
-      # TODO: we are currently just using the latest containers without building them beforehand. Maybe add deployment as step of the pipeline on commits on the main branch
-      - name: Replace OPEN API key
+      - name: Set up kubeconfig
         run: |
-          cp ./helm/values.yaml.template ./helm/values.yaml
-          sed -i 's/<YOUR_OPEN_API_KEY>/test/g' ./helm/values.yaml
+          mkdir -p ~/.kube
+          echo "$KUBECONF_B64" | base64 --decode > ~/.kube/config
+          chmod 600 ~/.kube/config
+          echo "KUBECONF=~/.kube/config" >> $GITHUB_ENV
+        env:
+          KUBECONF_B64: ${{ secrets.KUBECONF }}
 
       - name: Deploy using Helm
+        env:
+          KUBECONF: ${{ runner.home }}/.kube/config
         run: |
           helm upgrade --install mentor-pulse ./helm/ \
             --namespace team-the-merge-doctors \
+            --set tag=${{ github.sha }}} \
+            --debug

.gitignore

@@ -291,7 +291,6 @@ celerybeat.pid
 
 # Environments
 .secrets.env
-.env
 .venv
 env/
 venv/
@@ -377,7 +376,4 @@ sketch
 ### Vue ###
 # gitignore template for Vue.js projects
 #
-# Recommended template: Node.gitignore
-
-# Helm
-values.yaml
+# Recommended template: Node.gitignore

README.md

@@ -1,5 +1,33 @@
 # Mentor Pulse
 
+TODO: short introduction what mentor pulse is
+
+## Local Development Setup
+
+TODO: documentation to add for project setup (e.g. how to start with docker)
+
+```
+docker compose up --build
+```
+
+```
+docker compose down -v
+```
+
+### Loading Mock Data
+
+TODO: add link to mock data scripts
+
+## Deployment
+
+TODO: add documentation about deployments
+
+### Kubernetes
+
+TODO: add link to kubernetes
+
+### EC2
+
 ## Endpoint Documentation
 
 The endpoints are documented using OpenAPI or Swagger schemas:
@@ -12,6 +40,12 @@ The endpoints are documented using OpenAPI or Swagger schemas:
 
 Alternatively, you can also find the endpoints in the controllers of the services (e.g. [MentorProfileController](server/mentorshipservice/src/main/java/com/mentorpulse/mentorshipservice/controller/MentorProfileController.java), [GenAI](genai/controllers/api_controller.py)). Additionally, some are also documented in `.bru` files (see [mentor-pulse-bruno](/docs/mentor-pulse-bruno/)).
 
-## Setup
+## Generating Open API Schemas for Microservices
 
-TODO: documentation to add for project setup (e.g. how to start with docker)
+This is how you can generate schemas for the Java microservices. For [genai](/genai/README.md) the setup is different.
+
+1. Start database via `docker compose up --build postgres-db`.
+2. Start service via `docker compose up --build <service-name>` for which you want to generate the schema.
+3. Navigate to service that you want to generate the schema for. Execute `./gradlew generateOpenApiDocs` in root
+   directory of service. Alternatively, open `http://<endpoint>/v3/api-docs.yaml` in a browser and move the schema to
+   the correct folder in the service.

client/.env

@@ -0,0 +1 @@
+MENTORSHIP_SERVICE_PROD_URL=http://mentorship-

client/Dockerfile

@@ -13,6 +13,9 @@ RUN pnpm install --frozen-lockfile
 
 COPY . .
 
+ARG NODE_ENV=development
+ENV NODE_ENV=${NODE_ENV}
+
 RUN pnpm run build
 
 # Stage 2
@@ -27,6 +30,9 @@ COPY --from=build /app/dist ./dist
 
 EXPOSE 3000
 
+ARG NODE_ENV=development
+ENV NODE_ENV=${NODE_ENV}
+
 CMD ["serve", "-s", "dist", "-l", "3000"]
 
 

client/README.md

@@ -31,7 +31,7 @@ The client is tested using E2E/UI tests. We use playwright as the framework for
 3. Run Tests: `pnpm exec playwright test`
 4. Show Report: `pnpm exec playwright show-report`
 
-## Execute tests with UI
+### Execute tests with UI
 
 Alternatively, you can also execute the tests using a UI.
 

client/src/main.tsx

@@ -24,8 +24,16 @@ declare module '@tanstack/react-router' {
   }
 }
 
+if (process.env.NODE_ENV === 'production-kubernetes') {
+  axios.defaults.baseURL =
+    'https://mentor-pulse-devops25.student.k8s.aet.cit.tum.de';
+} else {
+  axios.defaults.baseURL = 'http://localhost:80';
+}
+
 axios.interceptors.request.use(
   (config) => {
+    console.log('Base URL:', axios.defaults.baseURL);
     const token = localStorage.getItem('token');
     if (token) {
       const parsedToken = JSON.parse(token);

compose.yml

@@ -38,9 +38,8 @@ services:
     platform: linux/amd64
     image: ghcr.io/aet-devops25/team-the-merge-doctors/ollama:latest
     build:
-      context: ./genai/ollama
+      context: genai/ollama
       dockerfile: Dockerfile
-    container_name: ollama
     ports:
       - "11434:11434"
     volumes:

docs/mentor-pulse-bruno/production-kubernetes/folder.bru

@@ -0,0 +1,8 @@
+meta {
+  name: production-kubernetes
+  seq: 5
+}
+
+auth {
+  mode: inherit
+}

docs/mentor-pulse-bruno/production-kubernetes/genai.bru

@@ -0,0 +1,17 @@
+meta {
+  name: genai
+  type: http
+  seq: 1
+}
+
+post {
+  url: https://mentor-pulse-devops25.student.k8s.aet.cit.tum.de/api/genai/summarize
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+    "textToSummarize": 'test',
+  }
+}

genai/ollama/Dockerfile

@@ -5,4 +5,6 @@ RUN ollama serve & \
     ollama pull llama3.2 && \
     pkill ollama
 
+EXPOSE 11434
+
 ENTRYPOINT ["ollama", "serve"]

genai/utils/langchain_utils.py

@@ -10,7 +10,7 @@
 def _get_llm():
     """Get Ollama LLM instance"""
     try:
-        base_url = os.getenv('OLLAMA_BASE_URL', 'http://localhost:11434')
+        base_url = os.getenv('OLLAMA_BASE_URL', 'http://ollama-service:11434')
         return OllamaLLM(model="llama3.2", base_url=base_url)
     except Exception as e:
         logger.error(f"Failed to initialize Ollama LLM: {e}")

helm/README.md

@@ -5,14 +5,51 @@
 1. Download kube config file from cluster.
 2. Place it at `~/.kube/config`
 
-## Project Setup
+## Deploy
 
-1. Copy `values.yaml.template` and rename it to `values.yaml`.
+Run the following commands in this directory to deploy the application to the cluster.
+The first two commands only need to be executed once.
 
-## Deploy
+1. Generate JWT secret key
+
+```
+../docker/backend_config_files/jwk-key-generator.sh
+```
+
+2. Create Secret in Kubernetes
+
+```
+kubectl create secret generic jwt-secret \
+  --from-file=jwt-secret.key=</path/to/local>/jwt-secret.key \
+  -n <namespace>
+```
+
+3. Deploy to cluster
+
+```
+helm upgrade --install mentor-pulse . --namespace team-the-merge-doctors --set tag=<branch_name>
+```
+
+## Remove Deployment
+
+To remove the deployment and delete everything from cluster, execute the following command.
+
+```
+kubectl delete all --all -n team-the-merge-doctors
+```
+
+## Debugging
+
+Some helpful commands for debugging.
+
+Inspect the logs of a pod.
+
+```
+kubectl logs <deployment name (see rancher)> -n team-the-merge-doctors
+```
 
-Run the following command in this directory to deploy the application to the cluster.
+ssh into a pod.
 
 ```
-helm upgrade --install mentor-pulse . --namespace team-the-merge-doctors
+kubectl exec -it <deployment name (see rancher)> -n team-the-merge-doctors -- /bin/sh
 ```

helm/templates/configmap.yaml → helm/templates/configmaps/backend-environment-config.yaml

@@ -5,6 +5,6 @@ metadata:
 data:
   FLASK_ENV: development
   FLASK_APP: app.py
-  POSTGRES_HOST: db
+  POSTGRES_HOST: postgres-db
   POSTGRES_PORT: "5432"
   POSTGRES_GEN_AI_DB: genai_backend