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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338# ------------------------------------------------------------------------------
# Configuration - Make
# ------------------------------------------------------------------------------
# Some sensible Make defaults: https://tech.davis-hansson.com/p/make/
SHELL := bash
.SHELLFLAGS := -eu -o pipefail -c
# ------------------------------------------------------------------------------
# Configuration - Repository
# ------------------------------------------------------------------------------
MAKEFLAGS += --no-print-directory
REPO_URL ?= github.com/kong/kubernetes-configuration
GO_MOD_MAJOR_VERSION ?= $(subst $(REPO_URL)/,,$(shell go list -m))
REPO_INFO ?= $(shell git config --get remote.origin.url)
VERSION ?= $(shell head -1 VERSION)
ifndef COMMIT
COMMIT := $(shell git rev-parse --short HEAD)
endif
# ------------------------------------------------------------------------------
# Configuration - Golang
# ------------------------------------------------------------------------------
export GO111MODULE=on
# 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
# ------------------------------------------------------------------------------
# Configuration - Tooling
# ------------------------------------------------------------------------------
PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
TOOLS_VERSIONS_FILE = .tools_versions.yaml
MISE := $(shell which mise)
.PHONY: mise
mise:
@mise -V >/dev/null || (echo "mise - https://github.com/jdx/mise - not found. Please install it." && exit 1)
.PHONY: tools
tools: controller-gen kustomize client-gen
export MISE_DATA_DIR = $(PROJECT_DIR)/bin/
# NOTE: mise targets use -q to silence the output.
# Users can use MISE_VERBOSE=1 MISE_DEBUG=1 to get more verbose output.
.PHONY: mise-plugin-install
mise-plugin-install: mise
@$(MISE) plugin install --yes -q $(DEP) $(URL)
.PHONY: mise-install
mise-install: mise
@$(MISE) install -q $(DEP_VER)
CONTROLLER_GEN_VERSION = $(shell yq -ojson -r '.controller-tools' < $(TOOLS_VERSIONS_FILE))
CONTROLLER_GEN = $(PROJECT_DIR)/bin/installs/kube-controller-tools/$(CONTROLLER_GEN_VERSION)/bin/controller-gen
.PHONY: controller-gen
controller-gen: mise ## Download controller-gen locally if necessary.
@$(MAKE) mise-plugin-install DEP=kube-controller-tools
@$(MAKE) mise-install DEP_VER=kube-controller-tools@$(CONTROLLER_GEN_VERSION)
KUSTOMIZE_VERSION = $(shell yq -ojson -r '.kustomize' < $(TOOLS_VERSIONS_FILE))
KUSTOMIZE = $(PROJECT_DIR)/bin/installs/kustomize/$(KUSTOMIZE_VERSION)/bin/kustomize
.PHONY: kustomize
kustomize: mise ## Download kustomize locally if necessary.
@$(MAKE) mise-plugin-install DEP=kustomize
@$(MAKE) mise-install DEP_VER=kustomize@$(KUSTOMIZE_VERSION)
CLIENT_GEN_VERSION = $(shell yq -ojson -r '.kube-code-generator' < $(TOOLS_VERSIONS_FILE))
CLIENT_GEN = $(PROJECT_DIR)/bin/installs/kube-code-generator/$(CLIENT_GEN_VERSION)/bin/client-gen
.PHONY: client-gen
client-gen: mise ## Download client-gen locally if necessary.
@$(MAKE) mise-plugin-install DEP=kube-code-generator
@$(MAKE) mise-install DEP_VER=kube-code-generator@$(CLIENT_GEN_VERSION)
YQ_VERSION = $(shell yq -ojson -r '.yq' < $(TOOLS_VERSIONS_FILE))
YQ = $(PROJECT_DIR)/bin/installs/yq/$(YQ_VERSION)/bin/yq
.PHONY: yq
yq: mise # Download yq locally if necessary.
@$(MAKE) mise-plugin-install DEP=yq
@$(MAKE) mise-install DEP_VER=yq@$(YQ_VERSION)
CRD_REF_DOCS_VERSION = $(shell yq -ojson -r '.crd-ref-docs' < $(TOOLS_VERSIONS_FILE))
CRD_REF_DOCS = $(PROJECT_DIR)/bin/crd-ref-docs
.PHONY: crd-ref-docs
crd-ref-docs: ## Download crd-ref-docs locally if necessary.
GOBIN=$(PROJECT_DIR)/bin go install -v \
github.com/elastic/crd-ref-docs@v$(CRD_REF_DOCS_VERSION)
GOTESTSUM_VERSION = $(shell $(YQ) -r '.gotestsum' < $(TOOLS_VERSIONS_FILE))
GOTESTSUM = $(PROJECT_DIR)/bin/installs/gotestsum/$(GOTESTSUM_VERSION)/bin/gotestsum
.PHONY: gotestsum
gotestsum: mise yq ## Download gotestsum locally if necessary.
@$(MISE) plugin install --yes -q gotestsum https://github.com/pmalek/mise-gotestsum.git
@$(MISE) install -q gotestsum@$(GOTESTSUM_VERSION)
GOLANGCI_LINT_VERSION = $(shell $(YQ) -r '.golangci-lint' < $(TOOLS_VERSIONS_FILE))
GOLANGCI_LINT = $(PROJECT_DIR)/bin/installs/golangci-lint/$(GOLANGCI_LINT_VERSION)/bin/golangci-lint
.PHONY: download.golangci-lint
download.golangci-lint: mise yq ## Download golangci-lint locally if necessary.
@$(MISE) plugin install --yes -q golangci-lint
@$(MISE) install -q golangci-lint@$(GOLANGCI_LINT_VERSION)
ACTIONLINT_VERSION = $(shell $(YQ) -r '.actionlint' < $(TOOLS_VERSIONS_FILE))
ACTIONLINT = $(PROJECT_DIR)/bin/installs/actionlint/$(ACTIONLINT_VERSION)/bin/actionlint
.PHONY: download.actionlint
download.actionlint: mise yq ## Download actionlint locally if necessary.
@$(MISE) plugin install --yes -q actionlint
@$(MISE) install -q actionlint@$(ACTIONLINT_VERSION)
SHELLCHECK_VERSION = $(shell $(YQ) -r '.shellcheck' < $(TOOLS_VERSIONS_FILE))
SHELLCHECK = $(PROJECT_DIR)/bin/installs/shellcheck/$(SHELLCHECK_VERSION)/bin/shellcheck
.PHONY: download.shellcheck
download.shellcheck: mise yq ## Download shellcheck locally if necessary.
@$(MISE) plugin install --yes -q shellcheck
@$(MISE) install -q shellcheck@$(SHELLCHECK_VERSION)
MARKDOWNLINT_VERSION = $(shell $(YQ) -r '.markdownlint-cli2' < $(TOOLS_VERSIONS_FILE))
MARKDOWNLINT = $(PROJECT_DIR)/bin/installs/markdownlint-cli2/$(MARKDOWNLINT_VERSION)/bin/markdownlint-cli2
.PHONY: download.markdownlint-cli2
download.markdownlint-cli2: mise yq ## Download markdownlint-cli2 locally if necessary.
@$(MISE) plugin install --yes -q markdownlint-cli2
@$(MISE) install -q markdownlint-cli2@$(MARKDOWNLINT_VERSION)
# ------------------------------------------------------------------------------
# Verify steps
# ------------------------------------------------------------------------------
.PHONY: verify.diff
verify.diff:
@$(PROJECT_DIR)/scripts/verify-diff.sh $(PROJECT_DIR)
.PHONY: verify.generators
verify.generators: generate verify.diff
# ------------------------------------------------------------------------------
# Build - Generators
# ------------------------------------------------------------------------------
CRD_GEN_PATHS ?= ./api/configuration/...;./api/konnect/...;./api/gateway-operator/...;./api/common/...
CRD_INCUBATOR_GEN_PATHS ?= ./api/incubator/...
CRD_OPTIONS ?= "+crd:allowDangerousTypes=true"
API_DIR ?= api
.PHONY: generate
generate: generate.crds generate.deepcopy generate.clientsets generate.docs generate.apitypes-funcs
.PHONY: generate.apitypes-funcs
generate.apitypes-funcs:
go run ./scripts/apitypes-funcs
.PHONY: generate.crds
generate.crds: controller-gen ## Generate WebhookConfiguration and CustomResourceDefinition objects.
VERSION=$(VERSION) go run ./scripts/crds-generator
.PHONY: generate.deepcopy
generate.deepcopy: controller-gen
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="$(CRD_GEN_PATHS)"
# this will generate the custom typed clients needed for end-users implementing logic in Go to use our API types.
.PHONY: generate.clientsets
generate.clientsets: client-gen
$(CLIENT_GEN) \
--go-header-file ./hack/boilerplate.go.txt \
--logtostderr \
--clientset-name clientset \
--input-base $(REPO_URL)/$(GO_MOD_MAJOR_VERSION)/$(API_DIR) \
--input configuration/v1 \
--input configuration/v1alpha1 \
--input configuration/v1beta1 \
--input konnect/v1alpha1 \
--input konnect/v1alpha2 \
--input incubator/v1alpha1 \
--input gateway-operator/v1alpha1 \
--input gateway-operator/v1beta1 \
--input gateway-operator/v2beta1 \
--output-dir pkg/ \
--output-pkg $(REPO_URL)/$(GO_MOD_MAJOR_VERSION)/pkg/
.PHONY: generate.docs
generate.docs: generate.apidocs
.PHONY: generate.apidocs
generate.apidocs: crd-ref-docs
./scripts/apidocs-gen/generate.sh $(CRD_REF_DOCS)
# NOTE(pmalek): We can't generate CLI args docs because the tool at
# https://github.com/Kong/kubernetes-ingress-controller/blob/513db87cbf94ce66207f74365b502e8cde841357/scripts/cli-arguments-docs-gen/main.go
#
# relies on an internal KIC package. We could solve this by exportint the internal/manager package.
# .PHONY: generate.cli-arguments
# generate.cli-arguments-docs:
# go run ./scripts/cli-arguments-docs-gen/main.go > ./docs/cli-arguments.md
# Define a constant list of channels
CHANNELS := ingress-controller ingress-controller-incubator gateway-operator
# Install all CRDs into the K8s cluster specified in ~/.kube/config.
.PHONY: install
install: generate.crds install.only
.PHONY: install.only
install.only: kustomize
@for channel in $(CHANNELS); do \
$(KUSTOMIZE) build config/crd/$$channel | kubectl apply --server-side -f -; \
done
.PHONY: uninstall
uninstall: generate.crds uninstall.only
.PHONY: uninstall.only
uninstall.only: kustomize
@for channel in $(CHANNELS); do \
$(KUSTOMIZE) build config/crd/$$channel | kubectl delete --ignore-not-found=true -f -; \
done
# lint target runs all linters.
.PHONY: lint
lint: lint.golangci-lint lint.markdownlint lint.actions
GOLANGCI_LINT_CONFIG ?= $(PROJECT_DIR)/.golangci.yaml
.PHONY: lint.golangci-lint
lint.golangci-lint: download.golangci-lint
$(GOLANGCI_LINT) run -v --config $(GOLANGCI_LINT_CONFIG) $(GOLANGCI_LINT_FLAGS)
.PHONY: lint.actions
lint.actions: download.actionlint download.shellcheck
$(ACTIONLINT) -shellcheck $(SHELLCHECK) ./.github/workflows/*
.PHONY: lint.markdownlint
lint.markdownlint: download.markdownlint-cli2
$(MARKDOWNLINT) \
CHANGELOG.md \
README.md
# Currently kube-api-linter can only be run with golangci-lint as custom linter.
# There have been some discussions about making it possible to be run as a standalone tool
# using go run but nothing has been implemented yet.
# ref: https://github.com/kubernetes-sigs/kube-api-linter/issues/86
GOLANGCI_LINT_KUBE_API_LINTER = $(PROJECT_DIR)/bin/golangci-kube-api-linter
# Target below only checks if the kube-api-linter is installed, if not it will
# run golangci-lint custom to produce a custom linter binary.
# It does not enforce the version of kube-api-linter, so when that changes in
# .custom-gcl.yml it will not cause a rebuild. Until that changes, we need to
# manually remove the binary and call `make lint.api` to rebuild it.
.PHONY: lint.api.remove
lint.api.remove:
@rm -f $(GOLANGCI_LINT_KUBE_API_LINTER)
.PHONY: lint.api
lint.api: download.golangci-lint
@[[ -f $(GOLANGCI_LINT_KUBE_API_LINTER) ]] || $(GOLANGCI_LINT) custom -v
$(GOLANGCI_LINT_KUBE_API_LINTER) run --config $(PROJECT_DIR)/.golangci-kube-api.yaml -v \
./api/gateway-operator/v2beta1/... \
./api/konnect/v1alpha1/... \
./api/konnect/v1alpha2/... \
./api/common/v1alpha1/...
.PHONY: test.samples
test.samples: kustomize
@cd config/samples/ && find . -not -name "kustomization.*" -type f | sort | xargs -I{} bash -c "echo;echo {}; kubectl apply -f {} && kubectl delete -f {}" \;
GOTESTSUM_FORMAT ?= standard-verbose
.PHONY: test
test: test.unit test.crds-validation test.conversion
.PHONY: test.pretty
test.pretty: test.unit.pretty test.crds-validation.pretty
UNIT_TEST_PATHS := ./test/unit/... ./pkg/...
CRDS_VALIDATION_TEST_PATHS := ./test/crdsvalidation/...
CONVERSION_TEST_PATHS := ./test/conversion/...
.PHONY: _test.unit
_test.unit: gotestsum
GOTESTSUM_FORMAT=$(GOTESTSUM_FORMAT) \
$(GOTESTSUM) -- $(GOTESTFLAGS) \
-race \
$(UNIT_TEST_PATHS)
.PHONY: _test.crds-validation
_test.crds-validation: gotestsum
GOTESTSUM_FORMAT=$(GOTESTSUM_FORMAT) \
$(GOTESTSUM) -- $(GOTESTFLAGS) \
-race \
$(CRDS_VALIDATION_TEST_PATHS)
.PHONY: _test.conversion
_test.conversion: gotestsum
GOTESTSUM_FORMAT=$(GOTESTSUM_FORMAT) \
$(GOTESTSUM) -- $(GOTESTFLAGS) \
-race \
$(CONVERSION_TEST_PATHS)
.PHONY: test.unit
test.unit:
@$(MAKE) _test.unit GOTESTFLAGS="$(GOTESTFLAGS)"
.PHONY: test.crds-validation
test.crds-validation:
@$(MAKE) _test.crds-validation GOTESTFLAGS="$(GOTESTFLAGS)"
.PHONY: test.conversion
test.conversion:
@$(MAKE) _test.conversion GOTESTFLAGS="$(GOTESTFLAGS)"
.PHONY: test.unit.pretty
test.unit.pretty:
@$(MAKE) _test.unit GOTESTSUM_FORMAT=testname \
GOTESTFLAGS="$(GOTESTFLAGS)" \
UNIT_TEST_PATHS="$(UNIT_TEST_PATHS)"
.PHONY: test.crds-validation.pretty
test.crds-validation.pretty:
@$(MAKE) _test.crds-validation GOTESTSUM_FORMAT=testname \
GOTESTFLAGS="$(GOTESTFLAGS)" \
UNIT_TEST_PATHS="$(UNIT_TEST_PATHS)"
.PHONY: test.conversion.pretty
test.conversion.pretty:
@$(MAKE) _test.conversion GOTESTSUM_FORMAT=testname \
GOTESTFLAGS="$(GOTESTFLAGS)" \
CONVERSION_TEST_PATHS="$(CONVERSION_TEST_PATHS)"