-
Notifications
You must be signed in to change notification settings - Fork 36
/
Makefile
338 lines (266 loc) · 14.3 KB
/
Makefile
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
# nos version. Used by release workflow, do not move this line.
NOS_VERSION ?= 0.1.2
DOCKER_REGISTRY ?= ghcr.io/nebuly-ai
# Image URLs to build/push Docker image targets
OPERATOR_IMG ?= $(DOCKER_REGISTRY)/nos-operator:$(NOS_VERSION)
SCHEDULER_IMG ?= $(DOCKER_REGISTRY)/nos-scheduler:$(NOS_VERSION)
GPU_PARTITIONER_IMG ?= $(DOCKER_REGISTRY)/nos-gpu-partitioner:$(NOS_VERSION)
MIG_AGENT_IMG ?= $(DOCKER_REGISTRY)/nos-mig-agent:$(NOS_VERSION)
GPU_AGENT_IMG ?= $(DOCKER_REGISTRY)/nos-gpu-agent:$(NOS_VERSION)
METRICS_EXPORTER_IMG ?= $(DOCKER_REGISTRY)/nos-metrics-exporter:$(NOS_VERSION)
# Helm chart URL to push Helm charts
HELM_CHART_REGISTRY ?= oci://ghcr.io/nebuly-ai/helm-charts
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.24.2
# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
ifeq (,$(shell go env GOBIN))
GOBIN=$(shell go env GOPATH)/bin
else
GOBIN=$(shell go env GOBIN)
endif
# Setting SHELL to bash allows bash commands to be executed by recipes.
# Options are set to exit when a recipe line exits non-zero or a piped command fails.
SHELL = /usr/bin/env bash -o pipefail
.SHELLFLAGS = -ec
.PHONY: all
all: build
##@ General
# The help target prints out all targets with their descriptions organized
# beneath their categories. The categories are represented by '##@' and the
# target descriptions by '##'. The awk commands is responsible for reading the
# entire set of makefiles included in this invocation, looking for lines of the
# file as xyz: ## something, and then pretty-format the target and help. Then,
# if there's a line with ##@ something, that gets pretty-printed as a category.
# More info on the usage of ANSI control characters for terminal formatting:
# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
# More info on the awk command:
# http://linuxcommand.org/lc3_adv_awk.php
.PHONY: help
help: ## Display this help.
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
##@ Development
.PHONY: operator-manifests ## Generate manifests for the nos operator (CRD, ClusterRole, WebhookConfig, etc.).
operator-manifests: controller-gen ## Generate CustomResourceDefinition objects.
$(CONTROLLER_GEN) crd paths="./internal/controllers/elasticquota/;./pkg/api/..." \
webhook \
rbac:roleName=operator-role \
output:rbac:artifacts:config=config/operator/rbac \
output:crd:artifacts:config=config/operator/crd/bases \
output:webhook:artifacts:config=config/operator/webhook
.PHONY: gpu-partitioner-manifests ## Generate manifests for the gpu-partitioner (ClusterRole, etc.).
gpu-partitioner-manifests: controller-gen
$(CONTROLLER_GEN) paths="./internal/controllers/gpupartitioner" \
rbac:roleName=gpu-partitioner-role \
output:rbac:artifacts:config=config/gpupartitioner/rbac
.PHONY: mig-agent-manifests ## Generate manifests for the mig-agent (ClusterRole, etc.).
mig-agent-manifests: controller-gen
$(CONTROLLER_GEN) paths="./internal/controllers/migagent/..." \
rbac:roleName=mig-agent-role \
output:rbac:artifacts:config=config/migagent/rbac
.PHONY: gpu-agent-manifests ## Generate manifests for the gpu-agent (ClusterRole, etc.).
gpu-agent-manifests: controller-gen
$(CONTROLLER_GEN) paths="./internal/controllers/gpuagent/..." \
rbac:roleName=gpu-agent-role \
output:rbac:artifacts:config=config/gpuagent/rbac
.PHONY: manifests
manifests: operator-manifests \
mig-agent-manifests \
gpu-partitioner-manifests \
gpu-agent-manifests
.PHONY: generate
generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate/license.txt" paths="./..."
.PHONY: generate-scheduler
generate-scheduler: defaulter-gen conversion-gen ## Generate defaults and conversions for scheduler.
CONVERSION_GEN=$(CONVERSION_GEN) DEFAULTER_GEN=$(DEFAULTER_GEN) bash hack/generate-scheduler.sh
.PHONY: fmt
fmt: ## Run go fmt against code.
go fmt ./...
.PHONY: vet
vet: ## Run go vet against code.
go vet ./...
.PHONY: test
test: manifests generate fmt vet envtest ## Run tests.
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test -tags integration ./... -coverprofile cover.out -covermode=count
.PHONY: lint
lint: vet golangci-lint ## Run Go linter.
$(GOLANGCI_LINT) run ./... -v
.PHONY: license-check
license-check: license-eye ## Check all files have the license header
$(LICENSE_EYE) header check
.PHONY: license-fix
license-fix: license-eye ## Add license header to files that still don't have it
$(LICENSE_EYE) header fix
.PHONY: helm-doc
helm-doc: helm-docs-bin ## Generate Helm charts documentation
$(HELM_DOCS) --chart-search-root ./helm-charts --document-dependency-values ; sh hack/generate-helm-docs.sh
##@ Build
.PHONY: cluster
cluster: kind ## Create a KIND cluster for development
kind create cluster --config hack/kind/cluster.yaml
.PHONY: build
build: generate fmt vet ## Build manager binary.
go build -o bin/manager main.go
.PHONY: docker-build-gpu-partitioner
docker-build-gpu-partitioner: ## Build docker image with the gpu-partitioner.
docker build -t ${GPU_PARTITIONER_IMG} -f build/gpupartitioner/Dockerfile .
.PHONY: docker-build-mig-agent
docker-build-mig-agent: ## Build docker image with the mig-agent.
docker build -t ${MIG_AGENT_IMG} -f build/migagent/Dockerfile .
.PHONY: docker-build-gpu-agent
docker-build-gpu-agent: ## Build docker image with the gpu-agent.
docker build -t ${GPU_AGENT_IMG} -f build/gpuagent/Dockerfile .
.PHONY: docker-build-operator
docker-build-operator: ## Build docker image with the operator.
docker build -t ${OPERATOR_IMG} -f build/operator/Dockerfile .
.PHONY: docker-build-scheduler
docker-build-scheduler: ## Build docker image with the scheduler.
docker build -t ${SCHEDULER_IMG} -f build/scheduler/Dockerfile .
.PHONY: docker-build-metrics-exporter
docker-build-metrics-exporter: ## Build docker image with the metrics-exporter.
docker build -t ${METRICS_EXPORTER_IMG} -f build/metricsexporter/Dockerfile .
.PHONY: docker-push-operator
docker-push-operator: ## Push docker image with the operator.
docker push ${OPERATOR_IMG}
.PHONY: docker-push-mig-agent
docker-push-mig-agent: ## Push docker image with the mig-agent.
docker push ${MIG_AGENT_IMG}
.PHONY: docker-push-gpu-agent
docker-push-gpu-agent: ## Push docker image with the gpu-agent.
docker push ${GPU_AGENT_IMG}
.PHONY: docker-push-scheduler
docker-push-scheduler: ## Push docker image with the scheduler.
docker push ${SCHEDULER_IMG}
.PHONY: docker-push-gpu-partitioner
docker-push-gpu-partitioner: ## Push docker image with the gpu-partitioner.
docker push ${GPU_PARTITIONER_IMG}
.PHONY: docker-push-metrics-exporter
docker-push-metrics-exporter: ## Push docker image with the metrics-exporter.
docker push ${METRICS_EXPORTER_IMG}
.PHONY: docker-build
docker-build: docker-build-mig-agent \
docker-build-gpu-agent \
docker-build-operator \
docker-build-scheduler \
docker-build-gpu-partitioner \
docker-build-metrics-exporter
.PHONY: docker-push
docker-push: docker-push-mig-agent \
docker-push-gpu-agent \
docker-push-operator \
docker-push-scheduler \
docker-push-gpu-partitioner \
docker-push-metrics-exporter
.PHONY: helm-push-nos
helm-push-nos: ## Push the nos Helm chart to the Helm repository.
helm package helm-charts/nos --destination /tmp
helm push /tmp/nos-*.tgz $(HELM_CHART_REGISTRY)
rm /tmp/nos-*.tgz
.PHONY: helm-push
helm-push: helm-push-nos ## Push the all the Helm charts to the Helm repository.
##@ Deployment
ifndef ignore-not-found
ignore-not-found = true
endif
.PHONY: install-cert-manager
install-cert-manager: ## Deploy cert-manager on the K8s cluster specified in ~/.kube/config
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/$(CERT_MANAGER_VERSION)/cert-manager.yaml
.PHONY: deploy-operator
deploy-operator: operator-manifests kustomize ## Deploy the nos Operator to the K8s cluster specified in ~/.kube/config.
cd config/operator/manager && $(KUSTOMIZE) edit set image controller=${OPERATOR_IMG}
$(KUSTOMIZE) build config/operator/default | kubectl apply -f -
.PHONY: deploy-scheduler
deploy-scheduler: kustomize ## Deploy the nos scheduler to the K8s cluster specified in ~/.kube/config.
cd config/scheduler/deployment && $(KUSTOMIZE) edit set image scheduler=${SCHEDULER_IMG}
$(KUSTOMIZE) build config/scheduler/default | kubectl apply -f -
.PHONY: deploy-mig-agent
deploy-mig-agent: kustomize ## Deploy the MIG Agent to the K8s cluster specified in ~/.kube/config.
cd config/migagent/manager && $(KUSTOMIZE) edit set image mig-agent=${MIG_AGENT_IMG}
$(KUSTOMIZE) build config/migagent/default | kubectl apply -f -
.PHONY: deploy-gpu-agent
deploy-gpu-agent: kustomize ## Deploy the GPU Agent to the K8s cluster specified in ~/.kube/config.
cd config/gpuagent/manager && $(KUSTOMIZE) edit set image gpu-agent=${GPU_AGENT_IMG}
$(KUSTOMIZE) build config/gpuagent/default | kubectl apply -f -
.PHONY: deploy-gpu-partitioner
deploy-gpu-partitioner: kustomize deploy-mig-agent deploy-gpu-agent ## Deploy the GPU Partitioner to the K8s cluster specified in ~/.kube/config.
cd config/gpupartitioner/manager && $(KUSTOMIZE) edit set image gpu-partitioner=${GPU_PARTITIONER_IMG}
$(KUSTOMIZE) build config/gpupartitioner/default | kubectl apply -f -
.PHONY: deploy
deploy: deploy-operator deploy-scheduler deploy-gpu-partitioner deploy-gpu-agent deploy-mig-agent ## Deploy the all the components to the K8s cluster specified in ~/.kube/config.
.PHONY: undeploy-operator
undeploy-operator: ## Undeploy the nos operator from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
$(KUSTOMIZE) build config/operator/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f -
.PHONY: undeploy-scheduler
undeploy-scheduler: ## Undeploy the nos scheduler from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
$(KUSTOMIZE) build config/scheduler/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f -
.PHONY: undeploy-mig-agent
undeploy-mig-agent: ## Undeploy the MIG agent from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
$(KUSTOMIZE) build config/migagent/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f -
.PHONY: undeploy-gpu-agent
undeploy-gpu-agent: ## Undeploy the GPU agent from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
$(KUSTOMIZE) build config/gpuagent/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f -
.PHONY: undeploy-gpu-partitioner
undeploy-gpu-partitioner: ## Undeploy the GPU Partitioner from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
$(KUSTOMIZE) build config/gpupartitioner/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f -
.PHONY: undeploy
undeploy: undeploy-operator undeploy-scheduler undeploy-gpu-partitioner undeploy-gpu-agent undeploy-mig-agent ## Undeploy the all the components to the K8s cluster specified in ~/.kube/config.
##@ Build Dependencies
## Location to install dependencies to
LOCALBIN ?= $(shell pwd)/bin
$(LOCALBIN):
mkdir -p $(LOCALBIN)
## Tool Binaries
KUSTOMIZE ?= $(LOCALBIN)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
DEFAULTER_GEN ?= $(LOCALBIN)/defaulter-gen
CONVERSION_GEN ?= $(LOCALBIN)/conversion-gen
CODE_GEN ?= $(LOCALBIN)/code-generator
ENVTEST ?= $(LOCALBIN)/setup-envtest
KIND ?= $(LOCALBIN)/kind
GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint
LICENSE_EYE ?= $(LOCALBIN)/license-eye
HELM_DOCS ?= $(LOCALBIN)/helm-docs
## Tool Versions
KUSTOMIZE_VERSION ?= v4.5.5
CONTROLLER_TOOLS_VERSION ?= v0.9.2
CODE_GENERATOR_VERSION ?= v0.24.3
GOLANGCI_LINT_VERSION ?= 1.50.1
HELM_DOCS_VERSION ?= v1.11.0
CERT_MANAGER_VERSION ?= v1.9.1
KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
.PHONY: kustomize
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
$(KUSTOMIZE): $(LOCALBIN)
test -s $(LOCALBIN)/kustomize || { curl -s $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); }
.PHONY: controller-gen
controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
$(CONTROLLER_GEN): $(LOCALBIN)
test -s $(LOCALBIN)/controller-gen || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
.PHONY: defaulter-gen
defaulter-gen: $(DEFAULTER_GEN) ## Download defaulter-gen locally if necessary
$(DEFAULTER_GEN): $(LOCALBIN)
test -s $(LOCALBIN)/defaulter-gen || GOBIN=$(LOCALBIN) go install k8s.io/code-generator/cmd/defaulter-gen@$(CODE_GENERATOR_VERSION)
.PHONY: conversion-gen
conversion-gen: $(CONVERSION_GEN) ## Download defaulter-gen locally if necessary
$(CONVERSION_GEN): $(LOCALBIN)
test -s $(LOCALBIN)/conversion-gen || GOBIN=$(LOCALBIN) go install k8s.io/code-generator/cmd/conversion-gen@$(CODE_GENERATOR_VERSION)
.PHONY: envtest
envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
$(ENVTEST): $(LOCALBIN)
test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
.PHONY: kind ## Download Kind if necessary
kind: $(KIND)
$(KIND): $(LOCALBIN)
test -s $(LOCALBIN)/kind || GOBIN=$(LOCALBIN) go install sigs.k8s.io/kind@latest
.PHONY: golangci-lint ## Download golanci-lint if necessary
golangci-lint: $(GOLANGCI_LINT)
$(GOLANGCI_LINT): $(LOCALBIN)
test -s $(LOCALBIN)/golanci-lint || GOBIN=$(LOCALBIN) go install github.com/golangci/golangci-lint/cmd/golangci-lint@v${GOLANGCI_LINT_VERSION}
.PHONY: license-eye ## Download license-eye if necessary
license-eye: $(LICENSE_EYE)
$(LICENSE_EYE): $(LOCALBIN)
test -s $(LOCALBIN)/license-eye || GOBIN=$(LOCALBIN) go install github.com/apache/skywalking-eyes/cmd/license-eye@latest
.PHONY: helm-docs-bin ## Download helm-docs if necessary
helm-docs-bin: $(HELM_DOCS)
$(HELM_DOCS): $(LOCALBIN)
test -s $(LOCALBIN)/helm-docs || GOBIN=$(LOCALBIN) go install github.com/norwoodj/helm-docs/cmd/helm-docs@$(HELM_DOCS_VERSION)