stackrox/config-controller/Makefile at master · stackrox/stackrox · GitHub

History

171 lines (136 loc) · 7.54 KB

Raw

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

# Image URL to use all building/pushing image targets

IMG ?= controller:latest

# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.

ENVTEST_K8S_VERSION = 1.30.0

# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)

ifeq (,$(shell go env GOBIN))

GOBIN=$(shell go env GOPATH)/bin

else

GOBIN=$(shell go env GOBIN)

endif

# CONTAINER_TOOL defines the container tool to be used for building images.

# Be aware that the target commands are only tested with Docker which is

# scaffolded by default. However, you might want to replace it to use other

# tools. (i.e. podman)

CONTAINER_TOOL ?= docker

# Setting SHELL to bash allows bash commands to be executed by recipes.

# Options are set to exit when a recipe line exits non-zero or a piped command fails.

SHELL = /usr/bin/env bash -o pipefail

.SHELLFLAGS = -ec

.PHONY: all

all: build

##@ 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 command 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%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

##@ Development

.PHONY: manifests

manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.

$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases

.PHONY: generate

generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.

$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."

.PHONY: fmt

fmt: ## Run go fmt against code.

go fmt ./...

.PHONY: vet

vet: ## Run go vet against code.

go vet ./...

.PHONY: test

test: manifests generate fmt vet envtest ## Run tests.

KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out

# Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.

.PHONY: test-e2e # Run the e2e tests against a Kind k8s instance that is spun up.

test-e2e:

go test ./test/e2e/ -v -ginkgo.v

GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint

GOLANGCI_LINT_VERSION ?= v1.54.2

golangci-lint:

@[ -f $(GOLANGCI_LINT) ] || { \

set -e ;\

curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) $(GOLANGCI_LINT_VERSION) ;\

}

.PHONY: lint

lint: golangci-lint ## Run golangci-lint linter

$(GOLANGCI_LINT) run

.PHONY: lint-fix

lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes

$(GOLANGCI_LINT) run --fix

##@ Build

.PHONY: build

build: manifests generate fmt vet ## Build manager binary.

../scripts/go-build-file.sh cmd/main.go bin/manager

.PHONY: run

run: manifests generate fmt vet ## Run a controller from your host.

go run ./cmd/main.go

# If you wish to build the manager image targeting other platforms you can use the --platform flag.

# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.

# More info: https://docs.docker.com/develop/develop-images/build_enhancements/

.PHONY: docker-build

docker-build: ## Build docker image with the manager.

$(CONTAINER_TOOL) build -t ${IMG} .

.PHONY: docker-push

docker-push: ## Push docker image with the manager.

$(CONTAINER_TOOL) push ${IMG}

# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple

# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:

# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/

# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/

# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)

# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.

PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le

.PHONY: docker-buildx

docker-buildx: ## Build and push docker image for the manager for cross-platform support

# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile

sed -e '1 s/$^FROM$/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross

- $(CONTAINER_TOOL) buildx create --name kubebuilder-builder

$(CONTAINER_TOOL) buildx use kubebuilder-builder

- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .

- $(CONTAINER_TOOL) buildx rm kubebuilder-builder

rm Dockerfile.cross

.PHONY: build-installer

build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.

mkdir -p dist

cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}

$(KUSTOMIZE) build config/default > dist/install.yaml

##@ Deployment

ifndef ignore-not-found

ignore-not-found = false

endif

.PHONY: install

install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.

$(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f -

.PHONY: uninstall

uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.

$(KUSTOMIZE) build config/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -

.PHONY: deploy

deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.

cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}

$(KUSTOMIZE) build config/default | $(KUBECTL) apply -f -

.PHONY: undeploy

undeploy: kustomize ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.

$(KUSTOMIZE) build config/default | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -

##@ Dependencies

PROJECT_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))

include $(PROJECT_DIR)/../make/gotools.mk

## Tool Binaries

KUBECTL ?= kubectl

$(call go-tool, KUSTOMIZE, sigs.k8s.io/kustomize/kustomize/v5, $(PROJECT_DIR)/../operator/tools/kustomize)

$(call go-tool, CONTROLLER_GEN, sigs.k8s.io/controller-tools/cmd/controller-gen, $(PROJECT_DIR)/../operator/tools/controller-gen)

$(call go-tool, ENVTEST, sigs.k8s.io/controller-runtime/tools/setup-envtest, $(PROJECT_DIR)/../operator/tools/envtest)

.PHONY: kustomize

kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.

.PHONY: controller-gen

controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.

.PHONY: envtest

envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.

stackrox/config-controller/Makefile at master · stackrox/stackrox · GitHub

Uh oh!

Expand file tree

Breadcrumbs

Makefile

Latest commit

History

Breadcrumbs

Makefile

File metadata and controls