forked from cilium/tetragon
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMakefile
485 lines (409 loc) · 18.1 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
# Copyright Authors of Tetragon
# SPDX-License-Identifier: Apache-2.0
include Makefile.defs
GO ?= go
INSTALL = $(QUIET)install
BINDIR ?= /usr/local/bin
CONTAINER_ENGINE ?= docker
DOCKER_IMAGE_TAG ?= latest
LOCAL_CLANG ?= 0
LOCAL_CLANG_FORMAT ?= 0
FORMAT_FIND_FLAGS ?= -name '*.c' -o -name '*.h' -not -path 'bpf/include/vmlinux.h' -not -path 'bpf/include/api.h' -not -path 'bpf/libbpf/*'
NOOPT ?= 0
CLANG_IMAGE = quay.io/cilium/clang:b97f5b3d5c38da62fb009f21a53cd42aefd54a2f@sha256:e1c8ed0acd2e24ed05377f2861d8174af28e09bef3bbc79649c8eba165207df0
TESTER_PROGS_DIR = "contrib/tester-progs"
# Extra flags to pass to test binary
EXTRA_TESTFLAGS ?=
SUDO ?= sudo
GO_TEST_TIMEOUT ?= 20m
E2E_TEST_TIMEOUT ?= 20m
BUILD_PKG_DIR ?= $(shell pwd)/build/$(TARGET_ARCH)
VERSION ?= $(shell git describe --tags --always --exclude '*/*')
# Do a parallel build with multiple jobs, based on the number of CPUs online
# in this system: 'make -j8' on a 8-CPU system, etc.
#
# (To override it, run 'make JOBS=1' and similar.)
JOBS ?= $(shell nproc)
# Detect architecture, use TARGET_ARCH=amd64 or TARGET_ARCH=arm64
# or let uname detect the appropriate arch for native build
UNAME_M := $(shell uname -m)
ifeq ($(UNAME_M),x86_64)
TARGET_ARCH ?= amd64
endif
ifeq ($(UNAME_M),aarch64)
TARGET_ARCH ?= arm64
endif
ifeq ($(UNAME_M),arm64)
TARGET_ARCH ?= arm64
endif
TARGET_ARCH ?= amd64
# Set GOARCH to TARGET_ARCH only if it's not set so that we can still use both
# GOARCH and TARGET_ARCH (make sense for pure Go program like tetragon-operator)
GOARCH ?= $(TARGET_ARCH)
# Set BPF_TARGET_ARCH using TARGET_ARCH
ifeq ($(TARGET_ARCH),amd64)
BPF_TARGET_ARCH ?= x86
endif
ifeq ($(TARGET_ARCH),arm64)
BPF_TARGET_ARCH ?= arm64
endif
BPF_TARGET_ARCH ?= x86
__BPF_DEBUG_FLAGS :=
ifeq ($(DEBUG),1)
NOOPT=1
NOSTRIP=1
__BPF_DEBUG_FLAGS += DEBUG=1
endif
# GO_BUILD_LDFLAGS is initialized to empty use EXTRA_GO_BUILD_LDFLAGS to add link flags
GO_BUILD_LDFLAGS =
GO_BUILD_LDFLAGS += -X 'github.com/cilium/tetragon/pkg/version.Version=$(VERSION)'
ifeq ($(NOSTRIP),)
# Note: these options will not remove annotations needed for stack
# traces, so panic backtraces will still be readable.
# -w: Omit the DWARF symbol table.
# -s: Omit the symbol table and debug information.
GO_BUILD_LDFLAGS += -s -w
endif
ifdef EXTRA_GO_BUILD_LDFLAGS
GO_BUILD_LDFLAGS += $(EXTRA_GO_BUILD_LDFLAGS)
endif
# GO_BUILD_FLAGS is initialized to empty use EXTRA_GO_BUILD_FLAGS to add build flags
GO_BUILD_FLAGS =
GO_BUILD_FLAGS += -ldflags "$(GO_BUILD_LDFLAGS)"
ifeq ($(NOOPT),1)
GO_BUILD_GCFLAGS = "all=-N -l"
GO_BUILD_FLAGS += -gcflags=$(GO_BUILD_GCFLAGS)
endif
GO_BUILD_FLAGS += -mod=vendor
ifdef EXTRA_GO_BUILD_FLAGS
GO_BUILD_FLAGS += $(EXTRA_GO_BUILD_FLAGS)
endif
GO_BUILD = CGO_ENABLED=0 GOARCH=$(GOARCH) $(GO) build $(GO_BUILD_FLAGS)
GO_BUILD_HOOK = CGO_ENABLED=0 GOARCH=$(GOARCH) $(GO) -C contrib/tetragon-rthooks build $(GO_BUILD_FLAGS)
.PHONY: all
all: tetragon-bpf tetragon tetra generate-flags test-compile tester-progs protoc-gen-go-tetragon tetragon-bench
-include Makefile.cli
.PHONY: clean
clean: cli-clean tarball-clean
$(MAKE) -C ./bpf clean
rm -f go-tests/*.test ./ksyms ./tetragon ./tetragon-operator ./tetra ./alignchecker
rm -f contrib/sigkill-tester/sigkill-tester contrib/namespace-tester/test_ns contrib/capabilities-tester/test_caps
$(MAKE) -C $(TESTER_PROGS_DIR) clean
##@ Build and install
.PHONY: tetragon
tetragon: ## Compile the Tetragon agent.
$(GO_BUILD) ./cmd/tetragon/
.PHONY: tetragon-operator
tetragon-operator: ## Compile the Tetragon operator.
$(GO_BUILD) -o $@ ./operator
.PHONY: tetra
tetra: ## Compile the Tetragon gRPC client.
$(GO_BUILD) ./cmd/tetra/
.PHONY: tetragon-bpf
ifeq (1,$(LOCAL_CLANG))
tetragon-bpf: tetragon-bpf-local ## Compile bpf programs (use LOCAL_CLANG=0 to compile in a Docker build env).
else
tetragon-bpf: tetragon-bpf-container
endif
.PHONY: tetragon-bpf-local
tetragon-bpf-local:
$(MAKE) -C ./bpf BPF_TARGET_ARCH=$(BPF_TARGET_ARCH) -j$(JOBS) $(__BPF_DEBUG_FLAGS)
.PHONY: tetragon-bpf-container
tetragon-bpf-container:
$(CONTAINER_ENGINE) rm tetragon-clang || true
$(CONTAINER_ENGINE) run -v $(CURDIR):/tetragon:Z -u $$(id -u) -e BPF_TARGET_ARCH=$(BPF_TARGET_ARCH) --name tetragon-clang $(CLANG_IMAGE) make -C /tetragon/bpf -j$(JOBS) $(__BPF_DEBUG_FLAGS)
$(CONTAINER_ENGINE) rm tetragon-clang
.PHONY: tetragon-bench
tetragon-bench: ## Compile tetragon-bench tool.
$(GO_BUILD) ./cmd/tetragon-bench/
.PHONY: tetragon-oci-hook
tetragon-oci-hook:
$(GO_BUILD_HOOK) -o $@ ./cmd/oci-hook
.PHONY: tetragon-nri-hook
tetragon-nri-hook:
$(GO_BUILD_HOOK) -o $@ ./cmd/nri-hook
.PHONY: tetragon-oci-hook-setup
tetragon-oci-hook-setup:
$(GO_BUILD_HOOK) -o $@ ./cmd/setup
.PHONY: ksyms
ksyms:
$(GO) build ./cmd/ksyms/
.PHONY: compile-commands
compile-commands: ## Generate a compile_commands.json with bear for bpf programs.
$(MAKE) -C ./bpf clean
bear -- $(MAKE) -C ./
.PHONY: install
install: ## Install tetragon agent and tetra as standalone binaries.
groupadd -f hubble
$(INSTALL) -m 0755 -d $(DESTDIR)$(BINDIR)
$(INSTALL) -m 0755 ./tetragon $(DESTDIR)$(BINDIR)
##@ Container images
.PHONY: image
image: ## Build the Tetragon agent container image.
$(CONTAINER_ENGINE) build -t "cilium/tetragon:${DOCKER_IMAGE_TAG}" --target release --build-arg TETRAGON_VERSION=$(VERSION) --platform=linux/${TARGET_ARCH} .
@echo "Push like this when ready:"
@echo "${CONTAINER_ENGINE} push cilium/tetragon:$(DOCKER_IMAGE_TAG)"
.PHONY: image-operator
image-operator: ## Build the Tetragon operator container image.
$(CONTAINER_ENGINE) build -f Dockerfile.operator -t "cilium/tetragon-operator:${DOCKER_IMAGE_TAG}" --platform=linux/${TARGET_ARCH} .
@echo "Push like this when ready:"
@echo "${CONTAINER_ENGINE} push cilium/tetragon-operator:$(DOCKER_IMAGE_TAG)"
.PHONY: image-rthooks
image-rthooks:
$(CONTAINER_ENGINE) build -f Dockerfile.rthooks -t "cilium/tetragon-rthooks:${DOCKER_IMAGE_TAG}" --platform=linux/${TARGET_ARCH} .
@echo "Push like this when ready:"
@echo "${CONTAINER_ENGINE} push cilium/tetragon-rthooks:$(DOCKER_IMAGE_TAG)"
.PHONY: image-test
image-test: image-clang
$(CONTAINER_ENGINE) build -f Dockerfile.test -t "cilium/tetragon-test:${DOCKER_IMAGE_TAG}" .
@echo "Push like this when ready:"
@echo "${CONTAINER_ENGINE} push cilium/tetragon-test:$(DOCKER_IMAGE_TAG)"
.PHONY: image-clang
image-clang:
$(CONTAINER_ENGINE) build -f Dockerfile.clang --build-arg VERSION=1:15.0.7-0ubuntu0.22.04.2 -t "cilium/clang:${DOCKER_IMAGE_TAG}" .
@echo "Push like this when ready:"
@echo "${CONTAINER_ENGINE} push cilium/clang:$(DOCKER_IMAGE_TAG)"
.PHONY: images
images: image image-operator ## Convenience alias for image and image-operator.
##@ Packages
.PHONY: tarball
# Share same build environment as docker image
# Then it uses docker save to dump the layer and use it to
# contruct the tarball.
# Requires 'jq' to be installed
tarball: tarball-clean image ## Build Tetragon compressed tarball.
$(CONTAINER_ENGINE) build --build-arg TETRAGON_VERSION=$(VERSION) --build-arg TARGET_ARCH=$(TARGET_ARCH) -f Dockerfile.tarball -t "cilium/tetragon-tarball:${DOCKER_IMAGE_TAG}" --platform=linux/${TARGET_ARCH} .
$(QUIET)mkdir -p $(BUILD_PKG_DIR)
$(CONTAINER_ENGINE) save cilium/tetragon-tarball:$(DOCKER_IMAGE_TAG) -o $(BUILD_PKG_DIR)/tetragon-$(VERSION)-$(TARGET_ARCH).tmp.tar
$(QUIET)mkdir -p $(BUILD_PKG_DIR)/docker/
$(QUIET)mkdir -p $(BUILD_PKG_DIR)/linux-tarball/
tar xC $(BUILD_PKG_DIR)/docker/ -f $(BUILD_PKG_DIR)/tetragon-$(VERSION)-$(TARGET_ARCH).tmp.tar
sync $(BUILD_PKG_DIR)/docker/manifest.json
cat $(BUILD_PKG_DIR)/docker/manifest.json
cp "${BUILD_PKG_DIR}/docker/$$(jq -r '.[].Layers[0]' "${BUILD_PKG_DIR}/docker/manifest.json")" ${BUILD_PKG_DIR}/linux-tarball/tetragon-$(VERSION)-$(TARGET_ARCH).tar
@tar -tf ${BUILD_PKG_DIR}/linux-tarball/tetragon-$(VERSION)-$(TARGET_ARCH).tar | grep "/usr/local/bin/tetragon" - \
|| (echo "make: '$@' Error: could not find tetragon inside generated tarball"; exit 1)
$(QUIET)rm -fr $(BUILD_PKG_DIR)/tetragon-$(VERSION)-$(TARGET_ARCH).tmp.tar
gzip -6 $(BUILD_PKG_DIR)/linux-tarball/tetragon-$(VERSION)-$(TARGET_ARCH).tar
@echo "Tetragon tarball is ready: $(BUILD_PKG_DIR)/linux-tarball/tetragon-$(VERSION)-$(TARGET_ARCH).tar.gz"
.PHONY: tarball-release
tarball-release: tarball ## Build Tetragon release tarball.
mkdir -p release/
mv $(BUILD_PKG_DIR)/linux-tarball/tetragon-$(VERSION)-$(TARGET_ARCH).tar.gz release/
(cd release && sha256sum tetragon-$(VERSION)-$(TARGET_ARCH).tar.gz > tetragon-$(VERSION)-$(TARGET_ARCH).tar.gz.sha256sum)
.PHONY: tarball-clean
tarball-clean:
rm -fr $(BUILD_PKG_DIR)
##@ Test
# renovate: datasource=docker
GOLANGCILINT_IMAGE=docker.io/golangci/golangci-lint:v1.61.0@sha256:e47065d755ca0afeac9df866d1dabdc99f439653a43fe234e05f50d9c36b6b90
GOLANGCILINT_WANT_VERSION := $(subst @sha256,,$(patsubst v%,%,$(word 2,$(subst :, ,$(lastword $(subst /, ,$(GOLANGCILINT_IMAGE)))))))
GOLANGCILINT_VERSION = $(shell golangci-lint version 2>/dev/null)
.PHONY: check
ifneq (,$(findstring $(GOLANGCILINT_WANT_VERSION),$(GOLANGCILINT_VERSION)))
check: ## Run Go linters.
golangci-lint run
else
check:
$(CONTAINER_ENGINE) run --rm -v `pwd`:/app:Z -w /app --env GOTOOLCHAIN=auto $(GOLANGCILINT_IMAGE) golangci-lint run
endif
.PHONY: copy-golangci-lint
copy-golangci-lint:
mkdir -p bin/
$(eval xid=$(shell $(CONTAINER_ENGINE) create $(GOLANGCILINT_IMAGE)))
echo ${xid}
docker cp ${xid}:/usr/bin/golangci-lint bin/golangci-lint
docker rm ${xid}
.PHONY: test
test: tester-progs tetragon-bpf ## Run Go tests.
$(GO) test -exec "$(SUDO)" -p 1 -parallel 1 $(GOFLAGS) -gcflags=$(GO_BUILD_GCFLAGS) -timeout $(GO_TEST_TIMEOUT) -failfast -cover ./pkg/... ./cmd/... ./operator/... ${EXTRA_TESTFLAGS}
.PHONY: tester-progs
tester-progs: ## Compile helper programs for unit testing.
$(MAKE) -C $(TESTER_PROGS_DIR)
## bpf-test: ## run BPF tests.
## bpf-test BPFGOTESTFLAGS="-v": ## run BPF tests with verbose.
.PHONY: bpf-test
bpf-test:
$(MAKE) -C ./bpf run-test
.PHONY: verify
verify: tetragon-bpf ## Verify BPF programs.
sudo contrib/verify/verify.sh bpf/objs
.PHONY: alignchecker
alignchecker: ## Run alignchecker.
$(GO) test -c ./pkg/alignchecker -o alignchecker
.PHONY: bench
bench: ## Run Go benchmarks.
$(GO) test -exec "$(SUDO)" -p 1 -parallel 1 -run ^$$ $(GOFLAGS) -gcflags=$(GO_BUILD_GCFLAGS) -timeout $(GO_TEST_TIMEOUT) -failfast -cover ./pkg/... ./cmd/... ./operator/... -bench=. ${EXTRA_TESTFLAGS}
TEST_COMPILE ?= ./...
.PHONY: test-compile
test-compile: ## Compile unit tests.
mkdir -p go-tests
for pkg in $$($(GO) list "$(TEST_COMPILE)"); do \
localpkg=$$(echo $$pkg | sed -e 's:github.com/cilium/tetragon/::'); \
localtestfile=$$(echo $$localpkg | sed -e 's:/:.:g'); \
numtests=$$(ls -l ./$$localpkg/*_test.go 2> /dev/null | wc -l); \
if [ $$numtests -le 0 ]; then \
continue; \
fi; \
echo -c ./$$localpkg -o go-tests/$$localtestfile; \
done | GOMAXPROCS=1 xargs -P $(JOBS) -L 1 $(GO) test -gcflags=$(GO_BUILD_GCFLAGS)
.PHONY: fetch-testdata
fetch-testdata:
wget -nc -P testdata/btf 'https://github.com/cilium/tetragon-testdata/raw/main/btf/vmlinux-5.4.104+'
# Agent image to use for end-to-end tests
E2E_AGENT ?= "cilium/tetragon:$(DOCKER_IMAGE_TAG)"
# Operator image to use for end-to-end tests
E2E_OPERATOR ?= "cilium/tetragon-operator:$(DOCKER_IMAGE_TAG)"
# BTF file to use in the E2E test. Set to nothing to use system BTF.
E2E_BTF ?= ""
# Actual flags to use for BTF file in e2e test. Use E2E_BTF instead.
ifneq ($(E2E_BTF), "")
E2E_BTF_FLAGS ?= "-tetragon.btf=$(shell readlink -f $(E2E_BTF))"
else
E2E_BTF_FLAGS = ""
endif
# Build image and operator images locally before running test. Set to 0 to disable.
E2E_BUILD_IMAGES ?= 1
E2E_TESTS ?= ./tests/e2e/tests/...
# List e2e-test packages that can run in parallel
.PHONY: ls-e2e-test
ls-e2e-test:
@$(GO) list -f '{{if or .TestGoFiles .XTestGoFiles}}{{.ImportPath}}{{end}}' $(E2E_TESTS)
## e2e-test: ## run e2e tests
## e2e-test E2E_BUILD_IMAGES=0: ## run e2e tests without (re-)building images
## e2e-test E2E_TESTS=./tests/e2e/tests/skeleton: ## run a specific e2e test
.PHONY: e2e-test
ifneq ($(E2E_BUILD_IMAGES), 0)
e2e-test: image image-operator
else
e2e-test:
endif
$(GO) list $(E2E_TESTS) | xargs -Ipkg $(GO) test $(GOFLAGS) -gcflags=$(GO_BUILD_GCFLAGS) -timeout $(E2E_TEST_TIMEOUT) -failfast -cover pkg ${EXTRA_TESTFLAGS} -fail-fast -tetragon.helm.set tetragon.image.override="$(E2E_AGENT)" -tetragon.helm.set tetragonOperator.image.override="$(E2E_OPERATOR)" -tetragon.helm.url="" -tetragon.helm.chart="$(realpath ./install/kubernetes/tetragon)" $(E2E_BTF_FLAGS)
##@ Development
.PHONY: cscope
cscope: ## Generate cscope for bpf files.
find bpf -name "*.[chxsS]" -print > cscope.files
cscope -b -q -k
.PHONY: kind
kind: ## Create a kind cluster for Tetragon development.
./contrib/kind/bootstrap-kind-cluster.sh
KIND_BUILD_IMAGES ?= 1
VALUES ?=
## kind-install-tetragon: ## Install Tetragon in a kind cluster.
## kind-install-tetragon KIND_BUILD_IMAGES=0: ## Install Tetragon in a kind cluster without (re-)building images.
## kind-install-tetragon VALUES=values.yaml: ## Install Tetragon in a kind cluster using additional Helm values.
.PHONY: kind-install-tetragon
ifneq ($(KIND_BUILD_IMAGES), 0)
kind-install-tetragon: images
else
kind-install-tetragon:
endif
ifneq ($(VALUES),)
./contrib/kind/install-tetragon.sh -v $(VALUES)
else
./contrib/kind/install-tetragon.sh
endif
.PHONY: kind-setup
kind-setup: kind kind-install-tetragon ## Create a kind cluster and install local version of Tetragon.
.PHONY: kind-down
kind-down: ## Delete a kind cluster for Tetragon development.
./contrib/kind/delete-kind-cluster.sh
##@ Chores and generated files
.PHONY: codegen protogen
codegen: | protogen
protogen: protoc-gen-go-tetragon ## Generate code based on .proto files.
# Need to call vendor twice here, once before and once after codegen the reason
# being we need to grab changes first plus pull in whatever gets generated here.
$(MAKE) -C api vendor
$(MAKE) -C api
$(GO) mod tidy
$(GO) mod vendor
$(GO) mod verify
.PHONY: protoc-gen-go-tetragon
protoc-gen-go-tetragon:
$(GO_BUILD) -o bin/$@ ./tools/protoc-gen-go-tetragon/
.PHONY: generate crds
generate: | crds
crds: ## Generate kubebuilder files.
# Need to call vendor twice here, once before and once after generate, the reason
# being we need to grab changes first plus pull in whatever gets generated here.
$(MAKE) -C pkg/k8s vendor
$(MAKE) -C pkg/k8s
$(MAKE) -C pkg/k8s vendor
$(GO) mod tidy
$(GO) mod vendor
$(GO) mod verify
# YAML CRDs also live in the helm charts, so update them as well.
$(MAKE) -C install/kubernetes tetragon/crds-yaml
.PHONY: vendor
vendor: ## Tidy and vendor Go modules.
$(MAKE) -C api vendor
$(MAKE) -C pkg/k8s vendor
$(MAKE) -C contrib/tetragon-rthooks vendor
$(GO) mod tidy
$(GO) mod vendor
$(GO) mod verify
.PHONY: clang-format
ifeq (1,$(LOCAL_CLANG_FORMAT))
clang-format: ## Run code formatter on BPF code.
find bpf $(FORMAT_FIND_FLAGS) | xargs -n 1000 clang-format -i -style=file
else
clang-format:
$(CONTAINER_ENGINE) build -f Dockerfile.clang-format -t "cilium/clang-format:${DOCKER_IMAGE_TAG}" .
find bpf $(FORMAT_FIND_FLAGS) | xargs -n 1000 \
$(CONTAINER_ENGINE) run -v $(shell realpath .):/tetragon "cilium/clang-format:${DOCKER_IMAGE_TAG}" -i -style=file
endif
.PHONY: go-format
go-format: ## Run code formatter on Go code.
find . -name '*.go' -not -path '**/vendor/*' -not -path './pkg/k8s/vendor/*' -not -path './api/v1/tetragon/*' | xargs goimports -w
.PHONY: format
format: go-format clang-format ## Convenience alias for clang-format and go-format.
.PHONY: generate-flags
generate-flags: tetragon ## Generate Tetragon daemon flags for documentation.
echo "$$(./tetragon --generate-docs)" > docs/data/tetragon_flags.yaml
METRICS_DOCS_PATH := docs/content/en/docs/reference/metrics.md
.PHONY: tetragon-metrics-docs
tetragon-metrics-docs:
$(GO_BUILD) ./cmd/tetragon-metrics-docs/
.PHONY: metrics-docs
metrics-docs: tetragon-metrics-docs ## Generate metrics reference documentation page.
echo '---' > $(METRICS_DOCS_PATH)
echo 'title: "Metrics"' >> $(METRICS_DOCS_PATH)
echo 'description: >' >> $(METRICS_DOCS_PATH)
echo ' This reference is autogenerated from the Tetragon Prometheus metrics registry.' >> $(METRICS_DOCS_PATH)
echo 'weight: 4' >> $(METRICS_DOCS_PATH)
echo '---' >> $(METRICS_DOCS_PATH)
echo '{{< comment >}}' >> $(METRICS_DOCS_PATH)
echo 'This page is autogenerated via `make metrics-doc` please do not edit directly.' >> $(METRICS_DOCS_PATH)
echo '{{< /comment >}}' >> $(METRICS_DOCS_PATH)
$(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetragon-metrics-docs health >> $(METRICS_DOCS_PATH)
$(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetragon-metrics-docs resources >> $(METRICS_DOCS_PATH)
$(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetragon-metrics-docs events >> $(METRICS_DOCS_PATH)
.PHONY: lint-metrics-md
lint-metrics-md: metrics-docs ## Check if metrics documentation is up to date.
@if [ -n "$$(git status --porcelain $(METRICS_DOCS_PATH))" ]; then \
echo "metrics doc out of sync; please run 'make metrics-docs'" > /dev/stderr; \
false; \
fi
##@ Documentation
.PHONY: help
help: ## Display this help, based on https://www.thapaliya.com/en/writings/well-documented-makefiles/
$(call print_help_from_comments)
@printf "\n\033[1m%s\033[0m\n" Options
$(call print_help_option,TARGET_ARCH,target architecture to build for (e.g. amd64 or arm64))
$(call print_help_option,BPF_TARGET_ARCH,target architecture for BPF progs (set by TARGET_ARCH))
$(call print_help_option,GO_ARCH,target architecture for Go progs (set by TARGET_ARCH))
$(call print_help_option,DEBUG,enable NOOPT and NOSTRIP)
$(call print_help_option,NOOPT,disable optimization in Go build (set by DEBUG))
$(call print_help_option,NOSTRIP,disable binary stripping in Go build (set by DEBUG))
$(call print_help_option,LOCAL_CLANG,use the local clang install for BPF compilation)
$(call print_help_option,JOBS,number of jobs to run for BPF compilation (default to nproc))
$(call print_help_option,EXTRA_GO_BUILD_LDFLAGS,extra flags to pass to the Go linker)
$(call print_help_option,EXTRA_GO_BUILD_FLAGS,extra flags to pass to the Go builder)
$(call print_help_option,EXTRA_TESTFLAGS,extra flags to pass to the test binary)
.PHONY: docs
docs: ## Preview documentation website.
$(MAKE) -C docs
.PHONY: version
version: ## Print Tetragon version.
@echo $(VERSION)