github/intel-device-plugins-for-kubernetes
7
0
Fork 0
mirror of https://github.com/intel/intel-device-plugins-for-kubernetes.git synced 2025-06-03 03:59:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor text edits to devel.md.

Browse Source 
Signed-off-by: MCamp859 <maryx.camp@intel.com>
This commit is contained in:
MCamp859 2019-02-13 09:36:33 -05:00
parent dc3787dfbc
commit 5e9afb3443
1 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
DEVEL.md
View File

@ -1,11 +1,11 @@
How to develop simple device plugins
====================================
This repository provides the package `github.com/intel/intel-device-plugins-for-kubernetes/pkg/deviceplugin`
which enables you to create a simple device plugin without the hassle of
developing your own gRPC server.
To create a simple device plugin without the hassle of developing your own gRPC
server, you can use a package included in this repository called
`github.com/intel/intel-device-plugins-for-kubernetes/pkg/deviceplugin`.
All you have to do is to instantiate a `deviceplugin.Manager` and call
All you have to do is instantiate a `deviceplugin.Manager` and call
its `Run()` method:
```go
@ -22,18 +22,17 @@ The manager's constructor accepts two parameters:
1. `namespace` which is a string like "color.example.com". All your devices
will be exposed under this name space, e.g. "color.example.com/yellow".
Please note that one device plugin can register many such "colors".
The manager will take care of instantiating multiple gRPC servers
each for every "color".
The manager will instantiate multiple gRPC servers for every registered "color".
2. `plugin` which is a reference to an object implementing one mandatory
interface `deviceplugin.Scanner`.
`deviceplugin.Scanner` defines one method `Scan()` which is called only
once for every device plugin by `deviceplugin.Manager` in a goroutine and
operates in an infinite loop. An implementation of this method is supposed
to scan the host for devices and to send all found devices to a
`deviceplugin.Notifier` instance. The latter is implemented and provided by the
`deviceplugin` package itself. The found devices are organized in an instance
of `deviceplugin.DeviceTree` object. The object is filled in with its
`deviceplugin.Scanner` defines one method `Scan()` which is called only once
for every device plugin by `deviceplugin.Manager` in a goroutine and operates
in an infinite loop. A `Scan()` implementation scans the host for devices and
sends all found devices to a `deviceplugin.Notifier` instance. The
`deviceplugin.Notifier` is implemented and provided by the `deviceplugin`
package itself. The found devices are organized in an instance of
`deviceplugin.DeviceTree` object. The object is filled in with its
`AddDevice()` method:
```go
@ -57,7 +56,9 @@ func (dp *devicePlugin) Scan(notifier deviceplugin.Notifier) error {
}
```
Optionally, your device plugin may also implement the `deviceplugin.PostAllocator`
interface. If implemented its method `PostAllocate()` modifies
`pluginapi.AllocateResponse` responses just before they are sent to `kubelet`
e.g. to augment the responses with annotations like in the FPGA plugin.
Optionally, your device plugin may also implement the
`deviceplugin.PostAllocator` interface. If implemented, its method
`PostAllocate()` modifies `pluginapi.AllocateResponse` responses just
before they are sent to `kubelet`. To see an example, refer to the FPGA
plugin which implements this interface to annotate its responses.