Skip to content

Commit 37c6b44

Browse files
add openshift clusterpolicy create web console docs (#177)
* add openshift clusterpolicy create webconsole docs Signed-off-by: Abigail McCarthy <[email protected]> Co-authored-by: Tariq <[email protected]> * add sandbox validator details Signed-off-by: Abigail McCarthy <[email protected]> --------- Signed-off-by: Abigail McCarthy <[email protected]> Co-authored-by: Tariq <[email protected]>
1 parent 4b8f7a0 commit 37c6b44

File tree

6 files changed

+50
-3
lines changed

6 files changed

+50
-3
lines changed
126 KB
Loading
137 KB
Loading
142 KB
Loading
114 KB
Loading
150 KB
Loading

openshift/openshift-virtualization.rst

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,14 @@ Node B receives the following software components:
5151

5252
* ``VFIO Manager`` - Optional. To load vfio-pci and bind it to all GPUs on the node.
5353
* ``Sandbox Device Plugin`` - Optional. To discover and advertise the passthrough GPUs to the kubelet.
54+
* ``Sandbox Validator`` -Optional. Validates that Sandbox Device Plugin is working.
5455

5556
Node C receives the following software components:
5657

5758
* ``NVIDIA vGPU Manager`` - To install the driver.
5859
* ``NVIDIA vGPU Device Manager`` - To create vGPU devices on the node.
5960
* ``Sandbox Device Plugin`` -Optional. To discover and advertise the vGPU devices to kubelet.
61+
* ``Sandbox Validator`` -Optional. Validates that Sandbox Device Plugin is working.
6062

6163

6264
******************************************
@@ -286,8 +288,8 @@ private container registry).
286288
.. _install-cluster-policy-vGPU:
287289

288290

289-
Creating a ClusterPolicy for the GPU Operator
290-
=============================================
291+
Creating a ClusterPolicy for the GPU Operator using the OpenShift Container Platform CLI
292+
=========================================================================================
291293

292294
As a cluster administrator, you can create a ClusterPolicy using the OpenShift Container Platform CLI.
293295
Create the cluster policy using the CLI:
@@ -330,6 +332,52 @@ Without additional configuration, the GPU Operator creates a default set of devi
330332
To learn more about how the vGPU Device Manager and configure which types of vGPU devices get created in your cluster, refer to :ref:`vGPU Device Configuration<vgpu-device-configuration>`.
331333

332334

335+
Creating a ClusterPolicy for the GPU Operator using the OpenShift Container Platform Web Console
336+
================================================================================================
337+
338+
As a cluster administrator, you can create a ClusterPolicy using the OpenShift Container Platform web console.
339+
340+
#. Navigate to **Operators** > **Installed Operators** and find your installed NVIDIA GPU Operator.
341+
342+
#. Under *Provided APIs*, click **ClusterPolicy**.
343+
344+
345+
.. image:: graphics/navigate_to_cluster_policy.png
346+
347+
348+
#. Click **Create ClusterPolicy**.
349+
350+
.. image:: graphics/create_cluster_policy.png
351+
352+
#. Expand the **NVIDIA GPU/vGPU Driver config** section.
353+
354+
#. Expand the **Sandbox Workloads config** section and select the checkbox to enable sandbox workloads.
355+
356+
In general, when sandbox workloads are enabled, ``ClusterPolicy`` controls whether the GPU Operator can provision GPU worker nodes for virtual machine workloads, in addition to container workloads. This flag is disabled by default, meaning all nodes get provisioned with the same software which enables container workloads, and the ``nvidia.com/gpu.workload.config`` node label is not used.
357+
358+
The term ``sandboxing`` refers to running software in a separate isolated environment, typically for added security (i.e. a virtual machine). We use the term ``sandbox workloads`` to signify workloads that run in a virtual machine, irrespective of the virtualization technology used.
359+
* Click **Create** to create the ClusterPolicy.
360+
361+
.. image:: graphics/cluster_policy_enable_sandbox_workloads.png
362+
363+
#. If you are planning to use NVIDIA vGPU, expand the **NVIDIA vGPU Manager config** section and fill in your desired configuration settings, including:
364+
365+
* Select the **enabled** checkbox to enable the NVIDIA vGPU Manager.
366+
* Add your **imagePullSecrets**.
367+
* Under *driverManager*, fill in **repository** with the path to your private repository.
368+
* Under *env*, fill in **image** with ``vgpu-manager`` and the **version** with your driver version.
369+
370+
If you are only using GPU passthrough, you dont need to fill this section out.
371+
372+
.. image:: graphics/cluster_policy_configure_vgpu.png
373+
374+
#. Click **Create** to create the ClusterPolicy.
375+
376+
The vGPU Device Manager, deployed by the GPU Operator, automatically creates vGPU devices which can be assigned to KubeVirt VMs.
377+
Without additional configuration, the GPU Operator creates a default set of devices on all GPUs.
378+
To learn more about the vGPU Device Manager and how to configure which types of vGPU devices get created in your cluster, refer to :ref:`vGPU Device Configuration<vgpu-device-configuration>`.
379+
380+
333381
*******************************************************
334382
Add GPU Resources to the HyperConverged Custom Resource
335383
*******************************************************
@@ -404,7 +452,6 @@ The following example permits the A10 GPU device and A10-24Q vGPU device.
404452

405453
Refer to the `KubeVirt user guide <https://kubevirt.io/user-guide/virtual_machines/host-devices/#listing-permitted-devices>`_ for more information on the configuration options.
406454

407-
408455
About Mediated Devices
409456
======================
410457

0 commit comments

Comments
 (0)