Skip to content

Update description of CDI spec directories #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,15 @@ to duplication of the functionality in higher-level abstractions (such as

For CDI to work the following needs to be done:

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

## How to configure CDI?

Expand Down