Skip to content

Commit 40e9bac

Browse files
authored
Update OpenShift documentation to use a secret for licensing (#306)
Signed-off-by: Vitaliy Emporopulo <[email protected]>
1 parent 5435e5c commit 40e9bac

File tree

2 files changed

+39
-6
lines changed

2 files changed

+39
-6
lines changed
-752 KB
Loading

openshift/install-gpu-ocp.rst

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Installing the NVIDIA GPU Operator by using the web console
1313

1414
#. In the OpenShift Container Platform web console, from the side menu, navigate to **Operators** > **OperatorHub** and select **All Projects**.
1515

16-
#. In **Operators** > **OperatorHub**, search for the **NVIDIA GPU Operator**. For additional information, refer to the `Red Hat OpenShift Container Platform documentation <https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html>`_.
1716
#. In **Operators** > **OperatorHub**, search for the **NVIDIA GPU Operator**. For additional information, refer to the `Red Hat OpenShift Container Platform documentation <https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html>`_.
1817

1918
#. Select the **NVIDIA GPU Operator**, click **Install**. In the following screen, click **Install**.
@@ -263,7 +262,32 @@ Create the ClusterPolicy instance with NVIDIA vGPU
263262
Prerequisites
264263
--------------
265264

266-
* Refer to the :ref:`install-gpu-operator-vgpu` section for prerequisite steps for using NVIDIA vGPU on Red Hat OpenShift.
265+
Before creating the ClusterPolicy for NVIDIA vGPU, ensure the following:
266+
267+
* Refer to the :ref:`install-gpu-operator-vgpu` section for detailed prerequisite steps, including building the vGPU driver container image and obtaining licensing files.
268+
269+
* Create a licensing secret in the ``nvidia-gpu-operator`` namespace:
270+
271+
.. code-block:: console
272+
273+
$ oc create secret generic licensing-config \
274+
-n nvidia-gpu-operator --from-file=gridd.conf --from-file=client_configuration_token.tok
275+
276+
.. note::
277+
278+
Using a Kubernetes Secret to store licensing information is the recommended approach.
279+
The ``configMap`` option is deprecated and will be removed in a future release.
280+
281+
* If your private registry requires authentication, create an image pull secret:
282+
283+
.. code-block:: console
284+
285+
$ oc create secret docker-registry registry-secret \
286+
--docker-server=<private-registry-url> \
287+
--docker-username=<username> \
288+
--docker-password=<password> \
289+
--docker-email=<email-id> \
290+
-n nvidia-gpu-operator
267291
268292
Create the cluster policy using the web console
269293
-----------------------------------------------
@@ -272,7 +296,11 @@ Create the cluster policy using the web console
272296

273297
#. Select the **ClusterPolicy** tab, then click **Create ClusterPolicy**. The platform assigns the default name *gpu-cluster-policy*.
274298

275-
#. Provide the name of the licensing ``ConfigMap`` under the **Driver** section. This should be created during the prerequisite steps for NVIDIA vGPU. Refer to the following screenshots for examples and modify values accordingly.
299+
#. Provide the name of the licensing ``Secret`` under the **Driver** section. This should be created during the prerequisite steps for NVIDIA vGPU (for example, ``licensing-config``). Refer to the following screenshots for examples and modify values accordingly.
300+
301+
.. note::
302+
303+
The ``ConfigMap`` option is deprecated. Use a Kubernetes ``Secret`` to store licensing information instead.
276304

277305
.. image:: graphics/cluster_policy_vgpu_1.png
278306

@@ -305,14 +333,19 @@ Create the cluster policy using the CLI
305333
"driver": {
306334
"repository": "<repository-path>",
307335
"image": "driver",
308-
"imagePullSecrets": [],
336+
"imagePullSecrets": ["registry-secret"],
309337
"licensingConfig": {
310-
"configMapName": "licensing-config",
338+
"secretName": "licensing-config",
311339
"nlsEnabled": true
312340
},
313-
"version": "470.82.01"
341+
"version": "580.95.05"
314342
}
315343
344+
.. note::
345+
346+
Using ``secretName`` to reference a Kubernetes Secret is the recommended approach.
347+
The ``configMapName`` option is deprecated and will be removed in a future release.
348+
316349
.. code-block:: console
317350
318351
$ oc apply -f clusterpolicy.json

0 commit comments

Comments
 (0)