Merge pull request #40 from innovatrics/SMAR-3012-add-extraction-conf…

…iguration

SMAR-3012 add configuration for extraction algorithm and faceCompatib…

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [v0.8.8]
+
+### Changed
+
+- Added extractionAlgorithm and compatibilityVersion for face templates
+
 ## [v0.8.7]
 
 ### Changed

Chart.yaml

@@ -36,6 +36,6 @@ maintainers:
 - name: Innovatrics
   url: https://www.innovatrics.com/
 
-version: 0.8.7
+version: 0.8.8
 
 appVersion: "v5_4.28.2"

README.md

@@ -1,6 +1,6 @@
 # smartface
 
-![Version: 0.8.7](https://img.shields.io/badge/Version-0.8.7-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v5_4.28.2](https://img.shields.io/badge/AppVersion-v5_4.28.2-informational?style=flat-square)
+![Version: 0.8.8](https://img.shields.io/badge/Version-0.8.8-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v5_4.28.2](https://img.shields.io/badge/AppVersion-v5_4.28.2-informational?style=flat-square)
 
 SmartFace is a Scalable Facial Recognition Server Platform Able to Process Multiple Real-Time Video Streams. Currently the helm chart supports edge stream and Lightweight Face Identification System (LFIS) deployments
 
@@ -332,6 +332,8 @@ metadata:
 | configurations.apiAuth.oauthTokenUrl | string | `""` | used only for enabling OAuth flows in swagger UI |
 | configurations.database.connectionStringKey | string | `"cs"` | key within the existing secret which contains the connection string, see https://learn.microsoft.com/en-us/dotnet/framework/data/adonet/connection-strings |
 | configurations.database.existingSecretName | string | `"db-cs"` | connection string needs to be provided as a dependency of the chart |
+| configurations.faceTemplate.compatibilityVersion | string | `nil` |  |
+| configurations.faceTemplate.extractionAlgorithm | string | `nil` |  |
 | configurations.license.mountPath | string | `"/etc/innovatrics"` |  |
 | configurations.license.secretName | string | `"iface-lic"` |  |
 | configurations.license.volumeMountName | string | `"license"` |  |

templates/_matcher.tpl

@@ -63,6 +63,10 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
+        {{- if .Values.configurations.faceTemplate.compatibilityVersion  }}
+        - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
+          value: {{ .Values.configurations.faceTemplate.compatibilityVersion | quote }}
+        {{- end }}
         {{- with .Values.matcher.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

templates/edge-streams/base-deployment.yaml

@@ -61,6 +61,10 @@ spec:
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
         {{- include "smartface.s3Config" . | nindent 8 }}
+        {{- if .Values.configurations.faceTemplate.compatibilityVersion  }}
+        - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
+          value: {{ .Values.configurations.faceTemplate.compatibilityVersion | quote }}
+        {{- end }}
         {{- with .Values.base.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

templates/edge-streams/edge-stream-processor-deployment.yaml

@@ -59,6 +59,10 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
+        {{- if .Values.configurations.faceTemplate.compatibilityVersion  }}
+        - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
+          value: {{ .Values.configurations.faceTemplate.compatibilityVersion | quote }}
+        {{- end }}
         {{- with .Values.edgeStreamProcessor.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

templates/edge-streams/face-matcher-deployment.yaml

@@ -59,6 +59,10 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
+        {{- if .Values.configurations.faceTemplate.compatibilityVersion  }}
+        - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
+          value: {{ .Values.configurations.faceTemplate.compatibilityVersion | quote }}
+        {{- end }}
         {{- with .Values.faceMatcher.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

templates/extractor-deployment.yaml

@@ -59,6 +59,10 @@ spec:
         env:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
+        {{- if .Values.configurations.faceTemplate.extractionAlgorithm  }}
+        - name: Extraction__Algorithm
+          value: {{ .Values.configurations.faceTemplate.extractionAlgorithm | quote }}
+        {{- end }}
         {{- with .Values.extractor.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

values.yaml

@@ -72,6 +72,14 @@ configurations:
     #   displayName: "Employee Number"
     # - label: "registrationPlate"
     #   displayName: "Registration Plate"
+  # If the compatibilityVersion or extractionAlgorithm value is null, the default value is used.
+  # It is specifically intended for use during the process of migrating templates
+  # Use this setting with caution, because it can break functionality
+  faceTemplate:
+    # Example of possible values: 1.40, 1.39
+    compatibilityVersion: null
+    # Example of possible values: balanced, accurate_mask
+    extractionAlgorithm: null
 
 features:
   multitenancy: