Merge pull request #56 from kerberos-io/feature/add-faceredaction-variables

feature/add-faceredaction-variables

charts/hub/Chart.yaml

@@ -16,7 +16,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.88.0
+version: 0.91.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/hub/templates/kerberos-hub/hub-api.yaml

@@ -385,8 +385,8 @@ spec:
 
             # Open Telemetry tracing
             - name: OTEL_EXPORTED_OTLP_ENABLED
-              value: "{{ .Values.kerberoshub.api.otlp.enabled }}"
+              value: "{{ .Values.opentelemetry.enabled }}"
             - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
-              value: "{{ .Values.kerberoshub.api.otlp.routingEnabled }}"
+              value: "{{ .Values.opentelemetry.routingEnabled }}"
             - name: OTEL_EXPORTER_OTLP_ENDPOINT
-              value: "{{ .Values.kerberoshub.api.otlp.endpoint }}"
+              value: "{{ .Values.opentelemetry.collector.endpoint }}"

charts/hub/templates/kerberos-hub/hub-frontend.yaml

@@ -337,23 +337,52 @@ spec:
           value: "{{ .Values.kerberoshub.frontend.colorDeviceIdle }}"
         - name: COLOR_DEVICE_MOTION
           value: "{{ .Values.kerberoshub.frontend.colorDeviceMotion }}"
+        - name: COLOR_LIVE_VIEW_CONTROL_ACTIVE
+          value: "{{ .Values.kerberoshub.frontend.colorLiveViewControlActive }}"
+        - name: COLOR_LIVE_VIEW_CONTROL_MOTION
+          value: "{{ .Values.kerberoshub.frontend.colorLiveViewControlMotion }}"
         - name: COLOR_FLOOR_PLAN_LABEL_TEXT
           value: "{{ .Values.kerberoshub.frontend.colorFloorPlanLabelText }}"
         - name: COLOR_FLOOR_PLAN_LABEL_BACKGROUND
           value: "{{ .Values.kerberoshub.frontend.colorFloorPlanLabelBackground }}"
         - name: COLOR_DEVICE_MARKER_BORDER
           value: "{{ .Values.kerberoshub.frontend.colorDeviceMarkerBorder }}"
+
+
+        - name: FEATURE_FACE_REDACTION
+          value: "{{ .Values.kerberoshub.frontend.features.faceRedaction }}"      
+        - name: COLOR_TRACK_BOX
+          value: "{{ .Values.kerberoshub.frontend.colorTrackBox }}"
+        - name: COLOR_TRACK_BOX_HOVER
+          value: "{{ .Values.kerberoshub.frontend.colorTrackBoxHover }}"
+        - name: COLOR_TRACK_BOX_DRAWING
+          value: "{{ .Values.kerberoshub.frontend.colorTrackBoxDrawing }}"
+        - name: COLOR_TRACK_BOX_CONTROLS_DELETE
+          value: "{{ .Values.kerberoshub.frontend.colorTrackBoxControlsDelete }}"
+
+        - name: MARKERS_NAME
+          value: "{{ .Values.kerberoshub.frontend.markersName }}"
+        - name: EVENTS_NAME
+          value: "{{ .Values.kerberoshub.frontend.eventsName }}"
         - name: FLOOR_PLAN_NAME
           value: "{{ .Values.kerberoshub.frontend.floorPlanName }}"
         - name: SITES_NAME
           value: "{{ .Values.kerberoshub.frontend.sitesName }}"
+        - name: SITES_DESCRIPTION
+          value: "{{ .Values.kerberoshub.frontend.sitesDescription }}"
         - name: GROUPS_NAME
           value: "{{ .Values.kerberoshub.frontend.groupsName }}"
+        - name: GROUPS_DESCRIPTION
+          value: "{{ .Values.kerberoshub.frontend.groupsDescription }}"
         - name: SITE_GROUP_NAME
           value: "{{ .Values.kerberoshub.frontend.siteGroupName }}"
+        - name: SITE_GROUP_DESCRIPTION
+          value: "{{ .Values.kerberoshub.frontend.siteGroupDescription }}"
         - name: DEVICE_GROUP_NAME
           value: "{{ .Values.kerberoshub.frontend.deviceGroupName }}"
-          
+        - name: DEVICE_GROUP_DESCRIPTION
+          value: "{{ .Values.kerberoshub.frontend.deviceGroupDescription }}"
+
         {{- if .Values.kerberoshub.extraEnv }}
         {{- toYaml .Values.kerberoshub.extraEnv | nindent 8 }}
         {{- end }}

charts/hub/templates/kerberos-pipeline/pipe-analysis.yaml

@@ -84,6 +84,14 @@ spec:
         # Sprites
         - name: SPRITE_ENABLED
           value: "{{ .Values.kerberospipeline.sprite.enabled }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-counting.yaml

@@ -58,6 +58,14 @@ spec:
           value: "{{ .Values.rabbitmq.username }}"
         - name: RABBITMQ_PASSWORD
           value: "{{ .Values.rabbitmq.password }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-dominantcolor.yaml

@@ -58,6 +58,14 @@ spec:
           value: "{{ .Values.rabbitmq.username }}"
         - name: RABBITMQ_PASSWORD
           value: "{{ .Values.rabbitmq.password }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-event.yaml

@@ -76,6 +76,14 @@ spec:
           value: "{{ .Values.rabbitmq.username }}"
         - name: RABBITMQ_PASSWORD
           value: "{{ .Values.rabbitmq.password }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-export.yaml

@@ -110,6 +110,14 @@ spec:
           value: "{{ .Values.kerberosvault.thumbnail.accessKey }}"
         - name: VAULT_THUMBNAIL_SECRET_KEY
           value: "{{ .Values.kerberosvault.thumbnail.secretKey }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-monitor.yaml

@@ -95,6 +95,14 @@ spec:
           value: "{{ .Values.email.smtp.username }}"
         - name: SMTP_PASSWORD
           value: "{{ .Values.email.smtp.password }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-notify-test.yaml

@@ -108,6 +108,14 @@ spec:
           value: "{{ .Values.email.smtp.username }}"
         - name: SMTP_PASSWORD
           value: "{{ .Values.email.smtp.password }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-notify.yaml

@@ -138,6 +138,14 @@ spec:
           value: "{{ .Values.kerberosvault.sprite.accessKey }}"
         - name: VAULT_SPRITE_SECRET_KEY
           value: "{{ .Values.kerberosvault.sprite.secretKey }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-sequence.yaml

@@ -72,6 +72,14 @@ spec:
           value: "{{ .Values.rabbitmq.username }}"
         - name: RABBITMQ_PASSWORD
           value: "{{ .Values.rabbitmq.password }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-sprite.yaml

@@ -82,6 +82,14 @@ spec:
           value: "{{ .Values.kerberospipeline.sprite.width }}"
         - name: VAULT_SPRITE_HEIGHT
           value: "{{ .Values.kerberospipeline.sprite.height }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-throttler.yaml

@@ -72,6 +72,14 @@ spec:
           value: "{{ .Values.rabbitmq.username }}"
         - name: RABBITMQ_PASSWORD
           value: "{{ .Values.rabbitmq.password }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
 ---
 apiVersion: v1
 kind: Service

charts/hub/templates/kerberos-pipeline/pipe-thumbnail.yaml

@@ -84,6 +84,15 @@ spec:
           value: "{{ .Values.kerberosvault.thumbnail.accessKey }}"
         - name: VAULT_THUMBNAIL_SECRET_KEY
           value: "{{ .Values.kerberosvault.thumbnail.secretKey }}"
+        
+        # Open Telemetry tracing
+        - name: OTEL_EXPORTED_OTLP_ENABLED
+          value: "{{ .Values.opentelemetry.enabled }}"
+        - name: OTEL_EXPORTED_OTLP_ROUTING_ENABLED
+          value: "{{ .Values.opentelemetry.routingEnabled }}"
+        - name: OTEL_EXPORTER_OTLP_ENDPOINT
+          value: "{{ .Values.opentelemetry.collector.endpoint }}"
+
 ---
 apiVersion: v1
 kind: Service

charts/hub/values.yaml

@@ -101,6 +101,15 @@ turn:
   username: "username1"
   password: "password1"
 ############################################
+# OpenTelemetry is used for distributed tracing and monitoring.
+# More information can be found at https://opentelemetry.io/docs/
+############################################
+opentelemetry:
+  enabled: false
+  routingEnabled: false
+  collector:
+    endpoint: "http://otel-collector:4317"
+############################################
 # OpenAI configuration (semantic search)
 #
 # Usecases:
@@ -169,7 +178,7 @@ kerberoshub:
   api:
     repository: uugai/hub-api
     pullPolicy: IfNotPresent
-    tag: "v1.6.1"
+    tag: "v1.6.3"
     replicas: 2
     jwtSecret: "this-is-a-secret-please-change-to-random-string" # change to a random value, this is for generating JWT tokens.
     schema: "https"
@@ -250,14 +259,10 @@ kerberoshub:
         clientSecret: "xxx"
         clientVerificationId: "" # This is only required for SSO chaining.
         extraHeaders: []
-    otlp: # Open Telemetry tracing
-      enabled: false # Set to 'true' to enable Open Telemetry tracing
-      routingEnabled: false # Set to 'true' to enable Gin routing middleware of traces
-      endpoint: "x.x.x.x:4318" # The endpoint to which traces are sent
   frontend:
     repository: uugai/hub-frontend
     pullPolicy: IfNotPresent
-    tag: "v1.4.2"
+    tag: "v1.5.1"
     replicas: 2
     schema: "https"
     url: "yourdomain.com"
@@ -300,7 +305,7 @@ kerberoshub:
     # By default the Kerberos Hub allows multi-tenancy through the concept
     # of accounts and subaccounts. However through the concept of domains, you
     # take it a step further. Within a domain, user accounts are unique, and are prefixed by a (domain\).
-    #multiTenant: true
+    multiTenant: false
     #tenantBaseDomain: "yourdomain.com" # this would resolve in following sub domain "https://domain.kerberos.io"
 
     # Page title (browser)
@@ -326,6 +331,19 @@ kerberoshub:
     #    persistentVolumeClaim:
     #      claimName: custom-favicon-claim
 
+    # Override naming conventions within the front-end.
+    floorPlanName: "map" # The name of the 'floor plan' feature to use in the front-end.
+    sitesName: "site" # The name of the 'sites' feature to use in the front-end.
+    sitesDescription: "" # The description of the 'sites' feature to use in the front-end.
+    groupsName: "group" # The name of the 'groups' feature to use in the front-end.
+    groupsDescription: "" # The description of the 'groups' feature to use in the front-end.
+    siteGroupName: "site Group" # The name of the 'site groups' feature to use in the front-end.
+    siteGroupDescription: "" # The description of the 'site groups' feature to use in the front-end.
+    deviceGroupName: "device Group" # The name of the 'device groups' feature to use in the front-end.
+    deviceGroupDescription: "" # The description of the 'device groups' feature to use in the front-end.
+    markersName: "marker" # The name of the 'markers' feature to use in the front-end.
+    eventsName: "event" # The name of the 'events' feature to use in the front-end.
+
     # By specifying the below environments variables, you can tweak the
     # headings and paragraphs of Kerberos Hub front-end.
     # Login page
@@ -337,6 +355,9 @@ kerberoshub:
     # Latest events page
     latestEventsTitle: ""
     latestEventsSubTitle: ""
+    # Day title
+    dayTitle: ""
+    daySubTitle: ""
     # Livestream/view page
     livestreamTitle: ""
     livestreamSubTitle: ""
@@ -360,23 +381,26 @@ kerberoshub:
     navigationLinkTitle5: ""
     navigationLinkUrl5: ""
     caseFilterAssigneesDefault: "false"
+
     # Custom colors for floor-plans, update the colors of the corresponding device icons to match these
     # charts/hub/custom-layout/icons.js
     colorDeviceActive: "hsla(131, 31%, 52%, 1)"
     colorDeviceInactive: "hsla(0, 3%, 41%, 1)"
     colorDeviceIdle: "hsla(47, 86%, 47%, 1)"
     colorDeviceMotion: "hsla(2, 58%, 48%, 1)"
+    colorLiveViewControlActive: "hsla(131, 31%, 52%, 1)" # Color for the live view control icon for an active device
+    colorLiveViewControlMotion: "hsla(2, 58%, 48%, 1)" # Color for the live view control icon for a device detecting motion, icon is hidden for other states
     colorFloorPlanLabelText: "hsla(0, 0%, 100%, 1)"
     colorFloorPlanLabelBackground: "hsla(0, 0%, 0%, 0.8)"
-    colorDeviceMarkerBorder: "hsla(0, 0%, 100%, 1)"
+    colorDeviceMarkerBorder: "hsla(0, 0%, 100%, 1)" # Border around the device marker circle on the map
+    colorTrackBox: "hsla(278, 30%, 48%, 1)"   # Boxes shown on the video
+    colorTrackBoxHover: "hsla(47, 86%, 47%, 1)"   # Boxes while hovering over the associated track
+    colorTrackBoxDrawing: "hsla(204, 100%, 50%, 1)"   # New box while drawing
+    colorTrackBoxControlsDelete: "hsla(219, 100%, 94%, 1)"   # Delete icon top right of the box while editing
+
+    features:
+      faceRedaction: "false" # Enable or disable face redaction 'true' or 'false
 
-    # Override naming conventions within the front-end.
-    floorPlanName: "map" # The name of the 'floor plan' feature to use in the front-end.
-    sitesName: "Sites" # The name of the 'sites' feature to use in the front-end.
-    groupsName: "Groups" # The name of the 'groups' feature to use in the front-end.
-    siteGroupName: "Site Groups" # The name of the 'site groups' feature to use in the front-end.
-    deviceGroupName: "Device Groups" # The name of the 'device groups' feature to use in the front-end.
-    
   support:
     enabled: false
   oauth2Proxy: