makefile consistency

.github/workflows/push_image.yml

@@ -5,11 +5,10 @@ on:
 
 env:
   REGISTRY_USER: netobserv+github_ci
-  REGISTRY_PASSWORD: ${{ secrets.QUAY_SECRET }}
   REGISTRY: quay.io/netobserv
   IMAGE: netobserv-ebpf-agent
-  IMAGE_ORG: netobserv
-  TAGS: main
+  ORG: netobserv
+  VERSION: main
 
 jobs:
   push-image:
@@ -31,11 +30,9 @@ jobs:
         uses: docker/login-action@v2
         with:
           username: ${{ env.REGISTRY_USER }}
-          password: ${{ env.REGISTRY_PASSWORD }}
+          password: ${{ secrets.QUAY_SECRET }}
           registry: quay.io
-      - name: get short sha
-        run: echo "short_sha=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
-      - name: build and push images
-        run: make ci-images-push
+      - name: build and push manifest with images
+        run: IMAGE_ORG=${{ env.ORG }} VERSION=${{ env.VERSION }} make ci
       - name: print image url
         run: echo "Image pushed to ${{ steps.push-to-quay.outputs.registry-paths }}"

.github/workflows/push_image_pr.yml

@@ -7,7 +7,8 @@ env:
   REGISTRY_USER: netobserv+github_ci
   REGISTRY: quay.io/netobserv
   IMAGE: netobserv-ebpf-agent
-  IMAGE_ORG: netobserv
+  ORG: netobserv
+  VERSION: temp
 
 jobs:
   push-pr-image:
@@ -37,7 +38,9 @@ jobs:
       - name: get short sha
         run: echo "short_sha=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
       - name: build and push images
-        run: SW_VERSION=temp make ci-images-push
+        run: IMAGE_ORG=${{ env.ORG }} IMAGE=${{ env.REGISTRY }}/${{ env.IMAGE }}:${{ env.short_sha }} make images
+      - name: build and push manifest
+        run: IMAGE_ORG=${{ env.ORG }} VERSION=${{ env.VERSION }} make ci-manifest
       - uses: actions/github-script@v6
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}

.github/workflows/release.yml

@@ -44,6 +44,6 @@ jobs:
           password: ${{ env.REGISTRY_PASSWORD }}
           registry: quay.io
       - name: build and push images
-        run: SW_VERSION="${{ env.tag }}" make image-push
+        run: VERSION="${{ env.tag }}" make images
       - name: print image url
         run: echo "Image pushed to ${{ steps.push-to-quay.outputs.registry-paths }}"

.mk/shortcuts.mk

@@ -0,0 +1,31 @@
+##@ shortcuts helpers
+
+.PHONY: build
+build: prereqs fmt lint test vendors compile ## Test and Build ebpf agent
+
+.PHONY: build-image
+build-image: image-build ## Build MULTIARCH_TARGETS images
+
+.PHONY: push-image
+push-image: image-push ## Push MULTIARCH_TARGETS images
+
+.PHONY: build-manifest
+build-manifest: manifest-build ## Build MULTIARCH_TARGETS manifest
+
+.PHONY: push-manifest
+push-manifest: manifest-push ## Push MULTIARCH_TARGETS manifest
+
+.PHONY: images
+images: image-build image-push manifest-build manifest-push ## Build and push MULTIARCH_TARGETS images and related manifest
+
+.PHONY: build-ci-manifest
+build-ci-manifest: ci-manifest-build ## Build CI manifest
+
+.PHONY: push-ci-manifest
+push-ci-manifest: ci-manifest-push ## Push CI manifest
+
+.PHONY: ci-manifest
+ci-manifest: ci-manifest-build ci-manifest-push ## Build and push CI manifest
+
+.PHONY: ci
+ci: images ci-manifest ## Build and push CI images and manifest

Dockerfile

@@ -6,7 +6,7 @@ FROM --platform=$BUILDPLATFORM docker.io/library/golang:1.19 as builder
 
 ARG TARGETPLATFORM
 ARG TARGETARCH=amd64
-ARG SW_VERSION="unknown"
+ARG VERSION="unknown"
 
 WORKDIR /opt/app-root
 
@@ -19,6 +19,7 @@ COPY vendor/ vendor/
 COPY go.mod go.mod
 COPY go.sum go.sum
 COPY Makefile Makefile
+COPY .mk/ .mk/
 
 # Build
 RUN GOARCH=$TARGETARCH make compile

Makefile

@@ -1,94 +1,103 @@
-# SW_VERSION defines the project version for the bundle.
+# 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 SW_VERSION as arg of the bundle target (e.g make bundle SW_VERSION=0.0.2)
-# - use environment variables to overwrite this value (e.g export SW_VERSION=0.0.2)
-SW_VERSION ?= main
-BUILD_VERSION := $(shell git describe --long HEAD)
+# - 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 ?= main
 BUILD_DATE := $(shell date +%Y-%m-%d\ %H:%M)
+TAG_COMMIT := $(shell git rev-list --abbrev-commit --tags --max-count=1)
+TAG := $(shell git describe --abbrev=0 --tags ${TAG_COMMIT} 2>/dev/null || true)
 BUILD_SHA := $(shell git rev-parse --short HEAD)
-
+BUILD_VERSION := $(TAG:v%=%)
+ifneq ($(COMMIT), $(TAG_COMMIT))
+	BUILD_VERSION := $(BUILD_VERSION)-$(BUILD_SHA)
+endif
+ifneq ($(shell git status --porcelain),)
+	BUILD_VERSION := $(BUILD_VERSION)-dirty
+endif
+
+# Go architecture and targets images to build
 GOARCH ?= amd64
-MULTIARCH_TARGETS := amd64 arm64 ppc64le
+MULTIARCH_TARGETS ?= amd64 arm64 ppc64le
 
 # In CI, to be replaced by `netobserv`
 IMAGE_ORG ?= $(USER)
 
 # IMAGE_TAG_BASE defines the namespace and part of the image name for remote images.
-# This variable is used to construct full image tags for bundle and catalog images.
 IMAGE_TAG_BASE ?= quay.io/$(IMAGE_ORG)/netobserv-ebpf-agent
 
 # Image URL to use all building/pushing image targets
-IMG ?= $(IMAGE_TAG_BASE):$(SW_VERSION)
-IMG_SHA = $(IMAGE_TAG_BASE):$(BUILD_SHA)
+IMAGE ?= $(IMAGE_TAG_BASE):$(VERSION)
+IMAGE_SHA = $(IMAGE_TAG_BASE):$(BUILD_SHA)
 
-LOCAL_GENERATOR_IMAGE ?= ebpf-generator:latest
+# Image building tool (docker / podman)
+OCI_BIN_PATH := $(shell which podman  || which docker)
+OCI_BIN ?= $(shell v='$(OCI_BIN_PATH)'; echo "$${v##*/}")
 
+LOCAL_GENERATOR_IMAGE ?= ebpf-generator:latest
 CILIUM_EBPF_VERSION := v0.10.0
 GOLANGCI_LINT_VERSION = v1.50.1
-
 CLANG ?= clang
 CFLAGS := -O2 -g -Wall -Werror $(CFLAGS)
 GOOS ?= linux
 PROTOC_ARTIFACTS := pkg/pbflow
-
 # regular expressions for excluded file patterns
 EXCLUDE_COVERAGE_FILES="(/cmd/)|(bpf_bpfe)|(/examples/)|(/pkg/pbflow/)"
 
-# Image building tool (docker / podman)
-OCI_BIN_PATH := $(shell which podman  || which docker)
-OCI_BIN ?= $(shell v='$(OCI_BIN_PATH)'; echo "$${v##*/}")
+.DEFAULT_GOAL := help
 
 # build a single arch target provided as argument
 define build_target
-	@echo 'building image for arch $(1)';
-	#The --load option is ignored by podman but required for docker
-	DOCKER_BUILDKIT=1 $(OCI_BIN) buildx build --load --build-arg TARGETPLATFORM=linux/$(1) --build-arg TARGETARCH=$(1) --build-arg BUILDPLATFORM=linux/amd64 -t ${IMG}-$(1) -f Dockerfile .;
-endef
-
-# build multiarch manifest containing the MULTIARCH_TARGETS
-define build_manifest
-	@echo 'building manifest $(SW_VERSION) to $(IMAGE_TAG_BASE)';
-	DOCKER_BUILDKIT=1 $(OCI_BIN) manifest create ${IMG} $(foreach target,$(MULTIARCH_TARGETS),--amend ${IMG}-$(target));
+	echo 'building image for arch $(1)'; \
+	DOCKER_BUILDKIT=1 $(OCI_BIN) buildx build --load --build-arg TARGETPLATFORM=linux/$(1) --build-arg TARGETARCH=$(1) --build-arg BUILDPLATFORM=linux/amd64 -t ${IMAGE}-$(1) -f Dockerfile .;
 endef
 
 # push a single arch target image
 define push_target
-	@echo 'pushing image ${IMG}-$(1)';
-	DOCKER_BUILDKIT=1 $(OCI_BIN) push ${IMG}-$(1);
+	echo 'pushing image ${IMAGE}-$(1)'; \
+	DOCKER_BUILDKIT=1 $(OCI_BIN) push ${IMAGE}-$(1);
 endef
 
-# push multiarch manifest
-define push_manifest
-	@echo 'publish manifest $(SW_VERSION) to $(IMAGE_TAG_BASE)';
-	ifeq (${OCI_BIN} , docker)
-		DOCKER_BUILDKIT=1 $(OCI_BIN) manifest push ${IMG};
-	else
-		DOCKER_BUILDKIT=1 $(OCI_BIN) manifest push ${IMG} docker://${IMG};
-	endif
-endef
+##@ 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%-20s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
 .PHONY: vendors
-vendors:
+vendors: ## Check go vendors
 	@echo "### Checking vendors"
 	go mod tidy && go mod vendor
 
 .PHONY: prereqs
-prereqs:
-	@echo "### Check if prerequisites are met, and installing missing dependencies"
+prereqs: ## Check if prerequisites are met, and install missing dependencies
+	@echo "### Checking if prerequisites are met, and installing missing dependencies"
 	test -f $(shell go env GOPATH)/bin/golangci-lint || GOFLAGS="" go install github.com/golangci/golangci-lint/cmd/golangci-lint@${GOLANGCI_LINT_VERSION}
 	test -f $(shell go env GOPATH)/bin/bpf2go || go install github.com/cilium/ebpf/cmd/bpf2go@${CILIUM_EBPF_VERSION}
 	test -f $(shell go env GOPATH)/bin/protoc-gen-go || go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
 	test -f $(shell go env GOPATH)/bin/protoc-gen-go-grpc || go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
 	test -f $(shell go env GOPATH)/bin/kind || go install sigs.k8s.io/kind@latest
 
+##@ Develop
+
 .PHONY: fmt
 fmt: ## Run go fmt against code.
 	@echo "### Formatting code"
 	go fmt ./...
 
 .PHONY: lint
-lint: prereqs
+lint: prereqs ## Lint the code
 	@echo "### Linting code"
 	golangci-lint run ./... --timeout=3m
 
@@ -99,28 +108,25 @@ lint: prereqs
 .PHONY: generate
 generate: export BPF_CLANG := $(CLANG)
 generate: export BPF_CFLAGS := $(CFLAGS)
-generate: prereqs
+generate: prereqs ## Generate artifacts of the code repo (pkg/ebpf and pkg/proto packages)
 	@echo "### Generating BPF Go bindings"
 	go generate ./pkg/...
 	@echo "### Generating gRPC and Protocol Buffers code"
 	protoc --go_out=pkg --go-grpc_out=pkg proto/flow.proto
 
 .PHONY: docker-generate
-docker-generate:
+docker-generate: ## Create the container that generates the eBPF binaries
 	@echo "### Creating the container that generates the eBPF binaries"
 	$(OCI_BIN) build . -f scripts/generators.Dockerfile -t $(LOCAL_GENERATOR_IMAGE)
 	$(OCI_BIN) run --rm -v $(shell pwd):/src $(LOCAL_GENERATOR_IMAGE)
 
-.PHONY: build
-build: prereqs fmt lint test vendors compile
-
 .PHONY: compile
-compile:
+compile: ## Compile ebpf agent project
 	@echo "### Compiling project"
-	GOARCH=${GOARCH} GOOS=$(GOOS) go build -ldflags "-X main.version=${SW_VERSION} -X 'main.buildVersion=${BUILD_VERSION}' -X 'main.buildDate=${BUILD_DATE}'" -mod vendor -a -o bin/netobserv-ebpf-agent cmd/netobserv-ebpf-agent.go
+	GOARCH=${GOARCH} GOOS=$(GOOS) go build -ldflags "-X main.version=${VERSION} -X 'main.buildVersion=${BUILD_VERSION}' -X 'main.buildDate=${BUILD_DATE}'" -mod vendor -a -o bin/netobserv-ebpf-agent cmd/netobserv-ebpf-agent.go
 
 .PHONY: test
-test:
+test: ## Test code using go test
 	@echo "### Testing code"
 	GOOS=$(GOOS) go test -mod vendor -a ./... -coverpkg=./... -coverprofile cover.all.out
 
@@ -129,46 +135,67 @@ cov-exclude-generated:
 	grep -vE "(/cmd/)|(bpf_bpfe)|(/examples/)|(/pkg/pbflow/)" cover.all.out > cover.out
 
 .PHONY: coverage-report
-coverage-report: cov-exclude-generated
+coverage-report: cov-exclude-generated ## Generate coverage report
 	@echo "### Generating coverage report"
 	go tool cover --func=./cover.out
 
 .PHONY: coverage-report-html
-coverage-report-html: cov-exclude-generated
+coverage-report-html: cov-exclude-generated ## Generate HTML coverage report
 	@echo "### Generating HTML coverage report"
 	go tool cover --html=./cover.out
 
-.PHONY: image-build
-image-build:
-	trap 'exit' INT
-	$(foreach target,$(MULTIARCH_TARGETS),$(call build_target,$(target)))
-	$(call build_manifest)
-
-.PHONY: image-push
-image-push: image-build
-	trap 'exit' INT
-	$(foreach target,$(MULTIARCH_TARGETS),$(call push_target,$(target)))
-	$(call push_manifest)
-
-.PHONY: ci-images-build
-ci-images-build: image-build
-	$(OCI_BIN) build --build-arg IMAGE_TAG_BASE=$(IMG) -t $(IMG_SHA) -f scripts/shortlived.Dockerfile .
-
-.PHONY: ci-images-push
-ci-images-push:
-	DOCKER_BUILDKIT=1 $(OCI_BIN) push $(IMG_SHA)
-	ifeq ($(SW_VERSION), main)
-		# Also tag "latest" only for branch "main"
-		DOCKER_BUILDKIT=1 $(OCI_BIN) push ${IMG}
-		DOCKER_BUILDKIT=1 $(OCI_BIN) push $(IMAGE_TAG_BASE):latest
-	endif
-
 .PHONY: tests-e2e
 .ONESHELL:
-tests-e2e: prereqs
+tests-e2e: prereqs ## Run e2e tests
 	go clean -testcache
 	# making the local agent image available to kind in two ways, so it will work in different
 	# environments: (1) as image tagged in the local repository (2) as image archive.
 	$(OCI_BIN) build . -t localhost/ebpf-agent:test
 	$(OCI_BIN) save -o ebpf-agent.tar localhost/ebpf-agent:test
 	GOOS=$(GOOS) go test -p 1 -timeout 30m -v -mod vendor -tags e2e ./e2e/...
+
+##@ Images
+
+# note: to build and push custom image tag use: IMAGE_ORG=myuser VERSION=dev s
+.PHONY: image-build
+image-build: ## Build MULTIARCH_TARGETS images
+	trap 'exit' INT; \
+	$(foreach target,$(MULTIARCH_TARGETS),$(call build_target,$(target)))
+
+.PHONY: image-push
+image-push: ## Push MULTIARCH_TARGETS images
+	trap 'exit' INT; \
+	$(foreach target,$(MULTIARCH_TARGETS),$(call push_target,$(target)))
+
+.PHONY: manifest-build
+manifest-build: ## Build MULTIARCH_TARGETS manifest
+	@echo 'building manifest $(IMAGE)'
+	DOCKER_BUILDKIT=1 $(OCI_BIN) manifest create ${IMAGE} $(foreach target,$(MULTIARCH_TARGETS),--amend ${IMAGE}-$(target));
+
+.PHONY: manifest-push
+manifest-push: ## Push MULTIARCH_TARGETS manifest
+	@echo 'publish manifest $(IMAGE)'
+ifeq (${OCI_BIN}, docker)
+	DOCKER_BUILDKIT=1 $(OCI_BIN) manifest push ${IMAGE};
+else
+	DOCKER_BUILDKIT=1 $(OCI_BIN) manifest push ${IMAGE} docker://${IMAGE};
+endif
+
+.PHONY: ci-manifest-build
+ci-manifest-build: manifest-build ## Build CI manifest
+	$(OCI_BIN) build --build-arg BASE_IMAGE=$(IMAGE) -t $(IMAGE_SHA) -f scripts/shortlived.Dockerfile .
+ifeq ($(VERSION), main)
+# Also tag "latest" only for branch "main"
+	$(OCI_BIN) build -t $(IMAGE) -t $(IMAGE_TAG_BASE):latest -f scripts/shortlived.Dockerfile .
+endif
+
+.PHONY: ci-manifest-push
+ci-manifest-push: ## Push CI manifest
+	$(OCI_BIN) push $(IMAGE_SHA)
+ifeq ($(VERSION), main)
+# Also tag "latest" only for branch "main"
+	$(OCI_BIN) push ${IMAGE}
+	$(OCI_BIN) push $(IMAGE_TAG_BASE):latest
+endif
+
+include .mk/shortcuts.mk