feat(TRG 5.09): created a workflow to lint and test the Helm deployment

.github/workflows/helm-test.yaml

@@ -0,0 +1,104 @@
+name: Lint and Test Charts
+
+on:
+  push:
+    paths:
+      - "charts/industry-core-hub/**"
+      - ".github/workflows/helm-test.yaml"
+      - "**/Dockerfile"
+    branches: main
+  pull_request:
+    paths:
+      - "charts/industry-core-hub/**"
+      - ".github/workflows/helm-test.yaml"
+      - "**/Dockerfile"
+    branches: main
+  workflow_dispatch:
+    inputs:
+      node_image:
+        description: "kindest/node image for k8s kind cluster"
+        # k8s version from 3.1 release as default
+        default: "kindest/node:v1.27.3"
+        required: false
+        type: string
+      # upgrade_from:
+      #   description: "chart version to upgrade from"
+      #   # chart version from 3.1 release as default
+      #   default: "x.x.x"
+      #   required: false
+      #   type: string
+      helm_version:
+        description: "helm version to test (default = latest)"
+        default: "latest"
+        required: false
+        type: string
+
+jobs:
+  lint-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Kubernetes KinD Cluster
+        uses: container-tools/kind-action@v1
+        with:
+          # upgrade version, default (v0.17.0) uses node image v1.21.1 and doesn't work with more recent node image versions
+          version: v0.20.0
+          # default value for event_name != workflow_dispatch
+          node_image: ${{ github.event.inputs.node_image || 'kindest/node:v1.27.3' }}
+
+      - name: Build backend image
+        uses: docker/build-push-action@v3
+        with:
+          context: "{{defaultContext}}:ichub-backend"
+          push: true
+          tags: kind-registry:5000/ichub-backend:testing
+
+      - name: Build frontend image
+        uses: docker/build-push-action@v3
+        with:
+          context: "{{defaultContext}}:ichub-frontend"
+          push: true
+          tags: kind-registry:5000/ichub-frontend:testing
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: ${{ github.event.inputs.helm_version || 'latest' }}
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+          check-latest: true
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.3.1
+
+      - name: Run chart-testing (list-changed)
+        id: list-changed
+        run: |
+          changed=$(ct list-changed --target-branch ${{ github.event.repository.default_branch }})
+          if [[ -n "$changed" ]]; then
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Run chart-testing (lint)
+        run: ct lint --validate-maintainers=false --target-branch ${{ github.event.repository.default_branch }}
+
+      - name: Run chart-testing (install)
+        run: ct install --charts charts/industry-core-hub --target-branch ${{ github.event.repository.default_branch }} --helm-extra-set-args "--set backend.image.repository=kind-registry:5000/ichub-backend --set backend.image.tag=testing --set frontend.image.repository=kind-registry:5000/ichub-frontend --set frontend.image.tag=testing"
+        if: github.event_name != 'pull_request' || steps.list-changed.outputs.changed == 'true'
+
+        # Upgrade the released chart version with the locally available chart
+        # default value for event_name != workflow_dispatch
+        # industry-core-hub: we don't have yet a released chart
+      #- name: Run helm upgrade
+      #  run: |
+      #    helm repo add bitnami https://charts.bitnami.com/bitnami
+      #    helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev
+      #    helm install [NAME] tractusx-dev/[CHART] --version ${{ github.event.inputs.upgrade_from || 'x.x.x' }}
+      #    helm dependency update charts/[CHART]
+      #    helm upgrade [NAME] charts/[CHART]
+      #  if: github.event_name != 'pull_request' || steps.list-changed.outputs.changed == 'true'

charts/industry-core-hub/templates/_helpers.tpl

@@ -203,15 +203,6 @@ Get the database secret key
 {{- end -}}
 {{- end -}}
 
-{{/*
-Return true if a secret object should be created for external database
-*/}}
-{{- define "industry-core-hub.externalDatabase.createSecret" -}}
-{{- if and (not .Values.postgresql.enabled) (not .Values.externalDatabase.existingSecret) }}
-    {{- true -}}
-{{- end -}}
-{{- end -}}
-
 {{/*
 Return the postgresql URL
 */}}

charts/industry-core-hub/templates/deployment-backend.yaml

@@ -20,7 +20,7 @@
 */}}
 {{ if .Values.backend.enabled }}
 apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: {{ include "industry-core-hub.fullname.backend" . }}
   labels:
@@ -59,7 +59,7 @@
           imagePullPolicy: {{ .Values.backend.image.pullPolicy }}
           ports:
             - name: http
-              containerPort: {{ .Values.backend.service.port }}
+              containerPort: {{ .Values.backend.service.portContainer }}
               protocol: TCP
           env:
             - name: DATABASE__HOST
@@ -73,13 +73,13 @@
             - name: DATABASE_PASSWORD
               valueFrom:
                 secretKeyRef:
                   name: {{ include "industry-core-hub.postgresql.secretName" . }}
                   key: {{ include "industry-core-hub.postgresql.ichub.secretKey" . }}
           {{- if .Values.backend.healthChecks.startup.enabled }}
           startupProbe:
             httpGet:
               path: {{ .Values.backend.healthChecks.startup.path }}
-              port: {{ .Values.backend.service.port }}
+              port: {{ .Values.backend.service.portContainer }}
               scheme: HTTP
             initialDelaySeconds: {{ .Values.startupProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.startupProbe.periodSeconds }}
@@ -91,7 +91,7 @@
           livenessProbe:
             httpGet:
               path: {{ .Values.backend.healthChecks.liveness.path }}
-              port: {{ .Values.backend.service.port }}
+              port: {{ .Values.backend.service.portContainer }}
               scheme: HTTP
             initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.livenessProbe.periodSeconds }}
@@ -103,7 +103,7 @@
           readinessProbe:
             httpGet:
               path: {{ .Values.backend.healthChecks.readiness.path }}
-              port: {{ .Values.backend.service.port }}
+              port: {{ .Values.backend.service.portContainer }}
               scheme: HTTP
             initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.readinessProbe.periodSeconds }}

charts/industry-core-hub/templates/deployment-frontend.yaml

@@ -23,7 +23,7 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: {{ include "industry-core-hub.fullname.frontend" . }}
   labels:
     {{- include "industry-core-hub.labels" . | nindent 4 }}
 spec:
@@ -57,10 +57,10 @@
           securityContext:
             {{- toYaml .Values.frontend.securityContext | nindent 12 }}
           image: "{{ .Values.frontend.image.repository }}:{{ .Values.frontend.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.frontend.image.pullPolicy }}
           ports:
             - name: http
-              containerPort: {{ .Values.frontend.service.port }}
+              containerPort: {{ .Values.frontend.service.portContainer }}
               protocol: TCP
           env:
             - name: ICHUB_BACKEND_URL
@@ -69,7 +69,7 @@
           startupProbe:
             httpGet:
               path: {{ .Values.frontend.healthChecks.startup.path }}
-              port: {{ .Values.frontend.service.port }}
+              port: {{ .Values.frontend.service.portContainer }}
               scheme: HTTP
             initialDelaySeconds: {{ .Values.startupProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.startupProbe.periodSeconds }}
@@ -81,7 +81,7 @@
           livenessProbe:
             httpGet:
               path: {{ .Values.frontend.healthChecks.liveness.path }}
-              port: {{ .Values.frontend.service.port }}
+              port: {{ .Values.frontend.service.portContainer }}
               scheme: HTTP
             initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.livenessProbe.periodSeconds }}
@@ -93,7 +93,7 @@
           readinessProbe:
             httpGet:
               path: {{ .Values.frontend.healthChecks.readiness.path }}
-              port: {{ .Values.frontend.service.port }}
+              port: {{ .Values.frontend.service.portContainer }}
               scheme: HTTP
             initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.readinessProbe.periodSeconds }}

charts/industry-core-hub/templates/secret-backend-external-db.yaml

@@ -19,7 +19,7 @@
 * SPDX-License-Identifier: Apache-2.0
 */}}
 
-{{- if and .Values.backend.enabled (not .Values.postgresql.enabled) (include "industry-core-hub.industry-core-hub.externalDatabase.createSecret" .) -}}
+{{- if not .Values.postgresql.enabled -}}
 apiVersion: v1
 kind: Secret
 metadata:

charts/industry-core-hub/templates/secret-backend-postgres.yaml

@@ -19,7 +19,7 @@
 * SPDX-License-Identifier: Apache-2.0
 */}}
 
-{{- if and .Values.backend.enabled .Values.postgresql.enabled -}}
+{{- if .Values.postgresql.enabled -}}
 apiVersion: v1
 kind: Secret
 metadata:

charts/industry-core-hub/templates/service-backend.yaml

@@ -22,14 +22,14 @@
 {{ if .Values.backend.enabled }}
 apiVersion: v1
 kind: Service
 metadata:
   name: {{ include "industry-core-hub.fullname.backend" . }}
   labels: {{ include "industry-core-hub.labels" . | nindent 4 }}
 spec:
   type: {{ .Values.backend.service.type }}
   ports:
-    - port: {{ .Values.backend.service.port }}
-      targetPort: {{ .Values.backend.service.targetPort }}
+    - port: {{ .Values.backend.service.portService }}
+      targetPort: {{ .Values.backend.service.portContainer }}
       protocol: TCP
       name: http
   selector: {{ include "industry-core-hub.frontend.selectorLabels" . | nindent 4 }}

charts/industry-core-hub/templates/service-frontend.yaml

@@ -22,14 +22,14 @@
 {{ if .Values.frontend.enabled }}
 apiVersion: v1
 kind: Service
 metadata:
   name: {{ include "industry-core-hub.fullname.frontend" . }}
   labels: {{ include "industry-core-hub.labels" . | nindent 4 }}
 spec:
   type: {{ .Values.frontend.service.type }}
   ports:
-    - port: {{ .Values.frontend.service.port }}
-      targetPort: {{ .Values.frontend.service.targetPort }}
+    - port: {{ .Values.frontend.service.portService }}
+      targetPort: {{ .Values.frontend.service.portContainer }}
       protocol: TCP
       name: http
   selector: {{ include "industry-core-hub.frontend.selectorLabels" . | nindent 4 }}

charts/industry-core-hub/values.yaml

@@ -29,7 +29,7 @@ replicaCount: 1
 
 # -- Backend configuration
 backend:
-  enabled: false
+  enabled: true
   name: "industry-core-hub-backend"
   image:
     repository: "ichub-backend"
@@ -42,8 +42,8 @@ backend:
   service:
     # -- [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service
     type: ClusterIP
-    port: 80
-    targetPort: 8000
+    portService: 8000
+    portContainer: 8000
 
   podAnnotations: {}
 
@@ -175,8 +175,8 @@ frontend:
   service:
     # -- [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service
     type: ClusterIP
-    port: 80
-    targetPort: 8000
+    portService: 8080
+    portContainer: 8080
 
   podAnnotations: {}
 

ichub-frontend/Dockerfile

@@ -63,12 +63,12 @@ RUN chmod +x /docker-entrypoint.d/00-inject-dynamic-env.sh \
 # Change to nginx user
 USER 101
 
-# Expose port 80
-EXPOSE 80
+# Expose port 8080
+EXPOSE 8080
 
 # Healthcheck to verify Nginx is running
 HEALTHCHECK --interval=30s --timeout=10s --start-period=10s --retries=3 \
-  CMD wget --spider -q http://localhost || exit 1
+  CMD wget --spider -q http://localhost:8080 || exit 1
 
 # Start Nginx
 CMD ["nginx", "-g", "daemon off;"]

ichub-frontend/nginx.conf

@@ -21,9 +21,9 @@
 #################################################################################
 
 server {
-    listen 80;
-    server_name localhost;
-
+    listen 8080;
+    server_name _;
+    
     location / {
         root /usr/share/nginx/html;
         index index.html;