From 627754823ce4f472ea84436a0ec062267e58c4ab Mon Sep 17 00:00:00 2001 From: Jeff Billimek Date: Sat, 27 Jul 2019 00:20:41 -0400 Subject: [PATCH] clarify readme (#53) * changing icon * fixing readme * clarifying readme instructions --- frigate/Chart.yaml | 2 +- frigate/README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/frigate/Chart.yaml b/frigate/Chart.yaml index 8936ae87..4f2eba6f 100644 --- a/frigate/Chart.yaml +++ b/frigate/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v1 appVersion: "0.2.0-beta" description: Realtime object detection on RTSP cameras with the Google Coral name: frigate -version: 0.1.4 +version: 0.1.5 keywords: - tensorflow - coral diff --git a/frigate/README.md b/frigate/README.md index 9566a5b5..1ec5cb5e 100644 --- a/frigate/README.md +++ b/frigate/README.md @@ -17,6 +17,24 @@ To install the chart with the release name `my-release`: helm install --name my-release billimek/frigate ``` +**IMPORTANT NOTE:** the [Google Coral USB Accelerator](https://coral.withgoogle.com/products/accelerator/) must be accessible on the node where this pod runs, in order for this chart to function properly. + +A way to achieve this can be with nodeAffinity rules, for example: + +```yaml +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: