From 7ba269f56cbabfa0bf9036aeb5f50bc299e3e7b0 Mon Sep 17 00:00:00 2001 From: Jeff Billimek Date: Fri, 26 Jul 2019 23:01:33 -0400 Subject: [PATCH] frigate helm chart (#48) * frigate helm chart Signed-off-by: Jeff Billimek * remove trailing spaces --- frigate/.helmignore | 24 +++++ frigate/Chart.yaml | 16 ++++ frigate/OWNERS | 4 + frigate/README.md | 74 ++++++++++++++++ frigate/templates/NOTES.txt | 21 +++++ frigate/templates/_helpers.tpl | 45 ++++++++++ frigate/templates/configmap.yaml | 13 +++ frigate/templates/deployment.yaml | 85 ++++++++++++++++++ frigate/templates/ingress.yaml | 36 ++++++++ frigate/templates/service.yaml | 49 +++++++++++ frigate/values.yaml | 141 ++++++++++++++++++++++++++++++ 11 files changed, 508 insertions(+) create mode 100644 frigate/.helmignore create mode 100644 frigate/Chart.yaml create mode 100644 frigate/OWNERS create mode 100644 frigate/README.md create mode 100644 frigate/templates/NOTES.txt create mode 100644 frigate/templates/_helpers.tpl create mode 100644 frigate/templates/configmap.yaml create mode 100644 frigate/templates/deployment.yaml create mode 100644 frigate/templates/ingress.yaml create mode 100644 frigate/templates/service.yaml create mode 100644 frigate/values.yaml diff --git a/frigate/.helmignore b/frigate/.helmignore new file mode 100644 index 00000000..e559de0a --- /dev/null +++ b/frigate/.helmignore @@ -0,0 +1,24 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS diff --git a/frigate/Chart.yaml b/frigate/Chart.yaml new file mode 100644 index 00000000..c19c3b4a --- /dev/null +++ b/frigate/Chart.yaml @@ -0,0 +1,16 @@ +apiVersion: v1 +appVersion: "0.2.0-beta" +description: Realtime object detection on RTSP cameras with the Google Coral +name: frigate +version: 0.1.0 +keywords: + - tensorflow + - coral + - ml +home: https://github.com/billimek/billimek-charts/tree/master/frigate +icon: https://svgsilh.com/svg/1293940.svg +sources: + - https://github.com/blakeblackshear/frigate +maintainers: + - name: billimek + email: jeff@billimek.com diff --git a/frigate/OWNERS b/frigate/OWNERS new file mode 100644 index 00000000..51f88652 --- /dev/null +++ b/frigate/OWNERS @@ -0,0 +1,4 @@ +approvers: +- billimek +reviewers: +- billimek \ No newline at end of file diff --git a/frigate/README.md b/frigate/README.md new file mode 100644 index 00000000..ea4c405e --- /dev/null +++ b/frigate/README.md @@ -0,0 +1,74 @@ +# frigate: Realtime object detection on RTSP cameras with the Google Coral + +This is a helm chart for [frigate](https://github.com/frigate/frigate/) leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/frigate/) + +## TL;DR; + +```shell +$ helm repo add billimek https://billimek.com/billimek-charts/ +$ helm install billimek/frigate +``` + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +helm install --name my-release billimek/frigate +``` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +helm delete my-release --purge +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration + +The following tables lists the configurable parameters of the Sentry chart and their default values. + +| Parameter | Description | Default | +|----------------------------|-------------------------------------|---------------------------------------------------------| +| `image.repository` | Image repository | `blakeblackshear/frigate` | +| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/blakeblackshear/frigate/tags/).| `0.2.0-beta`| +| `image.pullPolicy` | Image pull policy | `IfNotPresent` | +| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | +| `timezone` | Timezone the frigate instance should run as, e.g. 'America/New_York' | `UTC` | +| `rtspPassword` | Password to use for RTSP cameras | `password` | +| `config` | frigate configuration - see [config.yaml](https://github.com/blakeblackshear/frigate/blob/master/config/config.yml) for example | `{}` | +| `Service.type` | Kubernetes service type for the frigate GUI | `ClusterIP` | +| `Service.port` | Kubernetes port where the frigate GUI is exposed| `5000` | +| `Service.annotations` | Service annotations for the frigate GUI | `{}` | +| `Service.labels` | Custom labels | `{}` | +| `Service.loadBalancerIP` | Loadbalance IP for the frigate GUI | `{}` | +| `Service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None +| `ingress.enabled` | Enables Ingress | `false` | +| `ingress.annotations` | Ingress annotations | `{}` | +| `ingress.labels` | Custom labels | `{}` +| `ingress.path` | Ingress path | `/` | +| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | +| `ingress.tls` | Ingress TLS configuration | `[]` | +| `resources` | CPU/Memory resource requests/limits | `{}` | +| `nodeSelector` | Node labels for pod assignment | `{}` | +| `tolerations` | Toleration labels for pod assignment | `[]` | +| `affinity` | Affinity settings for pod assignment | `{}` | + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```console +helm install --name my-release \ + --set rtspPassword="nosecrets" \ + billimek/frigate +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, + +```console +helm install --name my-release -f values.yaml stable/frigate +``` + +Read through the [values.yaml](https://github.com/billimek/billimek-charts/blob/master/frigate/values.yaml) file. It has several commented out suggested values. diff --git a/frigate/templates/NOTES.txt b/frigate/templates/NOTES.txt new file mode 100644 index 00000000..edbc9f35 --- /dev/null +++ b/frigate/templates/NOTES.txt @@ -0,0 +1,21 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "frigate.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "frigate.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "frigate.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "frigate.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl port-forward $POD_NAME 8080:80 +{{- end }} diff --git a/frigate/templates/_helpers.tpl b/frigate/templates/_helpers.tpl new file mode 100644 index 00000000..d121f372 --- /dev/null +++ b/frigate/templates/_helpers.tpl @@ -0,0 +1,45 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "frigate.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "frigate.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- if contains $name .Release.Name -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} +{{- end -}} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "frigate.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Common labels +*/}} +{{- define "frigate.labels" -}} +app.kubernetes.io/name: {{ include "frigate.name" . }} +helm.sh/chart: {{ include "frigate.chart" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end -}} diff --git a/frigate/templates/configmap.yaml b/frigate/templates/configmap.yaml new file mode 100644 index 00000000..6733fb85 --- /dev/null +++ b/frigate/templates/configmap.yaml @@ -0,0 +1,13 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ template "frigate.fullname" . }} + namespace: {{ .Release.Namespace }} + labels: + app.kubernetes.io/name: {{ include "frigate.name" . }} + helm.sh/chart: {{ include "frigate.chart" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} +data: + config.yml: | +{{ toYaml .Values.config | default "{}" | indent 4 }} diff --git a/frigate/templates/deployment.yaml b/frigate/templates/deployment.yaml new file mode 100644 index 00000000..1bc49e6d --- /dev/null +++ b/frigate/templates/deployment.yaml @@ -0,0 +1,85 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "frigate.fullname" . }} + labels: +{{ include "frigate.labels" . | indent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + strategy: + type: {{ .Values.strategyType }} + selector: + matchLabels: + app.kubernetes.io/name: {{ include "frigate.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + template: + metadata: + labels: + app.kubernetes.io/name: {{ include "frigate.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + {{- if .Values.podAnnotations }} + annotations: + {{- range $key, $value := .Values.podAnnotations }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + containers: + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + securityContext: + privileged: true + ports: + - name: http + containerPort: 5000 + protocol: TCP + livenessProbe: + tcpSocket: + port: http + initialDelaySeconds: 30 + failureThreshold: 5 + timeoutSeconds: 5 + readinessProbe: + tcpSocket: + port: http + initialDelaySeconds: 30 + failureThreshold: 5 + timeoutSeconds: 5 + env: + {{- if .Values.timezone }} + - name: TZ + value: "{{ .Values.timezone }}" + {{- end }} + - name: RTSP_PASSWORD + value: "{{ .Values.rtspPassword }}" + volumeMounts: + - mountPath: /dev/bus/usb + name: usb + - mountPath: /config + name: config + resources: + {{- toYaml .Values.resources | nindent 12 }} + volumes: + - name: config + configMap: + name: {{ template "frigate.fullname" . }} + - name: usb + hostPath: + path: /dev/bus/usb + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/frigate/templates/ingress.yaml b/frigate/templates/ingress.yaml new file mode 100644 index 00000000..342a50f2 --- /dev/null +++ b/frigate/templates/ingress.yaml @@ -0,0 +1,36 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "frigate.fullname" . -}} +apiVersion: extensions/v1beta1 +kind: Ingress +metadata: + name: {{ $fullName }} + labels: +{{ include "frigate.labels" . | indent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: +{{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} +{{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ . }} + backend: + serviceName: {{ $fullName }} + servicePort: http + {{- end }} + {{- end }} +{{- end }} diff --git a/frigate/templates/service.yaml b/frigate/templates/service.yaml new file mode 100644 index 00000000..fae7a886 --- /dev/null +++ b/frigate/templates/service.yaml @@ -0,0 +1,49 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ template "frigate.fullname" . }} + labels: +{{ include "frigate.labels" . | indent 4 }} +{{- if .Values.service.labels }} +{{ toYaml .Values.service.labels | indent 4 }} +{{- end }} +{{- with .Values.service.annotations }} + annotations: +{{ toYaml . | indent 4 }} +{{- end }} +spec: +{{- if (or (eq .Values.service.type "ClusterIP") (empty .Values.service.type)) }} + type: ClusterIP + {{- if .Values.service.clusterIP }} + clusterIP: {{ .Values.service.clusterIP }} + {{end}} +{{- else if eq .Values.service.type "LoadBalancer" }} + type: {{ .Values.service.type }} + {{- if .Values.service.loadBalancerIP }} + loadBalancerIP: {{ .Values.service.loadBalancerIP }} + {{- end }} + {{- if .Values.service.loadBalancerSourceRanges }} + loadBalancerSourceRanges: +{{ toYaml .Values.service.loadBalancerSourceRanges | indent 4 }} + {{- end -}} +{{- else }} + type: {{ .Values.service.type }} +{{- end }} +{{- if .Values.service.externalIPs }} + externalIPs: +{{ toYaml .Values.service.externalIPs | indent 4 }} +{{- end }} + {{- if .Values.service.externalTrafficPolicy }} + externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }} + {{- end }} + ports: + - name: http + port: {{ .Values.service.port }} + protocol: TCP + targetPort: http +{{ if (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort))) }} + nodePort: {{.Values.service.nodePort}} +{{ end }} + selector: + app.kubernetes.io/name: {{ include "frigate.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} \ No newline at end of file diff --git a/frigate/values.yaml b/frigate/values.yaml new file mode 100644 index 00000000..6648c44b --- /dev/null +++ b/frigate/values.yaml @@ -0,0 +1,141 @@ +# Default values for frigate. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +# upgrade strategy type (e.g. Recreate or RollingUpdate) +strategyType: Recreate + +image: + repository: blakeblackshear/frigate + tag: 0.2.0-beta + pullPolicy: IfNotPresent + +rtspPassword: password + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +# frigate configuration - see https://github.com/blakeblackshear/frigate/blob/master/config/config.yml for example +config: + mqtt: + host: mqtt.server.com + topic_prefix: frigate + # user: username # Optional -- Uncomment for use + # password: password # Optional -- Uncomment for use + + cameras: + back: + rtsp: + user: viewer + host: 10.0.10.10 + port: 554 + # values that begin with a "$" will be replaced with environment variable + password: $RTSP_PASSWORD + path: /cam/realmonitor?channel=1&subtype=2 + + ################ + ## Optional mask. Must be the same dimensions as your video feed. + ## The mask works by looking at the bottom center of the bounding box for the detected + ## person in the image. If that pixel in the mask is a black pixel, it ignores it as a + ## false positive. In my mask, the grass and driveway visible from my backdoor camera + ## are white. The garage doors, sky, and trees (anywhere it would be impossible for a + ## person to stand) are black. + ################ + # mask: back-mask.bmp + + ################ + # Allows you to limit the framerate within frigate for cameras that do not support + # custom framerates. A value of 1 tells frigate to look at every frame, 2 every 2nd frame, + # 3 every 3rd frame, etc. + ################ + take_frame: 1 + + ################ + # Optional hardware acceleration parameters for ffmpeg. If your hardware supports it, it can + # greatly reduce the CPU power used to decode the video stream. You will need to determine which + # parameters work for your specific hardware. These may work for those with Intel hardware that + # supports QuickSync. + ################ + # ffmpeg_hwaccel_args: + # - -hwaccel + # - vaapi + # - -hwaccel_device + # - /dev/dri/renderD128 + # - -hwaccel_output_format + # - yuv420p + + regions: + - size: 350 + x_offset: 0 + y_offset: 300 + min_person_area: 5000 + threshold: 0.5 + - size: 400 + x_offset: 350 + y_offset: 250 + min_person_area: 2000 + threshold: 0.5 + - size: 400 + x_offset: 750 + y_offset: 250 + min_person_area: 2000 + threshold: 0.5 + +service: + type: ClusterIP + port: 5000 + ## Specify the nodePort value for the LoadBalancer and NodePort service types. + ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + ## + # nodePort: + ## Provide any additional annotations which may be required. This can be used to + ## set the LoadBalancer service type to internal only. + ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer + ## + annotations: {} + labels: {} + ## Use loadBalancerIP to request a specific static IP, + ## otherwise leave blank + ## + loadBalancerIP: + # loadBalancerSourceRanges: [] + ## Set the externalTrafficPolicy in the Service to either Cluster or Local + # externalTrafficPolicy: Cluster + + +ingress: + enabled: false + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: [] + + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +podAnnotations: {}