clarify readme (#53)

* changing icon

* fixing readme

* clarifying readme instructions
This commit is contained in:
Jeff Billimek 2019-07-27 00:20:41 -04:00 committed by GitHub
parent 3a892389d7
commit 627754823c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 1 deletions

View File

@ -2,7 +2,7 @@ apiVersion: v1
appVersion: "0.2.0-beta" appVersion: "0.2.0-beta"
description: Realtime object detection on RTSP cameras with the Google Coral description: Realtime object detection on RTSP cameras with the Google Coral
name: frigate name: frigate
version: 0.1.4 version: 0.1.5
keywords: keywords:
- tensorflow - tensorflow
- coral - coral

View File

@ -17,6 +17,24 @@ To install the chart with the release name `my-release`:
helm install --name my-release billimek/frigate 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 ## Uninstalling the Chart
To uninstall/delete the `my-release` deployment: To uninstall/delete the `my-release` deployment: