-
Notifications
You must be signed in to change notification settings - Fork 34
Expand file tree
/
Copy pathMakefile
More file actions
610 lines (518 loc) · 21.2 KB
/
Makefile
File metadata and controls
610 lines (518 loc) · 21.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
-include dev.env
## Set all the environment variables here
# Docker Registry
DOCKER_REGISTRY ?= docker.io/rocm
# Build Container environment
DOCKER_BUILDER_TAG ?= v1.10
BUILD_BASE_IMAGE ?= ubuntu:22.04
BUILD_CONTAINER ?= $(DOCKER_REGISTRY)/device-metrics-exporter-build:$(DOCKER_BUILDER_TAG)
# Exporter container environment
EXPORTER_IMAGE_TAG ?= latest
EXPORTER_IMAGE_NAME ?= device-metrics-exporter
EXPORTER_SRIOV_BASE_IMAGE ?= registry.access.redhat.com/ubi9/ubi-minimal:9.6
EXPORTER_SRIOV_IMAGE_NAME ?= device-metrics-exporter-sriov
RHEL_BASE_MIN_IMAGE ?= registry.access.redhat.com/ubi9/ubi-minimal:9.6
AZURE_BASE_IMAGE ?= mcr.microsoft.com/azurelinux/base/core:3.0
EXPORTER_AINIC_IMAGE_NAME ?= device-metrics-exporter-ainic
# Test runner container environment
TESTRUNNER_IMAGE_TAG ?= latest
TESTRUNNER_IMAGE_NAME ?= test-runner
TEST_RUNNER_RHEL_BASE_IMAGE ?= registry.access.redhat.com/ubi9/ubi-minimal:9.5
# External repo builders
GPUAGENT_BASE_IMAGE ?= ubuntu:22.04
GPUAGENT_BUILDER_IMAGE ?= gpuagent-builder:v1
AMDSMI_BASE_IMAGE ?= registry.access.redhat.com/ubi9/ubi:9.6
AMDSMI_BASE_UBUNTU22 ?= ubuntu:22.04
AMDSMI_BASE_UBUNTU24 ?= ubuntu:24.04
AMDSMI_BASE_AZURE ?= mcr.microsoft.com/azurelinux/base/core:3.0
ROCPROFILER_BASE_UBUNTU22 ?= ubuntu:22.04
AMDSMI_BUILDER_IMAGE ?= amdsmi-builder:rhel9
AMDSMI_BUILDER_UB22_IMAGE ?= amdsmi-builder:ub22
AMDSMI_BUILDER_UB24_IMAGE ?= amdsmi-builder:ub24
AMDSMI_BUILDER_AZURE_IMAGE ?= amdsmi-builder:azure
GIMSMI_BUILDER_IMAGE ?= gimsmi-builder:rhel9
GIMSMI_BUILDER_UB22_IMAGE ?= gimsmi-builder:ub22
GIMSMI_BUILDER_UB24_IMAGE ?= gimsmi-builder:ub24
ROCPROFILER_BUILDER_IMAGE ?= rocprofiler-builder:ub22
# export environment variables used across project
export DOCKER_REGISTRY
export BUILD_CONTAINER
export BUILD_BASE_IMAGE
export EXPORTER_IMAGE_NAME
export EXPORTER_SRIOV_BASE_IMAGE
export EXPORTER_SRIOV_IMAGE_NAME
export EXPORTER_IMAGE_TAG
export EXPORTER_AINIC_IMAGE_NAME
# testrunner base images
export TESTRUNNER_IMAGE_NAME
export TESTRUNNER_IMAGE_TAG
# exporter base container images
export TEST_RUNNER_RHEL_BASE_IMAGE
export RHEL_BASE_MIN_IMAGE
export AZURE_BASE_IMAGE
# asset builder base images and tags
export AMDSMI_BASE_IMAGE
export AMDSMI_BASE_UBUNTU22
export AMDSMI_BASE_UBUNTU24
export AMDSMI_BASE_AZURE
export GPUAGENT_BUILDER_IMAGE
export ROCPROFILER_BASE_UBUNTU22
export AMDSMI_BUILDER_IMAGE
export AMDSMI_BUILDER_UB22_IMAGE
export AMDSMI_BUILDER_UB24_IMAGE
export AMDSMI_BUILDER_AZURE_IMAGE
export GPUAGENT_BASE_IMAGE
export ROCPROFILER_BUILDER_IMAGE
TO_GEN := pkg/amdgpu/proto pkg/exporter/proto pkg/amdnic/proto
TO_MOCK := pkg/amdgpu/mock pkg/exporter/scheduler
OUT_DIR := bin
CUR_USER:=$(shell whoami)
CUR_TIME:=$(shell date +%Y-%m-%d_%H.%M.%S)
CONTAINER_NAME:=${CUR_USER}_exporter-bld
CONTAINER_WORKDIR := /usr/src/github.com/ROCm/device-metrics-exporter
TOP_DIR := $(PWD)
GEN_DIR := $(TOP_DIR)/pkg/amdgpu/
MOCK_DIR := ${TOP_DIR}/pkg/amdgpu/mock_gen
HELM_CHARTS_DIR := $(TOP_DIR)/helm-charts
CONFIG_DIR := $(TOP_DIR)/example/
GOINSECURE='github.com, google.golang.org, golang.org'
GOFLAGS ='-buildvcs=false'
GO_BUILD_TAGS ?=
BUILD_DATE ?= $(shell date +%Y-%m-%dT%H:%M:%S%z)
GIT_COMMIT ?= $(shell git rev-list -1 HEAD --abbrev-commit)
GIT_BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD)
VERSION ?= $(if $(RELEASE),$(RELEASE),$(GIT_BRANCH))
KUBECONFIG ?= ~/.kube/config
# docs build settings
DOCS_DIR := ${TOP_DIR}/docs
BUILD_DIR := $(DOCS_DIR)/_build
HTML_DIR := $(BUILD_DIR)/html
# library branch to build amdsmi libraries for gpuagent
AMDSMI_BRANCH ?= release/rocm-rel-7.2
AMDSMI_COMMIT ?= 91c1f54
GIMSMI_BRANCH ?= mainline
GIMSMI_COMMIT ?= mainline/8.3.0.K
GPUAGENT_BRANCH ?= main
GPUAGENT_COMMIT ?= 534af3b
ROCM_VERSION ?= .yum_7.2.1.64
ROCM_APT_VERSION ?= .apt_7.2.1
AINIC_VERSION ?= 1.117.5-a-56
export ${GOROOT}
export ${GOPATH}
export ${OUT_DIR}
export ${TOP_DIR}
export ${GOFLAGS}
export ${GOINSECURE}
export ${KUBECONFIG}
export ${AZURE_DOCKER_CONTAINER_IMG}
export ${BUILD_VER_ENV}
export ${AMDSMI_BRANCH}
export ${AMDSMI_COMMIT}
export ${GIMSMI_BRANCH}
export ${GIMSMI_COMMIT}
export AINIC_VERSION
export ROCM_VERSION
export ROCM_APT_VERSION
ASSETS_PATH :=${TOP_DIR}/assets
# 22.04 - jammy
# 24.04 - noble
UBUNTU_VERSION ?= jammy
UBUNTU_VERSION_NUMBER = 22.04
UBUNTU_LIBDIR = UBUNTU22
ifeq (${UBUNTU_VERSION}, noble)
UBUNTU_VERSION_NUMBER = 24.04
UBUNTU_LIBDIR = UBUNTU24
endif
# set version and run `make update-version` to all docs
PROJECT_VERSION ?= v1.5.0
HELM_CHARTS_VERSION ?= $(PROJECT_VERSION)
NIC_BUILD ?= 0
ifneq (,$(findstring nic-,$(PROJECT_VERSION)))
# extract v1.0.0 from the nic-v1.0.0 format
NIC_BUILD := 1
HELM_CHARTS_VERSION := $(subst ",,$(subst nic-,,$(PROJECT_VERSION)))
else ifneq (,$(findstring exporter-,$(PROJECT_VERSION)))
HELM_CHARTS_VERSION := $(subst ",,$(subst exporter-,,$(PROJECT_VERSION)))
endif
# Derive DEBIAN_VERSION from RELEASE tag
ifneq (,$(findstring exporter,$(RELEASE)))
#remove prefix from main tag
DEBIAN_VERSION := $(shell echo "$(RELEASE)" | cut -c 10-)
else ifneq (,$(findstring v,$(RELEASE)))
#remove prefix for release tag
DEBIAN_VERSION := $(shell echo "$(RELEASE)" | sed 's/^.//')
else
#apt is only released until this version
DEBIAN_VERSION := "1.5.0"
endif
# Remove 'v' from PROJECT_VERSION to get PACKAGE_VERSION
PACKAGE_VERSION := $(subst v,,$(PROJECT_VERSION))
# Split DEBIAN_VERSION on '-' to get RPM version and release labe`l
RPM_BUILD_VERSION := $(word 1,$(subst -, ,$(DEBIAN_VERSION)))
RPM_RELEASE_LABEL_TMP := $(word 2,$(subst -, ,$(DEBIAN_VERSION)))
RPM_RELEASE_LABEL := $(if $(RPM_RELEASE_LABEL_TMP),$(RPM_RELEASE_LABEL_TMP),0)
DOCS_DIR := $(TOP_DIR)/docs
DOCS_CONFIG_DIR := $(DOCS_DIR)/configuration/
DOCS_INSTALLATION_DIR := $(DOCS_DIR)/installation/
DOCS_INTEGRATION_DIR := $(DOCS_DIR)/integrations/
UPDATE_VERSION_TARGET_DIRS := $(DOCS_DIR)/configuration/ $(DOCS_DIR)/installation/ $(DOCS_DIR)/integrations/
REL_IMAGE_TAG := $(PROJECT_VERSION)
HELM_INSTALL_URL := https://github.com/ROCm/device-metrics-exporter/releases/download/${REL_IMAGE_TAG}/device-metrics-exporter-charts-${REL_IMAGE_TAG}\.tgz
export ${DEBIAN_VERSION}
export ${RPM_BUILD_VERSION}
export ${RPM_RELEASE_LABEL}
.PHONY: update-version
update-version:
@echo "Replacing versions with $(PACKAGE_VERSION)..."
@echo "Helm URL : $(HELM_INSTALL_URL)"
sed -i -e 's|version = .*|version = "${PACKAGE_VERSION}"|' docs/conf.py
for file in docs/installation/kubernetes-helm.md \
helm-charts/values.yaml; do \
sed -i -e 's|tag:.*|tag: ${REL_IMAGE_TAG}|' $$file; \
done
sed -i -e 's|version="[^"]*"|version="${REL_IMAGE_TAG}"|' docker/Dockerfile.exporter-release
sed -i -e 's|release="[^"]*"|release="${REL_IMAGE_TAG}"|' docker/Dockerfile.exporter-release
for file in docs/installation/docker.md \
docs/installation/singularity.md \
docs/configuration/configmap.md \
docs/configuration/docker.md \
docs/integrations/prometheus-grafana.md; do \
sed -i 's#v[0-9]\+\.[0-9]\+\.[0-9]\+#${REL_IMAGE_TAG}#g' $$file; \
done
TO_GEN_TESTRUNNER := pkg/testrunner/proto
GEN_DIR_TESTRUNNER := $(TOP_DIR)/pkg/testrunner/
include Makefile.build
include Makefile.compile
include Makefile.package
##################
# Makefile targets
#
##@ QuickStart
.PHONY: default
default: build-dev-container ## Quick start to build everything from docker shell container
${MAKE} docker-compile
.PHONY: docker-shell
docker-shell:
docker run --rm -it --privileged \
--name ${CONTAINER_NAME} \
-e "USER_NAME=$(shell whoami)" \
-e "USER_UID=$(shell id -u)" \
-e "USER_GID=$(shell id -g)" \
-e "GIT_COMMIT=${GIT_COMMIT}" \
-e "GIT_VERSION=${GIT_VERSION}" \
-e "BUILD_DATE=${BUILD_DATE}" \
-v $(CURDIR):$(CONTAINER_WORKDIR) \
-w $(CONTAINER_WORKDIR) \
$(BUILD_CONTAINER) \
bash -c "cd $(CONTAINER_WORKDIR) && git config --global --add safe.directory $(CONTAINER_WORKDIR) && bash"
.PHONY: docker-compile
docker-compile:
docker run --rm -it --privileged \
--name ${CONTAINER_NAME} \
-e "USER_NAME=$(shell whoami)" \
-e "USER_UID=$(shell id -u)" \
-e "USER_GID=$(shell id -g)" \
-e "GIT_COMMIT=${GIT_COMMIT}" \
-e "GIT_VERSION=${GIT_VERSION}" \
-e "BUILD_DATE=${BUILD_DATE}" \
-v $(CURDIR):$(CONTAINER_WORKDIR) \
-w $(CONTAINER_WORKDIR) \
$(BUILD_CONTAINER) \
bash -c "cd $(CONTAINER_WORKDIR) && source ~/.bashrc && git config --global --add safe.directory $(CONTAINER_WORKDIR) && make all"
.PHONY: all
all:
${MAKE} gen amdexporter metricutil amdtestrunner
##@ Configuration Generation
# NOTE: example/config.json is the source of truth for all configurations.
# config-nic.json and config-gpu.json are auto-generated from config.json.
# To update configs, modify config.json and run 'make gen-configs'
.PHONY: gen-configs
gen-configs: ## Generate config-nic.json and config-gpu.json from config.json
@echo "Generating config-nic.json from config.json"
@jq '{ServerPort: 5001, CommonConfig: .CommonConfig, NICConfig: .NICConfig}' \
$(CONFIG_DIR)/config.json > $(CONFIG_DIR)/config-nic.json
@echo "Generating config-gpu.json from config.json"
@jq '{ServerPort: .ServerPort, CommonConfig: .CommonConfig, GPUConfig: .GPUConfig}' \
$(CONFIG_DIR)/config.json > $(CONFIG_DIR)/config-gpu.json
@echo "Config generation complete"
.PHONY: gen
gen: gen-configs gopkglist gen-test-runner
@for c in ${TO_GEN}; do printf "\n+++++++++++++++++ Generating $${c} +++++++++++++++++\n"; PATH=$$PATH make -C $${c} GEN_DIR=$(GEN_DIR) || exit 1; done
@for c in ${TO_MOCK}; do printf "\n+++++++++++++++++ Generating mock $${c} +++++++++++++++++\n"; PATH=$$PATH make -C $${c} MOCK_DIR=$(MOCK_DIR) GEN_DIR=$(GEN_DIR) || exit 1; done
.PHONY: gen-test-runner
gen-test-runner: gopkglist
@for c in ${TO_GEN_TESTRUNNER}; do printf "\n+++++++++++++++++ Generating $${c} +++++++++++++++++\n"; PATH=$$PATH make -C $${c} GEN_DIR=$(GEN_DIR_TESTRUNNER) || exit 1; done
.PHONY:clean
clean: pkg-clean
rm -rf bin
rm -rf docker/obj
rm -rf docker/*.tgz
rm -rf docker/*.tar
rm -rf docker/*.tar.gz
rm -rf ${PKG_PATH}
rm -rf build
rm -rf helm-charts/*.tgz
GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint
.PHONY: golangci-lint
golangci-lint: ## Download golangci-lint locally if necessary.
$(call go-get-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/[email protected])
HELMDOCS = $(shell pwd)/bin/helm-docs
.PHONY: helm-docs
helm-docs: ## Download helm-docs locally if necessary
$(call go-get-tool,$(HELMDOCS),github.com/norwoodj/helm-docs/cmd/[email protected])
$(HELMDOCS) -c $(shell pwd)/helm-charts/ -g $(shell pwd)/helm-charts -u --ignore-non-descriptions
# go-get-tool will 'go install' any package $2 and install it to $1.
PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
define go-get-tool
@[ -f $(1) ] || { \
set -e ;\
echo "Downloading $(2)" ;\
GOBIN=$(PROJECT_DIR)/bin go install $(2) ;\
}
endef
EXCLUDE_PATTERN := "libamdsmi|gpuagent.sw|gpuagent.sw.nic|gpuagent.sw.nic.gpuagent"
GO_PKG := $(shell go list ./pkg/... ./tools/... ./test/... 2>/dev/null | grep github.com/ROCm/device-metrics-exporter | egrep -v ${EXCLUDE_PATTERN})
GOFILES_NO_VENDOR = $(shell find . -type f -name '*.go' -not -path "./vendor/*")
.PHONY: lint
lint: golangci-lint ## Run golangci-lint against code.
@if [ `gofmt -l $(GOFILES_NO_VENDOR) | wc -l` -ne 0 ]; then \
echo There are some malformed files, please make sure to run \'make fmt\'; \
gofmt -l $(GOFILES_NO_VENDOR); \
exit 1; \
fi
$(GOLANGCI_LINT) run -v --timeout 5m0s
.PHONY: fmt
fmt:## Run go fmt against code.
go fmt $(GO_PKG)
.PHONY: vet
vet: ## Run go vet against code.
$(info +++ govet sources)
go vet -source $(GO_PKG)
.PHONY: gopkglist
gopkglist:
go install google.golang.org/protobuf/cmd/[email protected]
go install google.golang.org/grpc/cmd/[email protected]
go install go.uber.org/mock/[email protected]
go install github.com/golangci/golangci-lint/cmd/[email protected]
go install golang.org/x/tools/cmd/[email protected]
go install github.com/alta/protopatch/cmd/[email protected]
amdexporter: metricsclient amdgpuhealth
@echo "building amd metrics exporter"
CGO_ENABLED=0 go build -C cmd/exporter \
$(if $(GO_BUILD_TAGS),-tags $(GO_BUILD_TAGS)) \
-ldflags "-X main.Version=${VERSION} \
-X main.GitCommit=${GIT_COMMIT} \
-X main.BuildDate=${BUILD_DATE} \
-X main.Publish=${DISABLE_DEBUG}" \
-o $(CURDIR)/bin/amd-metrics-exporter
amdtestrunner:
@echo "building amd test runner"
CGO_ENABLED=0 go build -C cmd/testrunner -ldflags "-X main.Version=${VERSION} -X main.GitCommit=${GIT_COMMIT} -X main.BuildDate=${BUILD_DATE}" -o $(CURDIR)/bin/amd-test-runner
metricutil:
@echo "building metrics util"
CGO_ENABLED=0 go build -C tools/metricutil -o $(CURDIR)/bin/metricutil
metricsclient:
@echo "building metrics client"
CGO_ENABLED=0 go build -C tools/metricsclient -o $(CURDIR)/bin/metricsclient
amdgpuhealth:
@echo "building amd gpu health util"
CGO_ENABLED=0 go build -C tools/amd-gpu-health -o $(CURDIR)/bin/amdgpuhealth
.PHONY: docker-cicd
docker-cicd: gen amdexporter
echo "Building cicd docker for publish"
${MAKE} -C docker docker-cicd TOP_DIR=$(CURDIR)
${MAKE} -C docker docker-save TOP_DIR=$(CURDIR)
.PHONY: docker
docker: gen amdexporter
${MAKE} -C docker TOP_DIR=$(CURDIR)
${MAKE} -C docker docker-save TOP_DIR=$(CURDIR)
.PHONY: docker-sriov
docker-sriov: gen amdexporter
echo "Building docker for sriov driver rhel9"
${MAKE} -C docker docker-sriov TOP_DIR=$(CURDIR)
${MAKE} -C docker docker-sriov-save TOP_DIR=$(CURDIR)
.PHONY: docker-ainic
docker-ainic: gen amdexporter
echo "Building docker for ainic driver rhel9"
${MAKE} -C docker docker-ainic TOP_DIR=$(CURDIR)
${MAKE} -C docker docker-save TOP_DIR=$(CURDIR) AINIC=1
# for development we use ubuntu based
.PHONY: docker-sriov-ub22
docker-sriov-ub22: gen amdexporter
echo "Building docker for sriov driver ub22"
${MAKE} -C docker docker-sriov-ub22 TOP_DIR=$(CURDIR)
${MAKE} -C docker docker-sriov-save TOP_DIR=$(CURDIR)
.PHONY: docker-mock
docker-mock: gen
GO_BUILD_TAGS=mock ${MAKE} amdexporter
${MAKE} mock-rocpctl
${MAKE} -C docker TOP_DIR=$(CURDIR) EXPORTER_IMAGE_NAME=$(EXPORTER_IMAGE_NAME)-mock docker-mock
${MAKE} -C docker docker-save TOP_DIR=$(CURDIR) EXPORTER_IMAGE_NAME=$(EXPORTER_IMAGE_NAME)-mock
.PHONY: docker-test-runner
docker-test-runner: gen-test-runner amdtestrunner
${MAKE} -C docker/testrunner TOP_DIR=$(CURDIR) docker
.PHOHY: docker-test-runner-cicd
docker-test-runner-cicd: gen-test-runner amdtestrunner
echo "Building test runner cicd docker for publish"
${MAKE} -C docker/testrunner TOP_DIR=$(CURDIR) docker-cicd
${MAKE} -C docker/testrunner TOP_DIR=$(CURDIR) docker-save
.PHONY: docker-azure
docker-azure: gen amdexporter
${MAKE} -C docker azure TOP_DIR=$(CURDIR)
${MAKE} -C docker docker-save TOP_DIR=$(CURDIR) DOCKER_CONTAINER_IMAGE=${EXPORTER_IMAGE_NAME}-${EXPORTER_IMAGE_TAG}-azure
.PHONY:checks
checks: gen vet lint
.PHONY: docker-publish
docker-publish:
${MAKE} -C docker docker-publish TOP_DIR=$(CURDIR)
.PHONY: unit-test
unit-test:
PATH=$$PATH LOGDIR=$(TOP_DIR)/ go test -v -cover -mod=vendor ./pkg/...
loadgpu:
sudo modprobe amdgpu
mod:
@echo "ignoring submodules gpuagent and libamdsmi"
@touch ${TOP_DIR}/gpuagent/go.mod
@touch ${TOP_DIR}/libamdsmi/go.mod
@echo "setting up go mod packages"
@go mod tidy
@go mod edit -go=1.25.5
#CVE-2024-24790 - amd-metrics-exporter
@go mod edit -replace golang.org/x/[email protected]=golang.org/x/[email protected]
#CVE-2025-30204 - amd-test-runner
@go mod edit -replace github.com/golang-jwt/jwt/[email protected]=github.com/golang-jwt/jwt/[email protected]
#CVE GHSA-fv92-fjc5-jj9h - amdgpuhealth
@go mod edit -replace github.com/go-viper/mapstructure/[email protected]=github.com/go-viper/mapstructure/[email protected]
@go mod vendor
@rm ${TOP_DIR}/gpuagent/go.mod
@rm ${TOP_DIR}/libamdsmi/go.mod
.PHONY: docs clean-docs dep-docs
dep-docs:
pip install -r $(DOCS_DIR)/sphinx/requirements.txt
docs: dep-docs
sphinx-build -b html $(DOCS_DIR) $(HTML_DIR)
@echo "Docs built at $(HTML_DIR)/index.html"
clean-docs:
rm -rf $(BUILD_DIR)
DOCS_MARKDOWNLINTCONFIG ?= docs/.markdownlint.yaml
DOCS_MD_GLOB ?= "**/*.md"
DOCS_SPELLCHECK_CONFIG ?= .spellcheck.yaml
.PHONY: docs-lint-markdown
docs-lint-markdown:
markdownlint-cli2 $(DOCS_MD_GLOB) --config $(DOCS_MARKDOWNLINTCONFIG)
.PHONY: docs-lint-spelling
docs-lint-spelling:
pyspelling -c $(DOCS_SPELLCHECK_CONFIG)
.PHONY: docs-lint
docs-lint: ## Run docs Markdown lint + spelling (full ROCm-style docs lint).
${MAKE} docs-lint-markdown
${MAKE} docs-lint-spelling
.PHONY: base-image
base-image:
${MAKE} -C tools/base-image
copyrights:
GOFLAGS=-mod=mod go run tools/build/copyright/main.go && ${MAKE} fmt && ./tools/build/check-local-files.sh
# target to update remote submodule repo for amdsmi and gpuagent
.PHONY: update-submodules
update-submodules:
git submodule update --remote --recursive
.PHONY: e2e-test
e2e-test:
$(MAKE) -C test/e2e
.PHONY: e2e
e2e:
$(MAKE) docker-mock
$(MAKE) e2e-test
.PHOHY: k8s-e2e
k8s-e2e:
TOP_DIR=$(CURDIR) $(MAKE) -C test/k8s-e2e
.PHONY: helm-lint
helm-lint:
@echo "Project Version is $(PROJECT_VERSION)"
@echo "RELEASE tag is $(RELEASE)"
#copy default config
ifeq ($(NIC_BUILD),1)
jq 'del(.ServerPort, .NICConfig.ExtraPodLabels)' $(CONFIG_DIR)/config-nic.json > $(HELM_CHARTS_DIR)/config.json
else
jq 'del(.ServerPort, .GPUConfig.ExtraPodLabels)' $(CONFIG_DIR)/config-gpu.json > $(HELM_CHARTS_DIR)/config.json
endif
cd $(HELM_CHARTS_DIR); helm lint .
# cicd target to build helm chart - requires PROJECT_VERSION, EXPORTER_IMAGE_TAG to be set
.PHONY: helm
helm: helm-lint
@rm -rf helm-charts-k8s
@rm -rf helm-charts/nic-device-metrics-exporter*
@rm -rf helm-charts/device-metrics-exporter*
@rm -rf helm-charts/manifests.yaml
# updating project version in helm Chart.yaml
@yq eval -i '.appVersion = "$(HELM_CHARTS_VERSION)"' helm-charts/Chart.yaml
@yq eval -i '.version = "$(HELM_CHARTS_VERSION)"' helm-charts/Chart.yaml
# set exporter image repo and tag
@yq eval -i '.image.repository = "$(HELM_EXPORTER_IMAGE)"' helm-charts/values.yaml
@yq eval -i '.image.tag = "$(PROJECT_VERSION)"' helm-charts/values.yaml
# update monitoring flags in values.yaml based on RELEASE tag
ifeq ($(NIC_BUILD),1)
@echo "Detected NIC build from tag ${PROJECT_VERSION} — enabling NIC monitoring";
@yq eval -i '.name = "nic-device-metrics-exporter-charts"' helm-charts/Chart.yaml;
@yq eval -i '.monitor.resources.nic = true | .monitor.resources.gpu = false' helm-charts/values.yaml;
@yq eval -i '.hostNetwork = true' helm-charts/values.yaml;
@yq eval -i '.service.ClusterIP.port = 5001' helm-charts/values.yaml;
@yq eval -i '.service.NodePort.port = 5001' helm-charts/values.yaml;
@yq eval -i '.service.NodePort.nodePort = 32501' helm-charts/values.yaml;
else
@echo "Standard build detected — enabling GPU monitoring";
@yq eval -i '.name = "device-metrics-exporter-charts"' helm-charts/Chart.yaml;
@yq eval -i '.monitor.resources.nic = false | .monitor.resources.gpu = true' helm-charts/values.yaml;
@yq eval -i '.hostNetwork = false' helm-charts/values.yaml;
@yq eval -i '.service.ClusterIP.port = 5000' helm-charts/values.yaml;
@yq eval -i '.service.NodePort.port = 5000' helm-charts/values.yaml;
@yq eval -i '.service.NodePort.nodePort = 32500' helm-charts/values.yaml;
endif
${MAKE} helm-docs
@mkdir -p helm-charts-k8s
helm package helm-charts/ --destination ./helm-charts
ifeq ($(NIC_BUILD),1)
cp -vf helm-charts/nic-device-metrics-exporter-charts-$(HELM_CHARTS_VERSION).tgz helm-charts/nic-device-metrics-exporter-charts.tgz
helm template nic-device-metrics-exporter helm-charts/nic-device-metrics-exporter-charts.tgz -n kube-amd-network -f helm-charts/values.yaml > helm-charts/manifests.yaml
kubectl kustomize helm-charts/ > /dev/null || { echo "Error: kubectl kustomize failed"; rm -rf helm-charts/manifests.yaml; exit 1; }
rm -rf helm-charts/manifests.yaml
cp -vf helm-charts/nic-device-metrics-exporter-charts-$(HELM_CHARTS_VERSION).tgz helm-charts-k8s/nic-device-metrics-exporter-helm-k8s-${PROJECT_VERSION}.tgz
else
cp -vf helm-charts/device-metrics-exporter-charts-$(HELM_CHARTS_VERSION).tgz helm-charts/device-metrics-exporter-charts.tgz
helm template device-metrics-exporter helm-charts/device-metrics-exporter-charts.tgz -n kube-amd-gpu -f helm-charts/values.yaml > helm-charts/manifests.yaml
kubectl kustomize helm-charts/ > /dev/null || { echo "Error: kubectl kustomize failed"; rm -rf helm-charts/manifests.yaml; exit 1; }
rm -rf helm-charts/manifests.yaml
cp -vf helm-charts/device-metrics-exporter-charts-$(HELM_CHARTS_VERSION).tgz helm-charts-k8s/device-metrics-exporter-helm-k8s-${PROJECT_VERSION}.tgz
endif
.PHONY: slurm-sim
slurm-sim:
${MAKE} -C pkg/exporter/scheduler/slurmsim TOP_DIR=$(CURDIR)
# create development build container only if there is changes done on
# tools/base-image/Dockerfile
.PHONY: build-dev-container
build-dev-container:
${MAKE} -C tools/base-image all INSECURE_REGISTRY=$(INSECURE_REGISTRY)
.PHONY: amdsmi-compile-all
amdsmi-compile-all:
${MAKE} amdsmi-compile-ub24
${MAKE} amdsmi-compile-ub22
${MAKE} amdsmi-compile-rhel
#${MAKE} amdsmi-compile-azure
.PHONY: gimsmi-compile-all
gimsmi-compile-all:
${MAKE} gimsmi-compile-ub24
${MAKE} gimsmi-compile-ub22
${MAKE} gimsmi-compile-rhel
# build all components
.PHONY: build-all
build-all:
${MAKE} amdsmi-compile-all
${MAKE} gimsmi-compile-all
# no need to run this everytime, we build and copy assets once
#${MAKE} rocprofiler-compile
#${MAKE} gpuagent-compile
@echo "Docker image build is available under docker/ directory"
${MAKE} docker
.PHONY: mock-rocpctl
mock-rocpctl:
${MAKE} -C tools/mock-rocpctl BIN_PATH=$(CURDIR)/bin