-
Notifications
You must be signed in to change notification settings - Fork 3
/
Makefile
327 lines (265 loc) · 13 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
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
# Image URL to use all building/pushing image targets
VERSION ?=
PRERELEASE ?= false
QUICK_BUILD ?= no
MANAGER_VERSION ?= $(VERSION)
DASHBOARD_VERSION ?= $(VERSION)
COSMOCTL_VERSION ?= $(VERSION)
TRAEFIK_PLUGINS_VERSION ?= $(VERSION)
CHART_VERSION ?= $(VERSION)
IMG_MANAGER ?= cosmo-controller-manager:$(MANAGER_VERSION)
IMG_DASHBOARD ?= cosmo-dashboard:$(DASHBOARD_VERSION)
IMG_TRAEFIK_PLUGINS ?= cosmo-traefik-plugins:$(TRAEFIK_PLUGINS_VERSION)
# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
CRD_OPTIONS ?= "crd:generateEmbeddedObjectMeta=true"
# 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
##---------------------------------------------------------------------
# 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%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
.PHONY: all
all: manager cosmoctl dashboard
##---------------------------------------------------------------------
##@ Development
##---------------------------------------------------------------------
.PHONY: manifests
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
ifeq ($(QUICK_BUILD),no)
$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./api/..." output:crd:artifacts:config=config/crd/bases
$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./internal/webhooks" output:crd:artifacts:config=config/crd/bases
endif
.PHONY: generate
generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
ifeq ($(QUICK_BUILD),no)
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./api/..."
endif
.PHONY: proto-generate
proto-generate: ## Generate code protocol buffer api.
make -C proto/ all
.PHONY: fmt
fmt: go ## Run go fmt against code.
ifeq ($(QUICK_BUILD),no)
$(GO) fmt ./...
endif
.PHONY: vet
vet: go ## Run go vet against code.
ifeq ($(QUICK_BUILD),no)
$(GO) vet ./...
endif
##---------------------------------------------------------------------
##@ Test
##---------------------------------------------------------------------
TEST_FILES ?= ./... ./traefik/plugins/cosmo-workspace/cosmoauth/
COVER_PROFILE ?= cover.out
#TEST_OPTS ?= --ginkgo.focus 'Dashboard server \[User\]' -ginkgo.v -ginkgo.progress -test.v > test.out 2>&1
.PHONY: clear-snapshots
clear-snapshots: ## Clear snapshots
-find . -type f | grep __snapshots__ | grep -v "/web/" | grep -v "/charts/" | xargs rm -f
.PHONY: ingressroute.yaml
ingressroute.yaml: helm config/crd/traefik/traefik.io_ingressroutes.yaml
config/crd/traefik/traefik.io_ingressroutes.yaml:
mkdir -p config/crd/traefik
$(HELM) dependency update ./charts/cosmo
tar -xvf ./charts/cosmo/charts/traefik-*.tgz -O traefik/crds/traefik.io_ingressroutes.yaml > config/crd/traefik/traefik.io_ingressroutes.yaml
.PHONY: go-test.env
go-test.env:
@echo KUBEBUILDER_ASSETS=$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path) > ./.vscode/go-test.env
@echo PATH=$(PATH) >> ./.vscode/go-test.env
.PHONY: test
test: manifests generate fmt vet envtest go-test.env go-test ## Run tests.
.PHONY: go-test
go-test: go ingressroute.yaml
ifeq ($(QUICK_BUILD),no)
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" \
$(GO) test $(TEST_FILES) -coverpkg="./..." -coverprofile $(COVER_PROFILE) $(TEST_OPTS)
endif
.PHONY: test-all-k8s-versions
test-all-k8s-versions: go manifests generate fmt vet envtest ## Run tests on targeting k8s versions.
ifeq ($(QUICK_BUILD),no)
-KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use 1.30.x -p path)" $(GO) test ./... -coverprofile $(COVER_PROFILE)
-KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use 1.29.x -p path)" $(GO) test ./... -coverprofile $(COVER_PROFILE)
-KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use 1.28.x -p path)" $(GO) test ./... -coverprofile $(COVER_PROFILE)
endif
.PHONY: clear-snapshots-ui
clear-snapshots-ui: ## Clear snapshots ui
-find ./web -type f | grep __snapshots__ | xargs rm -f
.PHONY: ui-test
ui-test: ## Run UI tests.
cd web/dashboard-ui && yarn install && yarn test --coverage --run
##---------------------------------------------------------------------
##@ Build
##---------------------------------------------------------------------
.PHONY: manager
manager: go generate fmt vet ## Build manager binary.
CGO_ENABLED=0 $(GO) build -o bin/manager ./cmd/controller-manager/main.go
.PHONY: cosmoctl
cosmoctl: go generate fmt vet ## Build cosmoctl binary.
CGO_ENABLED=0 $(GO) build -o bin/cosmoctl ./cmd/cosmoctl/main.go
.PHONY: dashboard
dashboard: go generate fmt vet ## Build dashboard binary.
CGO_ENABLED=0 $(GO) build -o bin/dashboard ./cmd/dashboard/main.go
.PHONY: update-version
update-version: kustomize ## Update version in version.go.
ifndef VERSION
@echo "Usage: make update-version VERSION=v9.9.9"
@exit 9
else
ifeq ($(shell expr $(VERSION) : '^v[0-9]\+\.[0-9]\+\.[0-9]\+'),0)
@echo "Usage: make update-version VERSION=v9.9.9"
@exit 9
endif
endif
sed -i.bk -e "s/v[0-9]\+.[0-9]\+.[0-9]\+.* cosmo-workspace/${MANAGER_VERSION} cosmo-workspace/" ./cmd/controller-manager/main.go
sed -i.bk -e "s/v[0-9]\+.[0-9]\+.[0-9]\+.* cosmo-workspace/${DASHBOARD_VERSION} cosmo-workspace/" ./internal/dashboard/root.go
sed -i.bk -e "s/v[0-9]\+.[0-9]\+.[0-9]\+.* cosmo-workspace/${COSMOCTL_VERSION} cosmo-workspace/" ./internal/cmd/version/version.go
cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG_MANAGER}
cd config/dashboard && $(KUSTOMIZE) edit set image dashboard=${IMG_DASHBOARD}
sed -i.bk \
-e "s/version: [0-9]\+.[0-9]\+.[0-9]\+.*/version: ${CHART_VERSION:v%=%}/" \
-e "s/appVersion: v[0-9]\+.[0-9]\+.[0-9]\+.*/appVersion: ${VERSION}/" \
-e 's;artifacthub.io/prerelease: "\(true\|false\)";artifacthub.io/prerelease: "$(PRERELEASE)";' \
charts/cosmo/Chart.yaml
##---------------------------------------------------------------------
##@ Run
##---------------------------------------------------------------------
LOG_LEVEL ?= 3
COOKIE_DOMAIN ?=
COOKIE_SESSION_NAME ?= test-cosmo-auth
COOKIE_HASHkEY ?= 12345678901234567890123456789012
COOKIE_BLOCKKEY ?= ----+----1----+----2----+----3--
# Run against the configured Kubernetes cluster in ~/.kube/config
.PHONY: run-dashboard
run-dashboard: go generate fmt vet manifests ## Run dashboard against the configured Kubernetes cluster in ~/.kube/config.
ifndef COOKIE_DOMAIN
@echo "Usage: make run-dashboard COOKIE_DOMAIN=xxxx.xxx"
@exit 9
endif
$(GO) run ./cmd/dashboard/main.go \
--zap-log-level $(LOG_LEVEL) \
--zap-time-encoding=iso8601 \
--cookie-session-name=$(COOKIE_SESSION_NAME) \
--cookie-domain=$(COOKIE_DOMAIN) \
--cookie-hashkey=$(COOKIE_HASHkEY) \
--cookie-blockkey=$(COOKIE_BLOCKKEY) \
--insecure
.PHONY: run-dashboard-ui
run-dashboard-ui: ## Run dashboard-ui.
cd web/dashboard-ui && yarn install && yarn start
.PHONY: run
run: go generate fmt vet manifests ## Run controller-manager against the configured Kubernetes cluster in ~/.kube/config.
$(GO) run ./cmd/controller-manager/main.go \
--zap-log-level $(LOG_LEVEL) \
--zap-time-encoding=iso8601 \
--metrics-bind-address :8085 \
--cert-dir .
##---------------------------------------------------------------------
##@ Docker build
##---------------------------------------------------------------------
.PHONY: docker-build
docker-build: docker-build-manager docker-build-dashboard docker-build-traefik-plugins ## Build the docker image.
.PHONY: docker-build-manager
docker-build-manager: test ## Build the docker image for controller-manager.
DOCKER_BUILDKIT=1 docker build . -t ${IMG_MANAGER} -f dockerfile/controller-manager.Dockerfile
.PHONY: docker-build-dashboard
docker-build-dashboard: test ## Build the docker image for dashboard.
DOCKER_BUILDKIT=1 docker build . -t ${IMG_DASHBOARD} -f dockerfile/dashboard.Dockerfile
.PHONY: docker-build-traefik-plugins
docker-build-traefik-plugins: test ## Build the docker image for traefik-plugins.
DOCKER_BUILDKIT=1 docker build . -t ${IMG_TRAEFIK_PLUGINS} -f dockerfile/traefik-plugins.Dockerfile
.PHONY: docker-push docker-push-manager docker-push-dashboard docker-push-traefik-plugins
docker-push: docker-push-manager docker-push-dashboard docker-push-traefik-plugins ## Build the docker image.
REGISTORY ?= ghcr.io/cosmo-workspace
docker-push-manager: docker-build-manager ## push cosmo contoller-manager image.
docker tag ${IMG_MANAGER} ${REGISTORY}/${IMG_MANAGER}
docker push ${REGISTORY}/${IMG_MANAGER}
docker-push-dashboard: docker-build-dashboard ## push cosmo dashboard image.
docker tag ${IMG_DASHBOARD} ${REGISTORY}/${IMG_DASHBOARD}
docker push ${REGISTORY}/${IMG_DASHBOARD}
docker-push-traefik-plugins: docker-build-traefik-plugins ## push cosmo traefik-plugins image.
docker tag ${IMG_TRAEFIK_PLUGINS} ${REGISTORY}/${IMG_TRAEFIK_PLUGINS}
docker push ${REGISTORY}/${IMG_TRAEFIK_PLUGINS}
##---------------------------------------------------------------------
##@ 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.
$(KUSTOMIZE) build config/default | kubectl apply -f -
.PHONY: undeploy
undeploy: ## 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 -
##---------------------------------------------------------------------
##@ Build Dependencies
##---------------------------------------------------------------------
## Tool Versions
GO_VERSION ?= 1.22.3
KUSTOMIZE_VERSION ?= v5.4.1
CONTROLLER_TOOLS_VERSION ?= v0.15.0
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION ?= 1.30.x
## Location to install dependencies to
LOCALBIN ?= $(shell pwd)/bin
$(LOCALBIN):
mkdir -p $(LOCALBIN)
export PATH := $(LOCALBIN):$(PATH)
# 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
GO ?= $(GOBIN)/go$(GO_VERSION)
## Tool Binaries
KUSTOMIZE ?= $(LOCALBIN)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
ENVTEST ?= $(LOCALBIN)/setup-envtest
HELM ?= $(LOCALBIN)/helm
KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
.PHONY: kustomize
kustomize: $(LOCALBIN) $(KUSTOMIZE) ## Download kustomize locally if necessary.
$(KUSTOMIZE):
curl -s $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN)
.PHONY: controller-gen
controller-gen: go $(LOCALBIN) $(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)
.PHONY: envtest
envtest: go $(LOCALBIN) $(ENVTEST) ## Download envtest-setup locally if necessary.
$(ENVTEST):
GOBIN=$(LOCALBIN) $(GO) install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
.PHONY: helm
helm: $(LOCALBIN) $(HELM) ## Download helm locally if necessary.
$(HELM):
export HELM_INSTALL_DIR=$(LOCALBIN) && \
curl -s curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
.PHONY: go
go: $(GO)
$(GO):
go install golang.org/dl/go$(GO_VERSION)@latest
$(GO) download
.PHONY: configure
configure: kustomize controller-gen envtest