Skip to content

Commit 50bb592

Browse files
neersightedthaJeztah
authored andcommitted
docs: tidy up CDI docs
Signed-off-by: Bjorn Neergaard <[email protected]> (cherry picked from commit 116db4f) Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent c4767b3 commit 50bb592

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

docs/reference/commandline/container_run.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -902,17 +902,19 @@ PS C:\> docker run --device=class/86E0D1E0-8089-11D0-9CE4-08003E301F73 mcr.micro
902902

903903
> **Note**
904904
>
905-
> This is experimental feature and as such doesn't represent a stable API.
905+
> The CDI feature is experimental, and potentially subject to change.
906+
> CDI is currently only supported for Linux containers.
906907
907-
Container Device Interface (CDI) is a
908-
[standardized](https://github.com/cncf-tags/container-device-interface/blob/main/SPEC.md)
909-
mechanism for container runtimes to create containers which are able to
910-
interact with third party devices.
908+
[Container Device Interface
909+
(CDI)](https://github.com/cncf-tags/container-device-interface/blob/main/SPEC.md)
910+
is a standardized mechanism for container runtimes to create containers which
911+
are able to interact with third party devices.
911912

912-
With CDI, device configurations are defined using a JSON file. In addition to
913-
enabling the container to interact with the device node, it also lets you
914-
specify additional configuration for the device, such as kernel modules, host
915-
libraries, and environment variables.
913+
With CDI, device configurations are declaratively defined using a JSON or YAML
914+
file. In addition to enabling the container to interact with the device node,
915+
it also lets you specify additional configuration for the device, such as
916+
environment variables, host mounts (such as shared objects), and executable
917+
hooks.
916918

917919
You can reference a CDI device with the `--device` flag using the
918920
fully-qualified name of the device, as shown in the following example:
@@ -924,10 +926,10 @@ $ docker run --device=vendor.com/class=device-name --rm -it ubuntu
924926
This starts an `ubuntu` container with access to the specified CDI device,
925927
`vendor.com/class=device-name`, assuming that:
926928

927-
- A valid CDI specification (JSON file) for the requested device is available
928-
on the system running the daemon, in one of the configured CDI specification
929-
directories.
930-
- The CDI feature has been enabled on the daemon side, see [Enable CDI
929+
- A valid CDI specification (JSON or YAML file) for the requested device is
930+
available on the system running the daemon, in one of the configured CDI
931+
specification directories.
932+
- The CDI feature has been enabled in the daemon; see [Enable CDI
931933
devices](https://docs.docker.com/reference/cli/dockerd/#enable-cdi-devices).
932934

933935
### <a name="attach"></a> Attach to STDIN/STDOUT/STDERR (-a, --attach)

0 commit comments

Comments
 (0)