diff options
author | Evan Lezar <elezar@nvidia.com> | 2022-05-03 17:24:15 +0200 |
---|---|---|
committer | Evan Lezar <elezar@nvidia.com> | 2022-08-10 10:49:42 +0200 |
commit | 658960c97b0dca06cb81472bc9bd7ff820fc56cf (patch) | |
tree | 0bfd231b688acf3c32ae6dae07ef22b9a26ca832 /vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go | |
parent | c33dc90ace724f920c14e41769ce237f5c5d14ec (diff) | |
download | podman-658960c97b0dca06cb81472bc9bd7ff820fc56cf.tar.gz podman-658960c97b0dca06cb81472bc9bd7ff820fc56cf.tar.bz2 podman-658960c97b0dca06cb81472bc9bd7ff820fc56cf.zip |
build(deps) bump CDI dependency from 0.4.0 to 0.5.0
bump github.com/container-orchestrated-devices/container-device-interface from 0.4.0 to 0.5.0
This requires that the cdi.Registry be instantiated with AutoRefresh disabled for CLI clients.
[NO NEW TESTS NEEDED]
Signed-off-by: Evan Lezar <elezar@nvidia.com>
Diffstat (limited to 'vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go')
-rw-r--r-- | vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go b/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go index a9017259c..847e51254 100644 --- a/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go +++ b/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go @@ -67,6 +67,21 @@ // // Cache Refresh // +// By default the CDI Spec cache monitors the configured Spec directories +// and automatically refreshes itself when necessary. This behavior can be +// disabled using the WithAutoRefresh(false) option. +// +// Failure to set up monitoring for a Spec directory causes the directory to +// get ignored and an error to be recorded among the Spec directory errors. +// These errors can be queried using the GetSpecDirErrors() function. If the +// error condition is transient, for instance a missing directory which later +// gets created, the corresponding error will be removed once the condition +// is over. +// +// With auto-refresh enabled injecting any CDI devices can be done without +// an explicit call to Refresh(), using a code snippet similar to the +// following: +// // In a runtime implementation one typically wants to make sure the // CDI Spec cache is up to date before performing device injection. // A code snippet similar to the following accmplishes that: @@ -146,5 +161,5 @@ // schema names which switch the used schema to the in-repo validation // schema embedded into the binary or the now default no-op schema // correspondingly. Other names are interpreted as the path to the actual -/// validation schema to load and use. +// validation schema to load and use. package cdi |