Skip to content

Commit d283334

Browse files
committed
Add description of a fully-qualified device name
This addresses #105 Signed-off-by: Evan Lezar <[email protected]>
1 parent 8087646 commit d283334

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@
66

77
CDI (Container Device Interface), is a [specification](SPEC.md), for container runtimes, to support third party devices.
88

9+
It introduces an abstract notion of a device as a resource. Such devices are uniquely specified by a fully-qualified name that is constructed from a vendor ID, a device class, and a name that is unique per vendor ID-device class pair.
10+
11+
```
12+
vendor.com/class=unique_name
13+
```
14+
15+
The combination of vendor ID and device class (`vendor.com/class` in the above example) is referred to as the device kind.
16+
917
CDI concerns itself only with enabling container to be device aware. Areas like resource management are explicitly left out of CDI (and is expected to be handled by the orchestrator). Because of this focus, the CDI specification is simple to implement and allows great flexibility to runtimes and orchestrators.
1018

1119
Note: The CDI model is based on the Container Networking Interface (CNI) model and specification.

0 commit comments

Comments
 (0)