Merge pull request #28 from intel/2025Q1

Release 24Q1

Author: byako

.gitignore

@@ -12,5 +12,6 @@
 *.sublime-project
 *.sublime-workspace
 *~
-
+*.o
+*.so
 *.out

DEV.md

@@ -23,20 +23,6 @@ version = 2
     cdi_specs_dir = ["/etc/cdi", "/var/run/cdi"]
 ```
 
-# Generated source code
-
-Custom resource definitions are in `pkg/intel.com/resource/<accelerator>/<apiversion>/*.go`
-(except generated `zz_deepcopy`) and in `pkg/intel.com/resource/<accelerator/<apiversion>/api/`.
-
-When changing those CRDs, remember to re-generate the YAMLs and clientset by running:
-```bash
-make generate
-```
-
-## Required tools
-
-Above step needs `controller-gen` and `client-gen` tools to generate CRD YAMLs (in `deployments/gpu/static/crd/...`).
-
 ### Determine your go binaries location from `go install --help`, quote:
 > Executables are installed in the directory named by the GOBIN environment
 > variable, which defaults to $GOPATH/bin or $HOME/go/bin if the GOPATH
@@ -75,3 +61,49 @@ cp controller-tools/controller-gen code-generator/client-gen $HOME/go/bin
 # ensure it's in the path. You may want to add export to $HOME/.bashrc
 echo $PATH | grep -q $HOME/go/bin || export PATH=$HOME/go/bin:$PATH
 ```
+# Running tests
+
+Since Q2 '25 Gaudi DRA driver uses `gohlml` to retrieve health-related information.
+There is a hardcoded path to the HLML shared library, and `hack/fake_libhlml` was created based
+on the `hlml.h` from `gohlml` project - it is effectively a stub / mock with flow control support.
+
+When health-related tests call `gohlml` - it should in turn call fake `libhlml`, instead of the real
+one, on the nodes where there is no real Gaudi HW and SW installed (e.g. CI). This means, if the
+tests are run on your development machine - you should either deploy fresh fake `libhlml.so`, or
+run tests in a `gaudi-dra-driver-test-image` container like CI does.
+
+Deploying fake hlml instead of real `libhlml` should allow running tests in VSCode and other IDEs,
+after `ldconfig` is [configured properly](hack/fake_libhlml/README.md)
+
+## Deploying 
+```shell
+$ cd hack/fake_libhlml
+$ make clean
+rm -f fake_libhlml.o fake_libhlml.so
+$ make
+gcc -O -Wall -Wextra -Wno-unused-parameter -fPIC -c fake_libhlml.c -o fake_libhlml.o
+gcc -shared -o fake_libhlml.so fake_libhlml.o
+$ sudo cp ./fake_libhlml.so /usr/lib/habanalabs/libhlml.so
+$ cat << EOF | sudo tee /etc/ld.so.conf.d/habanalabs.conf
+/usr/lib/habanalabs/
+EOF
+
+$ sudo ldconfig
+```
+
+## Running tests in container
+
+To have your own user ID inside container image without access / permission issues, build a fresh
+container image, then run tests. The CI uses its own user ID.
+
+```shell
+$ make test-image
+$ make test-containerized
+```
+
+Tests provide coverage data. If you need to see the coverage report, just run Make target for needed
+coverage target, e.g.
+
+```
+make gaudi-coverage
+```

Dockerfile.device-faker

@@ -0,0 +1,30 @@
+FROM golang:1.23.4@sha256:70031844b8c225351d0bb63e2c383f80db85d92ba894e3da7e13bcf80efa9a37 as build
+ARG LOCAL_LICENSES
+WORKDIR /build
+COPY . .
+
+RUN make bin/device-faker && \
+mkdir -p /install_root && \
+if [ -z "$LOCAL_LICENSES" ]; then \
+    make licenses; \
+fi && \
+cp -r licenses /install_root/ && \
+cp bin/device-faker /install_root/
+
+
+FROM alpine AS template
+COPY --from=build /install_root/device-faker /device-faker
+
+
+RUN mkdir -p /opt/templates && \
+    /device-faker gpu -n && \
+    mv /tmp/gpu-template-*.json /opt/templates/gpu-template.json && \
+    /device-faker gaudi -n && \
+    mv /tmp/gaudi-template-*.json /opt/templates/gaudi-template.json && \
+    chmod 644 /opt/templates/*.json
+
+FROM scratch
+LABEL description="Intel Device Faker"
+COPY --from=build /install_root/device-faker /device-faker
+COPY --from=template /opt/templates /opt/templates
+ENTRYPOINT ["/device-faker"]

Dockerfile.gaudi

@@ -12,22 +12,59 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FROM golang:1.23.4@sha256:70031844b8c225351d0bb63e2c383f80db85d92ba894e3da7e13bcf80efa9a37 as build
+ARG HTTP_PROXY
+ARG HTTPS_PROXY
+ARG NO_PROXY
+
+FROM golang:1.23.4@sha256:ccdca3b3bde3bfee2518a087b467f2b452fad9ba3e378d3c1578db494c8cb13b as build
 ARG LOCAL_LICENSES
 WORKDIR /build
 COPY . .
 
+# install libhlml.so
+RUN \
+export http_proxy=${HTTP_PROXY} https_proxy=${HTTPS_PROXY} no_proxy=${NO_PROXY} && \
+curl -fsSL https://vault.habana.ai/artifactory/api/gpg/key/public | gpg --dearmor | tee /etc/apt/trusted.gpg.d/habanalabs.gpg > /dev/null && \
+wget -q -O /etc/apt/sources.list.d/habanalabs_synapseai.list "https://vault.habana.ai/artifactory/gaudi-installer/repos/1.16.2/debian10.10/habanalabs_synapseai.list" > /dev/null && \
+apt-get update && \
+apt-get download habanalabs-firmware-tools && \
+ls -al && \
+dpkg --force-all -i *.deb
+
 RUN make gaudi && \
 mkdir -p /install_root && \
 if [ -z "$LOCAL_LICENSES" ]; then \
     make licenses; \
 fi && \
 cp -r licenses /install_root/ && \
+mkdir /install_root/licenses/habanalabs && \
+cp /usr/share/doc/habanalabs-firmware-tools/* /install_root/licenses/habanalabs/ && \
 cp bin/kubelet-gaudi-plugin /install_root/
 
+# Get libc and sources from Ubuntu24, libhlml needs GLIBC_2.38
+FROM ubuntu:24.04@sha256:80dd3c3b9c6cecb9f1667e9290b3bc61b78c2678c02cbdae5f0fea92cc6734ab as ubuntu
+RUN \
+cat /etc/apt/sources.list.d/ubuntu.sources && \
+sed -i 's/^Types: deb$/Types: deb deb-src/' /etc/apt/sources.list.d/ubuntu.sources && \
+apt-get update && \
+apt-get install -y dpkg-dev && \
+mkdir /tmp/src && \
+cd /tmp/src && \
+apt-get source libc6 coreutils dash
 
 FROM scratch
-WORKDIR /
 LABEL description="Intel Gaudi resource driver for Kubernetes"
 
 COPY --from=build /install_root /
+COPY --from=build /usr/lib/habanalabs/libhlml.so /usr/lib/habanalabs/libhlml.so
+COPY --from=ubuntu /lib/x86_64-linux-gnu/libc.so.6 /lib/x86_64-linux-gnu/libc.so.6
+COPY --from=ubuntu /lib64/ld-linux-x86-64.so.2 /lib64/ld-linux-x86-64.so.2
+COPY --from=ubuntu /usr/lib/x86_64-linux-gnu/libm.so.6 /usr/lib/x86_64-linux-gnu/libm.so.6
+COPY --from=ubuntu /usr/lib/x86_64-linux-gnu/libdl.so.2 /usr/lib/x86_64-linux-gnu/libdl.so.2
+COPY --from=ubuntu /usr/lib/x86_64-linux-gnu/libz.so.1 /usr/lib/x86_64-linux-gnu/libz.so.1
+COPY --from=ubuntu /bin/cat /bin/cat
+COPY --from=ubuntu /bin/sh /bin/sh
+COPY --from=ubuntu /tmp/src/*tar.xz /src/
+
+ENV LD_LIBRARY_PATH=/usr/lib/habanalabs:/lib/x86_64-linux-gnu:/lib64:/usr/lib/x86_64-linux-gnu
+ENV PATH=/bin

Dockerfile.gaudi-test

@@ -0,0 +1,46 @@
+# Copyright (c) 2025, Intel Corporation.  All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+FROM golang:1.23.4@sha256:ccdca3b3bde3bfee2518a087b467f2b452fad9ba3e378d3c1578db494c8cb13b as build
+WORKDIR /build
+COPY . .
+
+RUN cd hack/fake_libhlml && \
+make clean && make
+
+FROM golang:1.23.4@sha256:ccdca3b3bde3bfee2518a087b467f2b452fad9ba3e378d3c1578db494c8cb13b
+ARG UID=1001
+ARG GID=1001
+
+COPY --from=build /build/hack/fake_libhlml/fake_libhlml.so /usr/lib/habanalabs/libhlml.so
+
+RUN \
+echo "existing user: $(id $UID)" && \
+groupadd -g ${GID} ubuntu && \
+useradd -m -g ${GID} -u ${UID} -s /bin/bash ubuntu && \
+mkdir /github && \
+chmod 777 /github
+
+RUN \
+mkdir -m 755 /home/ubuntu/.cache/ && \
+mkdir -m 755 /home/ubuntu/.cache/go-build && \
+mkdir -m 755 /home/ubuntu/.cache/go-mod && \
+chown -R ubuntu:ubuntu /home/ubuntu/.cache && \
+mkdir /home/ubuntu/src && \
+git config --global --add safe.directory /home/ubuntu/src
+
+ENV GOCACHE=/home/ubuntu/.cache/go-build
+ENV GOMODCACHE=/home/ubuntu/.cache/go-mod
+
+USER ubuntu
+WORKDIR /home/ubuntu

Makefile

@@ -27,9 +27,11 @@ GIT_COMMIT = $(shell git rev-parse HEAD)
 BUILD_DATE = $(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
 GIT_BRANCH ?= $(shell git branch --show-current)
 
+TEST_IMAGE ?= gaudi-dra-driver-test-image:latest
+
 EXT_LDFLAGS = -static
 LDFLAGS = \
- -s -w -extldflags $(EXT_LDFLAGS) \
+ -s -w \
  -X ${PKG}/pkg/version.gitCommit=${GIT_COMMIT} \
  -X ${PKG}/pkg/version.buildDate=${BUILD_DATE}
 
@@ -69,13 +71,16 @@ include $(CURDIR)/qat.mk
 build: gpu gaudi qat bin/intel-cdi-specs-generator bin/device-faker
 
 
+
 bin/intel-cdi-specs-generator: cmd/cdi-specs-generator/*.go $(GPU_COMMON_SRC)
 	CGO_ENABLED=0 GOOS=linux GOARCH=${ARCH} \
-	  go build -a -ldflags "${LDFLAGS}" -mod vendor -o $@ ./cmd/cdi-specs-generator
+	  go build -a -ldflags "${LDFLAGS} -extldflags $(EXT_LDFLAGS)" \
+	  -mod vendor -o $@ ./cmd/cdi-specs-generator
 
 bin/device-faker: cmd/device-faker/*.go
 	CGO_ENABLED=0 GOOS=linux GOARCH=${ARCH} \
-	  go build -a -ldflags "${LDFLAGS}" -mod vendor -o $@ ./cmd/device-faker
+	  go build -a -ldflags "${LDFLAGS} -extldflags ${EXT_LDFLAGS}" \
+	  -mod vendor -o $@ ./cmd/device-faker
 
 
 .PHONY: branch-build
@@ -109,9 +114,6 @@ cleanall: clean
 .PHONY: rm-clientsets
 rm-clientsets: rm-gpu-clientset rm-gaudi-clientset
 
-.PHONY: generate
-generate: generate-gpu-crd generate-gaudi-crd
-
 .PHONY: generate-deepcopy
 generate-deepcopy: generate-gpu-deepcopy generate-gaudi-deepcopy
 
@@ -159,7 +161,7 @@ licenses: clean-licenses
 # linting targets for Go and other code
 .PHONY: lint format cilint vet shellcheck yamllint
 
-lint: format cilint vet klogformat shellcheck yamllint
+lint: vendor format cilint vet klogformat shellcheck yamllint
 
 format:
 	gofmt -w -s -l ./
@@ -187,18 +189,62 @@ yamllint:
 	@echo -e "\nyamllint: lint non-templated YAML files:"
 	git ls-files '*.yaml' | xargs grep -L '^ *{{-' | xargs yamllint -d relaxed --no-warnings
 
+.PHONE: test-image test-image-push
+test-image: vendor
+	@echo "Building container image with fake HLML for Gaudi tests with user $(shell id -u):$(shell id -g)"
+	$(DOCKER) build \
+	--build-arg UID=$(shell id -u) --build-arg GID=$(shell id -g) \
+	--platform="linux/$(ARCH)" \
+	-t "$(TEST_IMAGE)" 	-f Dockerfile.gaudi-test .
+
+test-image-push: test-image
+	$(DOCKER) push "$(TEST_IMAGE)"
 
-.PHONY: test coverage
+.PHONY: test html-coverage test-containerized
 COVERAGE_FILE := coverage.out
+# Gaudi tests expect fake HLML library to be present at /usr/lib/habanalabs/libhlml.so
+# Dependency comes from gohlml package hardcoded LD_LIBRARY_PATH pointing to it.
 test:
-	go test -v -coverprofile=$(COVERAGE_FILE) $(shell go list ./... | grep -v "test/e2e")
+ifeq ("$(container)","yes")
+		@echo setting safe directory
+		go test -buildvcs=false -v -coverprofile=$(COVERAGE_FILE) $(shell go list ./... | grep -v "test/e2e")
+else
+		@echo running tests
+		go test -v -coverprofile=$(COVERAGE_FILE) $(shell go list ./... | grep -v "test/e2e")
+endif
+
+test-containerized:
+	$(DOCKER) run \
+	-it -e container=yes \
+	--user 1000:1000 \
+	-v "$(shell pwd)":/home/ubuntu/src:rw \
+	"$(TEST_IMAGE)" \
+	bash -c "cd src && make test"
 
-coverage: test
+html-coverage: $(COVERAGE_FILE)
 	go tool cover -html=$(COVERAGE_FILE) -o coverage.html
 	@echo coverage file: coverage.html
-	@echo "average coverage (except main.go files)"
-	grep '<option value=' coverage.html | grep -v 'main.go' | grep -o '(.*)' | tr -d '()%' | awk 'BEGIN{s=0;}{s+=$$1;}END{print s/NR;}'
 
-.PHONY: e2e-qat
-e2e-qat:
-	go test -v ./test/e2e/... --clean-start=true -ginkgo.v -ginkgo.trace -ginkgo.show-node-events
+$(COVERAGE_FILE): $(shell find cmd pkg -name '*.go')
+	go test -v -coverprofile=$(COVERAGE_FILE) $(shell go list ./... | grep -v "test/e2e")
+
+.PHONY: gpu-coverage gaudi-coverage qat-coverage cdispecsgen-coverage excluded-coverage
+
+gpu-coverage: COVERAGE_EXCLUDE="cdi-specs-generator|device-faker|kubelet-gaudi-plugin|kubelet-qat-plugin|qat-showdevice|pkg/qat|pkg/gaudi|pkg/fakesysfs|plugintesthelpers"
+gpu-coverage: excluded-coverage
+# See: https://www.gnu.org/software/make/manual/html_node/Target_002dspecific.html
+
+gaudi-coverage: COVERAGE_EXCLUDE="cdi-specs-generator|device-faker|kubelet-gpu-plugin|kubelet-qat-plugin|qat-showdevice|pkg/qat|pkg/gpu|pkg/fakesysfs|plugintesthelpers"
+gaudi-coverage: excluded-coverage
+
+qat-coverage: COVERAGE_EXCLUDE="cdi-specs-generator|device-faker|kubelet-gpu-plugin|kubelet-gaudi-plugin|pkg/gpu|pkg/gaudi|pkg/fakesysfs|plugintesthelpers"
+qat-coverage: excluded-coverage
+
+cdispecsgen-coverage: COVERAGE_EXCLUDE="device-faker|kubelet-gpu-plugin|kubelet-gaudi-plugin|kubelet-qat-plugin|qat-showdevice|pkg/qat|pkg/gpu|pkg/gaudi|pkg/fakesysfs|plugintesthelpers"
+cdispecsgen-coverage: excluded-coverage
+
+COVERAGE_EXCLUDE ?= "$^"
+excluded-coverage: $(COVERAGE_FILE)
+	@grep -v -E $(COVERAGE_EXCLUDE) $(COVERAGE_FILE) > $(COVERAGE_FILE).tmp && \
+	go tool cover -func=$(COVERAGE_FILE).tmp && \
+	rm $(COVERAGE_FILE).tmp

NOTICE

@@ -0,0 +1 @@
+These contents may have been developed with support from one or more Intel-operated generative artificial intelligence solutions.

charts/intel-gaudi-resource-driver/.helmignore

@@ -0,0 +1,18 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/intel-gaudi-resource-driver/Chart.yaml

@@ -0,0 +1,22 @@
+apiVersion: v2
+name: intel-gaudi-resource-driver
+description: A Helm chart for a Dynamic Resource Allocation (DRA) Intel Gaudi Resource Driver
+
+type: application
+version: 0.3.0
+appVersion: "v0.3.0"
+home: https://github.com/intel/intel-resource-drivers-for-kubernetes/charts
+
+dependencies:
+  - name: node-feature-discovery
+    alias: nfd
+    version: "0.17.1"
+    condition: nfd.enabled
+    repository: https://kubernetes-sigs.github.io/node-feature-discovery/charts
+
+annotations:
+  org.opencontainers.image.url: "https://github.com/intel/intel-resource-drivers-for-kubernetes"
+  org.opencontainers.image.source: "https://github.com/intel/intel-resource-drivers-for-kubernetes"
+  org.opencontainers.image.version: "0.3.0"
+  org.opencontainers.image.title: "Intel Gaudi Resource Driver"
+  org.opencontainers.image.description: "This chart installs the Intel Gaudi resource driver on Kubernetes."