Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the deviceplugin v1 API group +kubebuilder:object:generate=true +groupName=deviceplugin.intel.com
Index ¶
- Variables
- type GpuDevicePlugin
- func (in *GpuDevicePlugin) DeepCopy() *GpuDevicePlugin
- func (in *GpuDevicePlugin) DeepCopyInto(out *GpuDevicePlugin)
- func (in *GpuDevicePlugin) DeepCopyObject() runtime.Object
- func (r *GpuDevicePlugin) Default()
- func (r *GpuDevicePlugin) SetupWebhookWithManager(mgr ctrl.Manager) error
- func (r *GpuDevicePlugin) ValidateCreate() error
- func (r *GpuDevicePlugin) ValidateDelete() error
- func (r *GpuDevicePlugin) ValidateUpdate(old runtime.Object) error
- type GpuDevicePluginList
- type GpuDevicePluginSpec
- type GpuDevicePluginStatus
- type KernelVfDriver
- type QatDevicePlugin
- func (in *QatDevicePlugin) DeepCopy() *QatDevicePlugin
- func (in *QatDevicePlugin) DeepCopyInto(out *QatDevicePlugin)
- func (in *QatDevicePlugin) DeepCopyObject() runtime.Object
- func (r *QatDevicePlugin) Default()
- func (r *QatDevicePlugin) SetupWebhookWithManager(mgr ctrl.Manager) error
- func (r *QatDevicePlugin) ValidateCreate() error
- func (r *QatDevicePlugin) ValidateDelete() error
- func (r *QatDevicePlugin) ValidateUpdate(old runtime.Object) error
- type QatDevicePluginList
- type QatDevicePluginSpec
- type QatDevicePluginStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "deviceplugin.intel.com", Version: "v1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type GpuDevicePlugin ¶
type GpuDevicePlugin struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec GpuDevicePluginSpec `json:"spec,omitempty"`
Status GpuDevicePluginStatus `json:"status,omitempty"`
}
GpuDevicePlugin is the Schema for the gpudeviceplugins API.
func (*GpuDevicePlugin) DeepCopy ¶
func (in *GpuDevicePlugin) DeepCopy() *GpuDevicePlugin
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GpuDevicePlugin.
func (*GpuDevicePlugin) DeepCopyInto ¶
func (in *GpuDevicePlugin) DeepCopyInto(out *GpuDevicePlugin)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GpuDevicePlugin) DeepCopyObject ¶
func (in *GpuDevicePlugin) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*GpuDevicePlugin) Default ¶
func (r *GpuDevicePlugin) Default()
Default implements webhook.Defaulter so a webhook will be registered for the type.
func (*GpuDevicePlugin) SetupWebhookWithManager ¶
func (r *GpuDevicePlugin) SetupWebhookWithManager(mgr ctrl.Manager) error
SetupWebhookWithManager sets up a webhook for GpuDevicePlugin custom resources.
func (*GpuDevicePlugin) ValidateCreate ¶
func (r *GpuDevicePlugin) ValidateCreate() error
ValidateCreate implements webhook.Validator so a webhook will be registered for the type.
func (*GpuDevicePlugin) ValidateDelete ¶
func (r *GpuDevicePlugin) ValidateDelete() error
ValidateDelete implements webhook.Validator so a webhook will be registered for the type.
func (*GpuDevicePlugin) ValidateUpdate ¶
func (r *GpuDevicePlugin) ValidateUpdate(old runtime.Object) error
ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.
type GpuDevicePluginList ¶
type GpuDevicePluginList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []GpuDevicePlugin `json:"items"`
}
GpuDevicePluginList contains a list of GpuDevicePlugin.
func (*GpuDevicePluginList) DeepCopy ¶
func (in *GpuDevicePluginList) DeepCopy() *GpuDevicePluginList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GpuDevicePluginList.
func (*GpuDevicePluginList) DeepCopyInto ¶
func (in *GpuDevicePluginList) DeepCopyInto(out *GpuDevicePluginList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GpuDevicePluginList) DeepCopyObject ¶
func (in *GpuDevicePluginList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GpuDevicePluginSpec ¶
type GpuDevicePluginSpec struct {
// Image is a container image with GPU device plugin executable.
Image string `json:"image,omitempty"`
// +kubebuilder:validation:Minimum=1
SharedDevNum int `json:"sharedDevNum,omitempty"`
// LogLevel sets the plugin's log level.
// +kubebuilder:validation:Minimum=0
LogLevel int `json:"logLevel,omitempty"`
// NodeSelector provides a simple way to constrain device plugin pods to nodes with particular labels.
NodeSelector map[string]string `json:"nodeSelector,omitempty"`
}
GpuDevicePluginSpec defines the desired state of GpuDevicePlugin.
func (*GpuDevicePluginSpec) DeepCopy ¶
func (in *GpuDevicePluginSpec) DeepCopy() *GpuDevicePluginSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GpuDevicePluginSpec.
func (*GpuDevicePluginSpec) DeepCopyInto ¶
func (in *GpuDevicePluginSpec) DeepCopyInto(out *GpuDevicePluginSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GpuDevicePluginStatus ¶
type GpuDevicePluginStatus struct {
// ControlledDaemoSet references the DaemonSet controlled by the operator.
// +optional
ControlledDaemonSet v1.ObjectReference `json:"controlledDaemonSet,omitempty"`
// The total number of nodes that should be running the device plugin
// pod (including nodes correctly running the device plugin pod).
DesiredNumberScheduled int32 `json:"desiredNumberScheduled"`
// The number of nodes that should be running the device plugin pod and have one
// or more of the device plugin pod running and ready.
NumberReady int32 `json:"numberReady"`
// The list of Node names where the device plugin pods are running.
// +optional
NodeNames []string `json:"nodeNames,omitempty"`
}
GpuDevicePluginStatus defines the observed state of GpuDevicePlugin. TODO(rojkov): consider code deduplication with QatDevicePluginStatus.
func (*GpuDevicePluginStatus) DeepCopy ¶
func (in *GpuDevicePluginStatus) DeepCopy() *GpuDevicePluginStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GpuDevicePluginStatus.
func (*GpuDevicePluginStatus) DeepCopyInto ¶
func (in *GpuDevicePluginStatus) DeepCopyInto(out *GpuDevicePluginStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KernelVfDriver ¶
type KernelVfDriver string
KernelVfDriver is a VF device driver for QuickAssist devices.
type QatDevicePlugin ¶
type QatDevicePlugin struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec QatDevicePluginSpec `json:"spec,omitempty"`
Status QatDevicePluginStatus `json:"status,omitempty"`
}
QatDevicePlugin is the Schema for the qatdeviceplugins API.
func (*QatDevicePlugin) DeepCopy ¶
func (in *QatDevicePlugin) DeepCopy() *QatDevicePlugin
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new QatDevicePlugin.
func (*QatDevicePlugin) DeepCopyInto ¶
func (in *QatDevicePlugin) DeepCopyInto(out *QatDevicePlugin)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*QatDevicePlugin) DeepCopyObject ¶
func (in *QatDevicePlugin) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*QatDevicePlugin) Default ¶
func (r *QatDevicePlugin) Default()
Default implements webhook.Defaulter so a webhook will be registered for the type.
func (*QatDevicePlugin) SetupWebhookWithManager ¶
func (r *QatDevicePlugin) SetupWebhookWithManager(mgr ctrl.Manager) error
SetupWebhookWithManager sets up a webhook for QatDevicePlugin custom resources.
func (*QatDevicePlugin) ValidateCreate ¶
func (r *QatDevicePlugin) ValidateCreate() error
ValidateCreate implements webhook.Validator so a webhook will be registered for the type.
func (*QatDevicePlugin) ValidateDelete ¶
func (r *QatDevicePlugin) ValidateDelete() error
ValidateDelete implements webhook.Validator so a webhook will be registered for the type.
func (*QatDevicePlugin) ValidateUpdate ¶
func (r *QatDevicePlugin) ValidateUpdate(old runtime.Object) error
ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.
type QatDevicePluginList ¶
type QatDevicePluginList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []QatDevicePlugin `json:"items"`
}
QatDevicePluginList contains a list of QatDevicePlugin.
func (*QatDevicePluginList) DeepCopy ¶
func (in *QatDevicePluginList) DeepCopy() *QatDevicePluginList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new QatDevicePluginList.
func (*QatDevicePluginList) DeepCopyInto ¶
func (in *QatDevicePluginList) DeepCopyInto(out *QatDevicePluginList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*QatDevicePluginList) DeepCopyObject ¶
func (in *QatDevicePluginList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type QatDevicePluginSpec ¶
type QatDevicePluginSpec struct {
// Image is a container image with QAT device plugin executable.
Image string `json:"image,omitempty"`
// DpdkDriver is a DPDK device driver for configuring the QAT device.
// +kubebuilder:validation:Enum=igb_uio;vfio-pci
DpdkDriver string `json:"dpdkDriver,omitempty"`
// KernelVfDrivers is a list of VF device drivers for the QuickAssist devices in the system.
KernelVfDrivers []KernelVfDriver `json:"kernelVfDrivers,omitempty"`
// MaxNumDevices is a maximum number of QAT devices to be provided to the QuickAssist device plugin
// +kubebuilder:validation:Minimum=1
MaxNumDevices int `json:"maxNumDevices,omitempty"`
// LogLevel sets the plugin's log level.
// +kubebuilder:validation:Minimum=0
LogLevel int `json:"logLevel,omitempty"`
// NodeSelector provides a simple way to constrain device plugin pods to nodes with particular labels.
NodeSelector map[string]string `json:"nodeSelector,omitempty"`
}
QatDevicePluginSpec defines the desired state of QatDevicePlugin.
func (*QatDevicePluginSpec) DeepCopy ¶
func (in *QatDevicePluginSpec) DeepCopy() *QatDevicePluginSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new QatDevicePluginSpec.
func (*QatDevicePluginSpec) DeepCopyInto ¶
func (in *QatDevicePluginSpec) DeepCopyInto(out *QatDevicePluginSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type QatDevicePluginStatus ¶
type QatDevicePluginStatus struct {
// ControlledDaemoSet references the DaemonSet controlled by the operator.
// +optional
ControlledDaemonSet v1.ObjectReference `json:"controlledDaemonSet,omitempty"`
// The total number of nodes that should be running the device plugin
// pod (including nodes correctly running the device plugin pod).
DesiredNumberScheduled int32 `json:"desiredNumberScheduled"`
// The number of nodes that should be running the device plugin pod and have one
// or more of the device plugin pod running and ready.
NumberReady int32 `json:"numberReady"`
// The list of Node names where the device plugin pods are running.
// +optional
NodeNames []string `json:"nodeNames,omitempty"`
}
QatDevicePluginStatus defines the observed state of QatDevicePlugin. TODO(rojkov): consider code deduplication with GpuDevicePluginStatus.
func (*QatDevicePluginStatus) DeepCopy ¶
func (in *QatDevicePluginStatus) DeepCopy() *QatDevicePluginStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new QatDevicePluginStatus.
func (*QatDevicePluginStatus) DeepCopyInto ¶
func (in *QatDevicePluginStatus) DeepCopyInto(out *QatDevicePluginStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.