https://github.com/evertras/nomad-generic-device-plugin
https://github.com/evertras/nomad-generic-device-plugin
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/evertras/nomad-generic-device-plugin
- Owner: Evertras
- License: mpl-2.0
- Created: 2021-06-01T12:57:52.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-03-13T03:13:35.000Z (over 4 years ago)
- Last Synced: 2025-04-07T10:01:50.831Z (about 1 year ago)
- Language: Go
- Size: 37.1 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Nomad Generic Device Plugin
===========================
Nomad allows jobs to request various devices to reserve, such as GPUs. However,
there is no way to specify generic devices to reserve, such as a mobile device
or external hardware.
This plugin uses the [Nomad device plugins](https://www.nomadproject.io/docs/internals/plugins/devices.html)
feature to allow you to configure arbitrary hardware devices to be available
on the node for reservation.
Based on [the Skeleton Device Plugin](https://github.com/hashicorp/nomad-skeleton-device-plugin)
provided by Hashicorp.
This repo is a bit messy/unpolished for the moment. Don't take anything here
as a best practice.
Features
--------
Currently, the plugin allows you to specify arbitrary values for a device.
No checks are made. If you configure a device in the client config, the device
will be made available for reservation.
Only single, discrete devices are currently supported.
A client config might include the following to enable the plugin and add some
devices to make available:
```hcl
# This particular client has two phones and a car connected to it
plugin "generic-device" {
config {
device {
type = "phone"
vendor = "woogle"
model = "nebula10"
}
device {
type = "phone"
vendor = "mango"
model = "mphone12-max"
}
device {
type = "car"
vendor = "doyota"
model = "mius"
}
}
}
```
Then a job might look like this:
```hcl
job "self-driving-demo" {
type = "batch"
datacenters = ["dc1"]
group "run-stuff" {
task "drive-around" {
driver = "exec"
config {
command = "bash"
args = ["-c", "echo Circling the block... && magic-self-driving && echo Done!"]
}
resources {
# Reserve a Doyota Mius to drive around with for the duration of this task
device "doyota/car/mius" {}
}
}
}
}
```
Wishlist
--------
Arbitrary health check scripts to see if the device is actually healthy/available.
Arbitrary attributes that can be selected against, such as memory usage.
Attribute/model scripts that can dynamically fill in data when fingerprinted.
Better tests and cleaner code, this was bare minimum changes from the skeleton
reference with some manual testing to see what actually works.
Requirements
------------
- [Go](https://golang.org/doc/install) 1.12 or later (to build the plugin)
Building the Generic Device Plugin
----------------------------------
```sh
$ make
```
Running the Plugin in Development
---------------------------------
You can test this plugin (and your own device plugins) in development using the
[plugin launcher](https://github.com/hashicorp/nomad/tree/master/plugins/shared/cmd/launcher). The makefile provides
a target for this:
```sh
$ make eval
```
Deploying Device Plugins in Nomad
---------------------------------
Copy the plugin binary to the
[plugins directory](https://www.nomadproject.io/docs/configuration/index.html#plugin_dir) and
[configure the plugin](https://www.nomadproject.io/docs/configuration/plugin.html) in the client config. Then use the
[device stanza](https://www.nomadproject.io/docs/job-specification/device.html) in the job file to schedule with
device support.