feat(lubelogger)!: added persistence

Brewfile

@@ -1,4 +1,2 @@
+brew "go"
 brew "helm"
-tap "norwoodj/tap"
-brew "norwoodj/tap/helm-docs"
-brew "kube-linter"

anza-labs/lubelogger/Chart.yaml

@@ -2,8 +2,9 @@ apiVersion: v2
 name: lubelogger
 description: LubeLogger is a web-based vehicle maintenance and fuel mileage tracker
 type: application
-version: 0.2.3
+version: 0.3.0
 appVersion: "v1.3.6"
 maintainers:
   - name: Mateusz Urbanek
     email: [email protected]
+    url: http://linkedin.com/in/urbanekmateusz

anza-labs/lubelogger/README.md

@@ -1,14 +1,14 @@
 # lubelogger
 
-![Version: 0.2.3](https://img.shields.io/badge/Version-0.2.3-informational?style=flat) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat) ![AppVersion: v1.3.6](https://img.shields.io/badge/AppVersion-v1.3.6-informational?style=flat)
+![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat) ![AppVersion: v1.3.6](https://img.shields.io/badge/AppVersion-v1.3.6-informational?style=flat)
 
 LubeLogger is a web-based vehicle maintenance and fuel mileage tracker
 
 ## Maintainers
 
 | Name | Email | Url |
 | ---- | ------ | --- |
-| Mateusz Urbanek | <[email protected]> |  |
+| Mateusz Urbanek | <[email protected]> | <http://linkedin.com/in/urbanekmateusz> |
 
 ## Values
 
@@ -19,22 +19,67 @@ LubeLogger is a web-based vehicle maintenance and fuel mileage tracker
 | autoscaling.maxReplicas | int | `3` | Maximum number of replicas for autoscaling. |
 | autoscaling.minReplicas | int | `1` | Minimum number of replicas for autoscaling. |
 | autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage for autoscaling. |
+| autoscaling.targetMemoryUtilizationPercentage | int | `80` | Target memory utilization percentage for autoscaling. |
 | config.LANG | string | `"en_US.UTF-8"` | Locale and Language Settings, this will affect how numbers, currencies, and dates are  formatted. |
 | config.LC_ALL | string | `"en_US.UTF-8"` | Same as above. Note that some languages don't have UTF-8 encodings. |
 | config.LOGLEVEL | string | `"Information"` | Specifies the level of logs. Valid levels are `Trace`, `Debug`, `Information`,  `Warning`, `Error`, `Critical` and `None`. Learn more at: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/ |
+| config.translations | list | `["https://raw.githubusercontent.com/hargata/lubelog_translations/main/Europe/pl_PL.json"]` | Translations defines a list of URLs from which translation files will be fetched. These URLs point to JSON files containing translations for different languages or regions. The files will be downloaded by the init container and stored in the appropriate directory. |
+| config.userConfig.AllowedHosts | string | `"*"` | Specifies allowed hosts for the application (use "*" to allow all hosts). |
+| config.userConfig.DefaultTab | int | `8` | Sets the default tab to be shown when the application starts. |
+| config.userConfig.EnableAuth | bool | `true` | Enables or disables authentication for the application. |
+| config.userConfig.EnableAutoOdometerInsert | bool | `false` | Automatically inserts odometer readings based on previous data. |
+| config.userConfig.EnableAutoReminderRefresh | bool | `false` | Automatically refreshes reminders without manual intervention. |
+| config.userConfig.EnableCsvImports | bool | `true` | Enables the ability to import data from CSV files. |
+| config.userConfig.EnableExtraFieldColumns | bool | `false` | Enables additional columns for extra field entries. |
+| config.userConfig.EnableShopSupplies | bool | `false` | Enables tracking of shop supplies in transactions. |
+| config.userConfig.HideSoldVehicles | bool | `false` | Hides vehicles marked as sold from the display. |
+| config.userConfig.HideZero | bool | `false` | Determines whether zero values should be hidden in the UI. |
+| config.userConfig.Logging.LogLevel."Microsoft.AspNetCore" | string | `"Warning"` | Sets the log level for Microsoft.AspNetCore-related components. Valid levels are `Trace`, `Debug`, `Information`, `Warning`, `Error`, `Critical` and `None`. Learn more at: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/ |
+| config.userConfig.Logging.LogLevel.Default | string | `"Information"` | Specifies the default log level for all components. Valid levels are `Trace`, `Debug`, `Information`, `Warning`, `Error`, `Critical` and `None`. Learn more at: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/ |
+| config.userConfig.PreferredGasMileageUnit | string | `""` | Specifies the preferred unit for gas mileage. |
+| config.userConfig.PreferredGasUnit | string | `""` | Specifies the preferred unit for gas volume. |
+| config.userConfig.UseDarkMode | bool | `false` | Enables or disables dark mode in the user interface. |
+| config.userConfig.UseDescending | bool | `false` | Determines if lists are ordered in descending order by default. |
+| config.userConfig.UseMPG | bool | `true` | Configures whether to use miles per gallon (MPG) as the fuel economy unit. |
+| config.userConfig.UseMarkDownOnSavedNotes | bool | `false` | Allows saved notes to support markdown formatting. |
+| config.userConfig.UseThreeDecimalGasCost | bool | `true` | Enables displaying gas costs with three decimal places for accuracy. |
+| config.userConfig.UseUKMPG | bool | `false` | Uses UK miles per gallon (UK MPG) as the fuel economy unit. |
+| config.userConfig.UserColumnPreferences | list | `[]` | Stores user preferences for column visibility. |
+| config.userConfig.UserLanguage | string | `"en_US"` | Defines the user's language preference (e.g., "en_US"). |
+| config.userConfig.UserNameHash | string | `"8c6976e5b5410415bde908bd4dee15dfb167a9c873fc4bb8a81f6f2ab448a918"` | Stores a hashed version of the user's username. It is sha256, and can be created using one the following commands: `python3 -c 'import hashlib; print(hashlib.sha256("admin".encode("utf-8")).hexdigest())'` |
+| config.userConfig.UserPasswordHash | string | `"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"` | Stores a hashed version of the user's password. It is sha256, and can be created using one the following commands: `python3 -c 'import hashlib; print(hashlib.sha256("password".encode("utf-8")).hexdigest())'` |
+| config.userConfig.VisibleTabs | list | `[0,1,4,2,3,6,5,8]` | Specifies which tabs are visible in the user interface. |
+| curl.pullPolicy | string | `"IfNotPresent"` | Image pull policy. |
+| curl.repository | string | `"docker.io/curlimages/curl"` | Registry and repository for the image. |
+| curl.tag | string | `"8.10.0"` | Tag for the image. |
 | fullnameOverride | string | `""` | Override for the full name. |
-| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy. |
-| image.repository | string | `"ghcr.io/hargata/lubelogger"` | Registry and repository for the image. |
-| image.tag | string | `"v1.3.6"` | Tag for the image. |
 | imagePullSecrets | list | `[]` | Secrets for pulling images. |
 | ingress.annotations | object | `{}` | Annotations to add to the ingress. |
 | ingress.className | string | `""` | Ingress class name. |
 | ingress.enabled | bool | `false` | Specifies whether ingress should be enabled. |
 | ingress.hosts | list | `[{"host":"lubelog.example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}]` | List of ingress hosts. |
 | ingress.tls | list | `[]` | List of TLS configurations for the ingress. |
 | livenessProbe.httpGet | object | `{"path":"/","port":"http"}` | Liveness probe configuration. |
+| lubelogger.pullPolicy | string | `"IfNotPresent"` | Image pull policy. |
+| lubelogger.repository | string | `"ghcr.io/hargata/lubelogger"` | Registry and repository for the lubelogger image. |
+| lubelogger.tag | string | `"v1.3.6"` | Tag for the image. |
 | nameOverride | string | `""` | Override for the name. |
 | nodeSelector | object | `{}` | Node selector for the pods. |
+| persistence.data.accessMode | string | `"ReadWriteOnce"` | Access mode for the PVC. |
+| persistence.data.enabled | bool | `false` | Enable/disable PVC creation for data. |
+| persistence.data.existingClaim | string | `""` | Use an existing PVC if defined, otherwise create one. |
+| persistence.data.size | string | `"10Gi"` | Storage size for the PVC. |
+| persistence.data.storageClass | string | `""` | Specify the StorageClass (if required). |
+| persistence.documents.accessMode | string | `"ReadWriteOnce"` | Access mode for the PVC. |
+| persistence.documents.enabled | bool | `true` | Enable/disable PVC creation for documents. |
+| persistence.documents.existingClaim | string | `""` | Use an existing PVC if defined, otherwise create one. |
+| persistence.documents.size | string | `"10Gi"` | Storage size for the PVC. |
+| persistence.documents.storageClass | string | `""` | Specify the StorageClass (if required). |
+| persistence.images.accessMode | string | `"ReadWriteOnce"` | Access mode for the PVC. |
+| persistence.images.enabled | bool | `true` | Enable/disable PVC creation for images. |
+| persistence.images.existingClaim | string | `""` | Use an existing PVC if defined, otherwise create one. |
+| persistence.images.size | string | `"10Gi"` | Storage size for the PVC. |
+| persistence.images.storageClass | string | `""` | Specify the StorageClass (if required). |
 | podAnnotations | object | `{}` | Annotations to be added to the pods. |
 | podLabels | object | `{}` | Labels to be added to the pods. |
 | podSecurityContext | object | `{}` |  |

anza-labs/lubelogger/templates/NOTES.txt

@@ -1,4 +1,4 @@
-1. Get the application URL by running these commands:
+Get the application URL by running these commands:
 {{- if .Values.ingress.enabled }}
 {{- range $host := .Values.ingress.hosts }}
   {{- range .paths }}
@@ -10,3 +10,11 @@
   echo "Visit http://127.0.0.1:8080 to use your application"
   kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:8080
 {{- end }}
+
+{{- $maxReplicas := int 1 }}
+{{- if (gt (int .Values.replicaCount) ($maxReplicas) ) }}
+WARNING!
+
+Your set the replica count to >1. Application does not sync Data, Documents and Images between replicas, so you will see 
+inconsistency and you will might observe data loss.
+{{- end }}

anza-labs/lubelogger/templates/_helpers.tpl

@@ -62,7 +62,7 @@ Create the name of the service account to use
 Create secret name used for configuring mail.
 */}}
 {{- define "lubelog.mailSecret" -}}
-    {{- default (include "lubelog.fullname" .) .Values.secret.name }}
+    {{- default (printf "%s-mail" (include "lubelog.fullname" .)) .Values.secret.name }}
 {{- end }}
 
 {{/*
@@ -78,3 +78,24 @@ Create key under which PostgreSQL connection string can be found.
 {{- define "lubelog.postgresSecretKey" -}}
     {{- default "POSTGRES_CONNECTION" .Values.postgres.keyRef }}
 {{- end }}
+
+{{/*
+Create pvc name used for configuring the data persistence in app.
+*/}}
+{{- define "lubelog.pvcData" -}}
+    {{- default ( printf "%s-data" (include "lubelog.fullname" .)) .Values.persistence.data.existingClaim }}
+{{- end }}
+
+{{/*
+Create pvc name used for configuring the documents persistence in app.
+*/}}
+{{- define "lubelog.pvcDocuments" -}}
+    {{- default ( printf "%s-documents" (include "lubelog.fullname" .)) .Values.persistence.documents.existingClaim }}
+{{- end }}
+
+{{/*
+Create pvc name used for configuring the images persistence in app.
+*/}}
+{{- define "lubelog.pvcImages" -}}
+    {{- default ( printf "%s-images" (include "lubelog.fullname" .)) .Values.persistence.images.existingClaim }}
+{{- end }}

anza-labs/lubelogger/templates/deployment.yaml

@@ -31,13 +31,61 @@ spec:
       serviceAccountName: {{ include "lubelog.serviceAccountName" . }}
       securityContext:
         {{- toYaml .Values.podSecurityContext | nindent 8 }}
-      volumes: []
+      volumes:
+        - name: config-ro
+          secret:
+            secretName: {{ include "lubelog.fullname" . }}
+            items:
+              - key: userConfig
+                path: userConfig.json
+        - name: translations
+          emptyDir: {}
+        - name: config
+          emptyDir: {}
+      {{- if .Values.persistence.data.enabled }}
+        - name: data
+          persistentVolumeClaim:
+            claimName: {{ include "lubelog.pvcData" . }}
+      {{- end }}
+      {{- if .Values.persistence.documents.enabled }}
+        - name: documents
+          persistentVolumeClaim:
+            claimName: {{ include "lubelog.pvcDocuments" . }}
+      {{- end }}
+      {{- if .Values.persistence.images.enabled }}
+        - name: images
+          persistentVolumeClaim:
+            claimName: {{ include "lubelog.pvcImages" . }}
+      {{- end }}
+      {{- if .Values.config.translations }}
+      initContainers:
+        - name: init-translations
+          image: "{{ .Values.curl.repository }}:{{ .Values.curl.tag | default "latest" }}"
+          imagePullPolicy: {{ .Values.curl.pullPolicy }}
+          command: ["/bin/sh", "-c"]
+          args:
+            - |
+              mkdir -p /config
+              cp /config-ro/* /config
+              mkdir -p /translations
+              {{- range .Values.config.translations }}
+              echo "Fetching {{ . }}"
+              curl -o "/translations/$(basename {{ . }})" "{{ . }}"
+              {{- end }}
+          volumeMounts:
+            - name: config-ro
+              mountPath: /config-ro
+            - name: config
+              mountPath: /config
+            - name: translations
+              mountPath: /translations
+      {{- end }}
       containers:
         - name: {{ .Chart.Name }}
           securityContext:
             {{- toYaml .Values.securityContext | nindent 12 }}
-          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default "latest" }}"
-          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          image: "{{ .Values.lubelogger.repository }}:{{ .Values.lubelogger.tag | default "latest" }}"
+          imagePullPolicy: {{ .Values.lubelogger.pullPolicy }}
           ports:
             - name: http
               containerPort: 8080
@@ -48,7 +96,23 @@ spec:
             {{- toYaml .Values.readinessProbe | nindent 12 }}
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
-          volumeMounts: []
+          volumeMounts:
+            - name: config
+              mountPath: /App/config
+            - name: translations
+              mountPath: /App/wwwroot/translations
+          {{- if .Values.persistence.data.enabled }}
+            - name: data
+              mountPath: /App/data
+          {{- end }}
+          {{- if .Values.persistence.documents.enabled }}
+            - name: documents
+              mountPath: /App/wwwroot/documents
+          {{- end }}
+          {{- if .Values.persistence.images.enabled }}
+            - name: images
+              mountPath: /App/wwwroot/images
+          {{- end }}
           env:
             - name: "LC_ALL"
               value: {{ .Values.config.LC_ALL | default "en_US.UTF-8" | quote }}

anza-labs/lubelogger/templates/pvc.yaml

@@ -0,0 +1,72 @@
+{{- if and .Values.persistence.data.enabled (not .Values.persistence.data.existingClaim) }}
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ include "lubelog.pvcData" . }}
+  namespace: {{ .Release.Namespace }}
+  labels:
+    {{- include "lubelog.labels" . | nindent 4 }}
+    {{- with .Values.podLabels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+  annotations:
+    helm.sh/resource-policy: "keep"
+spec:
+  accessModes:
+    - {{ .Values.persistence.data.accessMode }}
+  resources:
+    requests:
+      storage: {{ .Values.persistence.data.size }}
+  {{- if .Values.persistence.data.storageClass }}
+  storageClassName: {{ .Values.persistence.data.storageClass }}
+  {{- end }}
+{{- end }}
+{{- if and .Values.persistence.images.enabled (not .Values.persistence.images.existingClaim) }}
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ include "lubelog.pvcImages" . }}
+  namespace: {{ .Release.Namespace }}
+  labels:
+    {{- include "lubelog.labels" . | nindent 4 }}
+    {{- with .Values.podLabels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+  annotations:
+    helm.sh/resource-policy: "keep"
+spec:
+  accessModes:
+    - {{ .Values.persistence.images.accessMode }}
+  resources:
+    requests:
+      storage: {{ .Values.persistence.images.size }}
+  {{- if .Values.persistence.images.storageClass }}
+  storageClassName: {{ .Values.persistence.images.storageClass }}
+  {{- end }}
+{{- end }}
+{{- if and .Values.persistence.documents.enabled (not .Values.persistence.documents.existingClaim) }}
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ include "lubelog.pvcDocuments" . }}
+  namespace: {{ .Release.Namespace }}
+  labels:
+    {{- include "lubelog.labels" . | nindent 4 }}
+    {{- with .Values.podLabels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+  annotations:
+    helm.sh/resource-policy: "keep"
+spec:
+  accessModes:
+    - {{ .Values.persistence.documents.accessMode }}
+  resources:
+    requests:
+      storage: {{ .Values.persistence.documents.size }}
+  {{- if .Values.persistence.documents.storageClass }}
+  storageClassName: {{ .Values.persistence.documents.storageClass }}
+  {{- end }}
+{{- end }}

anza-labs/lubelogger/templates/secret.yaml

@@ -4,6 +4,7 @@
   {{- $port := .Values.secret.port | required ".Values.secret.port is required." -}}
   {{- $username := .Values.secret.username | required ".Values.secret.username is required." -}}
   {{- $password := .Values.secret.password | required ".Values.secret.password is required." -}}
+---
 apiVersion: v1
 kind: Secret
 metadata:
@@ -22,3 +23,17 @@ stringData:
   MailConfig__Username: "{{ $username }}"
   MailConfig__Password: "{{ $password }}"
 {{- end }}
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "lubelog.fullname" . }}
+  namespace: {{ .Release.Namespace }}
+  labels:
+    {{- include "lubelog.labels" . | nindent 4 }}
+    {{- with .Values.podLabels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+type: Opaque
+stringData:
+  userConfig: {{ toJson .Values.config.userConfig | quote }}