Makefile

# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
#       http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
#

.PHONY: all dist check clean \
		lint format check-format vet docker-vet \
		build-linux docker docker-init \
		unit-test unit-test-race build-docker-test docker-func-test \
		build-metrics docker-metrics \
		metrics-unit-test docker-metrics-test

# VERSION is the source revision that executables and images are built from.
VERSION ?= $(shell git describe --tags --always --dirty || echo "unknown")
GOLANG_VERSION ?= $(shell cat .go-version)
# GOLANG_IMAGE is the building golang container image used.
GOLANG_IMAGE ?= public.ecr.aws/eks-distro-build-tooling/golang:$(GOLANG_VERSION)-gcc-al2
# BASE_IMAGE_CNI is the base layer image for the primary AWS VPC CNI plugin container
BASE_IMAGE_CNI ?= public.ecr.aws/eks-distro-build-tooling/eks-distro-minimal-base-iptables:latest.2
# BASE_IMAGE_CNI_INIT is the base layer image for the AWS VPC CNI init container
BASE_IMAGE_CNI_INIT ?= public.ecr.aws/eks-distro-build-tooling/eks-distro-minimal-base-glibc:latest.2
# BASE_IMAGE_CNI_METRICS is the base layer image for the AWS VPC CNI metrics publisher sidecar container
BASE_IMAGE_CNI_METRICS ?= public.ecr.aws/eks-distro-build-tooling/eks-distro-minimal-base-glibc:latest.2

# DESTDIR is where distribution output (container images) is placed.
DESTDIR = .

# IMAGE is the primary AWS VPC CNI plugin container image.
IMAGE = amazon/amazon-k8s-cni
IMAGE_NAME = $(IMAGE)$(IMAGE_ARCH_SUFFIX):$(VERSION)
IMAGE_DIST = $(DESTDIR)/$(subst /,_,$(IMAGE_NAME)).tar.gz
# INIT_IMAGE is the init container for AWS VPC CNI.
INIT_IMAGE = amazon/amazon-k8s-cni-init
INIT_IMAGE_NAME = $(INIT_IMAGE)$(IMAGE_ARCH_SUFFIX):$(VERSION)
INIT_IMAGE_DIST = $(DESTDIR)/$(subst /,_,$(INIT_IMAGE_NAME)).tar.gz
MAKEFILE_PATH = $(dir $(realpath -s $(firstword $(MAKEFILE_LIST))))
# METRICS_IMAGE is the CNI metrics publisher sidecar container image.
METRICS_IMAGE = amazon/cni-metrics-helper
METRICS_IMAGE_NAME = $(METRICS_IMAGE)$(IMAGE_ARCH_SUFFIX):$(VERSION)
METRICS_IMAGE_DIST = $(DESTDIR)/$(subst /,_,$(METRICS_IMAGE_NAME)).tar.gz
REPO_FULL_NAME=aws/amazon-vpc-cni-k8s
HELM_CHART_NAMES ?= "aws-vpc-cni" "cni-metrics-helper"
# TEST_IMAGE is the testing environment container image.
TEST_IMAGE = amazon-k8s-cni-test
TEST_IMAGE_NAME = $(TEST_IMAGE)$(IMAGE_ARCH_SUFFIX):$(VERSION)

UNAME_ARCH = $(shell uname -m)
ARCH = $(lastword $(subst :, ,$(filter $(UNAME_ARCH):%,x86_64:amd64 aarch64:arm64)))
# This is only applied to the arm64 container image by default. Override to
# provide an alternate suffix or to omit.
IMAGE_ARCH_SUFFIX = $(addprefix -,$(filter $(ARCH),arm64))

# Mandate usage of docker buildkit as platform arguments are available only with buildkit
# Refer to https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
# and https://docs.docker.com/develop/develop-images/build_enhancements/#to-enable-buildkit-builds
export DOCKER_BUILDKIT=1
GOARCH = $(TARGETARCH)

# For the requested build, these are the set of Go specific build environment variables.
export GOOS = linux
export CGO_ENABLED = 0
# NOTE: Provided for local toolchains that require explicit module feature flag.
export GO111MODULE = on
export GOPROXY = direct

export GOSUMDB = sum.golang.org
export GOTOOLCHAIN = go$(GOLANG_VERSION)

VENDOR_OVERRIDE_FLAG =
# aws-sdk-go override in case we need to build against a custom version
EC2_SDK_OVERRIDE ?= "n"

ifeq ($(EC2_SDK_OVERRIDE), "y")
VENDOR_OVERRIDE_FLAG = -mod=mod
endif

# LDFLAGS is the set of flags used when building golang executables.
LDFLAGS = -X pkg/version/info.Version=$(VERSION) -X pkg/awsutils/awssession.version=$(VERSION)
# ALLPKGS is the set of packages provided in source.
ALLPKGS = $(shell go list $(VENDOR_OVERRIDE_FLAG) ./... | grep -v cmd/packet-verifier)
# BINS is the set of built command executables.
BINS = aws-k8s-agent aws-cni grpc-health-probe cni-metrics-helper aws-vpc-cni aws-vpc-cni-init egress-cni
# CORE_PLUGIN_DIR is the directory containing upstream containernetworking plugins
CORE_PLUGIN_DIR = $(MAKEFILE_PATH)/core-plugins/

# DOCKER_ARGS is extra arguments passed during container image build.
DOCKER_ARGS ?=
# DOCKER_RUN_FLAGS is set the flags passed during runs of containers.
DOCKER_RUN_FLAGS = --rm -ti $(DOCKER_ARGS)
# DOCKER_BUILD_FLAGS_CNI is the set of flags passed during CNI container image
# builds based on the requested build.
DOCKER_BUILD_FLAGS_CNI = --build-arg golang_image="$(GOLANG_IMAGE)" \
					  --build-arg base_image="$(BASE_IMAGE_CNI)"	\
					  --network=host \
	  		          $(DOCKER_ARGS)
# DOCKER_BUILD_FLAGS_CNI_INIT is the set of flags passed during CNI init
# container image builds based on the requested build.
DOCKER_BUILD_FLAGS_CNI_INIT = --build-arg golang_image="$(GOLANG_IMAGE)" \
					  --build-arg base_image="$(BASE_IMAGE_CNI_INIT)"	\
					  --network=host \
	  		          $(DOCKER_ARGS)
# DOCKER_BUILD_FLAGS_CNI_METRICS is the set of flags passed during metrics
# container image builds based on the requested build.
DOCKER_BUILD_FLAGS_CNI_METRICS = --build-arg golang_image="$(GOLANG_IMAGE)" \
					  --build-arg base_image="$(BASE_IMAGE_CNI_METRICS)"	\
					  --network=host \
	  		          $(DOCKER_ARGS)

MULTI_PLATFORM_BUILD_TARGETS = 	linux/amd64,linux/arm64

# Default to building an executable using the host's Go toolchain.
.DEFAULT_GOAL = build-linux

##@ Building

# Build both CNI and metrics helper container images.
all: docker docker-init docker-metrics   ## Builds Init, CNI and metrics helper container images.

dist: all
	mkdir -p $(DESTDIR)
	docker save $(IMAGE_NAME) | gzip > $(IMAGE_DIST)
	docker save $(INIT_IMAGE_NAME) | gzip > $(INIT_IMAGE_DIST)
	docker save $(METRICS_IMAGE_NAME) | gzip > $(METRICS_IMAGE_DIST)

# Build the VPC CNI plugin agent using the host's Go toolchain.
BUILD_MODE ?= -buildmode=pie
build-linux: BUILD_FLAGS = $(BUILD_MODE) -ldflags '-s -w $(LDFLAGS)'
build-linux:    ## Build the VPC CNI plugin agent using the host's Go toolchain.
	go build $(VENDOR_OVERRIDE_FLAG) $(BUILD_FLAGS) -o aws-k8s-agent     ./cmd/aws-k8s-agent
	go build $(VENDOR_OVERRIDE_FLAG) $(BUILD_FLAGS) -o aws-cni           ./cmd/routed-eni-cni-plugin
	go build $(VENDOR_OVERRIDE_FLAG) $(BUILD_FLAGS) -o grpc-health-probe ./cmd/grpc-health-probe
	go build $(VENDOR_OVERRIDE_FLAG) $(BUILD_FLAGS) -o egress-cni     ./cmd/egress-cni-plugin

# Build VPC CNI init container entrypoint
build-aws-vpc-cni-init: BUILD_FLAGS = $(BUILD_MODE) -ldflags '-s -w $(LDFLAGS)'
build-aws-vpc-cni-init:    ## Build the VPC CNI init container using the host's Go toolchain.
	go build $(VENDOR_OVERRIDE_FLAG) $(BUILD_FLAGS) -o aws-vpc-cni-init     ./cmd/aws-vpc-cni-init

# Build VPC CNI container entrypoint
build-aws-vpc-cni: BUILD_FLAGS = $(BUILD_MODE) -ldflags '-s -w $(LDFLAGS)'
build-aws-vpc-cni:    ## Build the VPC CNI container using the host's Go toolchain.
	go build $(VENDOR_OVERRIDE_FLAG) $(BUILD_FLAGS) -o aws-vpc-cni     ./cmd/aws-vpc-cni

# Build VPC CNI plugin & agent container image.
docker:	setup-ec2-sdk-override     ## Build VPC CNI plugin & agent container image.
	docker build $(DOCKER_BUILD_FLAGS_CNI) \
		-f scripts/dockerfiles/Dockerfile.release \
		-t "$(IMAGE_NAME)" \
		.
	@echo "Built Docker image \"$(IMAGE_NAME)\""

docker-init:     ## Build VPC CNI plugin Init container image.
	docker build $(DOCKER_BUILD_FLAGS_CNI_INIT) \
		-f scripts/dockerfiles/Dockerfile.init \
		-t "$(INIT_IMAGE_NAME)" \
		.
	@echo "Built Docker image \"$(INIT_IMAGE_NAME)\""

# Run the built CNI container image to use in functional testing
docker-func-test: docker     ## Run the built CNI container image to use in functional testing
	docker run $(DOCKER_RUN_FLAGS) \
		"$(IMAGE_NAME)"

## Build multi-arch VPC CNI plugin container image.
multi-arch-cni-build:
	docker buildx build $(DOCKER_BUILD_FLAGS_CNI) \
		-f scripts/dockerfiles/Dockerfile.release \
		--platform "$(MULTI_PLATFORM_BUILD_TARGETS)"\
		--cache-from=type=gha \
		--cache-to=type=gha,mode=max \
		.

## Build and push multi-arch VPC CNI plugin container image.
multi-arch-cni-build-push:
	docker buildx build $(DOCKER_BUILD_FLAGS_CNI) \
		-f scripts/dockerfiles/Dockerfile.release \
		--platform "$(MULTI_PLATFORM_BUILD_TARGETS)"\
		-t "$(IMAGE_NAME)" \
		--push \
		.

## Build VPC CNI plugin Init container image.
multi-arch-cni-init-build:
	docker buildx build $(DOCKER_BUILD_FLAGS_CNI_INIT) \
		-f scripts/dockerfiles/Dockerfile.init \
		--platform "$(MULTI_PLATFORM_BUILD_TARGETS)"\
		--cache-from=type=gha \
		--cache-to=type=gha,mode=max \
		.

## Build and push VPC CNI plugin Init container image.
multi-arch-cni-init-build-push:
	docker buildx build $(DOCKER_BUILD_FLAGS_CNI_INIT) \
		-f scripts/dockerfiles/Dockerfile.init \
		--platform "$(MULTI_PLATFORM_BUILD_TARGETS)"\
		-t "$(INIT_IMAGE_NAME)" \
		--push \
		.

##@ Run Unit Tests
# Run unit tests
unit-test: export AWS_VPC_K8S_CNI_LOG_FILE=stdout
unit-test:    ## Run unit tests
	go test -v $(VENDOR_OVERRIDE_FLAG) -coverprofile=coverage.txt -covermode=atomic ./cmd/...
	go test -v $(VENDOR_OVERRIDE_FLAG) -coverprofile=coverage.txt -covermode=atomic ./pkg/...

# Run unit tests with race detection (can only be run natively)
unit-test-race: export AWS_VPC_K8S_CNI_LOG_FILE=stdout
unit-test-race: CGO_ENABLED=1
unit-test-race: GOARCH=
unit-test-race:     ## Run unit tests with race detection (can only be run natively)
	go test -v -cover -race -timeout 10s  ./cmd/...
	go test -v -cover -race -timeout 150s ./pkg/awsutils/...
	go test -v -cover -race -timeout 10s  ./pkg/k8sapi/...
	go test -v -cover -race -timeout 10s  ./pkg/networkutils/...
	go test -v -cover -race -timeout 10s  ./pkg/utils/...
	go test -v -cover -race -timeout 10s  ./pkg/eniconfig/...
	go test -v -cover -race -timeout 10s  ./pkg/ipamd/...

##@ Build and Run Unit Tests
# Build the unit test driver container image.
build-docker-test:     ## Build the unit test driver container image.
	docker build $(DOCKER_BUILD_FLAGS_CNI) \
		-f scripts/dockerfiles/Dockerfile.test \
		-t $(TEST_IMAGE_NAME) \
		.

# Run unit tests inside of the testing container image.
docker-unit-tests: build-docker-test     ## Run unit tests inside of the testing container image.
	docker run $(DOCKER_RUN_ARGS) \
		$(TEST_IMAGE_NAME) \
		make unit-test

##@ Build the Test Binaries files in /test
build-test-binaries:
	mkdir -p ${MAKEFILE_PATH}test/build
	find ${MAKEFILE_PATH}test/ -name '*suite_test.go' -type f  | xargs dirname  | xargs ginkgo build
	find ${MAKEFILE_PATH}test/ -name "*.test" -print0 | xargs -0 -I {} mv {} ${MAKEFILE_PATH}test/build

##@ Build metrics helper agent

# Build metrics helper agent.

build-metrics:     ## Build metrics helper agent.
	go build $(VENDOR_OVERRIDE_FLAG) -ldflags="-s -w" -o cni-metrics-helper ./cmd/cni-metrics-helper

# Build metrics helper agent Docker image.
docker-metrics:    ## Build metrics helper agent Docker image.
	docker build $(DOCKER_BUILD_FLAGS_CNI_METRICS) \
		-f scripts/dockerfiles/Dockerfile.metrics \
		-t "$(METRICS_IMAGE_NAME)" \
		.
	@echo "Built Docker image \"$(METRICS_IMAGE_NAME)\""

##@ Run metrics helper Unit Tests

# Run metrics helper unit test suite (must be run natively).
metrics-unit-test: CGO_ENABLED=1
metrics-unit-test: GOARCH=
metrics-unit-test:       ## Run metrics helper unit test suite (must be run natively).
	go test -v $(VENDOR_OVERRIDE_FLAG) -cover -race -timeout 10s \
		./cmd/cni-metrics-helper/metrics/...

# Run metrics helper unit test suite in a container.
docker-metrics-test:     ## Run metrics helper unit test suite in a container.
	docker run $(DOCKER_RUN_FLAGS) \
		-v $(CURDIR):/src --workdir=/src \
		-e GOARCH -e GOOS -e GO111MODULE \
		$(GOLANG_IMAGE) \
		make metrics-unit-test

# Fetch the CNI plugins
plugins: FETCH_VERSION=1.4.0
plugins: FETCH_URL=https://github.com/containernetworking/plugins/releases/download/v$(FETCH_VERSION)/cni-plugins-$(GOOS)-$(GOARCH)-v$(FETCH_VERSION).tgz
plugins: VISIT_URL=https://github.com/containernetworking/plugins/tree/v$(FETCH_VERSION)/plugins/
plugins:   ## Fetch the CNI plugins
	@echo "Fetching Container networking plugins v$(FETCH_VERSION) from upstream release"
	@echo
	@echo "Visit upstream project for plugin details:"
	@echo "$(VISIT_URL)"
	@echo
	mkdir -p $(CORE_PLUGIN_DIR)
	curl -s -L $(FETCH_URL) | tar xzvf - -C $(CORE_PLUGIN_DIR)

##@ Debug script

debug-script: FETCH_URL=https://raw.githubusercontent.com/awslabs/amazon-eks-ami/master/log-collector-script/linux/eks-log-collector.sh
debug-script: VISIT_URL=https://github.com/awslabs/amazon-eks-ami/tree/master/log-collector-script/linux
debug-script:    ## Fetching debug script from awslabs/amazon-eks-ami
	@echo "Fetching debug script from awslabs/amazon-eks-ami"
	@echo
	@echo "Visit upstream project for debug script details:"
	@echo "$(VISIT_URL)"
	@echo
	curl -L $(FETCH_URL) -o ./aws-cni-support.sh
	chmod +x ./aws-cni-support.sh

##@ Formatting

# Run all source code checks.
check: check-format lint vet   ## Run all source code checks.

# Run golint on source code.
#
# To install:
#
#   go install golang.org/x/lint/golint@latest
#
lint: LINT_FLAGS = -set_exit_status
lint:   ## Run golint on source code.
	@command -v golint >/dev/null || { echo "ERROR: golint not installed"; exit 1; }
	find . \
	  -type f -name '*.go' \
	  -not -name 'mock_*' -not -name '*mocks.go' -not -name "cni.go" -not -name "eniconfig.go" \
	  -print0 | sort -z | xargs -0 -L1 -- golint $(LINT_FLAGS) 2>/dev/null

helm-lint:
	@${MAKEFILE_PATH}test/helm/helm-lint.sh

# Run go vet on source code.
vet: setup-ec2-sdk-override ## Run go vet on source code.
	go vet $(VENDOR_OVERRIDE_FLAG) $(ALLPKGS)


docker-vet: build-docker-test   ## Run go vet inside of a container.
	docker run $(DOCKER_RUN_FLAGS) \
		$(TEST_IMAGE_NAME) make vet

format:       ## Format all Go source code files. (Note! integration_test.go has an upstream import dependency that doesn't match)
	@command -v goimports >/dev/null || { echo "ERROR: goimports not installed"; exit 1; }
	@exit $(shell find ./* \
	  -type f \
	  -not -name 'integration_test.go' \
	  -not -name 'mock_publisher.go' \
	  -not -name 'rpc.pb.go' \
	  -not -name 'vpc_ip_resource_limit.go' \
	  -name '*.go' \
	  -print0 | sort -z | xargs -0 -- goimports $(or $(FORMAT_FLAGS),-w) | wc -l | bc)

# Check formatting of source code files without modification.
check-format: FORMAT_FLAGS = -l
check-format: format

version:
	@echo ${VERSION}

##@ Generate ENI/IP limits

generate:
	PATH=$(CURDIR)/scripts:$(PATH) go generate -x ./...
	$(MAKE) format

# Generate limit file go code
# Generate eni-max-pods.txt file for EKS AMI
generate-limits: GOOS=
generate-limits:    ## Generate limit file go code
	go run $(VENDOR_OVERRIDE_FLAG) scripts/gen_vpc_ip_limits.go

ekscharts-sync:
	for HELM_CHART_NAME in $(HELM_CHART_NAMES) ; do \
		${MAKEFILE_PATH}/scripts/sync-to-eks-charts.sh -b $$HELM_CHART_NAME -r ${REPO_FULL_NAME} ; \
	done

ekscharts-sync-release:
	for HELM_CHART_NAME in $(HELM_CHART_NAMES) ; do \
		${MAKEFILE_PATH}/scripts/sync-to-eks-charts.sh -b $$HELM_CHART_NAME -r ${REPO_FULL_NAME} -n -y ; \
	done

generate-cni-yaml:
	${MAKEFILE_PATH}/scripts/generate-cni-yaml.sh

config-folder-sync:
	${MAKEFILE_PATH}/scripts/sync-to-config-folder.sh

setup-ec2-sdk-override:
	@if [ "$(EC2_SDK_OVERRIDE)" = "y" ] ; then \
	    ./scripts/ec2_model_override/setup.sh ; \
	fi

cleanup-ec2-sdk-override:
	@if [ "$(EC2_SDK_OVERRIDE)" = "y" ] ; then \
	    ./scripts/ec2_model_override/cleanup.sh ; \
	fi

##@ Cleanup

# Clean temporary files and build artifacts from the project.
clean:    ## Clean temporary files and build artifacts from the project.
	@rm -f -- $(BINS)
	@rm -rf -- $(CORE_PLUGIN_DIR)
	@rm -f -- coverage.txt
	@rm -rf -- $(MAKEFILE_PATH)test/build

##@ Helpers

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)