Skip to content

Commit e3ab801

Browse files
committed
Update description of CDI dirs
This change improves the description of the CDI spec directories. The support for YAML files is called out and the exact file extensions are mentioned. Signed-off-by: Evan Lezar <[email protected]>
1 parent e665440 commit e3ab801

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,15 @@ to duplication of the functionality in higher-level abstractions (such as
5151

5252
For CDI to work the following needs to be done:
5353

54-
- CDI file containing updates for the OCI spec in JSON format should be present
55-
in the CDI spec directory. Default directories are `/etc/cdi` and
56-
`/var/run/cdi`
57-
- Fully qualified device name should be passed to the runtime either using
58-
command line parameters for podman or using container annotations for CRI-O
59-
and containerd
60-
- Container runtime should be able to find the CDI file by the device name and
61-
update the container config using CDI file content.
54+
- CDI file containing updates for the OCI spec in JSON or YAML format (with a
55+
`.json` or `.yaml` file extension, respectively) should be present in a CDI
56+
spec directory. The default directories are `/etc/cdi` and `/var/run/cdi`, but
57+
may depend on your runtime configuration
58+
- One or more fully-qualified device names should be passed to the runtime
59+
either using command line parameters for CLI tools such as podman or Docker,
60+
or using container annotations or CRI fields for CRI-O and containerd
61+
- The container runtime should be able to find the CDI file by the device name
62+
and update the container config using CDI file content.
6263

6364
## How to configure CDI?
6465

0 commit comments

Comments
 (0)