SMAR-3012 add configuration for extraction algorithm and faceCompatib…

…ilityTemplateVersion
innovatrics · Dec 11, 2024 · f2c7c3e · f2c7c3e
1 parent 36911cd
commit f2c7c3e
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [v0.8.8]
+
+### Changed
+
+- Added extractionAlgorithm property for Extractor
+- Added faceTemplateCompatibilityVersion property to validate templates versions
+
 ## [v0.8.7]
 
 ### Changed

diff --git a/Chart.yaml b/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"
diff --git a/README.md b/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,7 @@ 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.faceTemplateCompatibilityVersion | string | `nil` |  |
 | configurations.license.mountPath | string | `"/etc/innovatrics"` |  |
 | configurations.license.secretName | string | `"iface-lic"` |  |
 | configurations.license.volumeMountName | string | `"license"` |  |
@@ -437,6 +438,7 @@ metadata:
 | edgeStreamsStateSync.tolerations | list | `[]` |  |
 | experimentalFeatures.qr.enabled | bool | `false` | enable qr modality |
 | extractor.annotations | object | `{}` | Annotations for extractor deployment |
+| extractor.extractionAlgorithm | string | `nil` |  |
 | extractor.image.digest | string | `nil` | Overrides the image tag with an image digest |
 | extractor.image.pullPolicy | string | `"IfNotPresent"` | Docker image pull policy |
 | extractor.image.registry | string | `nil` | The Docker registry, overrides `global.image.registry` |

diff --git a/templates/_matcher.tpl b/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.faceTemplateCompatibilityVersion  }}
+        - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
+          value: {{ .Values.configurations.faceTemplateCompatibilityVersion | quote }}
+        {{- end }}
         {{- with .Values.matcher.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

diff --git a/templates/edge-streams/base-deployment.yaml b/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.faceTemplateCompatibilityVersion  }}
+        - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
+          value: {{ .Values.configurations.faceTemplateCompatibilityVersion | quote }}
+        {{- end }}
         {{- with .Values.base.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

diff --git a/templates/edge-streams/edge-stream-processor-deployment.yaml b/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.faceTemplateCompatibilityVersion  }}
+        - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
+          value: {{ .Values.configurations.faceTemplateCompatibilityVersion | quote }}
+        {{- end }}
         {{- with .Values.edgeStreamProcessor.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

diff --git a/templates/edge-streams/face-matcher-deployment.yaml b/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.faceTemplateCompatibilityVersion  }}
+        - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
+          value: {{ .Values.configurations.faceTemplateCompatibilityVersion | quote }}
+        {{- end }}
         {{- with .Values.faceMatcher.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

diff --git a/templates/extractor-deployment.yaml b/templates/extractor-deployment.yaml
@@ -59,6 +59,10 @@ spec:
         env:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
+        {{- if .Values.extractor.extractionAlgorithm  }}
+        - name: Extraction__Algorithm
+          value: {{ .Values.extractor.extractionAlgorithm | quote }}
+        {{- end }}
         {{- with .Values.extractor.extraVars }}
         {{- toYaml . | nindent 8 }}
         {{- end }}

diff --git a/values.yaml b/values.yaml
@@ -72,6 +72,11 @@ configurations:
     #   displayName: "Employee Number"
     # - label: "registrationPlate"
     #   displayName: "Registration Plate"
+  # If the faceTemplateCompatibilityVersion value is null, the default value is used.
+  # Example of possible values: 1.40, 1.39
+  # It is specifically intended for use during the process of migrating templates
+  # Use this setting with caution, becouse it can break functionality
+  faceTemplateCompatibilityVersion: null
 
 features:
   multitenancy:
@@ -498,6 +503,11 @@ extractor:
     digest: null
     # -- Docker image pull policy
     pullPolicy: IfNotPresent
+  # If the extractionAlgorithm value is null, the default algorithm is used.
+  # Possible values for this property are "accurate_mask" and "balanced".
+  # It is specifically intended for use during the process of migrating templates
+  # Use this setting with caution, becouse it can break functionality
+  extractionAlgorithm: null
   # --  Additional environment variables for the extractor component
   # extraVars:
   #  - name: EXTRA_VAR1