image

Documentation

Index

• Variables
• func IsPrivileged(s *specs.Spec) bool
• type CUDA
  • func New(opt ...Option) (CUDA, error)
  • func NewCUDAImageFromEnv(env []string) (CUDA, error)
  • func NewCUDAImageFromSpec(spec *specs.Spec) (CUDA, error)
  • func (i CUDA) CDIDevicesFromMounts() []string
  • func (i CUDA) DevicesFromEnvvars(envVars ...string) VisibleDevices
  • func (i CUDA) DevicesFromMounts() []string
  • func (i CUDA) GetDriverCapabilities() DriverCapabilities
  • func (i CUDA) GetRequirements() ([]string, error)
  • func (i CUDA) Getenv(key string) string
  • func (i CUDA) HasDisableRequire() bool
  • func (i CUDA) HasEnvvar(key string) bool
  • func (i CUDA) IsLegacy() bool
  • func (i CUDA) OnlyFullyQualifiedCDIDevices() bool
• type DriverCapabilities
  • func NewDriverCapabilities(capabilities ...string) DriverCapabilities
  • func (c DriverCapabilities) Any(capabilities ...DriverCapability) bool
  • func (c DriverCapabilities) Has(capability DriverCapability) bool
  • func (c DriverCapabilities) Intersection(s2 DriverCapabilities) DriverCapabilities
  • func (c DriverCapabilities) IsAll() bool
  • func (c DriverCapabilities) IsSuperset(s2 DriverCapabilities) bool
  • func (c DriverCapabilities) List() []string
  • func (c DriverCapabilities) String() string
• type DriverCapability
• type Option
  • func WithDisableRequire(disableRequire bool) Option
  • func WithEnv(env []string) Option
  • func WithEnvMap(env map[string]string) Option
  • func WithMounts(mounts []specs.Mount) Option
• type VisibleDevices
  • func NewVisibleDevices(envvars ...string) VisibleDevices

Variables

var (

	// DefaultDriverCapabilities sets the value for driver capabilities if no value is set.
	DefaultDriverCapabilities = NewDriverCapabilities("utility,compute")
	// SupportedDriverCapabilities defines the set of all supported driver capabilities.
	SupportedDriverCapabilities = NewDriverCapabilities("compute,compat32,graphics,utility,video,display,ngx")
)

Functions

func IsPrivileged

func IsPrivileged(s *specs.Spec) bool

IsPrivileged returns true if the container is a privileged container.

Types

type CUDA

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

CUDA represents a CUDA image that can be used for GPU computing. This wraps a map of environment variable to values that can be used to perform lookups such as requirements.

func New

func New(opt ...Option) (CUDA, error)

New creates a new CUDA image from the input options.

func NewCUDAImageFromEnv

func NewCUDAImageFromEnv(env []string) (CUDA, error)

NewCUDAImageFromEnv creates a CUDA image from the input environment. The environment is a list of strings of the form ENVAR=VALUE.

func NewCUDAImageFromSpec

func NewCUDAImageFromSpec(spec *specs.Spec) (CUDA, error)

NewCUDAImageFromSpec creates a CUDA image from the input OCI runtime spec. The process environment is read (if present) to construc the CUDA Image.

func (CUDA) CDIDevicesFromMounts

func (i CUDA) CDIDevicesFromMounts() []string

CDIDevicesFromMounts returns a list of CDI devices specified as mounts on the image.

func (CUDA) DevicesFromEnvvars

func (i CUDA) DevicesFromEnvvars(envVars ...string) VisibleDevices

DevicesFromEnvvars returns the devices requested by the image through environment variables

func (CUDA) DevicesFromMounts

func (i CUDA) DevicesFromMounts() []string

DevicesFromMounts returns a list of device specified as mounts. TODO: This should be merged with getDevicesFromMounts used in the NVIDIA Container Runtime

func (CUDA) GetDriverCapabilities

func (i CUDA) GetDriverCapabilities() DriverCapabilities

GetDriverCapabilities returns the requested driver capabilities.

func (CUDA) GetRequirements

func (i CUDA) GetRequirements() ([]string, error)

GetRequirements returns the requirements from all NVIDIA_REQUIRE_ environment variables.

func (CUDA) Getenv

func (i CUDA) Getenv(key string) string

Getenv returns the value of the specified environment variable. If the environment variable is not specified, an empty string is returned.

func (CUDA) HasDisableRequire

func (i CUDA) HasDisableRequire() bool

HasDisableRequire checks for the value of the NVIDIA_DISABLE_REQUIRE. If set to a valid (true) boolean value this can be used to disable the requirement checks

func (CUDA) HasEnvvar

func (i CUDA) HasEnvvar(key string) bool

HasEnvvar checks whether the specified envvar is defined in the image.

func (CUDA) IsLegacy

func (i CUDA) IsLegacy() bool

IsLegacy returns whether the associated CUDA image is a "legacy" image. An image is considered legacy if it has a CUDA_VERSION environment variable defined and no NVIDIA_REQUIRE_CUDA environment variable defined.

func (CUDA) OnlyFullyQualifiedCDIDevices

func (i CUDA) OnlyFullyQualifiedCDIDevices() bool

OnlyFullyQualifiedCDIDevices returns true if all devices requested in the image are requested as CDI devices/

type DriverCapabilities

type DriverCapabilities map[DriverCapability]bool

DriverCapabilities represents the NVIDIA_DRIVER_CAPABILITIES set for the specified image.

func NewDriverCapabilities

func NewDriverCapabilities(capabilities ...string) DriverCapabilities

NewDriverCapabilities creates a set of driver capabilities from the specified capabilities

func (DriverCapabilities) Any

func (c DriverCapabilities) Any(capabilities ...DriverCapability) bool

Any checks whether any of the specified capabilities are set

func (DriverCapabilities) Has

func (c DriverCapabilities) Has(capability DriverCapability) bool

Has check whether the specified capability is selected.

func (DriverCapabilities) Intersection

func (c DriverCapabilities) Intersection(s2 DriverCapabilities) DriverCapabilities

Intersection returns a new set which includes the item in BOTH d and s2. For example: d = {a1, a2} s2 = {a2, a3} s1.Intersection(s2) = {a2}

func (DriverCapabilities) IsAll

func (c DriverCapabilities) IsAll() bool

IsAll indicates whether the set of capabilities is `all`

func (DriverCapabilities) IsSuperset

func (c DriverCapabilities) IsSuperset(s2 DriverCapabilities) bool

IsSuperset returns true if and only if d is a superset of s2.

func (DriverCapabilities) List

func (c DriverCapabilities) List() []string

List returns the list of driver capabilities. The list is sorted.

func (DriverCapabilities) String

func (c DriverCapabilities) String() string

String returns the string repesentation of the driver capabilities.

type DriverCapability

type DriverCapability string

DriverCapability represents the possible values of NVIDIA_DRIVER_CAPABILITIES

const (
	DriverCapabilityAll      DriverCapability = "all"
	DriverCapabilityNone     DriverCapability = "none"
	DriverCapabilityCompat32 DriverCapability = "compat32"
	DriverCapabilityCompute  DriverCapability = "compute"
	DriverCapabilityDisplay  DriverCapability = "display"
	DriverCapabilityGraphics DriverCapability = "graphics"
	DriverCapabilityNgx      DriverCapability = "ngx"
	DriverCapabilityUtility  DriverCapability = "utility"
	DriverCapabilityVideo    DriverCapability = "video"
)

Constants for the supported driver capabilities

type Option

type Option func(*builder) error

Option is a functional option for creating a CUDA image.

func WithDisableRequire

func WithDisableRequire(disableRequire bool) Option

WithDisableRequire sets the disable require option.

func WithEnv

func WithEnv(env []string) Option

WithEnv sets the environment variables to use when creating the CUDA image. Note that this also overwrites the values set with WithEnvMap.

func WithEnvMap

func WithEnvMap(env map[string]string) Option

WithEnvMap sets the environment variable map to use when creating the CUDA image. Note that this also overwrites the values set with WithEnv.

func WithMounts

func WithMounts(mounts []specs.Mount) Option

WithMounts sets the mounts associated with the CUDA image.

type VisibleDevices

type VisibleDevices interface {
	List() []string
	Has(string) bool
}

VisibleDevices represents the devices selected in a container image through the NVIDIA_VISIBLE_DEVICES or other environment variables

func NewVisibleDevices

func NewVisibleDevices(envvars ...string) VisibleDevices

NewVisibleDevices creates a VisibleDevices based on the value of the specified envvar.