Update README.md; add Contributor License Agreement, update License Agreement, remove vgpu support, add iommufd support

Signed-off-by: Rajat Chopra <rajatc@nvidia.com>

Author: rajatchopra

.gitignore

@@ -1,4 +1,4 @@
 _out
 vendor/**/*_test.go
 coverage.out
-nvidia-kubevirt-gpu-device-plugin
+nvidia-sandbox-device-plugin

Dockerfile

@@ -28,7 +28,7 @@ FROM nvcr.io/nvidia/cuda:12.9.1-base-ubi9 as builder
 
 RUN yum install -y wget make gcc
 
-ARG GOLANG_VERSION=1.24.0
+ARG GOLANG_VERSION=1.24.7
 RUN wget -nv -O - https://storage.googleapis.com/golang/go${GOLANG_VERSION}.linux-amd64.tar.gz \
     | tar -C /usr/local -xz
 
@@ -38,7 +38,7 @@ ENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH
 ENV GOOS=linux\
     GOARCH=amd64
 
-WORKDIR /go/src/kubevirt-gpu-device-plugin
+WORKDIR /go/src/sandbox-device-plugin
 
 COPY . . 
 
@@ -48,17 +48,17 @@ FROM nvcr.io/nvidia/distroless/go:v3.1.11
 
 ARG VERSION
 
-LABEL io.k8s.display-name="NVIDIA KubeVirt GPU Device Plugin"
-LABEL name="NVIDIA KubeVirt GPU Device Plugin"
+LABEL io.k8s.display-name="NVIDIA Sandbox Device Plugin"
+LABEL name="NVIDIA Sandbox Device Plugin"
 LABEL vendor="NVIDIA"
 LABEL version="${VERSION}"
 LABEL release="N/A"
-LABEL summary="NVIDIA device plugin for KubeVirt"
+LABEL summary="NVIDIA Sandbox Device Plugin"
 LABEL description="See summary"
 
-COPY --from=builder /go/src/kubevirt-gpu-device-plugin/nvidia-kubevirt-gpu-device-plugin /usr/bin/
-COPY --from=builder /go/src/kubevirt-gpu-device-plugin/utils/pci.ids /usr/pci.ids
+COPY --from=builder /go/src/sandbox-device-plugin/nvidia-sandbox-device-plugin /usr/bin/
+COPY --from=builder /go/src/sandbox-device-plugin/utils/pci.ids /usr/pci.ids
 
 USER 0:0
 
-CMD ["nvidia-kubevirt-gpu-device-plugin"]
+CMD ["nvidia-sandbox-device-plugin"]

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.
+Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

Makefile

@@ -24,19 +24,19 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-DOCKER_REPO ?= "nvcr.io/nvidia/kubevirt-gpu-device-plugin"
+DOCKER_REPO ?= "nvcr.io/nvidia/sandbox-device-plugin"
 DOCKER_TAG ?= v1.4.0
 
 PCI_IDS_URL ?= https://pci-ids.ucw.cz/v2.2/pci.ids
 
 build:
-	go build -o nvidia-kubevirt-gpu-device-plugin kubevirt-gpu-device-plugin/cmd
+	go build -o nvidia-sandbox-device-plugin ./cmd
 test:
 	go test ./... -coverprofile=coverage.out -v
 test-coverage:
 	go tool cover -html=coverage.out
 clean:
-	rm -rf nvidia-kubevirt-gpu-device-plugin && rm -rf coverage.out
+	rm -f nvidia-sandbox-device-plugin && rm -rf coverage.out
 build-image:
 	docker build . -t $(DOCKER_REPO):$(DOCKER_TAG) 
 push-image: build-image

README.md

@@ -1,6 +1,4 @@
-# NVIDIA K8s Device Plugin to assign GPUs and vGPUs to KubeVirt VMs
-
-> Starting from v1.1.0, we will only be supporting KubeVirt v0.36.0 or newer. Please use v1.0.1 for compatibility with older KubeVirt versions.
+# NVIDIA K8s Device Plugin to assign Passthrough GPUs to Kata VMs for Confidential Containers
 
 ## Table of Contents
 - [About](#about)
@@ -10,26 +8,21 @@
 - [Docs](#docs)
 
 ## About
-This is a kubernetes device plugin that can discover and expose GPUs and vGPUs on a kubernetes node. This device plugin will enable to launch GPU attached [KubeVirt](https://github.com/kubevirt/kubevirt/blob/master/README.md) VMs in your kubernetes cluster. Its specifically developed to serve KubeVirt workloads in a Kubernetes cluster.
+This is a kubernetes device plugin that can discover and expose GPUs for passthrough on a kubernetes node. This device plugin will enable to launch GPU attached [Kata](https://katacontainers.io/) VM based containers in your kubernetes cluster. Its specifically developed to serve Kata workloads in a Kubernetes cluster.
 
 
 ## Features
 - Discovers Nvidia GPUs which are bound to VFIO-PCI driver and exposes them as devices available to be attached to VM in pass through mode.
-- Discovers Nvidia vGPUs configured on a kubernetes node and exposes them to be attached to KubeVirt VMs
 - Performs basic health check on the GPU on a kubernetes node.
 
 ## Prerequisites
-- Need to have Nvidia GPU configured for GPU passthrough or vGPU. Quickstart section provides details about this
+- Need to have Nvidia GPU configured for GPU passthrough. Quickstart section provides details about this
 - Kubernetes version >= v1.11
-- KubeVirt release >= v0.36.0
-- KubeVirt GPU feature gate should be enabled and permitted devices should be whitelisted. Feature gate is enabled by creating a ConfigMap. ConfigMap yaml can be found under `/examples`.
+- Kata release >= v3.23.0
 
 ## Quick Start
 
-Before starting the device plug, the GPUs on a kubernetes node need to configured to be in GPU pass through mode or vGPU mode
-
-### Whitelist GPU and vGPU in KubeVirt CR
-GPUs and vGPUs should be allowlisted in the KubeVirt CR following the instructions outlined [here](https://kubevirt.io/user-guide/virtual_machines/host-devices/#listing-permitted-devices). An example KubeVirt CR can be found under `/examples`.
+Before starting the device plug, the GPUs on a kubernetes node need to configured to be in GPU pass through mode.
 
 ### Preparing a GPU to be used in pass through mode
 GPU needs to be loaded with VFIO-PCI driver to be used in pass through mode
@@ -107,75 +100,12 @@ $ lspci -nnk -d 10de:
         Kernel driver in use: vfio-pci
         Kernel modules: nouveau
 ```
---------------------------------------------------------------
-### Preparing a GPU to be used in vGPU mode
-Nvidia Virtual GPU manager needs to be installed on the host to configure GPUs in vGPU mode.
-
-##### 1. Change to the mdev_supported_types directory for the physical GPU.
-```shell
-$ cd /sys/class/mdev_bus/domain\:bus\:slot.function/mdev_supported_types/
-```
-This example changes to the mdev_supported_types directory for the GPU with the domain 0000 and PCI device BDF 06:00.0.
-```shell
-$ cd /sys/bus/pci/devices/0000\:06\:00.0/mdev_supported_types/
-```
-##### 2. Find out which subdirectory of mdev_supported_types contains registration information for the vGPU type that you want to create.
-```shell
-$ grep -l "vgpu-type" nvidia-*/name
-vgpu-type
-```
-The vGPU type, for example, M10-2Q.
-This example shows that the registration information for the M10-2Q vGPU type is contained in the nvidia-41 subdirectory of mdev_supported_types.
-```shell
-$ grep -l "M10-2Q" nvidia-*/name
-nvidia-41/name
-```
-##### 3. Confirm that you can create an instance of the vGPU type on the physical GPU.
-```shell
-$ cat subdirectory/available_instances
-```
-**subdirectory** -- The subdirectory that you found in the previous step, for example, nvidia-41.
-
-The number of available instances must be at least 1. If the number is 0, either an instance of another vGPU type already exists on the physical GPU, or the maximum number of allowed instances has already been created.
-
-This example shows that four more instances of the M10-2Q vGPU type can be created on the physical GPU.
-```shell
-$ cat nvidia-41/available_instances
-4
-```
-##### 4. Generate a correctly formatted universally unique identifier (UUID) for the vGPU.
-```shell
-$ uuidgen
-aa618089-8b16-4d01-a136-25a0f3c73123
-```
-##### 5. Write the UUID that you obtained in the previous step to create the file in the registration information directory for the vGPU type that you want to create.
-```shell
-$ echo "uuid"> subdirectory/create
-```
-**uuid** -- The UUID that you generated in the previous step, which will become the UUID of the vGPU that you want to create.
-
-**subdirectory** -- The registration information directory for the vGPU type that you want to create, for example, nvidia-41.
-
-This example creates an instance of the M10-2Q vGPU type with the UUID aa618089-8b16-4d01-a136-25a0f3c73123.
-```shell
-$ echo "aa618089-8b16-4d01-a136-25a0f3c73123" > nvidia-41/create
-```
-An mdev device file for the vGPU is added to the parent physical device directory of the vGPU. The vGPU is identified by its UUID.
-
-The /sys/bus/mdev/devices/ directory contains a symbolic link to the mdev device file.
-
-##### 6. Confirm that the vGPU was created.
-```shell
-$ ls -l /sys/bus/mdev/devices/
-total 0
-lrwxrwxrwx. 1 root root 0 Nov 24 13:33 aa618089-8b16-4d01-a136-25a0f3c73123 -> ../../../devices/pci0000:00/0000:00:03.0/0000:03:00.0/0000:04:09.0/0000:06:00.0/aa618089-8b16-4d01-a136-25a0f3c73123
-```
 
 ## Docs
 ### Deployment
 The daemon set creation yaml can be used to deploy the device plugin. 
 ```
-kubectl apply -f nvidia-kubevirt-gpu-device-plugin.yaml
+kubectl apply -f nvidia-sandbox-device-plugin.yaml
 ```
 
 Example YAMLs for creating VMs with GPU/vGPU are in the `examples` folder
@@ -185,7 +115,7 @@ Example YAMLs for creating VMs with GPU/vGPU are in the `examples` folder
 Change to proper DOCKER_REPO and DOCKER_TAG env before building images
 e.g.
 ```shell
-export DOCKER_REPO="quay.io/nvidia/kubevirt-gpu-device-plugin"
+export DOCKER_REPO="quay.io/nvidia/nvidia-sandbox-device-plugin"
 export DOCKER_TAG=devel
 ```
 
@@ -203,5 +133,5 @@ make push-image DOCKER_REPO=<docker-repo-url> DOCKER_TAG=<image-tag>
 ```
 ### To Do
 - Improve the healthcheck mechanism for GPUs with VFIO-PCI drivers
-- Support GetPreferredAllocation API of DevicePluginServer. It returns a preferred set of devices to allocate from a list of available ones. The resulting preferred allocation is not guaranteed to be the allocation ultimately performed by the devicemanager. It is only designed to help the devicemanager make a more informed allocation decision when possible. It has not been implemented in kubevirt-gpu-device-plugin.
+- Support GetPreferredAllocation API of DevicePluginServer. It returns a preferred set of devices to allocate from a list of available ones. The resulting preferred allocation is not guaranteed to be the allocation ultimately performed by the devicemanager. It is only designed to help the devicemanager make a more informed allocation decision when possible. It has not been implemented in sandbox-device-plugin.
 --------------------------------------------------------------

cmd/main.go

@@ -1,35 +1,39 @@
-/*
- * Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *  * Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- *  * Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- *  * Neither the name of NVIDIA CORPORATION nor the names of its
- *    contributors may be used to endorse or promote products derived
- *    from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
- * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package main
-
-import "kubevirt-gpu-device-plugin/pkg/device_plugin"
-
-func main() {
-	device_plugin.InitiateDevicePlugin()
-}
+/*
+ * Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *  * Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *  * Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *  * Neither the name of NVIDIA CORPORATION nor the names of its
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package main
+
+import (
+	"github.com/nvidia/sandbox-device-plugin/pkg/device_plugin"
+	"os"
+)
+
+func main() {
+	device_plugin.PGPUAlias = os.Getenv("P_GPU_ALIAS")
+	device_plugin.InitiateDevicePlugin()
+}

go.mod

@@ -1,15 +1,14 @@
-module kubevirt-gpu-device-plugin
+module github.com/nvidia/sandbox-device-plugin
 
-go 1.23.0
+go 1.24.6
 
-toolchain go1.23.5
+toolchain go1.24.7
 
 require (
-	github.com/NVIDIA/gpu-monitoring-tools v0.0.0-20211102125545-5a2c58442e48
-	github.com/fsnotify/fsnotify v1.8.0
+	github.com/fsnotify/fsnotify v1.9.0
 	github.com/onsi/ginkgo/v2 v2.22.2
 	github.com/onsi/gomega v1.36.2
-	google.golang.org/grpc v1.70.0
+	google.golang.org/grpc v1.72.0
 	k8s.io/klog/v2 v2.130.1
 	k8s.io/kubelet v0.32.2
 )
@@ -18,13 +17,13 @@ require (
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
-	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/pprof v0.0.0-20241210010833-40e02aabc2ad // indirect
-	golang.org/x/net v0.38.0 // indirect
-	golang.org/x/sys v0.31.0 // indirect
-	golang.org/x/text v0.23.0 // indirect
+	golang.org/x/net v0.40.0 // indirect
+	golang.org/x/sys v0.33.0 // indirect
+	golang.org/x/text v0.25.0 // indirect
 	golang.org/x/tools v0.28.0 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20241202173237-19429a94021a // indirect
-	google.golang.org/protobuf v1.36.1 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250313205543-e70fdf4c4cb4 // indirect
+	google.golang.org/protobuf v1.36.6 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )