Skip to content

Commit fca22ae

Browse files
committed
Update NVAIE doc for OpenShift to use a secret for licensing
Signed-off-by: Vitaliy Emporopulo <[email protected]>
1 parent 09e1404 commit fca22ae

File tree

2 files changed

+34
-14
lines changed

2 files changed

+34
-14
lines changed
94.7 KB
Loading

openshift/nvaie-with-ocp.rst

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The steps involved are:
4444

4545
- Step 3: Create the NGC secret
4646

47-
- Step 4: Create the ConfigMap
47+
- Step 4: Create the licensing Secret
4848

4949
- Step 5: Create the Cluster Policy
5050

@@ -151,36 +151,52 @@ NGC container registry).
151151

152152
.. image:: graphics/created_pull-secret.png
153153

154-
Create the ConfigMap for NLS Token
155-
==================================
154+
Create the licensing Secret for NLS Token
155+
==========================================
156156

157157
Prerequisites
158158
-------------
159159

160-
Generate and download a NLS client license token. See Section 4.6 of the `NVIDIA License System User Guide <https://docs.nvidia.com/license-system/latest/pdf/nvidia-license-system-user-guide.pdf>`_ for instructions.
160+
#. Generate and download a NLS client license token. See Section 4.6 of the `NVIDIA License System User Guide <https://docs.nvidia.com/license-system/latest/pdf/nvidia-license-system-user-guide.pdf>`_ for instructions.
161+
Save the token to a file named ``client_configuration_token.tok``.
162+
163+
#. Create an empty ``gridd.conf`` file.
161164

162165
Procedure
163166
---------
164167

168+
Create a licensing secret in the ``nvidia-gpu-operator`` namespace via CLI:
169+
170+
.. code-block:: console
171+
172+
$ oc create secret generic licensing-config \
173+
-n nvidia-gpu-operator --from-file=gridd.conf --from-file=client_configuration_token.tok
174+
175+
Alternatively, you can create the secret using the OpenShift web console:
176+
165177
#. Navigate to **Home** > **Projects** and ensure the ``nvidia-gpu-operator`` is selected.
166178

167179
#. Select the **Workloads** Drop Down menu.
168180

169-
#. Select **ConfigMaps** and then click **Create ConfigMap**.
181+
#. Select **Secrets** and then click **Create**/ > **Key/value secret**.
170182

171-
#. On the **Create ConfigMap** window, click **YAML view**.
172-
173-
#. Enter the details for your config map.
183+
#. Enter the details for your secret.
174184

175185
#. The ``name`` must be ``licensing-config``.
176186

177-
#. Copy and paste the information for your NLS client token into the ``client_configuration_token.tok`` parameter.
187+
#. Upload the two files as keys:
188+
189+
* ``client_configuration_token.tok``
190+
* ``gridd.conf``
178191

179-
.. image:: graphics/create_config_map1.png
180-
:alt: Create ConfigMap window of the OpenShift Console.
192+
.. image:: graphics/create_licensing_secret.png
181193

182194
#. Click **Create**.
183195

196+
.. note::
197+
198+
Using a Kubernetes Secret to store licensing information is the recommended approach.
199+
The ``configMap`` option is deprecated and will be removed in a future release.
184200

185201
Create the Cluster Policy Instance
186202
==================================
@@ -194,13 +210,17 @@ Now create the cluster policy, which is responsible for maintaining policy resou
194210
The console assigns the default name ``gpu-cluster-policy``.
195211

196212
#. Expand the drop down for **NVIDIA GPU/vGPU Driver config** and then **licensingConfig**.
197-
In the **configMapName** field, enter the name of the licensing config map that you created previously, ``licensing-config``.
213+
In the **secretName** field, enter the name of the licensing Secret that you created previously, ``licensing-config``.
198214
Select the **nlsEnabled** checkbox.
199215
Refer the screenshots for parameter examples and modify values accordingly.
200216

201-
.. image:: graphics/cluster_policy_1.png
217+
.. note::
218+
219+
The ``ConfigMap`` option (``configMapName``) is deprecated. Use a Kubernetes ``Secret`` (``secretName``) to store licensing information instead.
220+
221+
.. image:: graphics/cluster_policy_vgpu_1.png
202222

203-
* **configMapName**: licensing-config
223+
* **secretName**: licensing-config
204224
* **nlsEnabled**: nlsEnabled
205225
* **enabled**: enabled
206226

0 commit comments

Comments
 (0)