-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathMakefile
More file actions
659 lines (542 loc) · 30.3 KB
/
Makefile
File metadata and controls
659 lines (542 loc) · 30.3 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
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
# SPDX-FileCopyrightText: (C) 2025 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
SHELL := bash -eu -o pipefail
# VERSION defines the project version for the bundle.
# Update this value when you upgrade the version of your project.
# To re-generate a bundle for another specific version without changing the standard setup, you can:
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
VERSION ?= $(shell cat VERSION | tr -d '[:space:]')
GIT_HASH_SHORT ?= $(shell git rev-parse --short=8 HEAD)
VERSION_DEV_SUFFIX := ${GIT_HASH_SHORT}
CLUSTERCTL_VERSION ?= v1.10.7
K3s_VERSION ?= v0.3.0
DOCKER_INFRA_VERSION ?= v1.10.7
CLUSTERCTL := $(shell command -v clusterctl 2> /dev/null)
CAPI_K3S_RBAC_PROXY_IMAGE ?= quay.io/brancz/kube-rbac-proxy:v0.21.0
FUZZTIME ?= 60s
# Add an identifying suffix for `-dev` builds only.
# Release build versions are verified as unique by the CI build process.
ifeq ($(findstring -dev,$(VERSION)), -dev)
VERSION := $(VERSION)-$(VERSION_DEV_SUFFIX)
endif
# Add VERSION_SUFFIX as suffix if specified and not empty
ifneq ($(strip $(VERSION_SUFFIX)),)
VERSION := $(VERSION)$(VERSION_SUFFIX)
endif
HELM_VERSION ?= ${VERSION}
REGISTRY ?= 080137407410.dkr.ecr.us-west-2.amazonaws.com
REGISTRY_NO_AUTH ?= edge-orch
REPOSITORY ?= cluster
DOCKER_TAG ?= ${VERSION}
DOCKER_IMAGE_TEMPLATE_CONTROLLER ?= ${REGISTRY}/${REGISTRY_NO_AUTH}/${REPOSITORY}/template-controller:${DOCKER_TAG}
DOCKER_IMAGE_CLUSTER_MANAGER ?= ${REGISTRY}/${REGISTRY_NO_AUTH}/${REPOSITORY}/cluster-manager:${DOCKER_TAG}
## Labels to add Docker/Helm/Service CI meta-data.
LABEL_SOURCE ?= $(shell git remote get-url $(shell git remote))
LABEL_REVISION = $(shell git rev-parse HEAD)
LABEL_CREATED ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ")
DOCKER_LABEL_ARGS ?= \
--build-arg org_oci_version="${VERSION}" \
--build-arg org_oci_source="${LABEL_SOURCE}" \
--build-arg org_oci_revision="${LABEL_REVISION}" \
--build-arg org_oci_created="${LABEL_CREATED}"
# Docker Build arguments
DOCKER_BUILD_ARGS ?= \
--build-arg http_proxy="$(http_proxy)" --build-arg https_proxy="$(https_proxy)" \
--build-arg no_proxy="$(no_proxy)" --build-arg HTTP_PROXY="$(http_proxy)" \
--build-arg HTTPS_PROXY="$(https_proxy)" --build-arg NO_PROXY="$(no_proxy)"
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.31.0
## Virtual environment name
VENV_NAME = venv-env
BUILD_DIR ?= build
# GoCov versions - pinned to avoid golang.org/x/tools@v0.13.0 incompatibility with Go 1.25+
GOLANG_GOCOV_VERSION := v1.1.0
GOLANG_GOCOV_XML_VERSION := v1.2.0
PKG := github.com/open-edge-platform/cluster-manager
# FIXME: The integration test in "./test" folder is failing. Commenting it for now
TEST_PATHS := ./internal/... ./pkg/... ./cmd/... # ./test/...
# 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
GOARCH := $(shell go env GOARCH)
GOEXTRAFLAGS := -trimpath -gcflags="all=-spectre=all -N -l" -asmflags="-spectre=all" -ldflags="all=-s -w -X main.version=${VERSION}"
ifeq ($(GOARCH),arm64)
GOEXTRAFLAGS := -trimpath -gcflags="all=-spectre= -N -l" -asmflags="all=-spectre=" -ldflags="all=-s -w -X main.version=${VERSION}"
endif
ifeq ($(GO_VENDOR),true)
GOEXTRAFLAGS := -mod=vendor $(GOEXTRAFLAGS)
endif
# CONTAINER_TOOL defines the container tool to be used for building images.
# Be aware that the target commands are only tested with Docker which is
# scaffolded by default. However, you might want to replace it to use other
# tools. (i.e. podman)
CONTAINER_TOOL ?= docker
# When set to true, disables integration with multi-tenanancy controllers. Should be false for production use cases
# Should be true for CO subsystem integration tests if multi-tenancy controllers are not deployed
DISABLE_MT ?= true
# When set to true, disables integration with keycloak oidc and opa sidecar. Should be false for production use cases
# Should be true for CO subsystem integration tests if keycloak is not deployed
DISABLE_AUTH ?= false
# When set to true, disables integration with infra inventory. Should be false for production use cases
# Should be true for CO subsystem integration tests if inventory is not deployed
DISABLE_INV ?= true
# When set to true, disables metrics collection.
DISABLE_METRICS ?= false
.PHONY: all
all: help
##@ 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 command 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: manifests
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
.PHONY: generate
generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
.PHONY: fmt
fmt: ## Run go fmt against code.
go fmt ./...
.PHONY: vet
vet: ## Run go vet against code.
go vet ./...
.PHONY: test
test: ## Run unit tests.
make test-unit
.PHONY: run-service-test
run-service-test: clusterctl ## Run service tests.
make kind-create
make helm-install
make test-service
.PHONY: mocks
mocks: ## Generate mock files for unit test using mockery
mockery --version || go install github.com/vektra/mockery/v2@latest
mockery
.PHONY: coverage
coverage: ## Generate test coverage report.
echo "TODO: coverage target not implemented"
.PHONY: test-unit
test-unit: envtest gocov
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(abspath $(LOCALBIN)) -p path)" go test $$(go list ${TEST_PATHS}) -v -race -gcflags -l -coverprofile cover.out -covermode atomic -short
${GOBIN}/gocov convert cover.out | ${GOBIN}/gocov-xml > coverage.xml
go tool cover -html=cover.out -o coverage.html
# TODO(user): To use a different vendor for e2e tests, modify the setup under 'tests/e2e'.
# The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
# Prometheus and CertManager are installed by default; skip with:
# - PROMETHEUS_INSTALL_SKIP=true
# - CERT_MANAGER_INSTALL_SKIP=true
.PHONY: test-service
test-service: ## Run the e2e tests. Expected an isolated environment using Kind.
DISABLE_AUTH=$(DISABLE_AUTH) make kind-expose-cm
DISABLE_AUTH=$(DISABLE_AUTH) go test ./test/service/ -v -ginkgo.v -timeout 5m
.PHONY: lint
lint: fmt vet golint yamllint helmlint mdlint ## Run linters
.PHONY: lint-fix
lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
$(GOLANGCI_LINT) run --fix
.PHONY: lint-config
lint-config: golangci-lint ## Verify golangci-lint linter configuration
$(GOLANGCI_LINT) config verify
.PHONY: mdlint
mdlint: ## Lint markdown files.
@markdownlint --version
@markdownlint "**/*.md"
.PHONY: dependency-check
dependency-check: ## Empty for now
##@ Build
.PHONY: build
build: build-template-controller build-cluster-manager ## Build template controller and cluster manager
.PHONY: build-template-controller
build-template-controller: ## Build template controller
go build -o bin/template-controller ${GOEXTRAFLAGS} cmd/template-controller/main.go
.PHONY: build-cluster-manager
build-cluster-manager: ## Build cluster manager
go build -o bin/cluster-manager ${GOEXTRAFLAGS} cmd/cluster-manager/main.go
.PHONY: run
run: manifests generate fmt vet ## Run a controller from your host.
go run ./cmd/template-controller/main.go
.PHONY: vendor
vendor: ## Build vendor directory of module dependencies.
GOPRIVATE=github.com/open-edge-platform/* go mod vendor
# If you wish to build the manager image targeting other platforms you can use the --platform flag.
# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
.PHONY: docker-build
DOCKER_ENV := DOCKER_BUILDKIT=1
docker-build: docker-build-template-controller docker-build-cluster-manager ## Build docker images.
.PHONY: docker-build-template-controller
docker-build-template-controller: vendor
$(CONTAINER_TOOL) build -t ${DOCKER_IMAGE_TEMPLATE_CONTROLLER} . -f deployment/images/Dockerfile.cluster-template-controller ${DOCKER_BUILD_ARGS} ${DOCKER_LABEL_ARGS}
.PHONY: docker-build-cluster-manager
docker-build-cluster-manager: vendor
$(CONTAINER_TOOL) build -t ${DOCKER_IMAGE_CLUSTER_MANAGER} . -f deployment/images/Dockerfile.cluster-manager ${DOCKER_BUILD_ARGS} ${DOCKER_LABEL_ARGS}
.PHONY: docker-push
docker-push: docker-push-template-controller docker-push-cluster-manager ## Push docker images.
.PHONY: docker-push-template-controller
docker-push-template-controller: ## Push docker image with the controller.
$(CONTAINER_TOOL) push ${DOCKER_IMAGE_TEMPLATE_CONTROLLER}
.PHONY: docker-push-cluster-manager
docker-push-cluster-manager: ## Push docker image with the cluster manager.
$(CONTAINER_TOOL) push ${DOCKER_IMAGE_CLUSTER_MANAGER}
.PHONY: docker-list
docker-list: ## Print name of docker container images
@echo "images:"
@echo " template-controller:"
@echo " name: '$(DOCKER_IMAGE_TEMPLATE_CONTROLLER)'"
@echo " version: '$(VERSION)'"
@echo " gitTagPrefix: 'v'"
@echo " buildTarget: 'docker-build-template-controller'"
@echo " cluster-manager:"
@echo " name: '$(DOCKER_IMAGE_CLUSTER_MANAGER)'"
@echo " version: '$(VERSION)'"
@echo " gitTagPrefix: 'v'"
@echo " buildTarget: 'docker-build-cluster-manager'"
# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
.PHONY: docker-buildx
docker-buildx: ## Build and push docker image for the manager for cross-platform support
# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
- $(CONTAINER_TOOL) buildx create --name cluster-manager-builder
$(CONTAINER_TOOL) buildx use cluster-manager-builder
- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
- $(CONTAINER_TOOL) buildx rm cluster-manager-builder
rm Dockerfile.cross
.PHONY: build-installer
build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
mkdir -p dist
cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
$(KUSTOMIZE) build config/default > dist/install.yaml
HELM_DIRS = $(shell find ./deployment/charts -maxdepth 1 -mindepth 1 -type d -print )
HELM_PKGS = $(shell find . -name "*.tgz" -maxdepth 1 -mindepth 1 -type f -print )
.PHONY: helm-clean
helm-clean: ## Clean helm chart build annotations.
for d in $(HELM_DIRS); do \
yq eval -i 'del(.annotations.revision)' $$d/Chart.yaml; \
yq eval -i 'del(.annotations.created)' $$d/Chart.yaml; \
done
rm -f $(HELM_PKGS)
.PHONY: helm-test
helm-test: ## Template the charts.
@for d in $(HELM_DIRS); do \
helm --debug template --namespace orch-cluster intel $$d; \
done
.PHONY: helm-build
helm-build: ## Package helm charts.
mkdir -p $(BUILD_DIR)
for d in $(HELM_DIRS); do \
yq eval '.version = "${HELM_VERSION}"' $$d/Chart.yaml > $$d/Chart.yaml.tmp && mv $$d/Chart.yaml.tmp $$d/Chart.yaml; \
yq eval '.appVersion = "${VERSION}"' $$d/Chart.yaml > $$d/Chart.yaml.tmp && mv $$d/Chart.yaml.tmp $$d/Chart.yaml; \
yq eval '.annotations.revision = "${LABEL_REVISION}"' $$d/Chart.yaml > $$d/Chart.yaml.tmp && mv $$d/Chart.yaml.tmp $$d/Chart.yaml; \
yq eval '.annotations.created = "${LABEL_CREATED}"' $$d/Chart.yaml > $$d/Chart.yaml.tmp && mv $$d/Chart.yaml.tmp $$d/Chart.yaml; \
helm package --app-version=${VERSION} --version=${HELM_VERSION} --debug -u $$d -d $(BUILD_DIR); \
done
.PHONY: helm-list
helm-list:
@echo "charts:"
@for d in $(HELM_DIRS); do \
cname=$$(grep "^name:" "$$d/Chart.yaml" | cut -d " " -f 2) ;\
echo " $$cname:" ;\
echo -n " "; grep "^version" "$$d/Chart.yaml" ;\
echo " gitTagPrefix: 'v'" ;\
echo " outDir: '$(BUILD_DIR)'" ;\
done
.PHONY: helm-push
helm-push: ## Push helm charts.
helm push $(BUILD_DIR)/cluster-template-crd-${HELM_VERSION}.tgz oci://$(REGISTRY)/$(REGISTRY_NO_AUTH)/$(REPOSITORY)/charts
helm push $(BUILD_DIR)/cluster-manager-${HELM_VERSION}.tgz oci://$(REGISTRY)/$(REGISTRY_NO_AUTH)/$(REPOSITORY)/charts
##@ Deployment
ifndef ignore-not-found
ignore-not-found = false
endif
.PHONY: install
install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
$(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f -
.PHONY: uninstall
uninstall: manifests kustomize ## Uninstall CRDs 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/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
.PHONY: deploy
deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
$(KUSTOMIZE) build config/default | $(KUBECTL) apply -f -
.PHONY: undeploy
undeploy: kustomize ## Undeploy controller 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/default | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
##@ Dependencies
## Location to install dependencies to
LOCALBIN ?= $(shell pwd)/bin
$(LOCALBIN):
mkdir -p $(LOCALBIN)
## Tool Binaries
KUBECTL ?= kubectl
KUSTOMIZE ?= $(LOCALBIN)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
ENVTEST ?= $(LOCALBIN)/setup-envtest
GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
## Tool Versions
KUSTOMIZE_VERSION ?= v5.5.0
CONTROLLER_TOOLS_VERSION ?= v0.17.0
#ENVTEST_VERSION is the version of controller-runtime release branch to fetch the envtest setup script (i.e. release-0.20)
ENVTEST_VERSION ?= $(shell go list -m -f "{{ .Version }}" sigs.k8s.io/controller-runtime | awk -F'[v.]' '{printf "release-%d.%d", $$2, $$3}')
#ENVTEST_K8S_VERSION is the version of Kubernetes to use for setting up ENVTEST binaries (i.e. 1.31)
ENVTEST_K8S_VERSION ?= $(shell go list -m -f "{{ .Version }}" k8s.io/api | awk -F'[v.]' '{printf "1.%d", $$3}')
GOLANGCI_LINT_VERSION ?= v1.64.8
.PHONY: kustomize
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
$(KUSTOMIZE): $(LOCALBIN)
$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION))
.PHONY: controller-gen
controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
$(CONTROLLER_GEN): $(LOCALBIN)
$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen,$(CONTROLLER_TOOLS_VERSION))
.PHONY: setup-envtest
setup-envtest: envtest ## Download the binaries required for ENVTEST in the local bin directory.
@echo "Setting up envtest binaries for Kubernetes version $(ENVTEST_K8S_VERSION)..."
@$(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path || { \
echo "Error: Failed to set up envtest binaries for version $(ENVTEST_K8S_VERSION)."; \
exit 1; \
}
.PHONY: envtest
envtest: $(ENVTEST) ## Download setup-envtest locally if necessary.
$(ENVTEST): $(LOCALBIN)
$(call go-install-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest,$(ENVTEST_VERSION))
.PHONY: golangci-lint
golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
$(GOLANGCI_LINT): $(LOCALBIN)
$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
# $1 - target path with name of binary
# $2 - package url which can be installed
# $3 - specific version of package
define go-install-tool
@[ -f "$(1)-$(3)" ] || { \
set -e; \
package=$(2)@$(3) ;\
echo "Downloading $${package}" ;\
rm -f $(1) || true ;\
GOBIN=$(LOCALBIN) go install $${package} ;\
mv $(1) $(1)-$(3) ;\
} ;\
ln -sf $(1)-$(3) $(1)
endef
##@ Standard targets
.PHONY: cobertura
cobertura:
go install github.com/boumenot/gocover-cobertura@latest
.PHONY: gocov
gocov:
@which gocov > /dev/null 2>&1 || go install github.com/axw/gocov/gocov@${GOLANG_GOCOV_VERSION}
@which gocov-xml > /dev/null 2>&1 || go install github.com/AlekSi/gocov-xml@${GOLANG_GOCOV_XML_VERSION}
$(VENV_NAME): requirements.txt
echo "Creating virtualenv $@"
python3 -m venv $@;\
. ./$@/bin/activate; set -u;\
python3 -m pip install --upgrade pip;\
python3 -m pip install -r requirements.txt
.PHONY: license
license: $(VENV_NAME) ## Check licensing with the reuse tool.
## Check licensing with the reuse tool.
. ./$</bin/activate; set -u;\
reuse --version;\
reuse --root . lint
.PHONY: golint
golint: golangci-lint ## Lint Go files.
$(GOLANGCI_LINT) run
.PHONY: helmlint
helmlint: ## Lint Helm charts.
helm lint ./deployment/charts/*
YAML_FILES := $(shell find . -type f \( -name '*.yaml' -o -name '*.yml' \) -print )
.PHONY: yamllint
yamllint: $(VENV_NAME) ## Lint YAML files.
. ./$</bin/activate; set -u;\
yamllint --version;\
yamllint -c .yamllint -s $(YAML_FILES)
.PHONY: fuzz
fuzz: vendor ## Run Fuzz tests against REST API handlers
hack/fuzz_all.sh ${FUZZTIME}
##@ Local KinD test targets
RS_REGISTRY ?= registry-rs.edgeorchestration.intel.com
RS_DOCKER_IMAGE_TEMPLATE_CONTROLLER ?= ${RS_REGISTRY}/${REGISTRY_NO_AUTH}/${REPOSITORY}/template-controller:${DOCKER_TAG}
RS_DOCKER_IMAGE_CLUSTER_MANAGER ?= ${RS_REGISTRY}/${REGISTRY_NO_AUTH}/${REPOSITORY}/cluster-manager:${DOCKER_TAG}
KIND_CLUSTER ?= capi
KIND_CONFIG ?= test/kind-cluster-with-extramounts.yaml
.PHONY: kind-delete
kind-delete: ## Delete a development kind cluster with CAPI enabled
@kind get clusters | grep -q '$(KIND_CLUSTER)' && kind delete cluster --name $(KIND_CLUSTER) || echo "No existing $(KIND_CLUSTER) cluster found."
.PHONY: kind-create
kind-create: ## Create a development kind cluster with CAPI enabled
@if kind get clusters | grep -q '$(KIND_CLUSTER)'; then \
echo "The '$(KIND_CLUSTER)' cluster is already running. Use \"make kind-delete\" to delete it before you proceed."; \
exit 1; \
fi
echo "Creating a Kind cluster with CAPI enabled..."
kind create cluster --name $(KIND_CLUSTER) --config $(KIND_CONFIG)
@make setup-clusterctl-config
CLUSTER_TOPOLOGY=true clusterctl init --core cluster-api:${CLUSTERCTL_VERSION} --bootstrap k3s:${K3s_VERSION} --control-plane k3s:${K3s_VERSION} --infrastructure docker:${DOCKER_INFRA_VERSION}
@make kind-fix-k3s-provider-images
.PHONY: kind-fix-k3s-provider-images
kind-fix-k3s-provider-images: ## Patch k3s provider sidecar image and wait for readiness
kubectl -n capi-k3s-bootstrap-system set image deployment/capi-k3s-bootstrap-controller-manager kube-rbac-proxy=$(CAPI_K3S_RBAC_PROXY_IMAGE)
kubectl -n capi-k3s-control-plane-system set image deployment/capi-k3s-control-plane-controller-manager kube-rbac-proxy=$(CAPI_K3S_RBAC_PROXY_IMAGE)
kubectl -n capi-k3s-bootstrap-system rollout status deployment/capi-k3s-bootstrap-controller-manager --timeout=120s
kubectl -n capi-k3s-control-plane-system rollout status deployment/capi-k3s-control-plane-controller-manager --timeout=120s
.PHONY: kind-expose-cm
kind-expose-cm: ## Expose the cluster manager service to the host
kubectl port-forward svc/cluster-manager 8080:8080 > /dev/null 2>&1 &
@if [ "$(DISABLE_AUTH)" = "false" ]; then \
kubectl port-forward svc/platform-keycloak 8081:80 -n orch-platform > /dev/null 2>&1 & \
fi
docker-load:
docker tag ${DOCKER_IMAGE_TEMPLATE_CONTROLLER} ${RS_DOCKER_IMAGE_TEMPLATE_CONTROLLER}
docker tag ${DOCKER_IMAGE_CLUSTER_MANAGER} ${RS_DOCKER_IMAGE_CLUSTER_MANAGER}
kind load docker-image ${RS_DOCKER_IMAGE_TEMPLATE_CONTROLLER} -n $(KIND_CLUSTER)
kind load docker-image ${RS_DOCKER_IMAGE_CLUSTER_MANAGER} -n $(KIND_CLUSTER)
helm-install: docker-build docker-load helm-build ## Install helm charts to the K8s cluster specified in ~/.kube/config.
@if [ "$(DISABLE_AUTH)" = "false" ]; then \
echo "Setting up mock keycloak and vault BEFORE cluster-manager deployment"; \
sed "s|CLUSTER_MANAGER_IMAGE_PLACEHOLDER:0.0.0|${RS_DOCKER_IMAGE_CLUSTER_MANAGER}|g" test/helpers/keycloak-mock.yaml | kubectl apply -f -; \
sed "s|CLUSTER_MANAGER_IMAGE_PLACEHOLDER:0.0.0|${RS_DOCKER_IMAGE_CLUSTER_MANAGER}|g" test/helpers/vault-mock.yaml | kubectl apply -f -; \
echo "Waiting for keycloak pod to be fully ready"; \
kubectl wait --for=condition=ready --timeout=120s pod -l app=platform-keycloak -n orch-platform; \
echo "Waiting for vault mock to be ready"; \
kubectl wait --for=condition=available --timeout=60s deployment/vault-mock -n orch-platform; \
echo "Mock services ready - cluster-manager can now fetch JWKS"; \
fi
helm upgrade --install --wait cluster-template-crd $(BUILD_DIR)/cluster-template-crd-${HELM_VERSION}.tgz
# Install cluster-manager without waiting, then patch probes for speed, then wait
helm upgrade --install cluster-manager $(BUILD_DIR)/cluster-manager-${HELM_VERSION}.tgz --set clusterManager.extraArgs.disable-multi-tenancy=${DISABLE_MT} --set clusterManager.extraArgs.disable-auth=${DISABLE_AUTH} --set clusterManager.extraArgs.disable-inventory=${DISABLE_INV} --set clusterManager.extraArgs.disable-metrics=${DISABLE_METRICS}
# TODO: Remove probe patching when we have a better way to speed up readiness checks in helm templates
kubectl patch deployment cluster-manager-template-controller -n default --type='json' -p='[{"op": "replace", "path": "/spec/template/spec/containers/0/readinessProbe/initialDelaySeconds", "value": 1}, {"op": "replace", "path": "/spec/template/spec/containers/0/readinessProbe/periodSeconds", "value": 1}]'
kubectl patch deployment cluster-manager -n default --type='json' -p='[{"op": "replace", "path": "/spec/template/spec/containers/0/readinessProbe/initialDelaySeconds", "value": 1}, {"op": "replace", "path": "/spec/template/spec/containers/0/readinessProbe/periodSeconds", "value": 1}]'
kubectl rollout status deployment/cluster-manager-template-controller -n default --timeout=60s
kubectl rollout status deployment/cluster-manager -n default --timeout=60s
helm-uninstall: # Uninstall helm charts from the K8s cluster specified in ~/.kube/config.
helm uninstall cluster-manager cluster-template-crd
redeploy: docker-build docker-load ## Redeploy the pod with the latest codes.
kubectl delete po -l app.kubernetes.io/instance=cluster-manager
.PHONY: generate-api
generate-api: check-oapi-codegen-version ## Generate Go client, server, client and types from OpenAPI spec with oapi-codegen
@echo "Generating..."
oapi-codegen -generate spec -o pkg/api/spec.gen.go -package api api/openapi/openapi.yaml
oapi-codegen -generate client -o pkg/api/client.gen.go -exclude-tags metrics -package api api/openapi/openapi.yaml
oapi-codegen -generate types -o pkg/api/types.gen.go -exclude-tags metrics -package api api/openapi/openapi.yaml
oapi-codegen -generate std-http,strict-server -exclude-tags metrics -o pkg/api/server.gen.go -package api api/openapi/openapi.yaml
.PHONY: check-oapi-codegen-version
check-oapi-codegen-version: ## Check oapi-codegen version
@version_output=$$(oapi-codegen --version); \
version_lines=$$(echo $$version_output | tr '\n' ' '); \
version=$$(echo $$version_lines | awk '{print $$2}'); \
if [ "$$version" != "v2.3.0" ]; then \
echo "oapi-codegen version must be v2.3.0, but got $$version"; \
exit 1; \
fi
##@ Dev targets
DEV_IMG ?= cluster-manager-image:${DEV_TAG}
DOCKER_DEV_REGISTRY ?= <placeholder>
DOCKER_DEV_REPOSITORY ?= <placeholder>
DOCKER_DEV_IMG := ${DOCKER_DEV_REGISTRY}${DOCKER_DEV_REPOSITORY}${DEV_IMG}
.PHONY: dev-image
dev-image: ## Build dev image and push to sandbox
@if test -z $(DEV_TAG); \
then echo "Please specify dev tag, make dev DEV_TAG=<dev-tag> " && exit 1; \
fi
${DOCKER_ENV} docker build --no-cache \
--build-arg http_proxy="$(http_proxy)" --build-arg https_proxy="$(https_proxy)" --build-arg no_proxy="$(no_proxy)" \
--build-arg HTTP_PROXY="$(HTTP_PROXY)" --build-arg HTTPS_PROXY="$(HTTPS_PROXY)" --build-arg NO_PROXY="$(NO_PROXY)" \
${DOCKER_LABEL_ARGS} \
-t ${DOCKER_DEV_IMG} . \
-f deployment/images/Dockerfile.cluster-manager
${DOCKER_ENV} docker push ${DOCKER_DEV_IMG}
.PHONY: dev-chart # Build dev helm chart and push to sandbox
dev-chart: ## Build dev helm chart and push to sandbox
@if test -z $(DEV_TAG); \
then echo "Please specify dev tag, make dev DEV_TAG=<dev-tag> " && exit 1; \
fi
helm package --app-version=${DEV_TAG} --version=${DEV_TAG} --debug -u deployment/charts/cluster-manager -d $(BUILD_DIR)
helm push $(BUILD_DIR)/cluster-manager-${DEV_TAG}.tgz oci://$(DOCKER_DEV_REGISTRY)$(DOCKER_DEV_REPOSITORY)charts
.PHONY: install-cert-manager
install-cert-manager: ## Install cert-manager using Helm.
helm repo add jetstack https://charts.jetstack.io
helm repo update
helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --version v1.15.0 --set crds.enabled=true
.PHONY: uninstall-cert-manager
uninstall-cert-manager: ## Uninstall cert-manager using Helm.
helm uninstall cert-manager --namespace cert-manager
kubectl delete namespace cert-manager
# Define variables for k3s provider URLs
BOOTSTRAP_URL := https://github.com/k3s-io/cluster-api-k3s/releases/$(K3s_VERSION)/bootstrap-components.yaml
CONTROL_PLANE_URL := https://github.com/k3s-io/cluster-api-k3s/releases/$(K3s_VERSION)/control-plane-components.yaml
.PHONY: setup-clusterctl-config
setup-clusterctl-config: ## Create clusterctl.yaml config for k3s providers
@if [ -d "$$HOME/.config/cluster-api" ] && [ ! -w "$$HOME/.config/cluster-api" ]; then \
echo "Error: Directory $$HOME/.config/cluster-api exists but is not writable."; \
exit 1; \
fi
@mkdir -p "$$HOME/.config/cluster-api" || { echo "Error: Failed to create directory $$HOME/.config/cluster-api."; exit 1; }
@printf "providers:\n - name: \"k3s\"\n url: \"$(BOOTSTRAP_URL)\"\n type: \"BootstrapProvider\"\n - name: \"k3s\"\n url: \"$(CONTROL_PLANE_URL)\"\n type: \"ControlPlaneProvider\"" > "$$HOME/.config/cluster-api/clusterctl.yaml"
.PHONY: clusterctl
clusterctl: ## Download clusterctl binary
ifndef CLUSTERCTL
curl -L https://github.com/kubernetes-sigs/cluster-api/releases/download/v1.9.4/clusterctl-linux-amd64 -o clusterctl
chmod +x clusterctl
mv clusterctl /usr/local/bin
endif
.PHONY: update-cm-version
update-cm-version: ## Update Cluster Manager version
@echo "Current version: $(VERSION)"
@read -p "Enter new version: " new_version; \
echo $$new_version > VERSION; \
sed -i "s/^version:.*/version: $${new_version}/" deployment/charts/cluster-manager/Chart.yaml; \
sed -i "s/^appVersion:.*/appVersion: $${new_version}/" deployment/charts/cluster-manager/Chart.yaml; \
sed -i "s/^version:.*/version: $${new_version}/" deployment/charts/cluster-template-crd/Chart.yaml; \
sed -i "s/^appVersion:.*/appVersion: $${new_version}/" deployment/charts/cluster-template-crd/Chart.yaml;
.PHONY: update-ct-version
update-ct-version: ## Update Cluster Template version
@echo "Current version: $(shell jq -r '.version' default-cluster-templates/baseline-k3s.json)"
@read -p "Enter new version: " new_version; \
sed -i "s/^ \"version\":.*/ \"version\": \"$${new_version}\",/" default-cluster-templates/baseline-k3s.json; \
sed -i "s/^ \"version\":.*/ \"version\": \"$${new_version}\",/" default-cluster-templates/privileged-k3s.json; \
sed -i "s/^ \"version\":.*/ \"version\": \"$${new_version}\",/" default-cluster-templates/restricted-k3s.json
.PHONY: update-api-version
update-api-version: ## Update API version
@echo "Current version: $(shell grep '^ version:' api/openapi/openapi.yaml | awk '{print $$2}')"
@read -p "Enter new version: " new_version; \
sed -i "s/^ version:.*/ version: $${new_version}/" api/openapi/openapi.yaml
make generate-api
HELM_VARS ?=
.PHONY: emf-redeploy
emf-redeploy: KIND_CLUSTER=kind
emf-redeploy: helm-build docker-build docker-load ## Redeploy cluster-manager helm charts in the running EMF cluster
kubectl patch application -n dev root-app --type=merge -p '{"spec":{"syncPolicy":{"automated":{"selfHeal":false}}}}'
kubectl delete application -n dev cluster-manager --ignore-not-found=true
kubectl delete crd clusters.cluster.edge-orchestrator.intel.com --ignore-not-found=true
kubectl delete crd clustertemplates.edge-orchestrator.intel.com --ignore-not-found=true
helm upgrade --install cluster-template-crd deployment/charts/cluster-template-crd -n orch-cluster --create-namespace
helm upgrade --install cluster-manager deployment/charts/cluster-manager -n orch-cluster --create-namespace \
--set clusterManager.extraArgs.disable-multi-tenancy=false \
--set clusterManager.extraArgs.disable-auth=false \
.PHONY: emf-rebuild
emf-rebuild: KIND_CLUSTER=kind
emf-rebuild: docker-build docker-load ## Rebuild cluster-manager container from source and redeploy
kubectl delete po -l app=cluster-manager-cm -n orch-cluster
kubectl delete po -l app=cluster-manager-controller -n orch-cluster