mirror of
https://github.com/intel/intel-device-plugins-for-kubernetes.git
synced 2025-06-03 03:59:37 +00:00
284 lines
10 KiB
Makefile
284 lines
10 KiB
Makefile
CONTROLLER_GEN ?= controller-gen
|
|
GO := go
|
|
GOFMT := gofmt
|
|
KUSTOMIZE ?= kustomize
|
|
OPERATOR_SDK ?= operator-sdk
|
|
|
|
BUILDTAGS ?= ""
|
|
BUILDER ?= "docker"
|
|
EXTRA_BUILD_ARGS ?= ""
|
|
|
|
CERT_MANAGER_VERSION ?= v1.11.0
|
|
CONTROLLER_GEN_VERSION ?= v0.11.1
|
|
GOLANGCI_LINT_VERSION ?= v1.50.1
|
|
KIND_VERSION ?= v0.17.0
|
|
GOLICENSES_VERSION ?= v1.6.0
|
|
# Default bundle image tag
|
|
BUNDLE_IMG ?= intel-device-plugins-controller-bundle:$(TAG)
|
|
# Options for 'bundle-build'
|
|
ifneq ($(origin CHANNELS), undefined)
|
|
BUNDLE_CHANNELS := --channels=$(CHANNELS)
|
|
endif
|
|
ifneq ($(origin DEFAULT_CHANNEL), undefined)
|
|
BUNDLE_DEFAULT_CHANNEL := --default-channel=$(DEFAULT_CHANNEL)
|
|
endif
|
|
BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
|
|
OLM_MANIFESTS = deployments/operator/manifests
|
|
BUNDLE_DIR = community-operators/operators/intel-device-plugins-operator/$(TAG)
|
|
|
|
TESTDATA_DIR = pkg/topology/testdata
|
|
|
|
EXTRA_BUILD_ARGS += --build-arg GOLICENSES_VERSION=$(GOLICENSES_VERSION)
|
|
|
|
pkgs = $(shell $(GO) list ./... | grep -v vendor | grep -v e2e | grep -v envtest)
|
|
cmds = $(shell ls --ignore=internal cmd)
|
|
|
|
all: build
|
|
|
|
format:
|
|
@report=`$(GOFMT) -s -d -w $$(find cmd pkg test -name \*.go)` ; if [ -n "$$report" ]; then echo "$$report"; exit 1; fi
|
|
|
|
vendor:
|
|
@$(GO) mod vendor -v
|
|
|
|
install-tools:
|
|
GO111MODULE=on $(GO) install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_GEN_VERSION)
|
|
$(GO) install github.com/golangci/golangci-lint/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)
|
|
$(GO) install sigs.k8s.io/kind@${KIND_VERSION}
|
|
|
|
go-mod-tidy:
|
|
$(GO) mod download all
|
|
@report=`$(GO) mod tidy -v 2>&1` ; if [ -n "$$report" ]; then echo "$$report"; exit 1; fi
|
|
|
|
update-fixture:
|
|
@scripts/ttar -C $(TESTDATA_DIR) -c -f $(TESTDATA_DIR)/sys.ttar sys/
|
|
|
|
fixture:
|
|
@scripts/ttar --recursive-unlink -C $(TESTDATA_DIR) -x -f $(TESTDATA_DIR)/sys.ttar
|
|
|
|
test: fixture
|
|
ifndef WHAT
|
|
@$(GO) test -tags $(BUILDTAGS) -race -coverprofile=coverage.txt -covermode=atomic $(pkgs)
|
|
else
|
|
@cd $(WHAT) && \
|
|
$(GO) test -tags $(BUILDTAGS) -v -race -cover -coverprofile cover.out || rc=1; \
|
|
$(GO) tool cover -html=cover.out -o coverage.html; \
|
|
rm cover.out; \
|
|
echo "Coverage report: file://$$(realpath coverage.html)"; \
|
|
exit $$rc
|
|
endif
|
|
|
|
test-with-kind: fixture intel-sgx-admissionwebhook intel-fpga-admissionwebhook intel-deviceplugin-operator install-tools
|
|
# Build a Cluster with KinD & Load Images & Install Cert-Manager
|
|
kind create cluster
|
|
kind load docker-image $(REG)intel-sgx-admissionwebhook:$(TAG)
|
|
kind load docker-image $(REG)intel-fpga-admissionwebhook:$(TAG)
|
|
kind load docker-image $(REG)intel-deviceplugin-operator:$(TAG)
|
|
kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/${CERT_MANAGER_VERSION}/cert-manager.yaml
|
|
# Test SGX Admission Webhook, FPGA Admission Webhook and Device Plugin Operator Manager's Webhook
|
|
$(GO) test -v ./test/e2e -args -kubeconfig ~/.kube/config -ginkgo.focus "SGX Admission"
|
|
$(GO) test -v ./test/e2e -args -kubeconfig ~/.kube/config -ginkgo.focus "FPGA Admission"
|
|
$(GO) test -v ./test/e2e -args -kubeconfig ~/.kube/config -ginkgo.focus "Operator"
|
|
|
|
envtest:
|
|
@$(GO) test ./test/envtest
|
|
|
|
lint:
|
|
@golangci-lint run --timeout 15m
|
|
|
|
checks: lint go-mod-tidy
|
|
|
|
generate:
|
|
$(CONTROLLER_GEN) object:headerFile="build/boilerplate/boilerplate.go.txt" paths="./pkg/apis/..."
|
|
$(CONTROLLER_GEN) crd:crdVersions=v1 \
|
|
paths="./pkg/apis/..." \
|
|
output:crd:artifacts:config=deployments/operator/crd/bases
|
|
$(CONTROLLER_GEN) crd:crdVersions=v1 \
|
|
paths="./pkg/apis/fpga/..." \
|
|
output:crd:artifacts:config=deployments/fpga_admissionwebhook/crd/bases
|
|
$(CONTROLLER_GEN) webhook \
|
|
paths="./pkg/..." \
|
|
output:webhook:artifacts:config=deployments/operator/webhook
|
|
$(CONTROLLER_GEN) webhook \
|
|
paths="./pkg/fpgacontroller/..." \
|
|
output:webhook:artifacts:config=deployments/fpga_admissionwebhook/webhook
|
|
$(CONTROLLER_GEN) webhook \
|
|
paths="./pkg/webhooks/sgx/..." \
|
|
output:webhook:artifacts:config=deployments/sgx_admissionwebhook/webhook
|
|
$(CONTROLLER_GEN) rbac:roleName=gpu-manager-role paths="./cmd/gpu_plugin/..." output:dir=deployments/operator/rbac
|
|
cp deployments/operator/rbac/role.yaml deployments/operator/rbac/gpu_manager_role.yaml
|
|
$(CONTROLLER_GEN) rbac:roleName=manager-role paths="./pkg/..." output:dir=deployments/operator/rbac
|
|
$(CONTROLLER_GEN) rbac:roleName=manager-role paths="./pkg/fpgacontroller/..." output:dir=deployments/fpga_admissionwebhook/rbac
|
|
|
|
$(cmds):
|
|
cd cmd/$@; $(GO) build -tags $(BUILDTAGS)
|
|
|
|
build: $(cmds)
|
|
|
|
.PHONY: bundle
|
|
bundle:
|
|
rm -rf $(BUNDLE_DIR)
|
|
mkdir -p $(BUNDLE_DIR)
|
|
$(OPERATOR_SDK) generate kustomize manifests -q --input-dir $(OLM_MANIFESTS) --output-dir $(OLM_MANIFESTS) --apis-dir pkg/apis
|
|
$(KUSTOMIZE) build $(OLM_MANIFESTS) | sed "s|intel-deviceplugin-operator:devel|intel-deviceplugin-operator:$(TAG)|" | $(OPERATOR_SDK) generate bundle -q --overwrite --kustomize-dir $(OLM_MANIFESTS) --version $(TAG) $(BUNDLE_METADATA_OPTS) --output-dir .
|
|
# Remove unneeded resources
|
|
rm manifests/*service.yaml
|
|
rm manifests/*clusterrole.yaml
|
|
# Put generated files in a directory
|
|
mv manifests metadata tests bundle.Dockerfile $(BUNDLE_DIR)
|
|
$(OPERATOR_SDK) bundle validate $(BUNDLE_DIR)/
|
|
|
|
bundle-build:
|
|
$(BUILDER) build -f $(BUNDLE_DIR)/bundle.Dockerfile -t $(BUNDLE_IMG) $(BUNDLE_DIR)
|
|
|
|
clean:
|
|
@for cmd in $(cmds) ; do pwd=$(shell pwd) ; cd cmd/$$cmd ; $(GO) clean ; cd $$pwd ; done
|
|
|
|
ORG?=intel
|
|
REG?=$(ORG)/
|
|
TAG?=0.26.2
|
|
export TAG
|
|
|
|
e2e-fpga:
|
|
@$(GO) test -v ./test/e2e/... -ginkgo.v -ginkgo.progress -ginkgo.focus "FPGA" -delete-namespace-on-failure=false
|
|
|
|
e2e-qat:
|
|
@$(GO) test -v ./test/e2e/... -ginkgo.v -ginkgo.progress -ginkgo.focus "QAT plugin in DPDK mode" -delete-namespace-on-failure=false
|
|
|
|
e2e-qat4:
|
|
@$(GO) test -v ./test/e2e/... -ginkgo.v -ginkgo.progress -ginkgo.focus "QAT Gen4" -delete-namespace-on-failure=false
|
|
|
|
e2e-sgx:
|
|
@$(GO) test -v ./test/e2e/... -ginkgo.v -ginkgo.progress -ginkgo.focus "SGX" -delete-namespace-on-failure=false
|
|
|
|
e2e-gpu:
|
|
@$(GO) test -v ./test/e2e/... -ginkgo.v -ginkgo.progress -ginkgo.focus "GPU" -delete-namespace-on-failure=false
|
|
|
|
e2e-dsa:
|
|
@$(GO) test -v ./test/e2e/... -ginkgo.v -ginkgo.progress -ginkgo.focus "DSA" -delete-namespace-on-failure=false
|
|
|
|
e2e-iaa:
|
|
@$(GO) test -v ./test/e2e/... -ginkgo.v -ginkgo.progress -ginkgo.focus "IAA" -delete-namespace-on-failure=false
|
|
|
|
e2e-dlb:
|
|
@$(GO) test -v ./test/e2e/... -ginkgo.v -ginkgo.progress -ginkgo.focus "DLB" -delete-namespace-on-failure=false
|
|
|
|
terrascan:
|
|
@ls deployments/*/kustomization.yaml | while read f ; \
|
|
do \
|
|
echo "\n==== $$(basename $$(dirname $$f)) ====" ; \
|
|
terrascan scan -v --show-passed -d $$(dirname $$f) -i kustomize --severity high \
|
|
--skip-rules 'AC_K8S_0051,AC_K8S_0076,AC_K8S_0087' \
|
|
|| exit $$? ; \
|
|
done
|
|
|
|
pre-pull:
|
|
ifeq ($(TAG),devel)
|
|
@$(BUILDER) pull golang:1.19-bullseye
|
|
@$(BUILDER) pull debian:unstable-slim
|
|
@$(BUILDER) pull ubuntu:22.04
|
|
endif
|
|
|
|
dockerlib = build/docker/lib
|
|
dockertemplates = build/docker/templates
|
|
images = $(shell basename -s .Dockerfile.in -a $(dockertemplates)/*.Dockerfile.in)
|
|
dockerfiles = $(shell basename -s .in -a $(dockertemplates)/*.Dockerfile.in | xargs -I"{}" echo build/docker/{})
|
|
|
|
|
|
skipbaselayercheck = intel-vpu-plugin intel-qat-plugin-kerneldrv intel-idxd-config-initcontainer
|
|
distroless_images = $(patsubst %,$(REG)%\:$(TAG),$(filter-out $(skipbaselayercheck),$(images)))
|
|
test-image-base-layer:
|
|
@for img in $(distroless_images); do scripts/test-image-base-layer.sh $$img $(BUILDER) || exit 1; done
|
|
|
|
$(dockerfiles): $(dockertemplates)/*.Dockerfile.in $(dockerlib)/*.docker
|
|
@cat $(dockerlib)/default_header.docker $(dockertemplates)/$(shell basename $@.in) \
|
|
| cpp -w -nostdinc -I./$(dockerlib) -DINPUT_FILENAME=$(dockertemplates)/$(shell basename $@.in) -C -P \
|
|
| sed 's/\\N/\\/' > $@
|
|
|
|
clean-dockerfiles:
|
|
@rm -f build/docker/*.Dockerfile
|
|
|
|
dockerfiles: clean-dockerfiles $(dockerfiles)
|
|
|
|
check-dockerfiles: dockerfiles
|
|
@GITDIFF=`git diff build/docker` ; \
|
|
if [ -n "$$GITDIFF" ]; then \
|
|
echo "Changes detected in Dockerfiles:" && \
|
|
echo "$$GITDIFF" && \
|
|
echo "Please commit result of \"make dockerfiles\" to make them in synch with the .in -files." ; \
|
|
exit 1; \
|
|
fi
|
|
|
|
$(images): $(dockerfiles)
|
|
@build/docker/build-image.sh $(REG)$@ $(BUILDER) $(EXTRA_BUILD_ARGS)
|
|
|
|
images: $(images)
|
|
|
|
demos = $(shell basename -a demo/*/)
|
|
|
|
$(demos):
|
|
@cd demo/ && ./build-image.sh $(REG)$@ $(BUILDER)
|
|
|
|
demos: $(demos)
|
|
|
|
image_tags = $(patsubst %,$(REG)%\:$(TAG),$(images) $(demos))
|
|
$(image_tags):
|
|
@docker push $@
|
|
|
|
push: test-image-base-layer $(image_tags)
|
|
|
|
set-version:
|
|
@scripts/set-version.sh $(TAG)
|
|
|
|
null :=
|
|
space := $(null) #
|
|
comma := ,
|
|
images_json := $(subst $(space),$(comma),[$(addprefix ",$(addsuffix ",$(images) $(demos))]))
|
|
skip_images := "ubuntu-demo-openvino"
|
|
|
|
check-github-actions:
|
|
@python3 -c 'import sys, yaml, json; json.dump(yaml.load(sys.stdin, Loader=yaml.SafeLoader), sys.stdout)' < .github/workflows/ci.yaml | \
|
|
jq -e '$(images_json) - [$(skip_images)] - .jobs.image.strategy.matrix.image == []' > /dev/null || \
|
|
(echo "Make sure all images are listed in .github/workflows/ci.yaml"; exit 1)
|
|
|
|
.PHONY: all format test lint build images $(cmds) $(images) lock-images vendor pre-pull set-version check-github-actions envtest fixture update-fixture install-tools test-image-base-layer
|
|
|
|
SPHINXOPTS =
|
|
SPHINXBUILD = sphinx-build
|
|
SOURCEDIR = .
|
|
BUILDDIR = _build
|
|
|
|
# Generate doc site under _build/html with Sphinx.
|
|
vhtml: _work/venv/.stamp
|
|
. _work/venv/bin/activate && \
|
|
$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
cp docs/index.html $(BUILDDIR)/html/index.html
|
|
|
|
html:
|
|
$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
cp docs/index.html $(BUILDDIR)/html/index.html
|
|
|
|
clean-html:
|
|
rm -rf $(BUILDDIR)/html
|
|
|
|
# Set up a Python3 environment with the necessary tools for document creation.
|
|
_work/venv/.stamp: docs/requirements.txt
|
|
rm -rf ${@D}
|
|
python3 -m venv ${@D}
|
|
. ${@D}/bin/activate && pip install wheel && pip install -r $<
|
|
touch $@
|
|
|
|
clean-licenses:
|
|
rm -rf licenses
|
|
|
|
licenses = $(shell ls --ignore=internal cmd | xargs -I"{}" echo licenses/{})
|
|
|
|
$(licenses):
|
|
@rm -rf $@
|
|
@license_cmd=`basename $@` && echo fetching licenses for $$license_cmd && \
|
|
GO111MODULE=on go run github.com/google/go-licenses@$(GOLICENSES_VERSION) save "./cmd/$$license_cmd" --save_path licenses/$$license_cmd
|
|
|
|
.PHONY: clean-licenses licenses $(licenses)
|
|
|
|
licenses: $(licenses)
|