feat(k8s): Adding Helm charts

.github/workflows/build_push.yml

@@ -12,7 +12,7 @@ permissions:
 jobs:
     docker_build_test:
         runs-on: ubuntu-24.04
-        name: Docker_build
+        name: Docker_build and Helm_build
         steps:
         - uses: actions/checkout@v4
 
@@ -25,4 +25,49 @@ jobs:
           run: |
             echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
             docker push ghcr.io/gabrielpalmar/hivebox:$(cat version.txt)
-            docker push ghcr.io/gabrielpalmar/hivebox:latest
+            docker push ghcr.io/gabrielpalmar/hivebox:latest
+
+            # Get the SHA256 digest
+            DIGEST=$(docker inspect --format='{{index .RepoDigests 0}}' ghcr.io/gabrielpalmar/hivebox:$(cat version.txt) | cut -d'@' -f2)
+            if [ -z "$DIGEST" ]; then
+              echo "Failed to capture Docker digest"
+              exit 1
+            fi
+            echo "Image digest: $DIGEST"
+            echo "DOCKER_DIGEST=$DIGEST" >> $GITHUB_ENV
+
+        - name: Install Helm
+          run: |
+            curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
+            chmod 700 get_helm.sh
+            ./get_helm.sh
+            if ! command -v helm version &> /dev/null; then
+              echo "Helm could not be installed"
+              exit 1
+            fi
+
+        - name: Build Helm Chart
+          run: |
+            VERSION=$(cat version.txt)
+            sed -i "s/^version:.*/version: $VERSION/" ./helm-chart/Chart.yaml
+            sed -i "s/^appVersion:.*/appVersion: \"$VERSION\"/" ./helm-chart/Chart.yaml
+            sed -i "s|hivebox: ghcr.io/gabrielpalmar/hivebox:.*|hivebox: ghcr.io/gabrielpalmar/hivebox:$VERSION@$DOCKER_DIGEST|" ./helm-chart/values.yaml
+            helm package ./helm-chart
+
+        - name: Push Helm Chart to GHCR
+          run: |
+            CHART_FILE="hivebox-$(cat version.txt).tgz"
+            if [ ! -f "$CHART_FILE" ]; then
+              echo "Helm chart $CHART_FILE not found"
+              exit 1
+            fi
+            echo "${{ secrets.GITHUB_TOKEN }}" | helm registry login ghcr.io -u ${{ github.actor }} --password-stdin
+            helm push $CHART_FILE oci://ghcr.io/gabrielpalmar/hivebox-helm-charts
+
+        - name: Add job summary
+          run: |
+            VERSION=$(cat version.txt)
+            echo "## Build Summary" >> $GITHUB_STEP_SUMMARY
+            echo "- Docker image: ghcr.io/gabrielpalmar/hivebox:$VERSION" >> $GITHUB_STEP_SUMMARY
+            echo "- Image digest: $DOCKER_DIGEST" >> $GITHUB_STEP_SUMMARY
+            echo "- Helm chart: hivebox-$VERSION" >> $GITHUB_STEP_SUMMARY

app/opensense.py

@@ -51,7 +51,7 @@ def get_temperature():
 
     print('Getting data from OpenSenseMap API...')
 
-    response = requests.get("https://api.opensensemap.org/boxes", params=params, timeout=300)
+    response = requests.get("https://api.opensensemap.org/boxes", params=params, timeout=480)
     print('Data retrieved successfully!')
 
     _sensor_stats["total_sensors"] = sum(

app/readiness.py

@@ -1,4 +1,5 @@
 '''Module to check the readiness of the stored information'''
+import json
 import requests
 import redis
 from app.opensense import get_temperature
@@ -41,16 +42,10 @@ def reachable_boxes():
             return 400
         return 200
 
-    except requests.exceptions.RequestException as e:
-        # Handle network-related errors from the API call
-        print(f"Network error checking reachable boxes: {e}")
-        return 200
-    except redis.RedisError as e:
-        # Handle Redis-related errors
-        print(f"Redis error checking reachable boxes: {e}")
+    except (json.JSONDecodeError, requests.exceptions.RequestException, redis.RedisError) as e:
+        print(f"Error checking reachable boxes: {e}")
         return 200
     except (ValueError, TypeError, KeyError) as e:
-        # Handle data parsing errors
         print(f"Data error checking reachable boxes: {e}")
         return 400
 

app/storage.py

@@ -54,8 +54,8 @@ def store_temperature_data():
             content_type='text/plain'
         )
 
-        return (f"Temperature data successfully uploaded as "
-                f"{destination_file} to bucket {bucket_name}")
+        return (f'Temperature data successfully uploaded as '
+                f'{destination_file} to bucket {bucket_name}\n')
 
     except (S3Error, InvalidResponseError) as exc:
         error_msg = f"MinIO S3 error occurred: {exc}"

helm-chart/Chart.yaml

@@ -0,0 +1,6 @@
+apiVersion: v2
+name: hivebox
+description: A Helm chart for HiveBox application
+type: application
+version: 0.1.0
+appVersion: "0.7.0"

helm-chart/NOTES.txt

@@ -0,0 +1,13 @@
+# filepath: helm-chart/NOTES.txt
+1. Get the application URL by running these commands:
+{{- if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services hivebox-service)
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "ClusterIP" .Values.service.type }}
+  kubectl port-forward --namespace {{ .Release.Namespace }} svc/hivebox-service 8080:80
+  echo "Visit http://127.0.0.1:8080 to use your application"
+{{- end }}
+
+2. Check the application status:
+  kubectl get pods --namespace {{ .Release.Namespace }} -l "app=hivebox"

helm-chart/templates/_helpers.tpl

@@ -0,0 +1,22 @@
+{{/* Pod-level securityContext */}}
+{{- define "common.podSecurityContext" -}}
+{{- with .Values.podSecurityContext }}
+{{ toYaml . }}
+{{- end }}
+{{- end }}
+
+{{/* Container-level securityContext */}}
+{{- define "common.containerSecurityContext" -}}
+{{- with .Values.containerSecurityContext }}
+{{ toYaml . }}
+{{- end }}
+{{- end }}
+
+{{/* Resources per workload (hivebox, redis, minio, cronjob) */}}
+{{- define "common.resources" -}}
+{{- $vals := .Values -}}
+{{- $name := .name -}}
+{{- with (index $vals.resources $name) }}
+{{ toYaml . }}
+{{- end }}
+{{- end }}

helm-chart/templates/cronjob.yaml

@@ -0,0 +1,49 @@
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: temperature-storage-cronjob
+  labels:
+    app: hivebox-cronjob
+spec:
+  schedule: "*/5 * * * *"
+  concurrencyPolicy: Forbid
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          restartPolicy: OnFailure
+          securityContext:
+            {{- include "common.podSecurityContext" . | nindent 12 }}
+          initContainers:
+            - name: wait-for-start
+              image: {{ .Values.images.cronjob }}
+              command: ["/bin/sh", "-c"]
+              args:
+                - |
+                  set -eu
+                  while true; do
+                    if curl -sSf -m 3 http://hivebox-service/version >/dev/null; then
+                      echo "Hivebox service is up!"
+                      exit 0
+                    else
+                      echo "Waiting for Hivebox service to be available..."
+                      sleep 5
+                    fi
+                  done
+          containers:
+            - name: temperature-storage
+              image: {{ .Values.images.cronjob }}
+              command: ["curl"]
+              args:
+                - "-f"
+                - "-s"
+                - "-S"
+                - "--max-time"
+                - "60"
+                - "http://hivebox-service/store"
+              securityContext:
+                {{- include "common.containerSecurityContext" . | nindent 16 }}
+              resources:
+                {{- include "common.resources" (dict "Values" .Values "name" "cronjob") | nindent 16 }}
+  successfulJobsHistoryLimit: 3
+  failedJobsHistoryLimit: 1

helm-chart/templates/deployment.yaml

@@ -0,0 +1,138 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: hivebox
+  labels:
+    app: hivebox
+spec:
+  replicas: {{ .Values.replicas.hivebox }}
+  selector:
+    matchLabels:
+      app: hivebox
+  template:
+    metadata:
+      labels:
+        app: hivebox
+    spec:
+      securityContext:
+        {{- include "common.podSecurityContext" . | nindent 8 }}
+      containers:
+        - name: hivebox
+          image: {{ .Values.images.hivebox }}
+          ports:
+            - containerPort: 5000
+          env:
+            - name: REDIS_HOST
+              value: {{ .Values.services.redis | quote }}
+            - name: MINIO_HOST
+              value: {{ .Values.services.minio | quote }}
+          securityContext:
+            {{- include "common.containerSecurityContext" . | nindent 12 }}
+          resources:
+            {{- include "common.resources" (dict "Values" .Values "name" "hivebox") | nindent 12 }}
+          startupProbe:
+            httpGet:
+              path: /readyz
+              port: 5000
+            periodSeconds: 10
+            failureThreshold: 1
+            timeoutSeconds: 480
+            initialDelaySeconds: 5
+          readinessProbe:
+            httpGet:
+              path: /readyz
+              port: 5000
+            periodSeconds: 60
+            timeoutSeconds: 3
+            failureThreshold: 3
+          livenessProbe:
+            httpGet:
+              path: /version
+              port: 5000
+            periodSeconds: 60
+            timeoutSeconds: 3
+            failureThreshold: 3
+          volumeMounts:
+            - name: tmp-volume
+              mountPath: /tmp
+      volumes:
+        - name: tmp-volume
+          emptyDir: {}
+
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: redis
+  labels:
+    app: redis
+spec:
+  replicas: {{ .Values.replicas.redis }}
+  selector:
+    matchLabels:
+      app: redis
+  template:
+    metadata:
+      labels:
+        app: redis
+    spec:
+      securityContext:
+        {{- include "common.podSecurityContext" . | nindent 10 }}
+      containers:
+        - name: valkey
+          image: {{ .Values.images.redis }}
+          ports:
+            - containerPort: 6379
+          command: ["valkey-server"]
+          args: ["--save", "", "--appendonly", "no"]
+          securityContext:
+            {{- include "common.containerSecurityContext" . | nindent 12 }}
+          resources:
+            {{- include "common.resources" (dict "Values" .Values "name" "redis") | nindent 12 }}
+          volumeMounts:
+            - name: valkey-data
+              mountPath: /data
+      volumes:
+        - name: valkey-data
+          emptyDir: {}
+
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: minio
+  labels:
+    app: minio
+spec:
+  replicas: {{ .Values.replicas.minio }}
+  selector:
+    matchLabels:
+      app: minio
+  template:
+    metadata:
+      labels:
+        app: minio
+    spec:
+      securityContext:
+        {{- include "common.podSecurityContext" . | nindent 10 }}
+      containers:
+        - name: minio
+          image: {{ .Values.images.minio }}
+          ports:
+            - containerPort: 9000
+          command: ["minio", "server", "/data"]
+          env:
+            - name: MINIO_ROOT_USER
+              value: {{ .Values.minio.accessKey | quote }}
+            - name: MINIO_ROOT_PASSWORD
+              value: {{ .Values.minio.secretKey | quote }}
+          securityContext:
+            {{- include "common.containerSecurityContext" . | nindent 12 }}
+          resources:
+            {{- include "common.resources" (dict "Values" .Values "name" "minio") | nindent 12 }}
+          volumeMounts:
+            - name: minio-data
+              mountPath: /data
+      volumes:
+        - name: minio-data
+          emptyDir: {}

helm-chart/templates/ingress.yaml

@@ -0,0 +1,21 @@
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: hivebox-ingress
+  annotations:
+    {{- if .Values.ingress.annotations }}
+    {{- toYaml .Values.ingress.annotations | nindent 4 }}
+    {{- end }}
+spec:
+  ingressClassName: {{ .Values.ingress.className | default "nginx" }}
+  rules:
+    - host: {{ .Values.ingress.host | quote }}
+      http:
+        paths:
+          - path: {{ .Values.ingress.path | default "/" }}
+            pathType: Prefix
+            backend:
+              service:
+                name: {{ .Values.ingress.serviceName | default "hivebox-service" }}
+                port:
+                  number: {{ .Values.ingress.servicePort | default 80 }}