Skip to content

Commit a5a08c0

Browse files
committed
Add quick start instructions to README.md
1 parent a1a502e commit a5a08c0

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
# Intel NCS2 device plugin for Kubernetes
22

33
[![PyPI](https://img.shields.io/pypi/v/ncs2-device-plugin.svg)](https://pypi.python.org/pypi/ncs2-device-plugin)
4+
[![PyPI](https://img.shields.io/pypi/pyversions/ncs2-device-plugin.svg)](https://pypi.python.org/pypi/ncs2-device-plugin)
5+
[![Docker Pulls](https://img.shields.io/docker/pulls/adaptant/ncs2-device-plugin.svg)](https://hub.docker.com/repository/docker/adaptant/ncs2-device-plugin)
46

57
A Kubernetes device plugin for the Intel Neural Compute Stick 2 (NCS2) / Intel Movidius MyriadX
68

9+
## Quick Start
10+
11+
To directly install `ncs2-device-plugin` as a `DaemonSet` into the Kubernetes cluster:
12+
13+
```
14+
$ kubectl apply -f https://raw.githubusercontent.com/adaptant-labs/ncs2-device-plugin/ncs2-device-plugin.yaml
15+
```
16+
17+
Pods will be scheduled on any node with a `feature.node.kubernetes.io/usb-ff_03e7_2485.present` (provided by [NFD]) or
18+
`accelerators/ncs2` (provided by [k8s-auto-labeller], in combination with NFD-based discovery) label set. These labels
19+
can also be set manually on NCS2-capable nodes for simple deployments in order to enqueue the Pod.
20+
21+
[NFD]: https://github.com/kubernetes-sigs/node-feature-discovery
22+
[k8s-auto-labeller]: https://github.com/adaptant-labs/k8s-auto-labeller
23+
724
## Annotations
825

926
Annotations are produced for the per-device full device name, allowing for different device types to be explicitly

0 commit comments

Comments
 (0)