mirror of
https://github.com/kyverno/kyverno.git
synced 2024-12-14 11:57:48 +00:00
289 lines
11 KiB
Makefile
289 lines
11 KiB
Makefile
.DEFAULT_GOAL: build
|
|
|
|
##################################
|
|
# DEFAULTS
|
|
##################################
|
|
GIT_VERSION := $(shell git describe --match "v[0-9]*")
|
|
GIT_BRANCH := $(shell git branch | grep \* | cut -d ' ' -f2)
|
|
GIT_HASH := $(GIT_BRANCH)/$(shell git log -1 --pretty=format:"%H")
|
|
TIMESTAMP := $(shell date '+%Y-%m-%d_%I:%M:%S%p')
|
|
CONTROLLER_GEN=controller-gen
|
|
CONTROLLER_GEN_REQ_VERSION := v0.4.0
|
|
VERSION ?= $(shell git describe --match "v[0-9]*")
|
|
|
|
REGISTRY?=ghcr.io
|
|
REPO=$(REGISTRY)/kyverno
|
|
IMAGE_TAG?=$(GIT_VERSION)
|
|
GOOS ?= $(shell go env GOOS)
|
|
ifeq ($(GOOS), darwin)
|
|
SED=gsed
|
|
else
|
|
SED=sed
|
|
endif
|
|
PACKAGE ?=github.com/kyverno/kyverno
|
|
LD_FLAGS="-s -w -X $(PACKAGE)/pkg/version.BuildVersion=$(GIT_VERSION) -X $(PACKAGE)/pkg/version.BuildHash=$(GIT_HASH) -X $(PACKAGE)/pkg/version.BuildTime=$(TIMESTAMP)"
|
|
|
|
# Used to disable inclusion of cloud provider code in k8schain
|
|
# https://github.com/google/go-containerregistry/tree/main/pkg/authn/k8schain
|
|
TAGS=disable_aws,disable_azure,disable_gcp
|
|
|
|
##################################
|
|
# KYVERNO
|
|
##################################
|
|
|
|
.PHONY: unused-package-check
|
|
unused-package-check:
|
|
@echo "------------------"
|
|
@echo "--> Check unused packages for the all kyverno components"
|
|
@echo "------------------"
|
|
@tidy=$$(go mod tidy); \
|
|
if [ -n "$${tidy}" ]; then \
|
|
echo "go mod tidy checking failed!"; echo "$${tidy}"; echo; \
|
|
fi
|
|
|
|
KYVERNO_PATH:= cmd/kyverno
|
|
build: kyverno
|
|
PWD := $(CURDIR)
|
|
|
|
##################################
|
|
# INIT CONTAINER
|
|
##################################
|
|
INITC_PATH := cmd/initContainer
|
|
INITC_IMAGE := kyvernopre
|
|
initContainer: fmt vet
|
|
GOOS=$(GOOS) go build -o $(PWD)/$(INITC_PATH)/kyvernopre -ldflags=$(LD_FLAGS) $(PWD)/$(INITC_PATH)/main.go
|
|
|
|
.PHONY: docker-build-initContainer docker-push-initContainer
|
|
|
|
docker-publish-initContainer: docker-build-initContainer docker-push-initContainer
|
|
|
|
docker-build-initContainer:
|
|
@docker buildx build --file $(PWD)/$(INITC_PATH)/Dockerfile --progress plane --platform linux/arm64,linux/amd64 --tag $(REPO)/$(INITC_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS)
|
|
|
|
docker-build-initContainer-amd64:
|
|
@docker build -f $(PWD)/$(INITC_PATH)/Dockerfile -t $(REPO)/$(INITC_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS) --build-arg TARGETPLATFORM="linux/amd64"
|
|
|
|
docker-push-initContainer:
|
|
@docker buildx build --file $(PWD)/$(INITC_PATH)/Dockerfile --progress plane --push --platform linux/arm64,linux/amd64 --tag $(REPO)/$(INITC_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS)
|
|
@docker buildx build --file $(PWD)/$(INITC_PATH)/Dockerfile --progress plane --push --platform linux/arm64,linux/amd64 --tag $(REPO)/$(INITC_IMAGE):latest . --build-arg LD_FLAGS=$(LD_FLAGS)
|
|
|
|
docker-build-initContainer-local:
|
|
CGO_ENABLED=0 GOOS=linux go build -o $(PWD)/$(INITC_PATH)/kyvernopre -tags $(TAGS) -ldflags=$(LD_FLAGS) $(PWD)/$(INITC_PATH)/main.go
|
|
@docker build -f $(PWD)/$(INITC_PATH)/localDockerfile -t $(REPO)/$(INITC_IMAGE):$(IMAGE_TAG) $(PWD)/$(INITC_PATH)
|
|
@docker tag $(REPO)/$(INITC_IMAGE):$(IMAGE_TAG) $(REPO)/$(INITC_IMAGE):latest
|
|
|
|
##################################
|
|
# KYVERNO CONTAINER
|
|
##################################
|
|
.PHONY: docker-build-kyverno docker-push-kyverno
|
|
KYVERNO_PATH := cmd/kyverno
|
|
KYVERNO_IMAGE := kyverno
|
|
|
|
local:
|
|
go build -tags $(TAGS) -ldflags=$(LD_FLAGS) $(PWD)/$(KYVERNO_PATH)
|
|
go build -tags $(TAGS) -ldflags=$(LD_FLAGS) $(PWD)/$(CLI_PATH)
|
|
|
|
kyverno: fmt vet
|
|
GOOS=$(GOOS) go build -o $(PWD)/$(KYVERNO_PATH)/kyverno -tags $(TAGS) -ldflags=$(LD_FLAGS) $(PWD)/$(KYVERNO_PATH)/main.go
|
|
|
|
docker-publish-kyverno: docker-build-kyverno docker-push-kyverno
|
|
|
|
docker-build-kyverno:
|
|
@docker buildx build --file $(PWD)/$(KYVERNO_PATH)/Dockerfile --progress plane --platform linux/arm64,linux/amd64 --tag $(REPO)/$(KYVERNO_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS) --build-arg TAGS=$(TAGS)
|
|
|
|
docker-build-kyverno-local:
|
|
CGO_ENABLED=0 GOOS=linux go build -o $(PWD)/$(KYVERNO_PATH)/kyverno -tags $(TAGS) -ldflags=$(LD_FLAGS) $(PWD)/$(KYVERNO_PATH)/main.go
|
|
@docker build -f $(PWD)/$(KYVERNO_PATH)/localDockerfile -t $(REPO)/$(KYVERNO_IMAGE):$(IMAGE_TAG) $(PWD)/$(KYVERNO_PATH)
|
|
@docker tag $(REPO)/$(KYVERNO_IMAGE):$(IMAGE_TAG) $(REPO)/$(KYVERNO_IMAGE):latest
|
|
|
|
docker-build-kyverno-amd64:
|
|
@docker build -f $(PWD)/$(KYVERNO_PATH)/Dockerfile -t $(REPO)/$(KYVERNO_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS) --build-arg TARGETPLATFORM="linux/amd64" --build-arg TAGS=$(TAGS)
|
|
|
|
docker-push-kyverno:
|
|
@docker buildx build --file $(PWD)/$(KYVERNO_PATH)/Dockerfile --progress plane --push --platform linux/arm64,linux/amd64 --tag $(REPO)/$(KYVERNO_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS) --build-arg TAGS=$(TAGS)
|
|
@docker buildx build --file $(PWD)/$(KYVERNO_PATH)/Dockerfile --progress plane --push --platform linux/arm64,linux/amd64 --tag $(REPO)/$(KYVERNO_IMAGE):latest . --build-arg LD_FLAGS=$(LD_FLAGS) --build-arg TAGS=$(TAGS)
|
|
|
|
##################################
|
|
|
|
# Generate Docs for types.go
|
|
##################################
|
|
|
|
generate-api-docs:
|
|
go run github.com/ahmetb/gen-crd-api-reference-docs -api-dir ./pkg/api -config documentation/api/config.json -template-dir documentation/api/template -out-file documentation/index.html
|
|
|
|
|
|
##################################
|
|
# CLI
|
|
##################################
|
|
.PHONY: docker-build-cli docker-push-cli
|
|
CLI_PATH := cmd/cli/kubectl-kyverno
|
|
KYVERNO_CLI_IMAGE := kyverno-cli
|
|
|
|
cli:
|
|
GOOS=$(GOOS) go build -o $(PWD)/$(CLI_PATH)/kyverno -ldflags=$(LD_FLAGS) $(PWD)/$(CLI_PATH)/main.go
|
|
|
|
docker-publish-cli: docker-build-cli docker-push-cli
|
|
|
|
docker-build-cli:
|
|
@docker buildx build --file $(PWD)/$(CLI_PATH)/Dockerfile --progress plane --platform linux/arm64,linux/amd64 --tag $(REPO)/$(KYVERNO_CLI_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS)
|
|
|
|
docker-build-cli-amd64:
|
|
@docker build -f $(PWD)/$(CLI_PATH)/Dockerfile -t $(REPO)/$(KYVERNO_CLI_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS) --build-arg TARGETPLATFORM="linux/amd64"
|
|
|
|
docker-push-cli:
|
|
@docker buildx build --file $(PWD)/$(CLI_PATH)/Dockerfile --progress plane --push --platform linux/arm64,linux/amd64 --tag $(REPO)/$(KYVERNO_CLI_IMAGE):$(IMAGE_TAG) . --build-arg LD_FLAGS=$(LD_FLAGS)
|
|
@docker buildx build --file $(PWD)/$(CLI_PATH)/Dockerfile --progress plane --push --platform linux/arm64,linux/amd64 --tag $(REPO)/$(KYVERNO_CLI_IMAGE):latest . --build-arg LD_FLAGS=$(LD_FLAGS)
|
|
|
|
##################################
|
|
docker-publish-all: docker-publish-initContainer docker-publish-kyverno docker-publish-cli
|
|
|
|
docker-build-all: docker-build-initContainer docker-build-kyverno docker-build-cli
|
|
|
|
docker-build-all-amd64: docker-build-initContainer-amd64 docker-build-kyverno-amd64 docker-build-cli-amd64
|
|
|
|
##################################
|
|
# Create e2e Infrastruture
|
|
##################################
|
|
|
|
create-e2e-infrastruture:
|
|
chmod a+x $(PWD)/scripts/create-e2e-infrastruture.sh
|
|
$(PWD)/scripts/create-e2e-infrastruture.sh
|
|
|
|
|
|
##################################
|
|
|
|
##################################
|
|
# Testing & Code-Coverage
|
|
##################################
|
|
|
|
## variables
|
|
BIN_DIR := $(GOPATH)/bin
|
|
GO_ACC := $(BIN_DIR)/go-acc@latest
|
|
CODE_COVERAGE_FILE:= coverage
|
|
CODE_COVERAGE_FILE_TXT := $(CODE_COVERAGE_FILE).txt
|
|
CODE_COVERAGE_FILE_HTML := $(CODE_COVERAGE_FILE).html
|
|
|
|
## targets
|
|
$(GO_ACC):
|
|
@echo " installing testing tools"
|
|
go install -v github.com/ory/go-acc@latest
|
|
$(eval export PATH=$(GO_ACC):$(PATH))
|
|
# go test provides code coverage per packages only.
|
|
# go-acc merges the result for pks so that it be used by
|
|
# go tool cover for reporting
|
|
|
|
test: test-clean test-unit test-e2e test-cmd
|
|
|
|
test-clean:
|
|
@echo " cleaning test cache"
|
|
go clean -testcache ./...
|
|
|
|
|
|
# go get downloads and installs the binary
|
|
# we temporarily add the GO_ACC to the path
|
|
test-unit: $(GO_ACC)
|
|
@echo " running unit tests"
|
|
go-acc ./... -o $(CODE_COVERAGE_FILE_TXT)
|
|
|
|
code-cov-report: $(CODE_COVERAGE_FILE_TXT)
|
|
# transform to html format
|
|
@echo " generating code coverage report"
|
|
go tool cover -html=coverage.txt
|
|
if [ -a $(CODE_COVERAGE_FILE_HTML) ]; then open $(CODE_COVERAGE_FILE_HTML); fi;
|
|
|
|
# Test E2E
|
|
test-e2e:
|
|
$(eval export E2E="ok")
|
|
go test ./test/e2e/metrics -v
|
|
go test ./test/e2e/mutate -v
|
|
go test ./test/e2e/generate -v
|
|
$(eval export E2E="")
|
|
|
|
test-e2e-local:
|
|
$(eval export E2E="ok")
|
|
kubectl apply -f https://raw.githubusercontent.com/kyverno/kyverno/main/definitions/github/rbac.yaml
|
|
kubectl port-forward -n kyverno service/kyverno-svc-metrics 8000:8000 &
|
|
go test ./test/e2e/metrics -v
|
|
go test ./test/e2e/mutate -v
|
|
go test ./test/e2e/generate -v
|
|
kill $!
|
|
$(eval export E2E="")
|
|
|
|
#Test TestCmd Policy
|
|
test-cmd: cli
|
|
$(PWD)/$(CLI_PATH)/kyverno test https://github.com/kyverno/policies/main
|
|
$(PWD)/$(CLI_PATH)/kyverno test ./test/cli/test-mutate
|
|
$(PWD)/$(CLI_PATH)/kyverno test ./test/cli/test
|
|
$(PWD)/$(CLI_PATH)/kyverno test ./test/cli/test-fail/missing-policy && exit 1 || exit 0
|
|
$(PWD)/$(CLI_PATH)/kyverno test ./test/cli/test-fail/missing-rule && exit 1 || exit 0
|
|
$(PWD)/$(CLI_PATH)/kyverno test ./test/cli/test-fail/missing-resource && exit 1 || exit 0
|
|
|
|
# godownloader create downloading script for kyverno-cli
|
|
godownloader:
|
|
godownloader .goreleaser.yml --repo kyverno/kyverno -o ./scripts/install-cli.sh --source="raw"
|
|
|
|
# kustomize-crd will create install.yaml
|
|
kustomize-crd:
|
|
# Create CRD for helm deployment Helm
|
|
kustomize build ./config/release | kustomize cfg grep kind=CustomResourceDefinition | $(SED) -e "1i{{- if .Values.installCRDs }}" -e '$$a{{- end }}' > ./charts/kyverno/templates/crds.yaml
|
|
# Generate install.yaml that have all resources for kyverno
|
|
kustomize build ./definitions > ./definitions/install.yaml
|
|
# Generate install_debug.yaml that for developer testing
|
|
kustomize build ./definitions/debug > ./definitions/install_debug.yaml
|
|
|
|
# guidance https://github.com/kyverno/kyverno/wiki/Generate-a-Release
|
|
release:
|
|
kustomize build ./definitions > ./definitions/install.yaml
|
|
kustomize build ./definitions/release > ./definitions/release/install.yaml
|
|
|
|
release-notes:
|
|
@bash -c 'while IFS= read -r line ; do if [[ "$$line" == "## "* && "$$line" != "## $(VERSION)" ]]; then break ; fi; echo "$$line"; done < "CHANGELOG.md"' \
|
|
true
|
|
|
|
kyverno-crd: controller-gen
|
|
$(CONTROLLER_GEN) crd paths=./pkg/api/kyverno/... crd:crdVersions=v1 output:dir=./definitions/crds
|
|
|
|
report-crd: controller-gen
|
|
$(CONTROLLER_GEN) crd paths=./pkg/api/policyreport/... crd:crdVersions=v1 output:dir=./definitions/crds
|
|
|
|
# install the right version of controller-gen
|
|
install-controller-gen:
|
|
@{ \
|
|
set -e ;\
|
|
CONTROLLER_GEN_TMP_DIR=$$(mktemp -d) ;\
|
|
cd $$CONTROLLER_GEN_TMP_DIR ;\
|
|
go mod init tmp ;\
|
|
go get sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_GEN_REQ_VERSION) ;\
|
|
rm -rf $$CONTROLLER_GEN_TMP_DIR ;\
|
|
}
|
|
CONTROLLER_GEN=$(GOPATH)/bin/controller-gen
|
|
|
|
# setup controller-gen with the right version, if necessary
|
|
controller-gen:
|
|
ifeq (, $(shell which controller-gen))
|
|
@{ \
|
|
echo "controller-gen not found!";\
|
|
echo "installing controller-gen $(CONTROLLER_GEN_REQ_VERSION)...";\
|
|
make install-controller-gen;\
|
|
}
|
|
else ifneq (Version: $(CONTROLLER_GEN_REQ_VERSION), $(shell controller-gen --version))
|
|
@{ \
|
|
echo "controller-gen $(shell controller-gen --version) found!";\
|
|
echo "required controller-gen $(CONTROLLER_GEN_REQ_VERSION)";\
|
|
echo "installing controller-gen $(CONTROLLER_GEN_REQ_VERSION)...";\
|
|
make install-controller-gen;\
|
|
}
|
|
else
|
|
CONTROLLER_GEN=$(shell which controller-gen)
|
|
endif
|
|
|
|
# Bootstrap auto-generable code associated with deepcopy
|
|
deepcopy-autogen: controller-gen
|
|
$(CONTROLLER_GEN) object:headerFile="scripts/boilerplate.go.txt" paths="./..."
|
|
|
|
# Run go fmt against code
|
|
fmt:
|
|
gofmt -s -w .
|
|
|
|
vet:
|
|
go vet ./...
|