discover

package
v1.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 21, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// AllHooks is a special hook name that allows all hooks to be matched.
	AllHooks = HookName("all")

	// A ChmodHook is used to set the file mode of the specified paths.
	// Deprecated: The chmod hook is deprecated and will be removed in a future release.
	ChmodHook = HookName("chmod")
	// A CreateSymlinksHook is used to create symlinks in the container.
	CreateSymlinksHook = HookName("create-symlinks")
	// DisableDeviceNodeModificationHook refers to the hook used to ensure that
	// device nodes are not created by libnvidia-ml.so or nvidia-smi in a
	// container.
	// Added in v1.17.8
	DisableDeviceNodeModificationHook = HookName("disable-device-node-modification")
	// An EnableCudaCompatHook is used to enabled CUDA Forward Compatibility.
	// Added in v1.17.5
	EnableCudaCompatHook = HookName("enable-cuda-compat")
	// An UpdateLDCacheHook is the hook used to update the ldcache in the
	// container. This allows injected libraries to be discoverable.
	UpdateLDCacheHook = HookName("update-ldcache")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Device 

type Device struct {
	HostPath string
	Path     string
}

Device represents a discovered character device.

type Discover 

type Discover interface {
	Devices() ([]Device, error)
	EnvVars() ([]EnvVar, error)
	Mounts() ([]Mount, error)
	Hooks() ([]Hook, error)
}

Discover defines an interface for discovering the devices, mounts, and hooks available on a system

func FirstValid added in v1.17.0 

func FirstValid(discoverers ...Discover) Discover

FirstValid returns a discoverer that returns the first non-error result from a list of discoverers.

func Merge added in v1.11.0 

func Merge(discoverers ...Discover) Discover

Merge creates a discoverer that is the composite of a list of discoverers.

func NewCUDACompatHookDiscoverer added in v1.17.5 

func NewCUDACompatHookDiscoverer(logger logger.Interface, hookCreator HookCreator, version string) Discover

NewCUDACompatHookDiscoverer creates a discoverer for a enable-cuda-compat hook. This hook is responsible for setting up CUDA compatibility in the container and depends on the host driver version.

func NewCharDeviceDiscoverer added in v1.11.0 

func NewCharDeviceDiscoverer(logger logger.Interface, devRoot string, devices []string) Discover

NewCharDeviceDiscoverer creates a discoverer which locates the specified set of device nodes.

func NewDRMNodesDiscoverer added in v1.15.0 

func NewDRMNodesDiscoverer(logger logger.Interface, devices image.VisibleDevices, devRoot string, hookCreator HookCreator) (Discover, error)

NewDRMNodesDiscoverer returns a discoverer for the DRM device nodes associated with the specified visible devices.

TODO: The logic for creating DRM devices should be consolidated between this and the logic for generating CDI specs for a single device. This is only used when applying OCI spec modifications to an incoming spec in "legacy" mode.

func NewGDRCopyDiscoverer added in v1.15.0 

func NewGDRCopyDiscoverer(logger logger.Interface, devRoot string) (Discover, error)

func NewGDSDiscoverer added in v1.11.0 

func NewGDSDiscoverer(logger logger.Interface, driverRoot string, devRoot string) (Discover, error)

NewGDSDiscoverer creates a discoverer for GPUDirect Storage devices and mounts.

func NewGraphicsMountsDiscoverer added in v1.12.0 

func NewGraphicsMountsDiscoverer(logger logger.Interface, driver *root.Driver, hookCreator HookCreator) (Discover, error)

NewGraphicsMountsDiscoverer creates a discoverer for the mounts required by graphics tools such as vulkan.

func NewIPCDiscoverer added in v1.13.0 

func NewIPCDiscoverer(logger logger.Interface, driverRoot string) (Discover, error)

NewIPCDiscoverer creats a discoverer for NVIDIA IPC sockets.

func NewLDCacheUpdateHook 

func NewLDCacheUpdateHook(logger logger.Interface, mounts Discover, hookCreator HookCreator, ldconfigPath string) (Discover, error)

NewLDCacheUpdateHook creates a discoverer that updates the ldcache for the specified mounts. A logger can also be specified

func NewMOFEDDiscoverer added in v1.11.0 

func NewMOFEDDiscoverer(logger logger.Interface, devRoot string) (Discover, error)

NewMOFEDDiscoverer creates a discoverer for MOFED devices.

func NewMounts added in v1.11.0 

func NewMounts(logger logger.Interface, lookup lookup.Locator, root string, required []string) Discover

NewMounts creates a discoverer for the required mounts using the specified locator.

func NewNvSwitchDiscoverer added in v1.15.0 

func NewNvSwitchDiscoverer(logger logger.Interface, devRoot string) (Discover, error)

NewNvSwitchDiscoverer creates a discoverer for NVSWITCH devices.

func WithCache added in v1.17.0 

func WithCache(d Discover) Discover

WithCache decorates the specified disoverer with a cache. 

func WithDriverDotSoSymlinks(logger logger.Interface, mounts Discover, version string, hookCreator HookCreator) Discover

WithDriverDotSoSymlinks decorates the provided discoverer. A hook is added that checks for specific driver symlinks that need to be created.

type DiscoverMock 

type DiscoverMock struct {
	// DevicesFunc mocks the Devices method.
	DevicesFunc func() ([]Device, error)

	// EnvVarsFunc mocks the EnvVars method.
	EnvVarsFunc func() ([]EnvVar, error)

	// HooksFunc mocks the Hooks method.
	HooksFunc func() ([]Hook, error)

	// MountsFunc mocks the Mounts method.
	MountsFunc func() ([]Mount, error)
	// contains filtered or unexported fields
}

DiscoverMock is a mock implementation of Discover. 

func TestSomethingThatUsesDiscover(t *testing.T) {

	// make and configure a mocked Discover
	mockedDiscover := &DiscoverMock{
		DevicesFunc: func() ([]Device, error) {
			panic("mock out the Devices method")
		},
		EnvVarsFunc: func() ([]EnvVar, error) {
			panic("mock out the EnvVars method")
		},
		HooksFunc: func() ([]Hook, error) {
			panic("mock out the Hooks method")
		},
		MountsFunc: func() ([]Mount, error) {
			panic("mock out the Mounts method")
		},
	}

	// use mockedDiscover in code that requires Discover
	// and then make assertions.

}

func (*DiscoverMock) Devices 

func (mock *DiscoverMock) Devices() ([]Device, error)

Devices calls DevicesFunc.

func (*DiscoverMock) DevicesCalls 

func (mock *DiscoverMock) DevicesCalls() []struct {
}

DevicesCalls gets all the calls that were made to Devices. Check the length with: 

len(mockedDiscover.DevicesCalls())

func (*DiscoverMock) EnvVars added in v1.18.0 

func (mock *DiscoverMock) EnvVars() ([]EnvVar, error)

EnvVars calls EnvVarsFunc.

func (*DiscoverMock) EnvVarsCalls added in v1.18.0 

func (mock *DiscoverMock) EnvVarsCalls() []struct {
}

EnvVarsCalls gets all the calls that were made to EnvVars. Check the length with: 

len(mockedDiscover.EnvVarsCalls())

func (*DiscoverMock) Hooks 

func (mock *DiscoverMock) Hooks() ([]Hook, error)

Hooks calls HooksFunc.

func (*DiscoverMock) HooksCalls 

func (mock *DiscoverMock) HooksCalls() []struct {
}

HooksCalls gets all the calls that were made to Hooks. Check the length with: 

len(mockedDiscover.HooksCalls())

func (*DiscoverMock) Mounts 

func (mock *DiscoverMock) Mounts() ([]Mount, error)

Mounts calls MountsFunc.

func (*DiscoverMock) MountsCalls 

func (mock *DiscoverMock) MountsCalls() []struct {
}

MountsCalls gets all the calls that were made to Mounts. Check the length with: 

len(mockedDiscover.MountsCalls())

type EnvVar added in v1.18.0 

type EnvVar struct {
	Name  string
	Value string
}

EnvVar represents a discovered environment variable.

func (EnvVar) Devices added in v1.18.0 

func (e EnvVar) Devices() ([]Device, error)

Devices returns an empty list of devices for a EnvVar discoverer.

func (EnvVar) EnvVars added in v1.18.0 

func (e EnvVar) EnvVars() ([]EnvVar, error)

EnvVars returns an empty list of envs for a EnvVar discoverer.

func (EnvVar) Hooks added in v1.18.0 

func (e EnvVar) Hooks() ([]Hook, error)

Hooks allows the Hook type to also implement the Discoverer interface. It returns a single hook

func (EnvVar) Mounts added in v1.18.0 

func (e EnvVar) Mounts() ([]Mount, error)

Mounts returns an empty list of mounts for a EnvVar discoverer.

type Filter added in v1.12.0 

type Filter interface {
	DeviceIsSelected(device Device) bool
}

Filter defines an interface for filtering discovered entities

type Hook 

type Hook struct {
	Lifecycle string
	Path      string
	Args      []string
	Env       []string
}

Hook represents a discovered hook.

func (*Hook) Devices added in v1.13.0 

func (h *Hook) Devices() ([]Device, error)

Devices returns an empty list of devices for a Hook discoverer.

func (*Hook) EnvVars added in v1.18.0 

func (h *Hook) EnvVars() ([]EnvVar, error)

EnvVars returns an empty list of envs for a Hook discoverer.

func (*Hook) Hooks added in v1.13.0 

func (h *Hook) Hooks() ([]Hook, error)

Hooks allows the Hook type to also implement the Discoverer interface. It returns a single hook

func (*Hook) Mounts added in v1.13.0 

func (h *Hook) Mounts() ([]Mount, error)

Mounts returns an empty list of mounts for a Hook discoverer.

type HookCreator added in v1.18.0 

type HookCreator interface {
	Create(HookName, ...string) *Hook
}

A HookCreator defines an interface for creating discover hooks.

func NewHookCreator added in v1.18.0 

func NewHookCreator(opts ...Option) HookCreator

type HookName added in v1.18.0 

type HookName string

A HookName represents a supported CDI hooks.

type Mount 

type Mount struct {
	HostPath string
	Path     string
	Options  []string
}

Mount represents a discovered mount.

type None 

type None struct{}

None is a null discoverer that returns an empty list of devices and mounts.

func (None) Devices 

func (e None) Devices() ([]Device, error)

Devices returns an empty list of devices

func (None) EnvVars added in v1.18.0 

func (e None) EnvVars() ([]EnvVar, error)

EnvVars returns an empty list of devices

func (None) Hooks 

func (e None) Hooks() ([]Hook, error)

Hooks returns an empty list of hooks

func (None) Mounts 

func (e None) Mounts() ([]Mount, error)

Mounts returns an empty list of mounts

type Option added in v1.18.0 

type Option func(*hookCreatorOptions)

func WithDebugLogging added in v1.18.0 

func WithDebugLogging(debugLogging bool) Option

func WithDisabledHooks added in v1.18.0 

func WithDisabledHooks(hooks ...HookName) Option

WithDisabledHooks explicitly disables the specified hooks. This can be specified multiple times.

func WithEnabledHooks added in v1.18.0 

func WithEnabledHooks(hooks ...HookName) Option

WithEnabledHooks explicitly enables the specified hooks. This is useful for enabling hooks that are disabled by default.

func WithNVIDIACDIHookPath added in v1.18.0 

func WithNVIDIACDIHookPath(nvidiaCDIHookPath string) Option

WithNVIDIACDIHookPath sets the path to the nvidia-cdi-hook binary. 

type Symlink struct {
	// contains filtered or unexported fields
}

func (*Symlink) String added in v1.18.0 

func (s *Symlink) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.