-
Notifications
You must be signed in to change notification settings - Fork 21
/
Makefile
298 lines (231 loc) · 12.4 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
# Define main package name
PKG = github.com/furiko-io/furiko
# Define the stable version of the Kubernetes API we should build for.
# Changing this may produce slightly different generated client code.
KUBE_VERSION = "v0.23.0"
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.23
# GENERATE_GROUPS_GENERATORS defines which generators should be run using generate-groups.
GENERATE_GROUPS_GENERATORS ?= "client,lister,informer"
# GENERATE_GROUPS_FLAGS defines flags to be passed to generate-groups.sh.
# To produce more debug output, set GENERATE_GROUPS_FLAGS="--v=2"
GENERATE_GROUPS_FLAGS ?= --v=1
# 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
# Set license header files.
LICENSE_HEADER_GO ?= hack/boilerplate.go.txt
# Set the registry name.
IMAGE_REGISTRY ?= "ghcr.io"
# Set image name prefix. The actual image name and tag will be appended to this.
IMAGE_NAME_PREFIX ?= "$(IMAGE_REGISTRY)/furiko-io"
# Define the image tag to use, otherwise will default to latest.
# The latest tag always refers to the latest stable release.
IMAGE_TAG ?= "latest"
# Set the development registry where images will be pushed to.
# This will only be used for Makefile targets related to local development.
DEV_IMAGE_REGISTRY ?= "localhost:5000"
# Set the development image name prefix. The actual image name and tag will be appended to this.
# This will only be used for Makefile targets related to local development.
DEV_IMAGE_NAME_PREFIX ?= "$(DEV_IMAGE_REGISTRY)/furiko-io"
# Define the image tag to use for development images.
# This will only be used for Makefile targets related to local development.
DEV_IMAGE_TAG ?= "dev"
# Setting SHELL to bash allows bash commands to be executed by recipes.
# This is a requirement for 'setup-envtest.sh' in the test target.
# 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
##@ General
.PHONY: all
all: manifests generate fmt build yaml ## Generate code, build Go binaries and YAML manifests.
# 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%-30s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
##@ Development
.PHONY: generate
generate: generate-deepcopy generate-groups ## Generate Go code.
generate-deepcopy: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
$(CONTROLLER_GEN) object:headerFile="$(LICENSE_HEADER_GO)" paths="./..."
generate-groups: generate-groups.sh ## Generate code such as client, lister, informers.
# TODO(irvinlim): Current version of generate-groups.sh requires running in GOPATH to generate correctly.
$(GENERATE_GROUPS) $(GENERATE_GROUPS_GENERATORS) "$(PKG)/pkg/generated" "$(PKG)/apis" execution:v1alpha1 --go-header-file=$(LICENSE_HEADER_GO) $(GENERATE_GROUPS_FLAGS)
.PHONY: fmt
fmt: goimports-reviser ## Format code.
./hack/run-fmt.sh "$(PKG)"
.PHONY: lint
lint: lint-go lint-license ## Lint all code.
.PHONY: lint-license
lint-license: license-header-checker ## Check license headers.
$(LICENSE_HEADER_CHECKER) "$(LICENSE_HEADER_GO)" . go
.PHONY: lint-go
lint-go: golangci-lint ## Lint Go code.
$(GOLANGCI_LINT) run -v --timeout=5m
.PHONY: tidy
tidy: ## Run go mod tidy.
go mod tidy
.PHONY: test
test: ## Run tests with coverage. Outputs to combined.cov.
./hack/run-tests.sh
##@ Building
.PHONY: build
build: build-furiko-cli build-execution-controller build-execution-webhook ## Build all Go binaries.
.PHONY: build-furiko-cli
build-furiko-cli: ## Build furiko-cli.
go build -o build/furiko ./cmd/furiko-cli
.PHONY: build-execution-controller
build-execution-controller: ## Build execution-controller.
go build -o build/execution-controller ./cmd/execution-controller
.PHONY: build-execution-webhook
build-execution-webhook: ## Build execution-webhook.
go build -o build/execution-webhook ./cmd/execution-webhook
##@ Command-line Tools
.PHONY: install-furiko-cli
install-furiko-cli: ## Install furiko-cli to PATH.
go install ./cmd/furiko-cli
mv $(GOBIN)/furiko-cli $(GOBIN)/furiko
##@ YAML Configuration
## Location to write YAMLs to
YAML_DEST ?= $(shell pwd)/yamls
$(YAML_DEST): ## Ensure that the directory exists
mkdir -p $(YAML_DEST)
KUSTOMIZE_DEST ?= $(shell pwd)/dist/kustomize
$(KUSTOMIZE_DEST):
mkdir -p $(KUSTOMIZE_DEST)
.PHONY: yaml
yaml: yaml-execution ## Build kustomize configs. Outputs to dist folder.
.PHONY: yaml-execution
yaml-execution: manifests kustomize $(YAML_DEST) $(KUSTOMIZE_DEST) ## Build furiko-execution.yaml with Kustomize.
DEST_DIR=$(KUSTOMIZE_DEST) ./hack/generate-kustomization.sh "$(IMAGE_NAME_PREFIX)" "$(IMAGE_TAG)"
$(KUSTOMIZE) build $(KUSTOMIZE_DEST) -o $(YAML_DEST)/furiko-execution.yaml
.PHONY: manifests
manifests: tidy controller-gen yq ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects into the "config" directory.
# Generate CRDs
$(CONTROLLER_GEN) crd paths="./..." output:crd:artifacts:config=config/crd/bases
# Generate webhook manifests
$(CONTROLLER_GEN) webhook paths="./apis/execution/..." output:dir=config/common/webhook/execution
# Generate ClusterRole manifests
$(CONTROLLER_GEN) rbac:roleName=controller-role paths="./cmd/execution-controller/..." output:stdout > config/common/rbac/execution/controller/cluster_role.yaml
$(CONTROLLER_GEN) rbac:roleName=webhook-role paths="./cmd/execution-webhook/..." output:stdout > config/common/rbac/execution/webhook/cluster_role.yaml
# Add preserveUnknownFields manually with yq, see https://github.com/kubernetes-sigs/controller-tools/issues/476
ls -1 config/crd/bases/*.yaml | xargs -I {} $(YQ) e '.spec.preserveUnknownFields = false' -i {}
##@ Deployment
ifndef ignore-not-found
ignore-not-found = false
endif
.PHONY: install
install: manifests kustomize ## Installs the CRDs into the K8s cluster.
$(KUSTOMIZE) build config/crd | kubectl apply -f -
.PHONY: uninstall
uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster. 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 $(KUSTOMIZE_DEST) ## Deploys snapshot version of all components to the K8s cluster. Use the IMAGE_TAG environment variable to override the image to be deployed.
DEST_DIR=$(KUSTOMIZE_DEST) ./hack/generate-kustomization.sh "$(IMAGE_NAME_PREFIX)" "$(IMAGE_TAG)"
$(KUSTOMIZE) build $(KUSTOMIZE_DEST) | kubectl apply -f -
.PHONY: undeploy
undeploy: $(KUSTOMIZE_DEST) ## Undeploy controller from the K8s cluster. Call with ignore-not-found=true to ignore resource not found errors during deletion.
$(KUSTOMIZE) build $(KUSTOMIZE_DEST) | kubectl delete --ignore-not-found=$(ignore-not-found) -f -
##@ Local Development
.PHONY: dev
dev: dev-build dev-push dev-deploy ## Builds local Docker images of all components and deploys them to the K8s cluster. Use the DEV_IMAGE_TAG environment variable to override the image tag, and DEV_IMAGE_REGISTRY to control the target registry to push to.
.PHONY: dev-build
dev-build: ## Builds local Docker images of all components. Use the DEV_IMAGE_TAG environment variable to override the image tag that is built.
./hack/build-images.sh -p "$(IMAGE_NAME_PREFIX)" -t "$(DEV_IMAGE_TAG)"
.PHONY: dev-push
dev-push: ## Pushes all Docker images to the specified registry. Use the DEV_IMAGE_TAG environment variable to override the image tag, and DEV_IMAGE_REGISTRY to override the image registry to use (usually a local one).
./hack/push-images.sh -p "$(IMAGE_NAME_PREFIX)" -t "$(DEV_IMAGE_TAG)" -P "$(DEV_IMAGE_NAME_PREFIX)" -T "$(DEV_IMAGE_TAG)"
.PHONY: dev-deploy
dev-deploy: manifests kustomize $(KUSTOMIZE_DEST) ## Deploys a development version of all components to the K8s cluster. Use the DEV_IMAGE_TAG environment variable to override the image tag that is deployed.
DEST_DIR=$(KUSTOMIZE_DEST) ./hack/generate-kustomization.sh "$(DEV_IMAGE_NAME_PREFIX)" "$(DEV_IMAGE_TAG)"
$(KUSTOMIZE) build $(KUSTOMIZE_DEST) | kubectl apply -f -
##@ Release
.PHONY: release-nightly
release-nightly: ## Perform nightly release and upload Docker image.
./hack/release-nightly.sh
##@ Build Dependencies
## Location to install dependencies to
LOCALBIN ?= $(shell pwd)/bin
$(LOCALBIN): ## Ensure that the directory exists
mkdir -p $(LOCALBIN)
## Tool Versions
KUSTOMIZE_VERSION ?= v4.5.5
CONTROLLER_TOOLS_VERSION ?= v0.8.0
YQ_VERSION ?= v4.14.1
GOIMPORTS_REVISER_VERSION ?= 32c80678d5d73a50b6966f06b346de58b1d018f1
GOLANGCI_LINT_VERSION ?= v1.55.2
LICENSEHEADERCHECKER_VERSION ?= v1.3.0
GORELEASER_VERSION ?= v1.8.2
## Tool Binaries
KUSTOMIZE ?= $(LOCALBIN)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
ENVTEST ?= $(LOCALBIN)/setup-envtest
GOIMPORTS ?= $(LOCALBIN)/goimports
GOIMPORTS_REVISER ?= $(LOCALBIN)/goimports-reviser
YQ ?= $(LOCALBIN)/yq
GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint@$(GOLANGCI_LINT_VERSION)
LICENSE_HEADER_CHECKER ?= $(LOCALBIN)/license-header-checker
GORELEASER ?= $(LOCALBIN)/goreleaser
.PHONY: controller-gen
controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
$(CONTROLLER_GEN):
GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
.PHONY: kustomize
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
$(KUSTOMIZE):
@[ -f $(KUSTOMIZE) ] || curl -s $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN)
.PHONY: envtest
envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
$(ENVTEST):
GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
.PHONY: goimports
goimports: $(GOIMPORTS) ## Download goimports locally if necessary.
$(GOIMPORTS):
GOBIN=$(LOCALBIN) go install golang.org/x/tools/cmd/goimports@latest
.PHONY: goimports-reviser
goimports-reviser: $(GOIMPORTS_REVISER) ## Download goimports-reviser locally if necessary.
$(GOIMPORTS_REVISER):
GOBIN=$(LOCALBIN) go install github.com/incu6us/goimports-reviser/v3@$(GOIMPORTS_REVISER_VERSION)
.PHONY: yq
yq: $(YQ) ## Download yq locally if necessary.
$(YQ):
GOBIN=$(LOCALBIN) go install github.com/mikefarah/yq/v4@$(YQ_VERSION)
GOLANGCILINT_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh"
.PHONY: golangci-lint
golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
$(GOLANGCI_LINT):
# Downloads to ./bin/golangci-lint.
@[ -f $(GOLANGCI_LINT) ] || curl -sSfL $(GOLANGCILINT_INSTALL_SCRIPT) | sh -s $(GOLANGCI_LINT_VERSION)
# Move to versioned path.
mv ./bin/golangci-lint $(GOLANGCI_LINT)
.PHONY: goreleaser
goreleaser: $(GORELEASER) ## Download goreleaser locally if necessary.
$(GORELEASER):
GOBIN=$(LOCALBIN) go install github.com/goreleaser/goreleaser@$(GORELEASER_VERSION)
.PHONY: license-header-checker
license-header-checker: $(LICENSE_HEADER_CHECKER) ## Download license-header-checker locally if necessary.
$(LICENSE_HEADER_CHECKER):
GOBIN=$(LOCALBIN) go install github.com/lsm-dev/license-header-checker/cmd/license-header-checker@$(LICENSEHEADERCHECKER_VERSION)
# generate-groups.sh will download generate-groups.sh which is used for generating client libraries.
generate-groups.sh:
@{ \
set -e ;\
cd /tmp ;\
rm -rf code-generator ;\
git clone https://github.com/kubernetes/code-generator.git --branch $(KUBE_VERSION) ;\
}
GENERATE_GROUPS=/tmp/code-generator/generate-groups.sh