Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=mellanox.com
Index ¶
- Constants
- Variables
- type AppliedState
- type DevicePluginSpec
- type ImageSpec
- type MacvlanNetwork
- type MacvlanNetworkList
- type MacvlanNetworkSpec
- type MacvlanNetworkStatus
- type MultusSpec
- type NVPeerDriverSpec
- type NicClusterPolicy
- type NicClusterPolicyList
- type NicClusterPolicySpec
- type NicClusterPolicyStatus
- type OFEDDriverSpec
- type SecondaryNetworkSpec
- type State
Constants ¶
const ( StateReady = "ready" StateNotReady = "notReady" StateIgnore = "ignore" StateError = "error" )
const (
MacvlanNetworkCRDName = "MacvlanNetwork"
)
const (
NicClusterPolicyCRDName = "NicClusterPolicy"
)
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "mellanox.com", Version: "v1alpha1"} // 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 AppliedState ¶
type AppliedState struct {
Name string `json:"name"`
// +kubebuilder:validation:Enum={"ready", "notReady", "ignore", "error"}
State State `json:"state"`
}
AppliedState defines a finer-grained view of the observed state of NicClusterPolicy
func (*AppliedState) DeepCopy ¶
func (in *AppliedState) DeepCopy() *AppliedState
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppliedState.
func (*AppliedState) DeepCopyInto ¶
func (in *AppliedState) DeepCopyInto(out *AppliedState)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DevicePluginSpec ¶
type DevicePluginSpec struct {
// Image information for device plugin
ImageSpec `json:""`
// Device plugin configuration
Config string `json:"config"`
}
DevicePluginSpec describes configuration options for device plugin
func (*DevicePluginSpec) DeepCopy ¶
func (in *DevicePluginSpec) DeepCopy() *DevicePluginSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevicePluginSpec.
func (*DevicePluginSpec) DeepCopyInto ¶
func (in *DevicePluginSpec) DeepCopyInto(out *DevicePluginSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ImageSpec ¶
type ImageSpec struct {
// +kubebuilder:validation:Pattern=[a-zA-Z0-9\-]+
Image string `json:"image"`
// +kubebuilder:validation:Pattern=[a-zA-Z0-9\.\-\/]+
Repository string `json:"repository"`
// +kubebuilder:validation:Pattern=[a-zA-Z0-9\.-]+
Version string `json:"version"`
}
ImageSpec Contains container image specifications
func (*ImageSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageSpec.
func (*ImageSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MacvlanNetwork ¶
type MacvlanNetwork struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec MacvlanNetworkSpec `json:"spec,omitempty"`
Status MacvlanNetworkStatus `json:"status,omitempty"`
}
MacvlanNetwork is the Schema for the macvlannetworks API
func (*MacvlanNetwork) DeepCopy ¶
func (in *MacvlanNetwork) DeepCopy() *MacvlanNetwork
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MacvlanNetwork.
func (*MacvlanNetwork) DeepCopyInto ¶
func (in *MacvlanNetwork) DeepCopyInto(out *MacvlanNetwork)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MacvlanNetwork) DeepCopyObject ¶
func (in *MacvlanNetwork) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MacvlanNetworkList ¶
type MacvlanNetworkList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []MacvlanNetwork `json:"items"`
}
MacvlanNetworkList contains a list of MacvlanNetwork
func (*MacvlanNetworkList) DeepCopy ¶
func (in *MacvlanNetworkList) DeepCopy() *MacvlanNetworkList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MacvlanNetworkList.
func (*MacvlanNetworkList) DeepCopyInto ¶
func (in *MacvlanNetworkList) DeepCopyInto(out *MacvlanNetworkList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MacvlanNetworkList) DeepCopyObject ¶
func (in *MacvlanNetworkList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MacvlanNetworkSpec ¶
type MacvlanNetworkSpec struct {
// Namespace of the NetworkAttachmentDefinition custom resource
NetworkNamespace string `json:"networkNamespace,omitempty"`
// Name of the host interface to enslave. Defaults to default route interface
Master string `json:"master,omitempty"`
// +kubebuilder:validation:Enum={"bridge", "private", "vepa", "passthru"}
// Mode of interface one of "bridge", "private", "vepa", "passthru"
Mode string `json:"mode,omitempty"`
// MTU of interface to the specified value. 0 for master's MTU
// +kubebuilder:validation:Minimum=0
Mtu int `json:"mtu,omitempty"`
// IPAM configuration to be used for this network.
IPAM string `json:"ipam,omitempty"`
}
MacvlanNetworkSpec defines the desired state of MacvlanNetwork
func (*MacvlanNetworkSpec) DeepCopy ¶
func (in *MacvlanNetworkSpec) DeepCopy() *MacvlanNetworkSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MacvlanNetworkSpec.
func (*MacvlanNetworkSpec) DeepCopyInto ¶
func (in *MacvlanNetworkSpec) DeepCopyInto(out *MacvlanNetworkSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MacvlanNetworkStatus ¶
type MacvlanNetworkStatus struct {
// Reflects the state of the MacvlanNetwork
// +kubebuilder:validation:Enum={"notReady", "ready", "error"}
State State `json:"state"`
// Network attachment definition generated from MacvlanNetworkSpec
MacvlanNetworkAttachmentDef string `json:"macvlanNetworkAttachmentDef,omitempty"`
// Informative string in case the observed state is error
Reason string `json:"reason,omitempty"`
}
MacvlanNetworkStatus defines the observed state of MacvlanNetwork
func (*MacvlanNetworkStatus) DeepCopy ¶
func (in *MacvlanNetworkStatus) DeepCopy() *MacvlanNetworkStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MacvlanNetworkStatus.
func (*MacvlanNetworkStatus) DeepCopyInto ¶
func (in *MacvlanNetworkStatus) DeepCopyInto(out *MacvlanNetworkStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MultusSpec ¶
type MultusSpec struct {
// Image information for device plugin
ImageSpec `json:""`
// Multus CNI config if config is missing or empty then multus config will be automatically generated from the CNI
// configuration file of the master plugin (the first file in lexicographical order in cni-conf-dir)
Config string `json:"config,omitempty"`
}
MultusSpec describes configuration options for Multus CNI
func (*MultusSpec) DeepCopy ¶
func (in *MultusSpec) DeepCopy() *MultusSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultusSpec.
func (*MultusSpec) DeepCopyInto ¶
func (in *MultusSpec) DeepCopyInto(out *MultusSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NVPeerDriverSpec ¶
type NVPeerDriverSpec struct {
// Image information for nv peer memory driver container
ImageSpec `json:""`
// GPU driver sources path - Optional
GPUDriverSourcePath string `json:"gpuDriverSourcePath,omitempty"`
}
NVPeerDriverSpec describes configuration options for NV Peer Memory driver
func (*NVPeerDriverSpec) DeepCopy ¶
func (in *NVPeerDriverSpec) DeepCopy() *NVPeerDriverSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NVPeerDriverSpec.
func (*NVPeerDriverSpec) DeepCopyInto ¶
func (in *NVPeerDriverSpec) DeepCopyInto(out *NVPeerDriverSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NicClusterPolicy ¶
type NicClusterPolicy struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec NicClusterPolicySpec `json:"spec,omitempty"`
Status NicClusterPolicyStatus `json:"status,omitempty"`
}
NicClusterPolicy is the Schema for the nicclusterpolicies API
func (*NicClusterPolicy) DeepCopy ¶
func (in *NicClusterPolicy) DeepCopy() *NicClusterPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NicClusterPolicy.
func (*NicClusterPolicy) DeepCopyInto ¶
func (in *NicClusterPolicy) DeepCopyInto(out *NicClusterPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NicClusterPolicy) DeepCopyObject ¶
func (in *NicClusterPolicy) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NicClusterPolicyList ¶
type NicClusterPolicyList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NicClusterPolicy `json:"items"`
}
NicClusterPolicyList contains a list of NicClusterPolicy
func (*NicClusterPolicyList) DeepCopy ¶
func (in *NicClusterPolicyList) DeepCopy() *NicClusterPolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NicClusterPolicyList.
func (*NicClusterPolicyList) DeepCopyInto ¶
func (in *NicClusterPolicyList) DeepCopyInto(out *NicClusterPolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NicClusterPolicyList) DeepCopyObject ¶
func (in *NicClusterPolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NicClusterPolicySpec ¶
type NicClusterPolicySpec struct {
OFEDDriver *OFEDDriverSpec `json:"ofedDriver,omitempty"`
NVPeerDriver *NVPeerDriverSpec `json:"nvPeerDriver,omitempty"`
DevicePlugin *DevicePluginSpec `json:"devicePlugin,omitempty"`
SecondaryNetwork *SecondaryNetworkSpec `json:"secondaryNetwork,omitempty"`
}
NicClusterPolicySpec defines the desired state of NicClusterPolicy
func (*NicClusterPolicySpec) DeepCopy ¶
func (in *NicClusterPolicySpec) DeepCopy() *NicClusterPolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NicClusterPolicySpec.
func (*NicClusterPolicySpec) DeepCopyInto ¶
func (in *NicClusterPolicySpec) DeepCopyInto(out *NicClusterPolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NicClusterPolicyStatus ¶
type NicClusterPolicyStatus struct {
// Reflects the current state of the cluster policy
// +kubebuilder:validation:Enum={"ignore", "notReady", "ready", "error"}
State State `json:"state"`
// Informative string in case the observed state is error
Reason string `json:"reason,omitempty"`
// AppliedStates provide a finer view of the observed state
AppliedStates []AppliedState `json:"appliedStates,omitempty"`
}
NicClusterPolicyStatus defines the observed state of NicClusterPolicy
func (*NicClusterPolicyStatus) DeepCopy ¶
func (in *NicClusterPolicyStatus) DeepCopy() *NicClusterPolicyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NicClusterPolicyStatus.
func (*NicClusterPolicyStatus) DeepCopyInto ¶
func (in *NicClusterPolicyStatus) DeepCopyInto(out *NicClusterPolicyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OFEDDriverSpec ¶
type OFEDDriverSpec struct {
// Image information for ofed driver container
ImageSpec `json:""`
}
OFEDDriverSpec describes configuration options for OFED driver
func (*OFEDDriverSpec) DeepCopy ¶
func (in *OFEDDriverSpec) DeepCopy() *OFEDDriverSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OFEDDriverSpec.
func (*OFEDDriverSpec) DeepCopyInto ¶
func (in *OFEDDriverSpec) DeepCopyInto(out *OFEDDriverSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecondaryNetworkSpec ¶
type SecondaryNetworkSpec struct {
// Image and configuration information for multus
Multus *MultusSpec `json:"multus,omitempty"`
// Image information for CNI plugins
CniPlugins *ImageSpec `json:"cniPlugins,omitempty"`
// Image information for IPAM plugin
IpamPlugin *ImageSpec `json:"ipamPlugin,omitempty"`
}
SecondaryNetwork describes configuration options for secondary network
func (*SecondaryNetworkSpec) DeepCopy ¶
func (in *SecondaryNetworkSpec) DeepCopy() *SecondaryNetworkSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecondaryNetworkSpec.
func (*SecondaryNetworkSpec) DeepCopyInto ¶
func (in *SecondaryNetworkSpec) DeepCopyInto(out *SecondaryNetworkSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.