charts/charts/frigate
BJWS bd9f296d6c
[frigate] Allow mask files to be passed to the container, version bump (#312)
* Update Frigate version

* Allow configmap that contains camera masks

* Enable startupProbe functionality

* Disable probes by default

* Disable probes only during CI

* Disable probes only during CI
2020-08-06 08:41:34 -04:00
..
ci [frigate] Allow mask files to be passed to the container, version bump (#312) 2020-08-06 08:41:34 -04:00
templates [frigate] Allow mask files to be passed to the container, version bump (#312) 2020-08-06 08:41:34 -04:00
.helmignore moving all charts under charts/ dir (#112) 2020-01-10 14:58:11 -05:00
Chart.yaml [frigate] Allow mask files to be passed to the container, version bump (#312) 2020-08-06 08:41:34 -04:00
OWNERS moving all charts under charts/ dir (#112) 2020-01-10 14:58:11 -05:00
README.md [frigate] Allow mask files to be passed to the container, version bump (#312) 2020-08-06 08:41:34 -04:00
values.yaml [frigate] Allow mask files to be passed to the container, version bump (#312) 2020-08-06 08:41:34 -04:00

frigate: Realtime object detection on RTSP cameras with the Google Coral

This is a helm chart for frigate

TL;DR;

$ 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:

helm install --name my-release billimek/frigate

IMPORTANT NOTE: the Google Coral USB Accelerator must be accessible on the node where this pod runs, in order for this chart to function properly.

The Coral USB device is now optional

A way to achieve this can be with nodeAffinity rules, for example:

affinity:
  nodeAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
      nodeSelectorTerms:
      - matchExpressions:
        - key: tpu
          operator: In
          values:
          - google-coral

... where a node with an attached Coral USB device is labeled with tpu: google-coral

Uninstalling the Chart

To uninstall/delete the my-release deployment:

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 Frigate chart and their default values.

Parameter Description Default
image.repository Image repository blakeblackshear/frigate
image.tag Image tag. Possible values listed here. 0.5.1
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
extraSecretForEnvFrom Secrets containing env variables for []
coral.enabled Use the Coral USB device false
coral.hostPath Host Path to reference USB device location (on the host) /dev/bus/usb
masksConfigMap Reference to existing ConfigMap that contains camera masks - more info {}
shmSize Shared memory size for processing 1Gi
config frigate configuration - see config.yaml 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,

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,

helm install --name my-release -f values.yaml stable/frigate

Read through the values.yaml file. It has several commented out suggested values.