# Packages
No description provided by the author
# Functions
AnnotationKey returns a unique annotation key for an device allocation by a K8s device plugin.
AnnotationValue returns an annotation value for the given devices.
Configure applies options to the default CDI cache.
GenerateNameForSpec generates a name for the given Spec using GenerateSpecName with the vendor and class taken from the Spec.
GenerateNameForTransientSpec generates a name for the given transient Spec using GenerateTransientSpecName with the vendor and class taken from the Spec.
GenerateSpecName generates a vendor+class scoped Spec file name.
GenerateTransientSpecName generates a vendor+class scoped transient Spec file name.
GetDefaultCache returns the default CDI cache instance.
GetErrors returns all errors encountered during the last refresh of the default CDI cache instance.
GetRegistry returns the CDI registry.
InjectDevices injects the given qualified devices to the given OCI Spec.
IsQualifiedName tests if a device name is qualified.
MinimumRequiredVersion determines the minimum spec version for the input spec.
NewCache creates a new CDI Cache.
ParseAnnotations parses annotations for CDI device injection requests.
ParseDevice tries to split a device name into vendor, class, and name.
ParseQualifiedName splits a qualified name into device vendor, class, and name.
ParseQualifier splits a device qualifier into vendor and class.
ParseSpec parses CDI Spec data into a raw CDI Spec.
QualifiedName returns the qualified name for a device.
ReadSpec reads the given CDI Spec file.
Refresh explicitly refreshes the default CDI cache instance.
SetSpecValidator sets a CDI Spec validator function.
UpdateAnnotations updates annotations with a plugin-specific CDI device injection request for the given devices.
ValidateClassName checks the validity of class name.
ValidateDeviceName checks the validity of a device name.
ValidateEnv validates the given environment variables.
ValidateIntelRdt validates the IntelRdt configuration.
ValidateVendorName checks the validity of a vendor name.
WithAutoRefresh returns an option to control automatic Cache refresh.
WithSpecDirs returns an option to override the CDI Spec directories.
# Constants
AnnotationPrefix is the prefix for CDI container annotation keys.
CreateContainerHook is the name of the OCI "createContainer" hook.
CreateRuntimeHook is the name of the OCI "createRuntime" hook.
CurrentVersion is the current version of the CDI Spec.
DefaultDynamicDir is the default directory for generated CDI Specs.
DefaultStaticDir is the default directory for static CDI Specs.
PoststartHook is the name of the OCI "poststart" hook.
PoststopHook is the name of the OCI "poststop" hook.
PrestartHook is the name of the OCI "prestart" hook.
StartContainerHook is the name of the OCI "startContainer" hook.
# Variables
DefaultSpecDirs is the default Spec directory configuration.
ErrStopScan can be returned from a ScanSpecFunc to stop the scan.
# Structs
Cache stores CDI Specs loaded from Spec directories.
ContainerEdits represent updates to be applied to an OCI Spec.
Device represents a CDI device of a Spec.
DeviceNode is a CDI Spec DeviceNode wrapper, used for validating DeviceNodes.
Hook is a CDI Spec Hook wrapper, used for validating hooks.
IntelRdt is a CDI IntelRdt wrapper.
Mount is a CDI Mount wrapper, used for validating mounts.
Spec represents a single CDI Spec.
# Interfaces
Registry keeps a cache of all CDI Specs installed or generated on the host.
RegistryDeviceDB is the registry interface for querying devices.
RegistryRefresher is the registry interface for refreshing the cache of CDI Specs and devices.
RegistryResolver is the registry interface for injecting CDI devices into an OCI Spec.
RegistrySpecDB is the registry interface for querying CDI Specs.
# Type aliases
Option is an option to change some aspect of default CDI behavior.