specs

package module

v0.0.0-...-61e4b15 Latest Latest Go to latest Published: Oct 31, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation ¶

Index ¶

Constants
type ContainerEdits
type Device
type DeviceNode
- func (d *DeviceNode) ToOCI() spec.LinuxDevice
type Hook
- func (h *Hook) ToOCI() spec.Hook
type Mount
- func (m *Mount) ToOCI() spec.Mount
type Spec

Constants ¶

const CurrentVersion = "0.6.0"

CurrentVersion is the current version of the Spec.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ContainerEdits ¶

type ContainerEdits struct {
	Env         []string      `json:"env,omitempty"`
	DeviceNodes []*DeviceNode `json:"deviceNodes,omitempty"`
	Hooks       []*Hook       `json:"hooks,omitempty"`
	Mounts      []*Mount      `json:"mounts,omitempty"`
}

ContainerEdits are edits a container runtime must make to the OCI spec to expose the device.

type Device ¶

type Device struct {
	Name string `json:"name"`
	// Annotations add meta information per device. Note these are CDI-specific and do not affect container metadata.
	Annotations    map[string]string `json:"annotations,omitempty"`
	ContainerEdits ContainerEdits    `json:"containerEdits"`
}

Device is a "Device" a container runtime can add to a container

type DeviceNode ¶

type DeviceNode struct {
	Path        string       `json:"path"`
	HostPath    string       `json:"hostPath,omitempty"`
	Type        string       `json:"type,omitempty"`
	Major       int64        `json:"major,omitempty"`
	Minor       int64        `json:"minor,omitempty"`
	FileMode    *os.FileMode `json:"fileMode,omitempty"`
	Permissions string       `json:"permissions,omitempty"`
	UID         *uint32      `json:"uid,omitempty"`
	GID         *uint32      `json:"gid,omitempty"`
}

DeviceNode represents a device node that needs to be added to the OCI spec.

func (*DeviceNode) ToOCI ¶

func (d *DeviceNode) ToOCI() spec.LinuxDevice

ToOCI returns the opencontainers runtime Spec LinuxDevice for this DeviceNode.

type Hook ¶

type Hook struct {
	HookName string   `json:"hookName"`
	Path     string   `json:"path"`
	Args     []string `json:"args,omitempty"`
	Env      []string `json:"env,omitempty"`
	Timeout  *int     `json:"timeout,omitempty"`
}

Hook represents a hook that needs to be added to the OCI spec.

func (*Hook) ToOCI ¶

func (h *Hook) ToOCI() spec.Hook

ToOCI returns the opencontainers runtime Spec Hook for this Hook.

type Mount ¶

type Mount struct {
	HostPath      string   `json:"hostPath"`
	ContainerPath string   `json:"containerPath"`
	Options       []string `json:"options,omitempty"`
	Type          string   `json:"type,omitempty"`
}

Mount represents a mount that needs to be added to the OCI spec.

func (*Mount) ToOCI ¶

func (m *Mount) ToOCI() spec.Mount

ToOCI returns the opencontainers runtime Spec Mount for this Mount.

type Spec ¶

type Spec struct {
	Version string `json:"cdiVersion"`
	Kind    string `json:"kind"`
	// Annotations add meta information per CDI spec. Note these are CDI-specific and do not affect container metadata.
	Annotations    map[string]string `json:"annotations,omitempty"`
	Devices        []Device          `json:"devices"`
	ContainerEdits ContainerEdits    `json:"containerEdits,omitempty"`
}

Spec is the base configuration for CDI

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL