Documentation ¶
Index ¶
- func RegisterDevicePluginServer(s *grpc.Server, srv DevicePluginServer)
- type ContainerReservation
- func (*ContainerReservation) Descriptor() ([]byte, []int)
- func (m *ContainerReservation) GetDevices() []*DeviceSpec
- func (m *ContainerReservation) GetEnvs() map[string]string
- func (m *ContainerReservation) GetMounts() []*Mount
- func (*ContainerReservation) ProtoMessage()
- func (m *ContainerReservation) Reset()
- func (m *ContainerReservation) String() string
- func (m *ContainerReservation) XXX_DiscardUnknown()
- func (m *ContainerReservation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ContainerReservation) XXX_Merge(src proto.Message)
- func (m *ContainerReservation) XXX_Size() int
- func (m *ContainerReservation) XXX_Unmarshal(b []byte) error
- type DetectedDevice
- func (*DetectedDevice) Descriptor() ([]byte, []int)
- func (m *DetectedDevice) GetHealthDescription() string
- func (m *DetectedDevice) GetHealthy() bool
- func (m *DetectedDevice) GetHwLocality() *DeviceLocality
- func (m *DetectedDevice) GetID() string
- func (*DetectedDevice) ProtoMessage()
- func (m *DetectedDevice) Reset()
- func (m *DetectedDevice) String() string
- func (m *DetectedDevice) XXX_DiscardUnknown()
- func (m *DetectedDevice) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DetectedDevice) XXX_Merge(src proto.Message)
- func (m *DetectedDevice) XXX_Size() int
- func (m *DetectedDevice) XXX_Unmarshal(b []byte) error
- type DeviceGroup
- func (*DeviceGroup) Descriptor() ([]byte, []int)
- func (m *DeviceGroup) GetAttributes() map[string]*proto1.Attribute
- func (m *DeviceGroup) GetDeviceName() string
- func (m *DeviceGroup) GetDeviceType() string
- func (m *DeviceGroup) GetDevices() []*DetectedDevice
- func (m *DeviceGroup) GetVendor() string
- func (*DeviceGroup) ProtoMessage()
- func (m *DeviceGroup) Reset()
- func (m *DeviceGroup) String() string
- func (m *DeviceGroup) XXX_DiscardUnknown()
- func (m *DeviceGroup) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DeviceGroup) XXX_Merge(src proto.Message)
- func (m *DeviceGroup) XXX_Size() int
- func (m *DeviceGroup) XXX_Unmarshal(b []byte) error
- type DeviceGroupStats
- func (*DeviceGroupStats) Descriptor() ([]byte, []int)
- func (m *DeviceGroupStats) GetInstanceStats() map[string]*DeviceStats
- func (m *DeviceGroupStats) GetName() string
- func (m *DeviceGroupStats) GetType() string
- func (m *DeviceGroupStats) GetVendor() string
- func (*DeviceGroupStats) ProtoMessage()
- func (m *DeviceGroupStats) Reset()
- func (m *DeviceGroupStats) String() string
- func (m *DeviceGroupStats) XXX_DiscardUnknown()
- func (m *DeviceGroupStats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DeviceGroupStats) XXX_Merge(src proto.Message)
- func (m *DeviceGroupStats) XXX_Size() int
- func (m *DeviceGroupStats) XXX_Unmarshal(b []byte) error
- type DeviceLocality
- func (*DeviceLocality) Descriptor() ([]byte, []int)
- func (m *DeviceLocality) GetPciBusId() string
- func (*DeviceLocality) ProtoMessage()
- func (m *DeviceLocality) Reset()
- func (m *DeviceLocality) String() string
- func (m *DeviceLocality) XXX_DiscardUnknown()
- func (m *DeviceLocality) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DeviceLocality) XXX_Merge(src proto.Message)
- func (m *DeviceLocality) XXX_Size() int
- func (m *DeviceLocality) XXX_Unmarshal(b []byte) error
- type DevicePluginClient
- type DevicePluginServer
- type DevicePlugin_FingerprintClient
- type DevicePlugin_FingerprintServer
- type DevicePlugin_StatsClient
- type DevicePlugin_StatsServer
- type DeviceSpec
- func (*DeviceSpec) Descriptor() ([]byte, []int)
- func (m *DeviceSpec) GetHostPath() string
- func (m *DeviceSpec) GetPermissions() string
- func (m *DeviceSpec) GetTaskPath() string
- func (*DeviceSpec) ProtoMessage()
- func (m *DeviceSpec) Reset()
- func (m *DeviceSpec) String() string
- func (m *DeviceSpec) XXX_DiscardUnknown()
- func (m *DeviceSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DeviceSpec) XXX_Merge(src proto.Message)
- func (m *DeviceSpec) XXX_Size() int
- func (m *DeviceSpec) XXX_Unmarshal(b []byte) error
- type DeviceStats
- func (*DeviceStats) Descriptor() ([]byte, []int)
- func (m *DeviceStats) GetStats() *proto1.StatObject
- func (m *DeviceStats) GetSummary() *proto1.StatValue
- func (m *DeviceStats) GetTimestamp() *timestamp.Timestamp
- func (*DeviceStats) ProtoMessage()
- func (m *DeviceStats) Reset()
- func (m *DeviceStats) String() string
- func (m *DeviceStats) XXX_DiscardUnknown()
- func (m *DeviceStats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DeviceStats) XXX_Merge(src proto.Message)
- func (m *DeviceStats) XXX_Size() int
- func (m *DeviceStats) XXX_Unmarshal(b []byte) error
- type FingerprintRequest
- func (*FingerprintRequest) Descriptor() ([]byte, []int)
- func (*FingerprintRequest) ProtoMessage()
- func (m *FingerprintRequest) Reset()
- func (m *FingerprintRequest) String() string
- func (m *FingerprintRequest) XXX_DiscardUnknown()
- func (m *FingerprintRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *FingerprintRequest) XXX_Merge(src proto.Message)
- func (m *FingerprintRequest) XXX_Size() int
- func (m *FingerprintRequest) XXX_Unmarshal(b []byte) error
- type FingerprintResponse
- func (*FingerprintResponse) Descriptor() ([]byte, []int)
- func (m *FingerprintResponse) GetDeviceGroup() []*DeviceGroup
- func (*FingerprintResponse) ProtoMessage()
- func (m *FingerprintResponse) Reset()
- func (m *FingerprintResponse) String() string
- func (m *FingerprintResponse) XXX_DiscardUnknown()
- func (m *FingerprintResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *FingerprintResponse) XXX_Merge(src proto.Message)
- func (m *FingerprintResponse) XXX_Size() int
- func (m *FingerprintResponse) XXX_Unmarshal(b []byte) error
- type Mount
- func (*Mount) Descriptor() ([]byte, []int)
- func (m *Mount) GetHostPath() string
- func (m *Mount) GetReadOnly() bool
- func (m *Mount) GetTaskPath() string
- func (*Mount) ProtoMessage()
- func (m *Mount) Reset()
- func (m *Mount) String() string
- func (m *Mount) XXX_DiscardUnknown()
- func (m *Mount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Mount) XXX_Merge(src proto.Message)
- func (m *Mount) XXX_Size() int
- func (m *Mount) XXX_Unmarshal(b []byte) error
- type ReserveRequest
- func (*ReserveRequest) Descriptor() ([]byte, []int)
- func (m *ReserveRequest) GetDeviceIds() []string
- func (*ReserveRequest) ProtoMessage()
- func (m *ReserveRequest) Reset()
- func (m *ReserveRequest) String() string
- func (m *ReserveRequest) XXX_DiscardUnknown()
- func (m *ReserveRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ReserveRequest) XXX_Merge(src proto.Message)
- func (m *ReserveRequest) XXX_Size() int
- func (m *ReserveRequest) XXX_Unmarshal(b []byte) error
- type ReserveResponse
- func (*ReserveResponse) Descriptor() ([]byte, []int)
- func (m *ReserveResponse) GetContainerRes() *ContainerReservation
- func (*ReserveResponse) ProtoMessage()
- func (m *ReserveResponse) Reset()
- func (m *ReserveResponse) String() string
- func (m *ReserveResponse) XXX_DiscardUnknown()
- func (m *ReserveResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ReserveResponse) XXX_Merge(src proto.Message)
- func (m *ReserveResponse) XXX_Size() int
- func (m *ReserveResponse) XXX_Unmarshal(b []byte) error
- type StatsRequest
- func (*StatsRequest) Descriptor() ([]byte, []int)
- func (m *StatsRequest) GetCollectionInterval() *duration.Duration
- func (*StatsRequest) ProtoMessage()
- func (m *StatsRequest) Reset()
- func (m *StatsRequest) String() string
- func (m *StatsRequest) XXX_DiscardUnknown()
- func (m *StatsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *StatsRequest) XXX_Merge(src proto.Message)
- func (m *StatsRequest) XXX_Size() int
- func (m *StatsRequest) XXX_Unmarshal(b []byte) error
- type StatsResponse
- func (*StatsResponse) Descriptor() ([]byte, []int)
- func (m *StatsResponse) GetGroups() []*DeviceGroupStats
- func (*StatsResponse) ProtoMessage()
- func (m *StatsResponse) Reset()
- func (m *StatsResponse) String() string
- func (m *StatsResponse) XXX_DiscardUnknown()
- func (m *StatsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *StatsResponse) XXX_Merge(src proto.Message)
- func (m *StatsResponse) XXX_Size() int
- func (m *StatsResponse) XXX_Unmarshal(b []byte) error
- type UnimplementedDevicePluginServer
- func (*UnimplementedDevicePluginServer) Fingerprint(req *FingerprintRequest, srv DevicePlugin_FingerprintServer) error
- func (*UnimplementedDevicePluginServer) Reserve(ctx context.Context, req *ReserveRequest) (*ReserveResponse, error)
- func (*UnimplementedDevicePluginServer) Stats(req *StatsRequest, srv DevicePlugin_StatsServer) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterDevicePluginServer ¶
func RegisterDevicePluginServer(s *grpc.Server, srv DevicePluginServer)
Types ¶
type ContainerReservation ¶
type ContainerReservation struct { // List of environment variable to be set Envs map[string]string `` /* 149-byte string literal not displayed */ // Mounts for the task. Mounts []*Mount `protobuf:"bytes,2,rep,name=mounts,proto3" json:"mounts,omitempty"` // Devices for the task. Devices []*DeviceSpec `protobuf:"bytes,3,rep,name=devices,proto3" json:"devices,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
ContainerReservation returns how to mount the device into a container that shares the host OS.
func (*ContainerReservation) Descriptor ¶
func (*ContainerReservation) Descriptor() ([]byte, []int)
func (*ContainerReservation) GetDevices ¶
func (m *ContainerReservation) GetDevices() []*DeviceSpec
func (*ContainerReservation) GetEnvs ¶
func (m *ContainerReservation) GetEnvs() map[string]string
func (*ContainerReservation) GetMounts ¶
func (m *ContainerReservation) GetMounts() []*Mount
func (*ContainerReservation) ProtoMessage ¶
func (*ContainerReservation) ProtoMessage()
func (*ContainerReservation) Reset ¶
func (m *ContainerReservation) Reset()
func (*ContainerReservation) String ¶
func (m *ContainerReservation) String() string
func (*ContainerReservation) XXX_DiscardUnknown ¶
func (m *ContainerReservation) XXX_DiscardUnknown()
func (*ContainerReservation) XXX_Marshal ¶
func (m *ContainerReservation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ContainerReservation) XXX_Merge ¶
func (m *ContainerReservation) XXX_Merge(src proto.Message)
func (*ContainerReservation) XXX_Size ¶
func (m *ContainerReservation) XXX_Size() int
func (*ContainerReservation) XXX_Unmarshal ¶
func (m *ContainerReservation) XXX_Unmarshal(b []byte) error
type DetectedDevice ¶
type DetectedDevice struct { // ID is the ID of the device. This ID is used during allocation and must be // stable across restarts of the device driver. ID string `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"` // Health of the device. Healthy bool `protobuf:"varint,2,opt,name=healthy,proto3" json:"healthy,omitempty"` // health_description allows the device plugin to optionally // annotate the health field with a human readable reason. HealthDescription string `protobuf:"bytes,3,opt,name=health_description,json=healthDescription,proto3" json:"health_description,omitempty"` // hw_locality is optionally set to expose hardware locality information for // more optimal placement decisions. HwLocality *DeviceLocality `protobuf:"bytes,4,opt,name=hw_locality,json=hwLocality,proto3" json:"hw_locality,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
DetectedDevice is a single detected device.
func (*DetectedDevice) Descriptor ¶
func (*DetectedDevice) Descriptor() ([]byte, []int)
func (*DetectedDevice) GetHealthDescription ¶
func (m *DetectedDevice) GetHealthDescription() string
func (*DetectedDevice) GetHealthy ¶
func (m *DetectedDevice) GetHealthy() bool
func (*DetectedDevice) GetHwLocality ¶
func (m *DetectedDevice) GetHwLocality() *DeviceLocality
func (*DetectedDevice) GetID ¶
func (m *DetectedDevice) GetID() string
func (*DetectedDevice) ProtoMessage ¶
func (*DetectedDevice) ProtoMessage()
func (*DetectedDevice) Reset ¶
func (m *DetectedDevice) Reset()
func (*DetectedDevice) String ¶
func (m *DetectedDevice) String() string
func (*DetectedDevice) XXX_DiscardUnknown ¶
func (m *DetectedDevice) XXX_DiscardUnknown()
func (*DetectedDevice) XXX_Marshal ¶
func (m *DetectedDevice) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DetectedDevice) XXX_Merge ¶
func (m *DetectedDevice) XXX_Merge(src proto.Message)
func (*DetectedDevice) XXX_Size ¶
func (m *DetectedDevice) XXX_Size() int
func (*DetectedDevice) XXX_Unmarshal ¶
func (m *DetectedDevice) XXX_Unmarshal(b []byte) error
type DeviceGroup ¶
type DeviceGroup struct { // vendor is the name of the vendor of the device Vendor string `protobuf:"bytes,1,opt,name=vendor,proto3" json:"vendor,omitempty"` // device_type is the type of the device (gpu, fpga, etc). DeviceType string `protobuf:"bytes,2,opt,name=device_type,json=deviceType,proto3" json:"device_type,omitempty"` // device_name is the name of the device. DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"` // devices is the set of devices detected by the plugin. Devices []*DetectedDevice `protobuf:"bytes,4,rep,name=devices,proto3" json:"devices,omitempty"` // attributes allows adding attributes to be used for constraints or // affinities. Attributes map[string]*proto1.Attribute `` /* 161-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
DeviceGroup is a group of devices that share a vendor, device type and name.
func (*DeviceGroup) Descriptor ¶
func (*DeviceGroup) Descriptor() ([]byte, []int)
func (*DeviceGroup) GetAttributes ¶
func (m *DeviceGroup) GetAttributes() map[string]*proto1.Attribute
func (*DeviceGroup) GetDeviceName ¶
func (m *DeviceGroup) GetDeviceName() string
func (*DeviceGroup) GetDeviceType ¶
func (m *DeviceGroup) GetDeviceType() string
func (*DeviceGroup) GetDevices ¶
func (m *DeviceGroup) GetDevices() []*DetectedDevice
func (*DeviceGroup) GetVendor ¶
func (m *DeviceGroup) GetVendor() string
func (*DeviceGroup) ProtoMessage ¶
func (*DeviceGroup) ProtoMessage()
func (*DeviceGroup) Reset ¶
func (m *DeviceGroup) Reset()
func (*DeviceGroup) String ¶
func (m *DeviceGroup) String() string
func (*DeviceGroup) XXX_DiscardUnknown ¶
func (m *DeviceGroup) XXX_DiscardUnknown()
func (*DeviceGroup) XXX_Marshal ¶
func (m *DeviceGroup) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DeviceGroup) XXX_Merge ¶
func (m *DeviceGroup) XXX_Merge(src proto.Message)
func (*DeviceGroup) XXX_Size ¶
func (m *DeviceGroup) XXX_Size() int
func (*DeviceGroup) XXX_Unmarshal ¶
func (m *DeviceGroup) XXX_Unmarshal(b []byte) error
type DeviceGroupStats ¶
type DeviceGroupStats struct { Vendor string `protobuf:"bytes,1,opt,name=vendor,proto3" json:"vendor,omitempty"` Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` // instance_stats is a mapping of each device ID to its statistics. InstanceStats map[string]*DeviceStats `` /* 188-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
DeviceGroupStats contains statistics for each device of a particular device group, identified by the vendor, type and name of the device.
func (*DeviceGroupStats) Descriptor ¶
func (*DeviceGroupStats) Descriptor() ([]byte, []int)
func (*DeviceGroupStats) GetInstanceStats ¶
func (m *DeviceGroupStats) GetInstanceStats() map[string]*DeviceStats
func (*DeviceGroupStats) GetName ¶
func (m *DeviceGroupStats) GetName() string
func (*DeviceGroupStats) GetType ¶
func (m *DeviceGroupStats) GetType() string
func (*DeviceGroupStats) GetVendor ¶
func (m *DeviceGroupStats) GetVendor() string
func (*DeviceGroupStats) ProtoMessage ¶
func (*DeviceGroupStats) ProtoMessage()
func (*DeviceGroupStats) Reset ¶
func (m *DeviceGroupStats) Reset()
func (*DeviceGroupStats) String ¶
func (m *DeviceGroupStats) String() string
func (*DeviceGroupStats) XXX_DiscardUnknown ¶
func (m *DeviceGroupStats) XXX_DiscardUnknown()
func (*DeviceGroupStats) XXX_Marshal ¶
func (m *DeviceGroupStats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DeviceGroupStats) XXX_Merge ¶
func (m *DeviceGroupStats) XXX_Merge(src proto.Message)
func (*DeviceGroupStats) XXX_Size ¶
func (m *DeviceGroupStats) XXX_Size() int
func (*DeviceGroupStats) XXX_Unmarshal ¶
func (m *DeviceGroupStats) XXX_Unmarshal(b []byte) error
type DeviceLocality ¶
type DeviceLocality struct { // pci_bus_id is the PCI bus ID for the device. If reported, it // allows Nomad to make NUMA aware optimizations. PciBusId string `protobuf:"bytes,1,opt,name=pci_bus_id,json=pciBusId,proto3" json:"pci_bus_id,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
DeviceLocality is used to expose HW locality information about a device.
func (*DeviceLocality) Descriptor ¶
func (*DeviceLocality) Descriptor() ([]byte, []int)
func (*DeviceLocality) GetPciBusId ¶
func (m *DeviceLocality) GetPciBusId() string
func (*DeviceLocality) ProtoMessage ¶
func (*DeviceLocality) ProtoMessage()
func (*DeviceLocality) Reset ¶
func (m *DeviceLocality) Reset()
func (*DeviceLocality) String ¶
func (m *DeviceLocality) String() string
func (*DeviceLocality) XXX_DiscardUnknown ¶
func (m *DeviceLocality) XXX_DiscardUnknown()
func (*DeviceLocality) XXX_Marshal ¶
func (m *DeviceLocality) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DeviceLocality) XXX_Merge ¶
func (m *DeviceLocality) XXX_Merge(src proto.Message)
func (*DeviceLocality) XXX_Size ¶
func (m *DeviceLocality) XXX_Size() int
func (*DeviceLocality) XXX_Unmarshal ¶
func (m *DeviceLocality) XXX_Unmarshal(b []byte) error
type DevicePluginClient ¶
type DevicePluginClient interface { // Fingerprint allows the device plugin to return a set of // detected devices and provide a mechanism to update the state of // the device. Fingerprint(ctx context.Context, in *FingerprintRequest, opts ...grpc.CallOption) (DevicePlugin_FingerprintClient, error) // Reserve is called by the client before starting an allocation // that requires access to the plugin’s devices. The plugin can use // this to run any setup steps and provides the mounting details to // the Nomad client Reserve(ctx context.Context, in *ReserveRequest, opts ...grpc.CallOption) (*ReserveResponse, error) // Stats returns a stream of device statistics. Stats(ctx context.Context, in *StatsRequest, opts ...grpc.CallOption) (DevicePlugin_StatsClient, error) }
DevicePluginClient is the client API for DevicePlugin service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewDevicePluginClient ¶
func NewDevicePluginClient(cc grpc.ClientConnInterface) DevicePluginClient
type DevicePluginServer ¶
type DevicePluginServer interface { // Fingerprint allows the device plugin to return a set of // detected devices and provide a mechanism to update the state of // the device. Fingerprint(*FingerprintRequest, DevicePlugin_FingerprintServer) error // Reserve is called by the client before starting an allocation // that requires access to the plugin’s devices. The plugin can use // this to run any setup steps and provides the mounting details to // the Nomad client Reserve(context.Context, *ReserveRequest) (*ReserveResponse, error) // Stats returns a stream of device statistics. Stats(*StatsRequest, DevicePlugin_StatsServer) error }
DevicePluginServer is the server API for DevicePlugin service.
type DevicePlugin_FingerprintClient ¶
type DevicePlugin_FingerprintClient interface { Recv() (*FingerprintResponse, error) grpc.ClientStream }
type DevicePlugin_FingerprintServer ¶
type DevicePlugin_FingerprintServer interface { Send(*FingerprintResponse) error grpc.ServerStream }
type DevicePlugin_StatsClient ¶
type DevicePlugin_StatsClient interface { Recv() (*StatsResponse, error) grpc.ClientStream }
type DevicePlugin_StatsServer ¶
type DevicePlugin_StatsServer interface { Send(*StatsResponse) error grpc.ServerStream }
type DeviceSpec ¶
type DeviceSpec struct { // Path of the device within the task. TaskPath string `protobuf:"bytes,1,opt,name=task_path,json=taskPath,proto3" json:"task_path,omitempty"` // Path of the device on the host. HostPath string `protobuf:"bytes,2,opt,name=host_path,json=hostPath,proto3" json:"host_path,omitempty"` // Cgroups permissions of the device, candidates are one or more of // * r - allows task to read from the specified device. // * w - allows task to write to the specified device. // * m - allows task to create device files that do not yet exist Permissions string `protobuf:"bytes,3,opt,name=permissions,proto3" json:"permissions,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
DeviceSpec specifies a host device to mount into a task.
func (*DeviceSpec) Descriptor ¶
func (*DeviceSpec) Descriptor() ([]byte, []int)
func (*DeviceSpec) GetHostPath ¶
func (m *DeviceSpec) GetHostPath() string
func (*DeviceSpec) GetPermissions ¶
func (m *DeviceSpec) GetPermissions() string
func (*DeviceSpec) GetTaskPath ¶
func (m *DeviceSpec) GetTaskPath() string
func (*DeviceSpec) ProtoMessage ¶
func (*DeviceSpec) ProtoMessage()
func (*DeviceSpec) Reset ¶
func (m *DeviceSpec) Reset()
func (*DeviceSpec) String ¶
func (m *DeviceSpec) String() string
func (*DeviceSpec) XXX_DiscardUnknown ¶
func (m *DeviceSpec) XXX_DiscardUnknown()
func (*DeviceSpec) XXX_Marshal ¶
func (m *DeviceSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DeviceSpec) XXX_Merge ¶
func (m *DeviceSpec) XXX_Merge(src proto.Message)
func (*DeviceSpec) XXX_Size ¶
func (m *DeviceSpec) XXX_Size() int
func (*DeviceSpec) XXX_Unmarshal ¶
func (m *DeviceSpec) XXX_Unmarshal(b []byte) error
type DeviceStats ¶
type DeviceStats struct { // summary exposes a single summary metric that should be the most // informative to users. Summary *proto1.StatValue `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"` // stats contains the verbose statistics for the device. Stats *proto1.StatObject `protobuf:"bytes,2,opt,name=stats,proto3" json:"stats,omitempty"` // timestamp is the time the statistics were collected. Timestamp *timestamp.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
DeviceStats is the statistics for an individual device
func (*DeviceStats) Descriptor ¶
func (*DeviceStats) Descriptor() ([]byte, []int)
func (*DeviceStats) GetStats ¶
func (m *DeviceStats) GetStats() *proto1.StatObject
func (*DeviceStats) GetSummary ¶
func (m *DeviceStats) GetSummary() *proto1.StatValue
func (*DeviceStats) GetTimestamp ¶
func (m *DeviceStats) GetTimestamp() *timestamp.Timestamp
func (*DeviceStats) ProtoMessage ¶
func (*DeviceStats) ProtoMessage()
func (*DeviceStats) Reset ¶
func (m *DeviceStats) Reset()
func (*DeviceStats) String ¶
func (m *DeviceStats) String() string
func (*DeviceStats) XXX_DiscardUnknown ¶
func (m *DeviceStats) XXX_DiscardUnknown()
func (*DeviceStats) XXX_Marshal ¶
func (m *DeviceStats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DeviceStats) XXX_Merge ¶
func (m *DeviceStats) XXX_Merge(src proto.Message)
func (*DeviceStats) XXX_Size ¶
func (m *DeviceStats) XXX_Size() int
func (*DeviceStats) XXX_Unmarshal ¶
func (m *DeviceStats) XXX_Unmarshal(b []byte) error
type FingerprintRequest ¶
type FingerprintRequest struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
FingerprintRequest is used to request for devices to be fingerprinted.
func (*FingerprintRequest) Descriptor ¶
func (*FingerprintRequest) Descriptor() ([]byte, []int)
func (*FingerprintRequest) ProtoMessage ¶
func (*FingerprintRequest) ProtoMessage()
func (*FingerprintRequest) Reset ¶
func (m *FingerprintRequest) Reset()
func (*FingerprintRequest) String ¶
func (m *FingerprintRequest) String() string
func (*FingerprintRequest) XXX_DiscardUnknown ¶
func (m *FingerprintRequest) XXX_DiscardUnknown()
func (*FingerprintRequest) XXX_Marshal ¶
func (m *FingerprintRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*FingerprintRequest) XXX_Merge ¶
func (m *FingerprintRequest) XXX_Merge(src proto.Message)
func (*FingerprintRequest) XXX_Size ¶
func (m *FingerprintRequest) XXX_Size() int
func (*FingerprintRequest) XXX_Unmarshal ¶
func (m *FingerprintRequest) XXX_Unmarshal(b []byte) error
type FingerprintResponse ¶
type FingerprintResponse struct { // device_group is a group of devices that share a vendor, device_type, and // device_name. This is returned as a set so that a single plugin could // potentially detect several device types and models. DeviceGroup []*DeviceGroup `protobuf:"bytes,1,rep,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
FingerprintResponse returns a set of detected devices.
func (*FingerprintResponse) Descriptor ¶
func (*FingerprintResponse) Descriptor() ([]byte, []int)
func (*FingerprintResponse) GetDeviceGroup ¶
func (m *FingerprintResponse) GetDeviceGroup() []*DeviceGroup
func (*FingerprintResponse) ProtoMessage ¶
func (*FingerprintResponse) ProtoMessage()
func (*FingerprintResponse) Reset ¶
func (m *FingerprintResponse) Reset()
func (*FingerprintResponse) String ¶
func (m *FingerprintResponse) String() string
func (*FingerprintResponse) XXX_DiscardUnknown ¶
func (m *FingerprintResponse) XXX_DiscardUnknown()
func (*FingerprintResponse) XXX_Marshal ¶
func (m *FingerprintResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*FingerprintResponse) XXX_Merge ¶
func (m *FingerprintResponse) XXX_Merge(src proto.Message)
func (*FingerprintResponse) XXX_Size ¶
func (m *FingerprintResponse) XXX_Size() int
func (*FingerprintResponse) XXX_Unmarshal ¶
func (m *FingerprintResponse) XXX_Unmarshal(b []byte) error
type Mount ¶
type Mount struct { // Path of the mount within the task. TaskPath string `protobuf:"bytes,1,opt,name=task_path,json=taskPath,proto3" json:"task_path,omitempty"` // Path of the mount on the host. HostPath string `protobuf:"bytes,2,opt,name=host_path,json=hostPath,proto3" json:"host_path,omitempty"` // If set, the mount is read-only. ReadOnly bool `protobuf:"varint,3,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Mount specifies a host volume to mount into a task. where device library or tools are installed on host and task
func (*Mount) Descriptor ¶
func (*Mount) GetHostPath ¶
func (*Mount) GetReadOnly ¶
func (*Mount) GetTaskPath ¶
func (*Mount) ProtoMessage ¶
func (*Mount) ProtoMessage()
func (*Mount) XXX_DiscardUnknown ¶
func (m *Mount) XXX_DiscardUnknown()
func (*Mount) XXX_Marshal ¶
func (*Mount) XXX_Unmarshal ¶
type ReserveRequest ¶
type ReserveRequest struct { // device_ids are the requested devices. DeviceIds []string `protobuf:"bytes,1,rep,name=device_ids,json=deviceIds,proto3" json:"device_ids,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
ReserveRequest is used to ask the device driver for information on how to allocate the requested devices.
func (*ReserveRequest) Descriptor ¶
func (*ReserveRequest) Descriptor() ([]byte, []int)
func (*ReserveRequest) GetDeviceIds ¶
func (m *ReserveRequest) GetDeviceIds() []string
func (*ReserveRequest) ProtoMessage ¶
func (*ReserveRequest) ProtoMessage()
func (*ReserveRequest) Reset ¶
func (m *ReserveRequest) Reset()
func (*ReserveRequest) String ¶
func (m *ReserveRequest) String() string
func (*ReserveRequest) XXX_DiscardUnknown ¶
func (m *ReserveRequest) XXX_DiscardUnknown()
func (*ReserveRequest) XXX_Marshal ¶
func (m *ReserveRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ReserveRequest) XXX_Merge ¶
func (m *ReserveRequest) XXX_Merge(src proto.Message)
func (*ReserveRequest) XXX_Size ¶
func (m *ReserveRequest) XXX_Size() int
func (*ReserveRequest) XXX_Unmarshal ¶
func (m *ReserveRequest) XXX_Unmarshal(b []byte) error
type ReserveResponse ¶
type ReserveResponse struct { // container_res contains information on how to mount the device // into a task isolated using container technologies (where the // host is shared) ContainerRes *ContainerReservation `protobuf:"bytes,1,opt,name=container_res,json=containerRes,proto3" json:"container_res,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
ReserveResponse informs Nomad how to expose the requested devices to the the task.
func (*ReserveResponse) Descriptor ¶
func (*ReserveResponse) Descriptor() ([]byte, []int)
func (*ReserveResponse) GetContainerRes ¶
func (m *ReserveResponse) GetContainerRes() *ContainerReservation
func (*ReserveResponse) ProtoMessage ¶
func (*ReserveResponse) ProtoMessage()
func (*ReserveResponse) Reset ¶
func (m *ReserveResponse) Reset()
func (*ReserveResponse) String ¶
func (m *ReserveResponse) String() string
func (*ReserveResponse) XXX_DiscardUnknown ¶
func (m *ReserveResponse) XXX_DiscardUnknown()
func (*ReserveResponse) XXX_Marshal ¶
func (m *ReserveResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ReserveResponse) XXX_Merge ¶
func (m *ReserveResponse) XXX_Merge(src proto.Message)
func (*ReserveResponse) XXX_Size ¶
func (m *ReserveResponse) XXX_Size() int
func (*ReserveResponse) XXX_Unmarshal ¶
func (m *ReserveResponse) XXX_Unmarshal(b []byte) error
type StatsRequest ¶
type StatsRequest struct { // collection_interval is the duration in which to collect statistics. CollectionInterval *duration.Duration `protobuf:"bytes,1,opt,name=collection_interval,json=collectionInterval,proto3" json:"collection_interval,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
StatsRequest is used to parameterize the retrieval of statistics.
func (*StatsRequest) Descriptor ¶
func (*StatsRequest) Descriptor() ([]byte, []int)
func (*StatsRequest) GetCollectionInterval ¶
func (m *StatsRequest) GetCollectionInterval() *duration.Duration
func (*StatsRequest) ProtoMessage ¶
func (*StatsRequest) ProtoMessage()
func (*StatsRequest) Reset ¶
func (m *StatsRequest) Reset()
func (*StatsRequest) String ¶
func (m *StatsRequest) String() string
func (*StatsRequest) XXX_DiscardUnknown ¶
func (m *StatsRequest) XXX_DiscardUnknown()
func (*StatsRequest) XXX_Marshal ¶
func (m *StatsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*StatsRequest) XXX_Merge ¶
func (m *StatsRequest) XXX_Merge(src proto.Message)
func (*StatsRequest) XXX_Size ¶
func (m *StatsRequest) XXX_Size() int
func (*StatsRequest) XXX_Unmarshal ¶
func (m *StatsRequest) XXX_Unmarshal(b []byte) error
type StatsResponse ¶
type StatsResponse struct { // groups contains statistics for each device group. Groups []*DeviceGroupStats `protobuf:"bytes,1,rep,name=groups,proto3" json:"groups,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
StatsResponse returns the statistics for each device group.
func (*StatsResponse) Descriptor ¶
func (*StatsResponse) Descriptor() ([]byte, []int)
func (*StatsResponse) GetGroups ¶
func (m *StatsResponse) GetGroups() []*DeviceGroupStats
func (*StatsResponse) ProtoMessage ¶
func (*StatsResponse) ProtoMessage()
func (*StatsResponse) Reset ¶
func (m *StatsResponse) Reset()
func (*StatsResponse) String ¶
func (m *StatsResponse) String() string
func (*StatsResponse) XXX_DiscardUnknown ¶
func (m *StatsResponse) XXX_DiscardUnknown()
func (*StatsResponse) XXX_Marshal ¶
func (m *StatsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*StatsResponse) XXX_Merge ¶
func (m *StatsResponse) XXX_Merge(src proto.Message)
func (*StatsResponse) XXX_Size ¶
func (m *StatsResponse) XXX_Size() int
func (*StatsResponse) XXX_Unmarshal ¶
func (m *StatsResponse) XXX_Unmarshal(b []byte) error
type UnimplementedDevicePluginServer ¶ added in v0.11.0
type UnimplementedDevicePluginServer struct { }
UnimplementedDevicePluginServer can be embedded to have forward compatible implementations.
func (*UnimplementedDevicePluginServer) Fingerprint ¶ added in v0.11.0
func (*UnimplementedDevicePluginServer) Fingerprint(req *FingerprintRequest, srv DevicePlugin_FingerprintServer) error
func (*UnimplementedDevicePluginServer) Reserve ¶ added in v0.11.0
func (*UnimplementedDevicePluginServer) Reserve(ctx context.Context, req *ReserveRequest) (*ReserveResponse, error)
func (*UnimplementedDevicePluginServer) Stats ¶ added in v0.11.0
func (*UnimplementedDevicePluginServer) Stats(req *StatsRequest, srv DevicePlugin_StatsServer) error