forked from microsoft/retina
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
588 lines (481 loc) · 21.2 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
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
.DEFAULT_GOAL := help
# Default platform commands
RMDIR := rm -rf
## Globals
GIT_CURRENT_BRANCH_NAME := $(shell git rev-parse --abbrev-ref HEAD)
REPO_ROOT = $(shell git rev-parse --show-toplevel)
ifndef TAG
TAG ?= $(shell git describe --tags --always)
endif
OUTPUT_DIR = $(REPO_ROOT)/output
BUILD_DIR = $(OUTPUT_DIR)/$(GOOS)_$(GOARCH)
RETINA_BUILD_DIR = $(BUILD_DIR)/retina
RETINA_DIR = $(REPO_ROOT)/controller
OPERATOR_DIR=$(REPO_ROOT)/operator
CAPTURE_WORKLOAD_DIR = $(REPO_ROOT)/captureworkload
KIND = /usr/local/bin/kind
KIND_CLUSTER = retina-cluster
WINVER2022 ?= "10.0.20348.1906"
WINVER2019 ?= "10.0.17763.4737"
APP_INSIGHTS_ID ?= ""
GENERATE_TARGET_DIRS = \
./pkg/plugin/linuxutil
# Default platform is linux/amd64
GOOS ?= linux
GOARCH ?= amd64
OS ?= $(GOOS)
ARCH ?= $(GOARCH)
PLATFORM ?= $(OS)/$(ARCH)
PLATFORMS ?= linux/amd64 linux/arm64 windows/amd64
OS_VERSION ?= ltsc2019
HUBBLE_VERSION ?= v1.16.3
CONTAINER_BUILDER ?= docker
CONTAINER_RUNTIME ?= docker
YEAR ?= 2022
ALL_ARCH.linux = amd64 arm64
ALL_ARCH.windows = amd64
#######
# TLS #
#######
ENABLE_TLS ?= true
CERT_DIR := $(REPO_ROOT)/.certs
CERT_FILES := tls.crt:tls-client-cert-file \
tls.key:tls-client-key-file \
ca.crt:tls-ca-cert-files
# TAG is OS and platform agonstic, which can be used for binary version and image manifest tag,
# while RETINA_PLATFORM_TAG is platform specific, which can be used for image built for specific platforms.
RETINA_PLATFORM_TAG ?= $(TAG)-$(subst /,-,$(PLATFORM))
# used for looping through components in container build
AGENT_TARGETS ?= init agent
WINDOWS_YEARS ?= "2019 2022"
# for windows os, add year to the platform tag
ifeq ($(OS),windows)
RETINA_PLATFORM_TAG = $(TAG)-windows-ltsc$(YEAR)-amd64
endif
qemu-user-static: ## Set up the host to run qemu multiplatform container builds.
sudo $(CONTAINER_RUNTIME) run --rm --privileged multiarch/qemu-user-static --reset -p yes
.PHONY: version
version: ## prints the root version
@if [ "$(shell git tag --points-at HEAD)" != "" ]; then \
export VERSION="$$(git tag --points-at HEAD)"; \
else \
export VERSION="$$(git rev-parse --short HEAD)"; \
fi; \
echo "$${VERSION}"
##@ Help
help: ## Display this help
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
##@ Tools
TOOLS_DIR = $(REPO_ROOT)/hack/tools
TOOLS_BIN_DIR = $(TOOLS_DIR)/bin
GOFUMPT = $(TOOLS_BIN_DIR)/gofumpt
GOLANGCI_LINT = $(TOOLS_BIN_DIR)/golangci-lint
GORELEASER = $(TOOLS_BIN_DIR)/goreleaser
CONTROLLER_GEN = $(TOOLS_BIN_DIR)/controller-gen
GINKGO = $(TOOLS_BIN_DIR)/ginkgo
MOCKGEN = $(TOOLS_BIN_DIR)/mockgen
ENVTEST = $(TOOLS_BIN_DIR)/setup-envtest
$(TOOLS_DIR)/go.mod:
cd $(TOOLS_DIR); go mod init && go mod tidy
$(GOFUMPT): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go mod download; go build -tags=tools -o bin/gofumpt mvdan.cc/gofumpt
gofumpt: $(GOFUMPT) ## Build gofumpt
$(GOLANGCI_LINT): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go mod download; go build -tags=tools -o bin/golangci-lint github.com/golangci/golangci-lint/cmd/golangci-lint
golangci-lint: $(GOLANGCI_LINT) ## Build golangci-lint
$(CONTROLLER_GEN): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go mod download; go build -tags=tools -o bin/controller-gen sigs.k8s.io/controller-tools/cmd/controller-gen
goreleaser: $(GORELEASER) ## Build goreleaser
$(GORELEASER): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go mod download; go build -tags=tools -o bin/goreleaser github.com/goreleaser/goreleaser
controller-gen: $(CONTROLLER_GEN) ## Build controller-gen
$(GINKGO): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go mod download; go build -tags=tools -o bin/ginkgo github.com/onsi/ginkgo/ginkgo
ginkgo: $(GINKGO) ## Build ginkgo
$(MOCKGEN): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go mod download; go build -tags=$(TOOL_TAG) -o bin/mockgen go.uber.org/mock/mockgen
mockgen: $(MOCKGEN) ## Build mockgen
$(ENVTEST): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go mod download; go build -tags=$(TOOL_TAG) -o bin/setup-envtest sigs.k8s.io/controller-runtime/tools/setup-envtest
setup-envtest: $(ENVTEST)
all: generate
generate: generate-bpf-go
go generate ./...
for dir in $(GENERATE_TARGET_DIRS); do \
make -C $$dir $@; \
done
generate-bpf-go: ## generate ebpf wrappers for plugins for all archs
for arch in $(ALL_ARCH.linux); do \
GOARCH=$$arch go generate ./pkg/plugin/...; \
done
.PHONY: all generate generate-bpf-go
##@ Utils
FMT_PKG ?= .
LINT_PKG ?= .
fmt: $(GOFUMPT) ## run gofumpt on $FMT_PKG (default "retina").
$(GOFUMPT) -w $(FMT_PKG)
lint: $(GOLANGCI_LINT) ## Fast lint vs default branch showing only new issues.
$(GOLANGCI_LINT) run --new-from-rev main --timeout 10m -v $(LINT_PKG)/...
lint-existing: $(GOLANGCI_LINT) ## Lint the current branch in entirety.
$(GOLANGCI_LINT) run -v $(LINT_PKG)/...
clean: ## clean build artifacts
$(RMDIR) $(OUTPUT_DIR)
##@ Build Binaries
retina: ## builds retina binary
$(MAKE) retina-binary
retina-binary: ## build the Retina binary
go generate ./... && \
go build -v -o $(RETINA_BUILD_DIR)/retina$(EXE_EXT) -gcflags="-dwarflocationlists=true" -ldflags "-X github.com/microsoft/retina/internal/buildinfo.Version=$(TAG) -X github.com/microsoft/retina/internal/buildinfo.ApplicationInsightsID=$(APP_INSIGHTS_ID)" $(RETINA_DIR)/main.go
retina-capture-workload: ## build the Retina capture workload
cd $(CAPTURE_WORKLOAD_DIR) && go build -v -o $(RETINA_BUILD_DIR)/captureworkload$(EXE_EXT) -gcflags="-dwarflocationlists=true" -ldflags "-X main.version=$(TAG)"
##@ Containers
IMAGE_REGISTRY ?= ghcr.io
IMAGE_NAMESPACE ?= $(shell git config --get remote.origin.url | sed -E 's/.*github\.com[\/:]([^\/]+)\/([^\/.]+)(.git)?/\1\/\2/' | tr '[:upper:]' '[:lower:]')
RETINA_BUILDER_IMAGE = $(IMAGE_NAMESPACE)/retina-builder
RETINA_TOOLS_IMAGE = $(IMAGE_NAMESPACE)/retina-tools
RETINA_IMAGE = $(IMAGE_NAMESPACE)/retina-agent
RETINA_INIT_IMAGE = $(IMAGE_NAMESPACE)/retina-init
RETINA_OPERATOR_IMAGE = $(IMAGE_NAMESPACE)/retina-operator
RETINA_SHELL_IMAGE = $(IMAGE_NAMESPACE)/retina-shell
KUBECTL_RETINA_IMAGE = $(IMAGE_NAMESPACE)/kubectl-retina
RETINA_INTEGRATION_TEST_IMAGE = $(IMAGE_NAMESPACE)/retina-integration-test
RETINA_PROTO_IMAGE = $(IMAGE_NAMESPACE)/retina-proto-gen
RETINA_GO_GEN_IMAGE = $(IMAGE_NAMESPACE)/retina-go-gen
KAPINGER_IMAGE = kapinger
skopeo-export: # util target to copy a container from containers-storage to the docker daemon.
skopeo copy \
containers-storage:$(REF) \
docker-daemon:$(REF)
container-push: # util target to publish container image. do not invoke directly.
$(CONTAINER_BUILDER) push \
$(IMAGE_REGISTRY)/$(IMAGE):$(TAG)
container-pull: # util target to pull container image.
$(CONTAINER_BUILDER) pull \
$(IMAGE_REGISTRY)/$(IMAGE):$(TAG)
retina-skopeo-export:
$(MAKE) skopeo-export \
REF=$(IMAGE_REGISTRY)/$(RETINA_IMAGE):$(RETINA_PLATFORM_TAG) \
IMG=$(RETINA_IMAGE)
TAG=$(RETINA_PLATFORM_TAG)
manifest-skopeo-archive: # util target to export tar archive of multiarch container manifest.
skopeo copy --all docker://$(IMAGE_REGISTRY)/$(IMAGE):$(TAG) oci-archive:$(IMAGE_ARCHIVE_DIR)/$(IMAGE)-$(TAG).tar --debug
buildx:
if docker buildx inspect retina > /dev/null 2>&1; then \
echo "Buildx instance retina already exists."; \
else \
echo "Creating buildx instance retina..."; \
docker buildx create --name retina --use --driver-opt image=mcr.microsoft.com/oss/v2/moby/buildkit:v0.16.0-2 --platform $$(echo "$(PLATFORMS)" | tr ' ' ','); \
docker buildx use retina; \
echo "Buildx instance retina created."; \
fi;
container-docker: buildx # util target to build container images using docker buildx. do not invoke directly.
os=$$(echo $(PLATFORM) | cut -d'/' -f1); \
arch=$$(echo $(PLATFORM) | cut -d'/' -f2); \
image_name=$$(basename $(IMAGE)); \
image_metadata_filename="image-metadata-$$image_name-$(TAG).json"; \
touch $$image_metadata_filename; \
echo "Building $$image_name for $$os/$$arch "; \
docker buildx build \
--platform $(PLATFORM) \
--metadata-file=$$image_metadata_filename \
-f $(DOCKERFILE) \
--build-arg APP_INSIGHTS_ID=$(APP_INSIGHTS_ID) \
--build-arg GOARCH=$$arch \
--build-arg GOOS=$$os \
--build-arg OS_VERSION=$(OS_VERSION) \
--build-arg HUBBLE_VERSION=$(HUBBLE_VERSION) \
--build-arg VERSION=$(VERSION) $(EXTRA_BUILD_ARGS) \
--target=$(TARGET) \
-t $(IMAGE_REGISTRY)/$(IMAGE):$(TAG) \
$(BUILDX_ACTION) \
$(CONTEXT_DIR)
retina-image: ## build the retina linux container image.
echo "Building for $(PLATFORM)"
for target in $(AGENT_TARGETS); do \
echo "Building for $$target"; \
if [ "$$target" = "init" ]; then \
image_name=$(RETINA_INIT_IMAGE); \
else \
image_name=$(RETINA_IMAGE); \
fi; \
$(MAKE) container-$(CONTAINER_BUILDER) \
PLATFORM=$(PLATFORM) \
DOCKERFILE=controller/Dockerfile \
REGISTRY=$(IMAGE_REGISTRY) \
IMAGE=$$image_name \
VERSION=$(TAG) \
TAG=$(RETINA_PLATFORM_TAG) \
APP_INSIGHTS_ID=$(APP_INSIGHTS_ID) \
CONTEXT_DIR=$(REPO_ROOT) \
TARGET=$$target; \
done
retina-image-win: ## build the retina Windows container image.
for year in $(WINDOWS_YEARS); do \
tag=$(TAG)-windows-ltsc$$year-amd64; \
echo "Building $(RETINA_PLATFORM_TAG)"; \
set -e ; \
$(MAKE) container-$(CONTAINER_BUILDER) \
PLATFORM=windows/amd64 \
DOCKERFILE=controller/Dockerfile \
REGISTRY=$(IMAGE_REGISTRY) \
IMAGE=$(RETINA_IMAGE) \
OS_VERSION=ltsc$$year \
VERSION=$(TAG) \
TAG=$$tag \
TARGET=agent-win \
CONTEXT_DIR=$(REPO_ROOT); \
done
retina-operator-image: ## build the retina linux operator image.
echo "Building for $(PLATFORM)"
set -e ; \
$(MAKE) container-$(CONTAINER_BUILDER) \
PLATFORM=$(PLATFORM) \
DOCKERFILE=operator/Dockerfile \
REGISTRY=$(IMAGE_REGISTRY) \
IMAGE=$(RETINA_OPERATOR_IMAGE) \
VERSION=$(TAG) \
TAG=$(RETINA_PLATFORM_TAG) \
APP_INSIGHTS_ID=$(APP_INSIGHTS_ID) \
CONTEXT_DIR=$(REPO_ROOT)
retina-shell-image:
echo "Building for $(PLATFORM)"
set -e ; \
$(MAKE) container-$(CONTAINER_BUILDER) \
PLATFORM=$(PLATFORM) \
DOCKERFILE=shell/Dockerfile \
REGISTRY=$(IMAGE_REGISTRY) \
IMAGE=$(RETINA_SHELL_IMAGE) \
VERSION=$(TAG) \
TAG=$(RETINA_PLATFORM_TAG) \
CONTEXT_DIR=$(REPO_ROOT)
kubectl-retina-image:
echo "Building for $(PLATFORM)"
set -e ; \
$(MAKE) container-$(CONTAINER_BUILDER) \
PLATFORM=$(PLATFORM) \
DOCKERFILE=cli/Dockerfile \
REGISTRY=$(IMAGE_REGISTRY) \
IMAGE=$(KUBECTL_RETINA_IMAGE) \
VERSION=$(TAG) \
TAG=$(RETINA_PLATFORM_TAG) \
CONTEXT_DIR=$(REPO_ROOT)
kapinger-image:
docker buildx build --builder retina --platform windows/amd64 --target windows-amd64 -t $(IMAGE_REGISTRY)/$(KAPINGER_IMAGE):$(TAG)-windows-amd64 ./hack/tools/kapinger/ --push
docker buildx build --builder retina --platform linux/amd64 --target linux-amd64 -t $(IMAGE_REGISTRY)/$(KAPINGER_IMAGE):$(TAG)-linux-amd64 ./hack/tools/kapinger/ --push
docker buildx build --builder retina --platform linux/arm64 --target linux-arm64 -t $(IMAGE_REGISTRY)/$(KAPINGER_IMAGE):$(TAG)-linux-arm64 ./hack/tools/kapinger/ --push
docker buildx imagetools create -t $(IMAGE_REGISTRY)/$(KAPINGER_IMAGE):$(TAG) \
$(IMAGE_REGISTRY)/$(KAPINGER_IMAGE):$(TAG)-windows-amd64 \
$(IMAGE_REGISTRY)/$(KAPINGER_IMAGE):$(TAG)-linux-amd64 \
$(IMAGE_REGISTRY)/$(KAPINGER_IMAGE):$(TAG)-linux-arm64
proto-gen: ## generate protobuf code
docker build --platform=linux/amd64 \
-t $(IMAGE_REGISTRY)/$(RETINA_PROTO_IMAGE):$(RETINA_PLATFORM_TAG) \
-f controller/Dockerfile.proto .
docker run --rm --platform=linux/amd64 \
--user $(shell id -u):$(shell id -g) \
-v $(PWD):/app $(IMAGE_REGISTRY)/$(RETINA_PROTO_IMAGE):$(RETINA_PLATFORM_TAG)
go-gen: ## run go generate at the repository root
docker build -t $(IMAGE_REGISTRY)/$(RETINA_GO_GEN_IMAGE):$(RETINA_PLATFORM_TAG) \
--build-arg GOOS=$(GOOS) \
--build-arg GOARCH=$(GOARCH) \
-f controller/Dockerfile.gogen .
docker run --rm --user $(shell id -u):$(shell id -g) -v $(PWD):/app $(IMAGE_REGISTRY)/$(RETINA_GO_GEN_IMAGE):$(RETINA_PLATFORM_TAG)
all-gen: ## generate all code
$(MAKE) proto-gen
$(MAKE) go-gen
##@ Multiplatform
manifest-retina-image: ## create a multiplatform manifest for the retina image
$(eval FULL_IMAGE_NAME=$(IMAGE_REGISTRY)/$(RETINA_IMAGE):$(TAG))
$(eval FULL_INIT_IMAGE_NAME=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE):$(TAG))
docker buildx imagetools create -t $(FULL_IMAGE_NAME) $(foreach platform,linux/amd64 linux/arm64 windows-ltsc2019-amd64 windows-ltsc2022-amd64, $(FULL_IMAGE_NAME)-$(subst /,-,$(platform)))
docker buildx imagetools create -t $(FULL_INIT_IMAGE_NAME) $(foreach platform,linux/amd64 linux/arm64, $(FULL_INIT_IMAGE_NAME)-$(subst /,-,$(platform)))
manifest-operator-image: ## create a multiplatform manifest for the operator image
$(eval FULL_IMAGE_NAME=$(IMAGE_REGISTRY)/$(RETINA_OPERATOR_IMAGE):$(TAG))
docker buildx imagetools create -t $(FULL_IMAGE_NAME) $(foreach platform,linux/amd64, $(FULL_IMAGE_NAME)-$(subst /,-,$(platform)))
manifest-shell-image:
$(eval FULL_IMAGE_NAME=$(IMAGE_REGISTRY)/$(RETINA_SHELL_IMAGE):$(TAG))
docker buildx imagetools create -t $(FULL_IMAGE_NAME) $(foreach platform,linux/amd64 linux/arm64, $(FULL_IMAGE_NAME)-$(subst /,-,$(platform)))
manifest-kubectl-retina-image:
$(eval FULL_IMAGE_NAME=$(IMAGE_REGISTRY)/$(KUBECTL_RETINA_IMAGE):$(TAG))
docker buildx imagetools create -t $(FULL_IMAGE_NAME) $(foreach platform,linux/amd64 linux/arm64, $(FULL_IMAGE_NAME)-$(subst /,-,$(platform)))
manifest:
echo "Building for $(COMPONENT)"
if [ "$(COMPONENT)" = "retina" ]; then \
$(MAKE) manifest-retina-image; \
elif [ "$(COMPONENT)" = "operator" ]; then \
$(MAKE) manifest-operator-image; \
elif [ "$(COMPONENT)" = "shell" ]; then \
$(MAKE) manifest-shell-image; \
elif [ "$(COMPONENT)" = "kubectl-retina" ]; then \
$(MAKE) manifest-kubectl-retina-image; \
fi
##@ Tests
# Make sure the layer has only one directory.
# the test DockerFile needs to build the scratch stage with all the output files
# and we will untar the archive and copy the files from scratch stage
test-image: ## build the retina container image for testing.
$(MAKE) container-docker \
PLATFORM=$(PLATFORM) \
DOCKERFILE=./test/image/Dockerfile \
REGISTRY=$(IMAGE_REGISTRY) \
IMAGE=$(RETINA_IMAGE) \
CONTEXT_DIR=$(REPO_ROOT) \
TAG=$(RETINA_PLATFORM_TAG)
COVER_PKG ?= .
test: $(ENVTEST) # Run unit tests.
go build -o test-summary ./test/utsummary/main.go
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use -p path)" go test -tags=unit,dashboard -skip=TestE2E* -coverprofile=coverage.out -v -json ./... | ./test-summary --progress --verbose
coverage: # Code coverage.
# go generate ./... && go test -tags=unit -coverprofile=coverage.out.tmp ./...
cat coverage.out | grep -v "_bpf.go\|_bpfel_x86.go\|_bpfel_arm64.go|_generated.go|mock_" | grep -v mock > coveragenew.out
go tool cover -html coveragenew.out -o coverage.html
go tool cover -func=coveragenew.out -o coverageexpanded.out
ls -al
rm coverage.out
mv coveragenew.out coverage.out
if [ "$(GIT_CURRENT_BRANCH_NAME)" != "main" ]; then \
python3 scripts/coverage/get_coverage.py; \
go tool cover -func=mainbranchcoverage/coverage.out -o maincoverageexpanded.out; \
python3 scripts/coverage/compare_cov.py; \
fi;
## Reusable targets for building multiplat container image manifests.
.PHONY: manifests
manifests:
cd crd && make manifests && make generate
# Fetch the latest tag from the GitHub
LATEST_TAG := $(shell curl -s https://api.github.com/repos/microsoft/retina/releases | jq -r '.[0].name')
HELM_IMAGE_TAG ?= $(LATEST_TAG)
# basic/node-level mode
helm-install: manifests
helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
--namespace kube-system \
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
--set image.tag=$(HELM_IMAGE_TAG) \
--set operator.tag=$(HELM_IMAGE_TAG) \
--set image.pullPolicy=Always \
--set logLevel=info \
--set os.windows=true \
--set operator.enabled=false \
--set enabledPlugin_linux="\[dropreason\,packetforward\,linuxutil\,dns\]"
helm-install-with-operator: manifests
helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
--namespace kube-system \
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
--set image.tag=$(HELM_IMAGE_TAG) \
--set operator.tag=$(HELM_IMAGE_TAG) \
--set image.pullPolicy=Always \
--set logLevel=info \
--set os.windows=true \
--set operator.enabled=true \
--set operator.enableRetinaEndpoint=true \
--set operator.repository=$(IMAGE_REGISTRY)/$(RETINA_OPERATOR_IMAGE) \
--skip-crds \
--set enabledPlugin_linux="\[dropreason\,packetforward\,linuxutil\,dns\,packetparser\]"
# advanced/pod-level mode with scale limitations, where metrics are aggregated by source and destination Pod
helm-install-advanced-remote-context: manifests
helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
--namespace kube-system \
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
--set image.tag=$(HELM_IMAGE_TAG) \
--set operator.tag=$(HELM_IMAGE_TAG) \
--set image.pullPolicy=Always \
--set logLevel=info \
--set os.windows=true \
--set operator.enabled=true \
--set operator.enableRetinaEndpoint=true \
--set operator.repository=$(IMAGE_REGISTRY)/$(RETINA_OPERATOR_IMAGE) \
--skip-crds \
--set enabledPlugin_linux="\[dropreason\,packetforward\,linuxutil\,dns\,packetparser\]" \
--set enablePodLevel=true \
--set remoteContext=true
# advanced/pod-level mode designed for scale, where metrics are aggregated by "local" Pod (source for outgoing traffic, destination for incoming traffic)
helm-install-advanced-local-context: manifests
helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
--namespace kube-system \
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
--set image.tag=$(HELM_IMAGE_TAG) \
--set operator.tag=$(HELM_IMAGE_TAG) \
--set image.pullPolicy=Always \
--set logLevel=info \
--set os.windows=true \
--set operator.enabled=true \
--set operator.enableRetinaEndpoint=true \
--set operator.repository=$(IMAGE_REGISTRY)/$(RETINA_OPERATOR_IMAGE) \
--skip-crds \
--set enabledPlugin_linux="\[dropreason\,packetforward\,linuxutil\,dns\,packetparser\]" \
--set enablePodLevel=true \
--set enableAnnotations=true
helm-install-hubble:
helm upgrade --install retina ./deploy/hubble/manifests/controller/helm/retina/ \
--namespace kube-system \
--set os.windows=true \
--set operator.enabled=true \
--set operator.repository=$(IMAGE_REGISTRY)/$(RETINA_OPERATOR_IMAGE) \
--set operator.tag=$(HELM_IMAGE_TAG) \
--set agent.enabled=true \
--set agent.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
--set agent.tag=$(HELM_IMAGE_TAG) \
--set agent.init.enabled=true \
--set agent.init.repository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
--set agent.init.tag=$(HELM_IMAGE_TAG) \
--set logLevel=info \
--set hubble.tls.enabled=$(ENABLE_TLS) \
--set hubble.relay.tls.server.enabled=$(ENABLE_TLS) \
--set hubble.tls.auto.enabled=$(ENABLE_TLS) \
--set hubble.tls.auto.method=cronJob \
--set hubble.tls.auto.certValidityDuration=1 \
--set hubble.tls.auto.schedule="*/10 * * * *"
helm-install-without-tls: clean-certs
$(MAKE) helm-install-hubble ENABLE_TLS=false
helm-uninstall:
helm uninstall retina -n kube-system
.PHONY: get-certs
get-certs:
mkdir -p $(CERT_DIR)
$(foreach kv,$(CERT_FILES),\
$(eval FILE=$(word 1,$(subst :, ,$(kv)))) \
$(eval CONFIG_KEY=$(word 2,$(subst :, ,$(kv)))) \
kubectl get secret $(TLS_SECRET_NAME) \
-n kube-system \
-o jsonpath="{.data['$(call escape_dot,$(FILE))']}" \
| base64 -d > $(CERT_DIR)/$(FILE);\
hubble config set $(CONFIG_KEY) $(CERT_DIR)/$(FILE);\
)
hubble config set tls true
hubble config set tls-server-name instance.hubble-relay.cilium.io
.PHONY: clean-certs
clean-certs:
rm -rf $(CERT_DIR)
$(foreach kv,$(CERT_FILES),\
$(eval CONFIG_KEY=$(word 2,$(subst :, ,$(kv)))) \
hubble config reset $(CONFIG_KEY);\
)
hubble config set tls false
hubble config reset tls-server-name
.PHONY: docs
docs:
echo $(PWD)
docker run -it -p 3000:3000 -v $(PWD):/retina -w /retina/ node:20-alpine sh ./site/start-dev.sh
.PHONY: docs-pod
docs-prod:
docker run -i -p 3000:3000 -v $(PWD):/retina -w /retina/ node:20-alpine npm install --prefix site && npm run build --prefix site
.PHONY: quick-build
quick-build:
$(MAKE) retina-image PLATFORM=linux/amd64 BUILDX_ACTION=--push
$(MAKE) retina-operator-image PLATFORM=linux/amd64 BUILDX_ACTION=--push
.PHONY: quick-deploy
quick-deploy:
$(MAKE) helm-install-advanced-local-context HELM_IMAGE_TAG=$(TAG)-linux-amd64
.PHONY: quick-deploy-hubble
quick-deploy-hubble:
$(MAKE) helm-uninstall || true
$(MAKE) helm-install-without-tls HELM_IMAGE_TAG=$(TAG)-linux-amd64
.PHONY: simplify-dashboards
simplify-dashboards:
cd deploy/testutils && go test ./... -tags=dashboard,simplifydashboard -v && cd $(REPO_ROOT)
run-perf-test:
go test -v ./test/e2e/retina_perf_test.go -timeout 2h -tags=perf -count=1 -args -image-tag=${TAG} -image-registry=${IMAGE_REGISTRY} -image-namespace=${IMAGE_NAMESPACE}