Update PCIDevice doc comments

kubernetes-sigs · Jun 20, 2024 · f18ba35 · f18ba35
1 parent 438c6e5
commit f18ba35
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/apis/v1beta1/types.go b/apis/v1beta1/types.go
@@ -251,19 +251,22 @@ type PCIDeviceSpec struct {
 	// DeviceID is the device ID of a virtual machine's PCI, in integer.
 	// Defaults to the eponymous property value in the template from which the
 	// virtual machine is cloned.
-	// Mutually exclusive with VGPUProfile.
+	// Mutually exclusive with VGPUProfile as VGPUProfile and DeviceID + VendorID
+	// are two independent ways to define PCI devices.
 	// +kubebuilder:validation:Required
 	DeviceID *int32 `json:"deviceId,omitempty"`
 	// VendorId is the vendor ID of a virtual machine's PCI, in integer.
 	// Defaults to the eponymous property value in the template from which the
 	// virtual machine is cloned.
-	// Mutually exclusive with VGPUProfile.
+	// Mutually exclusive with VGPUProfile as VGPUProfile and DeviceID + VendorID
+	// are two independent ways to define PCI devices.
 	// +kubebuilder:validation:Required
 	VendorID *int32 `json:"vendorId,omitempty"`
 	// VGPUProfile is the profile name of a virtual machine's vGPU, in string.
 	// Defaults to the eponymous property value in the template from which the
 	// virtual machine is cloned.
-	// Mutually exclusive with DeviceID and VendorID.
+	// Mutually exclusive with DeviceID and VendorID as VGPUProfile and DeviceID + VendorID
+	// are two independent ways to define PCI devices.
 	// +kubebuilder:validation:Required
 	VGPUProfile string `json:"vGPUProfile,omitempty"`
 	// CustomLabel is the hardware label of a virtual machine's PCI device.