Skip to content

Commit df87f0b

Browse files
committed
Update microk8s env vars and descriptions
Signed-off-by: Andrew Chen <[email protected]>
1 parent 19e7747 commit df87f0b

File tree

1 file changed

+20
-25
lines changed

1 file changed

+20
-25
lines changed

gpu-operator/getting-started.rst

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -483,10 +483,8 @@ options are used with the container-toolkit deployed with GPU Operator:
483483
value: /var/snap/microk8s/common/run/containerd.sock
484484
- name: RUNTIME_CONFIG_SOURCE
485485
value: file=/var/snap/microk8s/current/args/containerd.toml
486-
- name: CONTAINERD_RUNTIME_CLASS
487-
value: nvidia
488-
- name: CONTAINERD_SET_AS_DEFAULT
489-
value: true
486+
- name: NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES
487+
value: "cdi.k8s.io/"
490488
491489
492490
If you need to specify custom values, refer to the following sample command for the syntax:
@@ -503,42 +501,39 @@ If you need to specify custom values, refer to the following sample command for
503501
--set toolkit.env[1].value=/var/snap/microk8s/common/run/containerd.sock \
504502
--set toolkit.env[2].name=RUNTIME_CONFIG_SOURCE \
505503
--set toolkit.env[2].value=file=/var/snap/microk8s/current/args/containerd.toml \
506-
--set toolkit.env[2].name=CONTAINERD_RUNTIME_CLASS \
507-
--set toolkit.env[2].value=nvidia \
508-
--set toolkit.env[3].name=CONTAINERD_SET_AS_DEFAULT \
509-
--set-string toolkit.env[3].value=true
504+
--set toolkit.env[2].name=NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES \
505+
--set toolkit.env[2].value="cdi.k8s.io/"
510506
511507
These options are defined as follows:
512508

513509
CONTAINERD_CONFIG
514510
The path on the host to the ``containerd`` config
515511
you would like to have updated with support for the ``nvidia-container-runtime``.
516-
By default this will point to ``/etc/containerd/config.toml`` (the default
517-
location for ``containerd``). It should be customized if your ``containerd``
512+
By default this will point to ``/var/snap/microk8s/current/args/containerd-template.toml``
513+
(the default location for ``containerd``). It should be customized if your ``containerd``
518514
installation is not in the default location.
519515

520516
CONTAINERD_SOCKET
521517
The path on the host to the socket file used to
522518
communicate with ``containerd``. The operator will use this to send a
523519
``SIGHUP`` signal to the ``containerd`` daemon to reload its config. By
524-
default this will point to ``/run/containerd/containerd.sock``
520+
default this will point to ``/var/snap/microk8s/common/run/containerd.sock``
525521
(the default location for ``containerd``). It should be customized if
526522
your ``containerd`` installation is not in the default location.
527523

528-
CONTAINERD_RUNTIME_CLASS
529-
The name of the
530-
`Runtime Class <https://kubernetes.io/docs/concepts/containers/runtime-class>`_
531-
you would like to associate with the ``nvidia-container-runtime``.
532-
Pods launched with a ``runtimeClassName`` equal to CONTAINERD_RUNTIME_CLASS
533-
will always run with the ``nvidia-container-runtime``. The default
534-
CONTAINERD_RUNTIME_CLASS is ``nvidia``.
535-
536-
CONTAINERD_SET_AS_DEFAULT
537-
A flag indicating whether you want to set
538-
``nvidia-container-runtime`` as the default runtime used to launch all
539-
containers. When set to false, only containers in pods with a ``runtimeClassName``
540-
equal to CONTAINERD_RUNTIME_CLASS will be run with the ``nvidia-container-runtime``.
541-
The default value is ``true``.
524+
RUNTIME_CONFIG_SOURCE
525+
The path on the host to the runtime config source file used to
526+
load the nvidia-container-runtime into the containerd runtime.
527+
By default this will point to ``/var/snap/microk8s/current/args/containerd.toml``
528+
(the default location for ``containerd``). It should be customized if
529+
your ``containerd`` installation is not in the default location.
530+
531+
NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES
532+
The annotation prefix for the CDI modes.
533+
By default this will point to ``cdi.k8s.io/``
534+
(the default prefix for CDI modes). It should be customized if
535+
your CDI installation is not in the default location.
536+
542537

543538
Rancher Kubernetes Engine 2
544539
===========================

0 commit comments

Comments
 (0)