Merge pull request #20 from catenax-ng/main

Release changes for QG4

Author: mkanal

.github/workflows/chart-release.yml

@@ -32,7 +32,7 @@ jobs:
 
       - name: Update helm dependencies for trace-x
         run: |
-          cd charts/tx-traceability-foss-frontend
+          cd charts/traceability-foss-frontend
           helm repo add bitnami https://charts.bitnami.com/bitnami
           helm dependency update
       - name: Run chart-releaser

DEPENDENCIES

@@ -1,3 +1,4 @@
+# Nonroot user is not needed beause we are using the "nginx-unprivileged" image
 # STAGE 1: Build
 FROM node:18-alpine as builder
 
@@ -20,6 +21,7 @@ HEALTHCHECK --interval=30s --timeout=10s --retries=3 --start-period=10s \
     CMD curl -fSs 127.0.0.1:8080/healthz || exit 1
 
 USER root
+
 RUN rm /usr/share/nginx/html/index.html && rm /etc/nginx/conf.d/default.conf
 
 # Copy project files from ‘builder’ stage copy over the artifacts in dist folder to default nginx public folder
@@ -43,3 +45,4 @@ COPY ./scripts/inject-dynamic-env.js /docker-entrypoint.d/
 
 # Validate NGINX configuration
 RUN nginx -t
+USER 101

Dockerfile

@@ -1,13 +1,5 @@
-## How to build the application
-
-The angular app is built into Docker containers and exposed through NGINX
-
-It is important to specify the type of configuration profile, previously defined in the angular JSON file, so it can
-build the application correctly.
-
-## How to run the docker image
+# Environment variables
 
-When running the build docker image you are able to pass through multiple environment variables to configure the FE.
 Support environment variables are:
 
 ```javascript
@@ -39,6 +31,82 @@ This variable points to the desired api
 `CATENAX_PORTAL_BASE_URL`
 This variable is used to set the base path of the application. (Should be set if application runs as a subtopic)
 
+# Helm deployment
+
+## Configuration of values.yaml
+
+To run a helm chart you first need to specify a values file with instructions on how to run your helm file.
+Here is an example how you could structure this file for this frontend helm chart.
+
+`your-values.yaml`
+
+```yaml
+image:
+  tag: $APP_REVISION
+  ENVIRONMENT_VAR_1: 'VALUE'
+  ENVIRONMENT_VAR_2: 'VALUE'
+  ...
+
+ingress:
+  enabled: true
+  className: "nginx"
+  annotations:
+    cert-manager.io/cluster-issuer: letsencrypt-prod
+  hosts:
+    - host: "${FE_HOST_URL}"
+      paths:
+        - path: /
+          pathType: Prefix
+  tls:
+    - hosts:
+        - "${FE_HOST_URL}"
+      secretName: "${FE_HOST_URL}-tls"
+
+```
+
+## Helm installation
+
+Add the Trace-X frontend Helm repository:
+
+```sh
+$ helm repo add traceability-foss-frontend https://catenax-ng.github.io/tx-traceability-foss-frontend
+```
+
+Then install the Helm chart into your cluster:
+
+```sh
+$ helm install -f your-values.yaml traceability-foss-frontend traceability-foss-frontend/traceability-foss-frontend
+```
+
+### Deployment using ArgoCD
+
+Create a new Helm chart and use Trace-X as a dependency.
+
+```yaml
+dependencies:
+  - name: traceability-foss-frontend
+    alias: frontend
+    version: x.x.x
+    repository: 'https://catenax-ng.github.io/tx-traceability-foss-frontend/'
+```
+
+Then provide your configuration as the values.yaml of that chart.
+
+Create a new application in ArgoCD and point it to your repository / Helm chart folder.
+
+# Docker deployment
+
+## How to build the application
+
+The angular app is built into Docker containers and exposed through NGINX
+
+It is important to specify the type of configuration profile, previously defined in the angular JSON file, so it can
+build the application correctly.
+
+## How to run the docker image
+
+When running the build docker image you are able to pass through multiple environment variables to configure the FE.
+
 ### Example command:
 
 ```shell

INSTALL.md

@@ -25,6 +25,7 @@ Secondly, Angular `scales` perfectly in the long run. Because of the restricted
 With that in mind it made sense it chose Angular for an `open source` project.
 
 Source files are exposed statically through the NGINX web server.
+TRACE-FOSS product composes of the backend and frontend repositories, backend repository can be found under [GitHub repository](https://github.com/catenax-ng/tx-traceability-foss-backend).
 
 ### Challenges and solutions
 

README.md

@@ -1,5 +1,5 @@
 apiVersion: v2
-name: tx-traceability-foss-frontend
+name: traceability-foss-frontend
 description: A Helm chart for Traceability frontend application
 
 # A chart can be either an 'application' or a 'library' chart.

charts/tx-traceability-foss-frontend/.helmignore renamed to charts/traceability-foss-frontend/.helmignore

@@ -1,15 +1,15 @@
 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 {{ include "tx-traceability-foss-frontend.fullname" . }})
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "traceability-foss-frontend.fullname" . }})
   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 "LoadBalancer" .Values.service.type }}
      NOTE: It may take a few minutes for the LoadBalancer IP to be available.
-           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "tx-traceability-foss-frontend.fullname" . }}'
-  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "tx-traceability-foss-frontend.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "traceability-foss-frontend.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "traceability-foss-frontend.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
   echo http://$SERVICE_IP:{{ .Values.service.port }}
 {{- else if contains "ClusterIP" .Values.service.type }}
-  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "tx-traceability-foss-frontend.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "traceability-foss-frontend.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
   export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
   echo "Visit http://127.0.0.1:8080 to use your application"
   kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT

charts/tx-traceability-foss-frontend/Chart.yaml renamed to charts/traceability-foss-frontend/Chart.yaml

@@ -1,7 +1,7 @@
 {{/*
 Expand the name of the chart.
 */}}
-{{- define "tx-traceability-foss-frontend.name" -}}
+{{- define "traceability-foss-frontend.name" -}}
 {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
@@ -10,7 +10,7 @@ Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
 If release name contains chart name it will be used as a full name.
 */}}
-{{- define "tx-traceability-foss-frontend.fullname" -}}
+{{- define "traceability-foss-frontend.fullname" -}}
 {{- if .Values.fullnameOverride }}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
 {{- else }}
@@ -26,16 +26,16 @@ If release name contains chart name it will be used as a full name.
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "tx-traceability-foss-frontend.chart" -}}
+{{- define "traceability-foss-frontend.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
 {{/*
 Common labels
 */}}
-{{- define "tx-traceability-foss-frontend.labels" -}}
-helm.sh/chart: {{ include "tx-traceability-foss-frontend.chart" . }}
-{{ include "tx-traceability-foss-frontend.selectorLabels" . }}
+{{- define "traceability-foss-frontend.labels" -}}
+helm.sh/chart: {{ include "traceability-foss-frontend.chart" . }}
+{{ include "traceability-foss-frontend.selectorLabels" . }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
@@ -45,17 +45,17 @@ app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{/*
 Selector labels
 */}}
-{{- define "tx-traceability-foss-frontend.selectorLabels" -}}
-app.kubernetes.io/name: {{ include "tx-traceability-foss-frontend.name" . }}
+{{- define "traceability-foss-frontend.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "traceability-foss-frontend.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}
 
 {{/*
 Create the name of the service account to use
 */}}
-{{- define "tx-traceability-foss-frontend.serviceAccountName" -}}
+{{- define "traceability-foss-frontend.serviceAccountName" -}}
 {{- if .Values.serviceAccount.create }}
-{{- default (include "tx-traceability-foss-frontend.fullname" .) .Values.serviceAccount.name }}
+{{- default (include "traceability-foss-frontend.fullname" .) .Values.serviceAccount.name }}
 {{- else }}
 {{- default "default" .Values.serviceAccount.name }}
 {{- end }}

charts/tx-traceability-foss-frontend/templates/NOTES.txt renamed to charts/traceability-foss-frontend/templates/NOTES.txt

@@ -2,16 +2,16 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   namespace: {{ .Values.namespace | default .Release.Namespace }}
-  name: {{ include "tx-traceability-foss-frontend.fullname" . }}
+  name: {{ include "traceability-foss-frontend.fullname" . }}
   labels:
-    {{- include "tx-traceability-foss-frontend.labels" . | nindent 4 }}
+    {{- include "traceability-foss-frontend.labels" . | nindent 4 }}
 spec:
   {{- if not .Values.autoscaling.enabled }}
   replicas: {{ .Values.replicaCount }}
   {{- end }}
   selector:
     matchLabels:
-      {{- include "tx-traceability-foss-frontend.selectorLabels" . | nindent 6 }}
+      {{- include "traceability-foss-frontend.selectorLabels" . | nindent 6 }}
   revisionHistoryLimit: 2
   template:
     metadata:
@@ -21,19 +21,19 @@ spec:
         {{- toYaml . | nindent 8 }}
       {{- end }}
       labels:
-        {{- include "tx-traceability-foss-frontend.selectorLabels" . | nindent 8 }}
+        {{- include "traceability-foss-frontend.selectorLabels" . | nindent 8 }}
     spec:
       automountServiceAccountToken: false
       {{- if .Values.imagePullSecret.dockerconfigjson }}
       imagePullSecrets:
-        - name: {{ include "tx-traceability-foss-frontend.fullname" . }}-imagepullsecret
+        - name: {{ include "traceability-foss-frontend.fullname" . }}-imagepullsecret
       {{- else }}
       {{- with .Values.imagePullSecrets }}
       imagePullSecrets:
         {{- toYaml . | nindent 8 }}
       {{- end }}
       {{- end }}
-      serviceAccountName: {{ include "tx-traceability-foss-frontend.serviceAccountName" . }}
+      serviceAccountName: {{ include "traceability-foss-frontend.serviceAccountName" . }}
       securityContext:
         {{- toYaml .Values.podSecurityContext | nindent 8 }}
       containers:
@@ -76,4 +76,4 @@ spec:
       {{- with .Values.tolerations }}
       tolerations:
         {{- toYaml . | nindent 8 }}
-      {{- end }}
+      {{- end }}