From df6cf952532f88cb2b7a45f38721bad2ce6a3ec3 Mon Sep 17 00:00:00 2001 From: Tuomas Katila Date: Thu, 14 Sep 2023 10:47:34 +0300 Subject: [PATCH] sgx & gpu crds: improve comments and note sgx's initimage replacement with NFD rules Signed-off-by: Tuomas Katila --- .../bases/deviceplugin.intel.com_gpudeviceplugins.yaml | 8 +++++--- .../bases/deviceplugin.intel.com_sgxdeviceplugins.yaml | 4 ++-- pkg/apis/deviceplugin/v1/gpudeviceplugin_types.go | 5 +++-- pkg/apis/deviceplugin/v1/sgxdeviceplugin_types.go | 2 +- 4 files changed, 11 insertions(+), 8 deletions(-) diff --git a/deployments/operator/crd/bases/deviceplugin.intel.com_gpudeviceplugins.yaml b/deployments/operator/crd/bases/deviceplugin.intel.com_gpudeviceplugins.yaml index dabfa1bcc..56d7cd1ea 100644 --- a/deployments/operator/crd/bases/deviceplugin.intel.com_gpudeviceplugins.yaml +++ b/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,7 +74,8 @@ 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 @@ -81,7 +83,7 @@ spec: 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 diff --git a/deployments/operator/crd/bases/deviceplugin.intel.com_sgxdeviceplugins.yaml b/deployments/operator/crd/bases/deviceplugin.intel.com_sgxdeviceplugins.yaml index 3d032db35..eded2a496 100644 --- a/deployments/operator/crd/bases/deviceplugin.intel.com_sgxdeviceplugins.yaml +++ b/deployments/operator/crd/bases/deviceplugin.intel.com_sgxdeviceplugins.yaml @@ -58,8 +58,8 @@ 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: Recommendation is to leave this unset and prefer the + SGX NodeFeatureRule. type: string logLevel: description: LogLevel sets the plugin's log level. diff --git a/pkg/apis/deviceplugin/v1/gpudeviceplugin_types.go b/pkg/apis/deviceplugin/v1/gpudeviceplugin_types.go index 2e464c212..3fdede394 100644 --- a/pkg/apis/deviceplugin/v1/gpudeviceplugin_types.go +++ b/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"` } diff --git a/pkg/apis/deviceplugin/v1/sgxdeviceplugin_types.go b/pkg/apis/deviceplugin/v1/sgxdeviceplugin_types.go index b36f53f6f..f7a055aad 100644 --- a/pkg/apis/deviceplugin/v1/sgxdeviceplugin_types.go +++ b/pkg/apis/deviceplugin/v1/sgxdeviceplugin_types.go @@ -31,7 +31,7 @@ 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. + // Recommendation is to leave this unset and prefer the SGX NodeFeatureRule. InitImage string `json:"initImage,omitempty"` // EnclaveLimit is a number of containers that can share the same SGX enclave device.