Skip to content

Commit 9378307

Browse files
shivakunvShiva Kumar
andauthored
update documentation for NLS licensing token use for secret (#285)
* update documentation for NLS licensing token use for secret Signed-off-by: Shiva Kumar (SW-CLOUD) <[email protected]> Signed-off-by: Abigail McCarthy <[email protected]> * Minor changes for style guide compliance Signed-off-by: Andrew Chen <[email protected]> update documentation for NLS licensing token use for secret Signed-off-by: Shiva Kumar (SW-CLOUD) <[email protected]> Signed-off-by: Abigail McCarthy <[email protected]> --------- Signed-off-by: Shiva Kumar (SW-CLOUD) <[email protected]> Signed-off-by: Abigail McCarthy <[email protected]> Co-authored-by: Shiva Kumar <[email protected]>
1 parent 6b1be84 commit 9378307

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

gpu-operator/install-gpu-operator-nvaie.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,24 +117,29 @@ Procedure
117117
Updating NLS Client License Token
118118
*********************************
119119

120-
In case the NLS client license token needs to be updated, please use the following procedure:
120+
In case the NLS client license token needs to be updated, use the following procedure:
121121

122122
Create an empty vGPU license configuration file:
123123

124124
.. code-block:: console
125125
126126
$ sudo touch gridd.conf
127127
128-
Generate and download a new NLS client license token. Please refer to Section 4.6 of the `NLS User Guide <https://docs.nvidia.com/license-system/latest/pdf/nvidia-license-system-user-guide.pdf>`_ for instructions.
128+
Generate and download a new NLS client license token. Refer to Section 4.6 of the `NLS User Guide <https://docs.nvidia.com/license-system/latest/pdf/nvidia-license-system-user-guide.pdf>`_ for instructions.
129129

130130
Rename the NLS client license token that you downloaded to ``client_configuration_token.tok``.
131131

132-
Create a new ``licensing-config-new`` ConfigMap object in the ``gpu-operator`` namespace (make sure the name of the configmap is not already used in the kubernetes cluster). Both the vGPU license configuration file and the NLS client license token will be added to this ConfigMap:
132+
.. warning::
133+
134+
The ``configMap(configMapName)`` is **deprecated** and will be removed in a future release.
135+
Use ``secrets(secretName)`` instead.
136+
137+
Create a new ``licensing-config-new`` Secret object in the ``gpu-operator`` namespace (make sure the name of the secret is not already used in the kubernetes cluster). Both the vGPU license configuration file and the NLS client license token will be added to this Secret:
133138

134139

135140
.. code-block:: console
136141
137-
$ kubectl create configmap licensing-config-new \
142+
$ kubectl create secret generic licensing-config-new \
138143
-n gpu-operator --from-file=gridd.conf --from-file=<path>/client_configuration_token.tok
139144
140145
@@ -150,14 +155,14 @@ Go to the driver section and replace the following argument:
150155
.. code-block:: console
151156
152157
licensingConfig:
153-
configMapName: licensing-config
158+
secretName: licensing-config
154159
155160
with
156161

157162
.. code-block:: console
158163
159164
licensingConfig:
160-
configMapName: licensing-config-new
165+
secretName: licensing-config-new
161166
162167
Write and exit from the kubectl edit session (you can use :qw for instance if vi utility is used)
163168

gpu-operator/install-gpu-operator-vgpu.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,11 +207,11 @@ Configure the Cluster with the vGPU License Information and the Driver Container
207207
208208
$ kubectl create namespace gpu-operator
209209
210-
#. Create a config map that is named ``licensing-config`` using the ``gridd.conf`` and ``client_configuration_token.tok`` files:
210+
#. Create a secret that is named ``licensing-config`` using the ``gridd.conf`` and ``client_configuration_token.tok`` files:
211211

212212
.. code-block:: console
213213
214-
$ kubectl create configmap licensing-config \
214+
$ kubectl create secret generic licensing-config \
215215
-n gpu-operator --from-file=gridd.conf --from-file=client_configuration_token.tok
216216
217217
#. Create an image pull secret in the ``gpu-operator`` namespace with the registry secret and private registry.
@@ -249,7 +249,7 @@ Install the Operator
249249
--set driver.repository=${PRIVATE_REGISTRY} \
250250
--set driver.version=${VGPU_DRIVER_VERSION} \
251251
--set driver.imagePullSecrets={$REGISTRY_SECRET_NAME} \
252-
--set driver.licensingConfig.configMapName=licensing-config
252+
--set driver.licensingConfig.secretName=licensing-config
253253
254254
The preceding command installs the Operator with the default configuration.
255255
Refer to :ref:`gpu-operator-helm-chart-options` for information about configuration options.

0 commit comments

Comments
 (0)