Merge pull request #1534 from tkatila/crd-comment-updates

Author: mythi

deployments/operator/crd/bases/deviceplugin.intel.com_gpudeviceplugins.yaml

@@ -51,7 +51,8 @@ spec:
             properties:
               enableMonitoring:
                 description: EnableMonitoring enables the monitoring resource ('i915_monitoring')
-                  which gives access to all GPU devices on given node.
+                  which gives access to all GPU devices on given node. Typically used
+                  with Intel XPU-Manager.
                 type: boolean
               image:
                 description: Image is a container image with GPU device plugin executable.
@@ -73,15 +74,16 @@ spec:
               preferredAllocationPolicy:
                 description: PreferredAllocationPolicy sets the mode of allocating
                   GPU devices on a node. See documentation for detailed description
-                  of the policies. Only valid when SharedDevNum > 1 is set.
+                  of the policies. Only valid when SharedDevNum > 1 is set. Not applicable
+                  with ResourceManager.
                 enum:
                 - balanced
                 - packed
                 - none
                 type: string
               resourceManager:
                 description: ResourceManager handles the fractional resource management
-                  for multi-GPU nodes
+                  for multi-GPU nodes. Enable only for clusters with GPU Aware Scheduling.
                 type: boolean
               sharedDevNum:
                 description: SharedDevNum is a number of containers that can share

deployments/operator/crd/bases/deviceplugin.intel.com_sgxdeviceplugins.yaml

@@ -58,8 +58,9 @@ spec:
                 description: Image is a container image with SGX device plugin executable.
                 type: string
               initImage:
-                description: InitImage is a container image with tools (e.g., SGX
-                  NFD source hook) installed on each node.
+                description: InitImage is a container image with tools (i.e., SGX
+                  NFD source hook) installed on each node. Recommendation is to leave
+                  this unset and prefer the SGX NodeFeatureRule instead.
                 type: string
               logLevel:
                 description: LogLevel sets the plugin's log level.

pkg/apis/deviceplugin/v1/gpudeviceplugin_types.go

@@ -36,6 +36,7 @@ type GpuDevicePluginSpec struct {
 
 	// PreferredAllocationPolicy sets the mode of allocating GPU devices on a node.
 	// See documentation for detailed description of the policies. Only valid when SharedDevNum > 1 is set.
+	// Not applicable with ResourceManager.
 	// +kubebuilder:validation:Enum=balanced;packed;none
 	PreferredAllocationPolicy string `json:"preferredAllocationPolicy,omitempty"`
 
@@ -47,11 +48,11 @@ type GpuDevicePluginSpec struct {
 	// +kubebuilder:validation:Minimum=0
 	LogLevel int `json:"logLevel,omitempty"`
 
-	// ResourceManager handles the fractional resource management for multi-GPU nodes
+	// ResourceManager handles the fractional resource management for multi-GPU nodes. Enable only for clusters with GPU Aware Scheduling.
 	ResourceManager bool `json:"resourceManager,omitempty"`
 
 	// EnableMonitoring enables the monitoring resource ('i915_monitoring')
-	// which gives access to all GPU devices on given node.
+	// which gives access to all GPU devices on given node. Typically used with Intel XPU-Manager.
 	EnableMonitoring bool `json:"enableMonitoring,omitempty"`
 }
 

pkg/apis/deviceplugin/v1/sgxdeviceplugin_types.go

@@ -31,7 +31,8 @@ type SgxDevicePluginSpec struct {
 	// Image is a container image with SGX device plugin executable.
 	Image string `json:"image,omitempty"`
 
-	// InitImage is a container image with tools (e.g., SGX NFD source hook) installed on each node.
+	// InitImage is a container image with tools (i.e., SGX NFD source hook) installed on each node.
+	// Recommendation is to leave this unset and prefer the SGX NodeFeatureRule instead.
 	InitImage string `json:"initImage,omitempty"`
 
 	// EnclaveLimit is a number of containers that can share the same SGX enclave device.