[deepstack] add deepstack-ui (#1275)

* [deepstack] add deepstack-ui

* use API key

Co-authored-by: angelnu <git@angelnucom>

charts/stable/deepstack/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: cpu-2021.09.1
 description: An AI API engine that serves pre-built models and custom models on multiple edge devices locally or on your private cloud
 name: deepstack
-version: 1.0.0
+version: 1.1.0
 kubeVersion: ">=1.16.0-0"
 keywords:
   - deepstack
@@ -12,6 +12,7 @@ icon: https://deepquest.sfo2.digitaloceanspaces.com/deepstackcc/static/img/deeps
 sources:
   - https://deepstack.cc
   - https://github.com/johnolafenwa/DeepStack
+  - https://github.com/robmarkcole/deepstack-ui
 maintainers:
   - name: crutonjohn
     email: crutonjohn@pm.me

charts/stable/deepstack/README.md

@@ -1,6 +1,6 @@
 # deepstack
 
-![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: cpu-2021.09.1](https://img.shields.io/badge/AppVersion-cpu--2021.09.1-informational?style=flat-square)
+![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![AppVersion: cpu-2021.09.1](https://img.shields.io/badge/AppVersion-cpu--2021.09.1-informational?style=flat-square)
 
 An AI API engine that serves pre-built models and custom models on multiple edge devices locally or on your private cloud
 
@@ -10,6 +10,7 @@ An AI API engine that serves pre-built models and custom models on multiple edge
 
 * <https://deepstack.cc>
 * <https://github.com/johnolafenwa/DeepStack>
+* <https://github.com/robmarkcole/deepstack-ui>
 
 ## Requirements
 
@@ -84,6 +85,12 @@ N/A
 | persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
 | securityContext | object | See values.yaml | security context. May be necessary when using GPU image |
 | service | object | See values.yaml | Configures service settings for the chart. |
+| ui.enabled | bool | `true` | enable web UI |
+| ui.env | string | `nil` | environment variables. See more environment variables in the [deepstack-ui README](https://github.com/robmarkcole/deepstack-ui). |
+| ui.image.pullPolicy | string | `"Always"` | image pull policy |
+| ui.image.repository | string | `"robmarkcole/deepstack-ui"` | image repository for ui |
+| ui.image.tag | string | `"latest"` | image tag |
+| ui.ingress.ui | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
 
 ## Changelog
 
@@ -91,6 +98,12 @@ All notable changes to this application Helm chart will be documented in this fi
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [1.1.0]
+
+#### Added
+
+- add [deepstack-ui](https://github.com/robmarkcole/deepstack-ui)
+
 ### [1.0.0]
 
 #### Added

charts/stable/deepstack/README_CHANGELOG.md.gotmpl

@@ -9,6 +9,12 @@ All notable changes to this application Helm chart will be documented in this fi
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [1.1.0]
+
+#### Added
+
+- add [deepstack-ui](https://github.com/robmarkcole/deepstack-ui)
+
 ### [1.0.0]
 
 #### Added

charts/stable/deepstack/templates/common.yaml

@@ -1 +1,57 @@
+{{/* Make sure all variables are set properly */}}
+{{- include "common.values.setup" . }}
+
+{{/* Append the hardcoded settings */}}
+{{- define "deepstack.harcodedValues" -}}
+
+{{/* Set port number used by UI */}}
+{{- $uiPortNumber := 8501 }}
+
+{{/* Add port to each defined ingress */}}
+{{- if .Values.ui.enabled }}
+{{- range .Values.ui.ingress.ui.hosts }}
+{{- range .paths }}
+{{- $_ := mergeOverwrite . (dict "service" (dict "port" $uiPortNumber)) -}}
+{{- end }}
+{{- end }}
+
+additionalContainers:
+  ui:
+    image: {{.Values.ui.image.repository }}:{{ .Values.ui.image.tag }}
+    imagePullPolicy: {{ .Values.ui.image.pullPolicy }}
+    env:
+    # -- the IP address of your deepstack instance
+    - name: DEEPSTACK_IP
+      value: localhost
+    # -- the port of your deepstack instance
+    - name: DEEPSTACK_PORT
+      value: {{ .Values.service.main.ports.http.port | quote }}
+    {{- if kindIs "map" .Values.env }}
+    {{- if hasKey .Values.env "API-KEY" }}
+    - name: DEEPSTACK_API_KEY
+      value : {{ index .Values.env "API-KEY"  | quote }}
+    {{- end }}
+    {{- end }}
+    {{- if .Values.ui.env }}
+    {{ .Values.ui.env | toYaml | nindent 4 }}
+    {{- end }}
+    ports:
+    - name: ui
+      containerPort: {{ $uiPortNumber }}
+      protocol: TCP
+service:
+  main:
+    enabled: true
+    ports:
+      ui:
+        enabled: true
+        port: {{ $uiPortNumber }}
+ingress:
+{{ .Values.ui.ingress | toYaml | nindent 2 }}
+{{- end }}
+
+{{- end -}}
+{{- $_ := mergeOverwrite .Values (include "deepstack.harcodedValues" . | fromYaml) -}}
+
+{{/* Render the templates */}}
 {{ include "common.all" . }}

charts/stable/deepstack/values.yaml

@@ -22,6 +22,36 @@ env:
   # VISION-FACE: True
   # -- Enable object detection
   # VISION-DETECTION: True
+  # -- Protect detection and recognition APIs with a key
+  # API-KEY: changeMe
+  # -- Protect admin APIs (such as managing models) with a key
+  # ADMIN-KEY: changeMe
+
+ui:
+  # -- enable web UI
+  enabled: true
+  image:
+    # -- image repository for ui
+    repository: robmarkcole/deepstack-ui
+    # -- image tag
+    tag: latest
+    # -- image pull policy
+    pullPolicy: Always
+  # -- environment variables. See more environment variables in the [deepstack-ui README](https://github.com/robmarkcole/deepstack-ui).
+  # @default -- See below
+  env:
+  # - name: DEEPSTACK_TIMEOUT
+  #   value: the timeout to wait for deepstack, default 30 seconds
+  # - name: DEEPSTACK_CUSTOM_MODEL
+  #   value: the name of a custom model, if you wish to use one
+  # - name: DEEPSTACK_UI_DEBUG_MODE
+  #   value: options `True` or `False` (default). Lowers the minimum confidence threshold to 1%
+  ingress:
+    # -- Enable and configure ingress settings for the chart under this key.
+    # @default -- See values.yaml
+    ui:
+      enabled: false
+      primary: false
 
 # -- Configures service settings for the chart.
 # @default -- See values.yaml