forked from maleck13/kcp-ingress
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMakefile
282 lines (218 loc) · 9.55 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
SHELL := /usr/bin/env bash
NUM_CLUSTERS := 2
DO_BREW := true
KCP_BRANCH := release-0.5
IMAGE_TAG_BASE ?= quay.io/kuadrant/kcp-glbc
IMAGE_TAG ?= latest
IMG ?= $(IMAGE_TAG_BASE):$(IMAGE_TAG)
KUBECONFIG ?= $(shell pwd)/.kcp/admin.kubeconfig
CLUSTERS_KUBECONFIG_DIR ?= $(shell pwd)/tmp
.PHONY: all
all: build
##@ General
.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%-20s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
##@ Development
.PHONY: clean
clean: clean-ld-kubeconfig ## Clean up temporary files.
-rm -rf ./.kcp
-rm -f ./bin/*
-rm -rf ./tmp
.PHONY: generate
generate: generate-deepcopy generate-crd generate-client ## Generate code containing DeepCopy method implementations, CustomResourceDefinition objects and Clients.
.PHONY: generate-deepcopy
generate-deepcopy: controller-gen
cd pkg/apis/kuadrant && $(CONTROLLER_GEN) paths="./..." object
.PHONY: generate-deepcopy
generate-crd: controller-gen
cd pkg/apis/kuadrant && $(CONTROLLER_GEN) crd paths=./... output:crd:artifacts:config=../../../config/crd output:crd:dir=../../../config/crd/bases crd:crdVersions=v1 && rm -rf ./config
.PHONY: generate-client
generate-client:
./scripts/gen_client.sh
.PHONY: vendor
vendor: ## Vendor the dependencies.
go mod tidy
go mod vendor
.PHONY: fmt
fmt: ## Run go fmt against code.
go fmt ./...
.PHONY: vet
vet: ## Run go vet against code.
go vet ./...
.PHONY: lint
lint: ## Run golangci-lint against code.
golangci-lint run ./...
.PHONY: test
test: generate ## Run tests.
go test -v ./... -coverprofile=cover.out
.PHONY: e2e
e2e: build
## Run the metrics test first, so it starts from a clean state
KUBECONFIG="$(KUBECONFIG)" CLUSTERS_KUBECONFIG_DIR="$(CLUSTERS_KUBECONFIG_DIR)" \
AWS_DNS_PUBLIC_ZONE_ID="${AWS_DNS_PUBLIC_ZONE_ID}" \
go test -timeout 60m -v ./e2e/metrics -tags=e2e
## Run the other tests
KUBECONFIG="$(KUBECONFIG)" CLUSTERS_KUBECONFIG_DIR="$(CLUSTERS_KUBECONFIG_DIR)" \
go test -timeout 60m -v ./e2e -tags=e2e
##@ CI
#Note, these targets are expected to run in a clean CI environment.
.PHONY: verify-generate
verify-generate: generate ## Verify generate update.
git diff --exit-code
##@ Build
.PHONY: build
build: ## Build the project.
go build -o bin ./cmd/...
.PHONY: docker-build
docker-build: ## Build docker image.
docker build -t ${IMG} .
##@ Deployment
.PHONY: install
install: generate-crd kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
$(KUSTOMIZE) build config/crd | kubectl apply -f -
.PHONY: uninstall
uninstall: generate-crd kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config.
$(KUSTOMIZE) build config/crd | kubectl delete -f -
.PHONY: deploy
deploy: generate-crd kustomize generate-ld-config ## Deploy controller to the K8s cluster specified in ~/.kube/config.
cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
$(KUSTOMIZE) build config/deploy/local | kubectl apply -f -
.PHONY: undeploy
undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
$(KUSTOMIZE) build config/deploy/local | kubectl delete -f -
## Local Deployment
LD_DIR=config/deploy/local
LD_AWS_CREDS_ENV=$(LD_DIR)/aws-credentials.env
LD_CONTROLLER_CONFIG_ENV=$(LD_DIR)/controller-config.env
LD_KCP_KUBECONFIG=$(LD_DIR)/kcp.kubeconfig
$(LD_AWS_CREDS_ENV):
envsubst \
< $(LD_AWS_CREDS_ENV).template \
> $(LD_AWS_CREDS_ENV)
$(LD_CONTROLLER_CONFIG_ENV):
envsubst \
< $(LD_CONTROLLER_CONFIG_ENV).template \
> $(LD_CONTROLLER_CONFIG_ENV)
$(LD_KCP_KUBECONFIG):
cp .kcp/admin.kubeconfig $(LD_KCP_KUBECONFIG)
.PHONY: generate-ld-config
generate-ld-config: $(LD_AWS_CREDS_ENV) $(LD_CONTROLLER_CONFIG_ENV) $(LD_KCP_KUBECONFIG) ## Generate local deployment files.
.PHONY: clean-ld-env
clean-ld-env:
-rm -f $(LD_AWS_CREDS_ENV)
-rm -f $(LD_CONTROLLER_CONFIG_ENV)
.PHONY: clean-ld-kubeconfig
clean-ld-kubeconfig:
-rm -f $(LD_KCP_KUBECONFIG)
.PHONY: clean-ld-config
clean-ld-config: clean-ld-env clean-ld-kubeconfig ## Remove local deployment files.
LOCAL_SETUP_FLAGS=""
ifeq ($(DO_BREW),true)
LOCAL_SETUP_FLAGS="-b"
endif
.PHONY: local-setup
local-setup: export KCP_VERSION=${KCP_BRANCH}
local-setup: clean kind kcp kustomize build ## Setup kcp locally using kind.
./utils/local-setup.sh -c ${NUM_CLUSTERS} ${LOCAL_SETUP_FLAGS}
##@ Build Dependencies
## Location to install dependencies to
LOCALBIN ?= $(shell pwd)/bin
$(LOCALBIN): ## Ensure that the directory exists
mkdir -p $(LOCALBIN)
## Tool Binaries
KCP ?= $(LOCALBIN)/kcp
KUSTOMIZE ?= $(LOCALBIN)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
KIND ?= $(LOCALBIN)/kind
## Tool Versions
KUSTOMIZE_VERSION ?= v4.5.4
CONTROLLER_TOOLS_VERSION ?= v0.8.0
KIND_VERSION ?= v0.11.1
.PHONY: kcp
kcp: $(KCP) ## Download kcp locally if necessary.
$(KCP):
rm -rf ./tmp/kcp
git clone --depth=1 --branch ${KCP_BRANCH} https://github.com/kcp-dev/kcp ./tmp/kcp
cd ./tmp/kcp && make
cp ./tmp/kcp/bin/* $(LOCALBIN)
rm -rf ./tmp/kcp
.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)
.PHONY: kind
kind: $(KIND) ## Download kind locally if necessary.
$(KIND):
GOBIN=$(LOCALBIN) go install sigs.k8s.io/kind@$(KIND_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):
curl -s $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN)
# Generate metrics adoc content based on /metrics response from a running server
.PHONY: gen-metrics-docs
gen-metrics-docs:
curl http://localhost:8080/metrics > tmp/metrics.pef
go run ./utils/prometheus_format.go -f tmp/metrics.pef -c utils/prometheus_format_tables.csv > docs/observability/generated_metrics.adoc
# Ensure the generated metrics content is latest
.PHONY: verify-gen-metrics-docs
verify-gen-metrics-docs: gen-metrics-docs
git diff --exit-code
DHALL ?= $(LOCALBIN)/dhall
DHALL_TO_YAML ?= $(LOCALBIN)/dhall-to-yaml
DHALL_TO_JSON ?= $(LOCALBIN)/dhall-to-json
DHALL_TO_YAML_BINARY_LINUX ?= "https://github.com/dhall-lang/dhall-haskell/releases/download/1.41.1/dhall-json-1.7.10-x86_64-linux.tar.bz2"
DHALL_TO_YAML_BINARY_MACOS ?= "https://github.com/dhall-lang/dhall-haskell/releases/download/1.41.1/dhall-json-1.7.10-x86_64-macos.tar.bz2"
DHALL_BINARY_LINUX ?= "https://github.com/dhall-lang/dhall-haskell/releases/download/1.41.1/dhall-1.41.1-x86_64-linux.tar.bz2"
DHALL_BINARY_MACOS ?= "https://github.com/dhall-lang/dhall-haskell/releases/download/1.41.1/dhall-1.41.1-x86_64-macos.tar.bz2"
UNAME_S := $(shell uname -s)
ifeq ($(UNAME_S),Linux)
DHALL_TO_YAML_BINARY=$(DHALL_TO_YAML_BINARY_LINUX)
DHALL_BINARY=$(DHALL_BINARY_LINUX)
endif
ifeq ($(UNAME_S),Darwin)
DHALL_TO_YAML_BINARY=$(DHALL_TO_YAML_BINARY_MACOS)
DHALL_BINARY=$(DHALL_BINARY_MACOS)
endif
.PHONY: dhall
dhall: $(DHALL) ## Download dhall locally if necessary.
$(DHALL):
curl -L $(DHALL_TO_YAML_BINARY) | tar --extract --bzip2
curl -L $(DHALL_BINARY) | tar --exclude='./share' --extract --bzip2
DHALL_SOURCE_DIR := config/observability/monitoring_resources
DHALL_COMMON_SOURCE_DIR := $(DHALL_SOURCE_DIR)/common
DHALL_K8S_SOURCE_DIR := $(DHALL_SOURCE_DIR)/kubernetes
DHALL_OPENSHIFT_SOURCE_DIR := $(DHALL_SOURCE_DIR)/openshift
DHALL_K8S_TARGET_DIR := config/observability/kubernetes/monitoring_resources
DHALL_OPENSHIFT_TARGET_DIR := config/observability/openshift/monitoring_resources
DHALL_K8S_TARGETS := $(addprefix $(DHALL_K8S_TARGET_DIR)/,$(patsubst %.dhall,%.yaml,$(shell ls $(DHALL_COMMON_SOURCE_DIR)/*.dhall | xargs -n 1 basename))) $(addprefix $(DHALL_K8S_TARGET_DIR)/,$(patsubst %.dhall,%.yaml,$(shell ls $(DHALL_K8S_SOURCE_DIR)/*.dhall | xargs -n 1 basename)))
DHALL_OPENSHIFT_TARGETS := $(addprefix $(DHALL_OPENSHIFT_TARGET_DIR)/,$(patsubst %.dhall,%.yaml,$(shell ls $(DHALL_COMMON_SOURCE_DIR)/*.dhall | xargs -n 1 basename))) $(addprefix $(DHALL_OPENSHIFT_TARGET_DIR)/,$(patsubst %.dhall,%.yaml,$(shell ls $(DHALL_OPENSHIFT_SOURCE_DIR)/*.dhall | xargs -n 1 basename)))
# TODO: detect when dashboard json file has been modified, which is used by dashboard dhall files
# May need to run this if only the .json has changed for grafana dashboard
# touch config/observability/monitoring_resources/kubernetes/dashboard-glbc.dhall config/observability/monitoring_resources/openshift/dashboard-glbc.dhall
define GENERATE_DHALL
$(DHALL) format $<
$(DHALL_TO_YAML) --generated-comment --file $< --output $@
endef
$(DHALL_K8S_TARGET_DIR)/%.yaml: $(DHALL_COMMON_SOURCE_DIR)/%.dhall
$(GENERATE_DHALL)
$(DHALL_OPENSHIFT_TARGET_DIR)/%.yaml: $(DHALL_COMMON_SOURCE_DIR)/%.dhall
$(GENERATE_DHALL)
$(DHALL_K8S_TARGET_DIR)/%.yaml: $(DHALL_K8S_SOURCE_DIR)/%.dhall
$(GENERATE_DHALL)
$(DHALL_OPENSHIFT_TARGET_DIR)/%.yaml: $(DHALL_OPENSHIFT_SOURCE_DIR)/%.dhall
$(GENERATE_DHALL)
$(DHALL_K8S_TARGETS): | $(DHALL_K8S_TARGET_DIR)
$(DHALL_OPENSHIFT_TARGETS): | $(DHALL_OPENSHIFT_TARGET_DIR)
$(DHALL_K8S_TARGET_DIR):
mkdir $(DHALL_K8S_TARGET_DIR)
$(DHALL_OPENSHIFT_TARGET_DIR):
mkdir $(DHALL_OPENSHIFT_TARGET_DIR)
# Generate monitoring resources for prometheus etc...
.PHONY: gen-monitoring-resources
gen-monitoring-resources: dhall ${DHALL_K8S_TARGETS} ${DHALL_OPENSHIFT_TARGETS}
# Ensure the generated monitoring resources are the latest
.PHONY: verify-gen-monitoring-resources
verify-gen-monitoring-resources: gen-monitoring-resources
git diff --exit-code