-
Notifications
You must be signed in to change notification settings - Fork 140
/
Makefile
401 lines (318 loc) · 14.9 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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
# Define the target to run if make is called with no arguments.
.PHONY: default
default: pre-commit
export LOG_LEVEL?=9
export KUBECONFIG?=$(HOME)/.kube/config
export GOBIN=$(CURDIR)/bin
export PATH:=$(GOBIN):$(PATH)
include .bingo/Variables.mk
export GOROOT=$(shell go env GOROOT)
export GOFLAGS=
export GO111MODULE=on
export GODEBUG=x509ignoreCN=0
ifdef OVERLAY
$(if $(wildcard $(OVERLAY)),,$(error "OVERLAY file '$(OVERLAY)' does not exist"))
# Set variables from overlay file instead of environment variables.
KUSTOMIZE_VALUE=$(shell grep '$(1): *' $(OVERLAY)/kustomization.yaml | sed 's/^.*$(1): *//')
IMAGE_NAME=$(or $(call KUSTOMIZE_VALUE,newName),$(call KUSTOMIZE_VALUE,name))
VERSION=$(call KUSTOMIZE_VALUE,newTag)
NAMESPACE=$(shell awk '/namespace:/{print $$2}' $(OVERLAY)/kustomization.yaml)
# Get operand image names from the deployment patch in the overlay.
DEPLOY_ENV=$(shell awk '/name:/ {NAME = $$NF} /value: / { if (NAME == "$(1)") { print $$NF; exit 0; } }' $(OVERLAY)/deployment_patch.yaml)
IMAGE_LOGGING_VECTOR=$(call DEPLOY_ENV,RELATED_IMAGE_VECTOR)
IMAGE_LOGFILEMETRICEXPORTER=$(call DEPLOY_ENV,RELATED_IMAGE_LOG_FILE_METRIC_EXPORTER)
export IMAGE_TAG=$(IMAGE_NAME):$(VERSION)
BUNDLE_TAG=$(IMAGE_NAME)-bundle:$(VERSION)
LOGGING_VERSION=$(shell echo "$(VERSION)" | grep -o '^[0-9]\+\.[0-9]\+')
ES_LOGGING_VERSION?=5.8
else
# Set variables from environment or hard-coded default
export OPERATOR_NAME=cluster-logging-operator
export CURRENT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD;)
export IMAGE_TAG?=127.0.0.1:5000/openshift/origin-$(OPERATOR_NAME):$(CURRENT_BRANCH)
BUNDLE_TAG=$(error set OVERLAY to deploy or run a bundle)
export LOGGING_VERSION?=6.0
export VERSION=$(LOGGING_VERSION).0
export NAMESPACE?=openshift-logging
IMAGE_LOGGING_VECTOR?=quay.io/openshift-logging/vector:6.0
IMAGE_LOGFILEMETRICEXPORTER?=quay.io/openshift-logging/log-file-metric-exporter:6.0
endif # ifdef OVERLAY
REPLICAS?=0
export E2E_TEST_INCLUDES?=
export CLF_TEST_INCLUDES?=
.PHONY: force
.PHONY: tools
tools: $(BINGO) $(GOLANGCI_LINT) $(JUNITREPORT) $(OPERATOR_SDK) $(OPM) $(KUSTOMIZE) $(CONTROLLER_GEN) $(GEN_CRD_API_REFERENCE_DOCS)
.PHONY: pre-commit
# Should pass when run before commit.
pre-commit: clean bundle check docs
.PHONY: check
# check health of the code:
# - Update generated code
# - Build all code and test
# - Run lint, automatically fix trivial issues
# - Run unit tests
#
check: build compile-tests bin/forwarder-generator bin/cluster-logging-operator bin/functional-benchmarker lint test-unit
# Compile all tests and code but don't run the tests.
compile-tests: generate
go test ./test/... -run NONE > /dev/null
.PHONY: ci-check
# CI calls ci-check first.
ci-check: check
@echo
@git diff-index --name-status --exit-code HEAD || { \
echo -e '\nerror: files changed during "make check", not up-to-date\n' ; \
exit 1 ; \
}
# .target is used to hold timestamp files to avoid un-necessary rebuilds. Do NOT check in.
.target:
mkdir -p .target
# Note: Go has built-in build caching, so always run `go build`.
# It will do a better job than using source dependencies to decide if we need to build.
bin/functional-benchmarker: force
go build $(BUILD_OPTS) -o $@ ./internal/cmd/functional-benchmarker
bin/forwarder-generator: force
go build $(BUILD_OPTS) -o $@ ./internal/cmd/forwarder-generator
bin/cluster-logging-operator: force
go build $(BUILD_OPTS) -o $@ ./cmd
.PHONY: openshift-client
openshift-client:
@type -p oc > /dev/null || bash hack/get-openshift-client.sh
.PHONY: build
build: bin/cluster-logging-operator
.PHONY: build-debug
build-debug:
$(MAKE) build BUILD_OPTS='-gcflags=all="-N -l"'
docs: docs/reference/operator/api.adoc docs/reference/datamodels/viaq/v1.adoc docs/reference/operator/secrets.adoc
.PHONY: docs
docs/reference/operator/api.adoc: $(GEN_CRD_API_REFERENCE_DOCS)
$(GEN_CRD_API_REFERENCE_DOCS) -api-dir "github.com/openshift/cluster-logging-operator/api/" -config "$(PWD)/config/docs/config.json" -template-dir "$(PWD)/config/docs/templates/apis/asciidoc" -out-file "$(PWD)/$@"
.PHONY: docs/reference/operator/api.adoc
docs/reference/datamodels/viaq/v1.adoc: $(GEN_CRD_API_REFERENCE_DOCS)
$(GEN_CRD_API_REFERENCE_DOCS) -api-dir "github.com/openshift/cluster-logging-operator/internal/datamodels/viaq/v1" -config "$(PWD)/config/docs/config.json" -template-dir "$(PWD)/config/docs/templates/datamodels/asciidoc" -out-file "$(PWD)/$@"
.PHONY: docs/reference/datamodels/viaq/v1.adoc
docs/reference/operator/secrets.adoc: $(GEN_CRD_API_REFERENCE_DOCS)
$(GEN_CRD_API_REFERENCE_DOCS) -api-dir "github.com/openshift/cluster-logging-operator/internal/datamodels/operator/v1" -config "$(PWD)/config/docs/config.json" -template-dir "$(PWD)/config/docs/templates/datamodels/asciidoc" -out-file "$(PWD)/$@"
.PHONY: docs/reference/datamodels/logging/v1.adoc
# Run the CLO locally - see HACKING.md
RUN_CMD?=go run
.PHONY: run
run:
@ls ./bundle/manifests/logging.openshift.io_*.yaml | xargs -n1 oc apply -f
@mkdir -p $(CURDIR)/tmp
LOG_LEVEL=$(LOG_LEVEL) \
RELATED_IMAGE_VECTOR=$(IMAGE_LOGGING_VECTOR) \
RELATED_IMAGE_LOG_FILE_METRIC_EXPORTER=$(IMAGE_LOGFILEMETRICEXPORTER) \
OPERATOR_NAME=$(OPERATOR_NAME) \
WATCH_NAMESPACE="" \
KUBERNETES_CONFIG=$(KUBECONFIG) \
WORKING_DIR=$(CURDIR)/tmp \
$(RUN_CMD) cmd/main.go
.PHONY: run-debug
run-debug:
$(MAKE) run RUN_CMD='dlv debug'
.PHONY: scale-cvo
scale-cvo:
@oc -n openshift-cluster-version scale deployment/cluster-version-operator --replicas=$(REPLICAS)
.PHONY: scale-olm
scale-olm:
@oc -n openshift-operator-lifecycle-manager scale deployment/olm-operator --replicas=$(REPLICAS)
.PHONY: clean
clean:
rm -rf bin/cluster-logging-operator bin/forwarder-generator bin/functional-benchmarker tmp _output .target .cache
find -name .kube | xargs rm -rf
spotless: clean
go clean -cache -testcache
.PHONY: image
image: .target/image
.target/image: .target $(GEN_TIMESTAMP) $(shell find must-gather version bundle .bingo api internal -type f 2>/dev/null) Dockerfile go.mod go.sum
podman build -t $(IMAGE_TAG) . -f Dockerfile
touch $@
# Notes:
# - override the .cache dir for CI, where $HOME/.cache may not be writable.
# - don't run with --fix in CI, complain about everything. Do try to auto-fix outside of CI.
export GOLANGCI_LINT_CACHE=$(CURDIR)/.cache
lint: $(GOLANGCI_LINT) lint-repo
$(GOLANGCI_LINT) run --color=never --timeout=3m $(if $(CI),,--fix)
.PHONY: lint
.PHONY: lint-repo
lint-repo:
@hack/run-linter
.PHONY: fmt
fmt:
@echo gofmt # Show progress, real gofmt line is too long
find version test internal api -name '*.go' | xargs gofmt -s -l -w
# Do all code/CRD generation at once, with timestamp file to check out-of-date.
GEN_TIMESTAMP=.target/codegen
generate: $(GEN_TIMESTAMP)
$(GEN_TIMESTAMP): $(shell find api -name '*.go') $(OPERATOR_SDK) $(CONTROLLER_GEN) $(KUSTOMIZE) .target
@$(CONTROLLER_GEN) object paths="./api/..."
@$(CONTROLLER_GEN) crd:crdVersions=v1 rbac:roleName=clusterlogging-operator paths="./..." output:crd:artifacts:config=config/crd/bases
echo -e "package version\n\nvar Version = \"$(or $(CI_CONTAINER_VERSION),$(VERSION))\"" > version/version.go
@$(MAKE) fmt
@touch $@
.PHONY: regenerate
regenerate: $(OPERATOR_SDK) $(CONTROLLER_GEN) $(KUSTOMIZE)
@rm -f $(GEN_TIMESTAMP)
@$(MAKE) generate
.PHONY: deploy-image
deploy-image: .target/image
hack/deploy-image.sh
.PHONY: deploy
deploy: deploy-cluster-logging-operator
.PHONY: deploy-cluster-logging-operator
deploy-cluster-logging-operator: deploy-image deploy-catalog install
.PHONY: install
install:
IMAGE_CLUSTER_LOGGING_OPERATOR=image-registry.openshift-image-registry.svc:5000/openshift/origin-cluster-logging-operator:$(CURRENT_BRANCH) \
$(MAKE) cluster-logging-operator-install
.PHONY: deploy-catalog
deploy-catalog:
LOCAL_IMAGE_CLUSTER_LOGGING_OPERATOR_REGISTRY=127.0.0.1:5000/openshift/cluster-logging-operator-registry:$(CURRENT_BRANCH) \
$(MAKE) cluster-logging-catalog-build
IMAGE_CLUSTER_LOGGING_OPERATOR_REGISTRY=image-registry.openshift-image-registry.svc:5000/openshift/cluster-logging-operator-registry:$(CURRENT_BRANCH) \
IMAGE_CLUSTER_LOGGING_OPERATOR=image-registry.openshift-image-registry.svc:5000/openshift/origin-cluster-logging-operator:$(CURRENT_BRANCH) \
$(MAKE) cluster-logging-catalog-deploy
# NOTE: you can run tests directly using `go test` as follows:
# env $(make -s test-env) go test ./my/packages
test-env: ## Echo test environment, useful for running tests outside of the Makefile.
@echo \
RELATED_IMAGE_VECTOR=$(IMAGE_LOGGING_VECTOR) \
RELATED_IMAGE_LOG_FILE_METRIC_EXPORTER=$(IMAGE_LOGFILEMETRICEXPORTER) \
.PHONY: test-functional
test-functional:
exit 0
.PHONY: test-functional-vector
test-functional-vector: test-functional-benchmarker-vector
RELATED_IMAGE_VECTOR=$(IMAGE_LOGGING_VECTOR) \
RELATED_IMAGE_LOG_FILE_METRIC_EXPORTER=$(IMAGE_LOGFILEMETRICEXPORTER) \
go test -race \
./test/functional/... \
-ginkgo.noColor -timeout=40m -ginkgo.slowSpecThreshold=45.0
.PHONY: test-forwarder-generator
test-forwarder-generator: bin/forwarder-generator
WATCH_NAMESPACE=openshift-logging bin/forwarder-generator --file hack/logforwarder.yaml > /dev/null
test-functional-benchmarker-vector: bin/functional-benchmarker
@rm -rf /tmp/benchmark-test-vector
@out=$$(RELATED_IMAGE_VECTOR=$(IMAGE_LOGGING_VECTOR) bin/functional-benchmarker --image=$(IMAGE_LOGGING_VECTOR) --collector-impl=vector --artifact-dir=/tmp/benchmark-test-vector 2>&1); if [ "$$?" != "0" ] ; then echo "$$out"; exit 1; fi
.PHONY: test-unit
test-unit: test-forwarder-generator
RELATED_IMAGE_VECTOR=$(IMAGE_LOGGING_VECTOR) \
RELATED_IMAGE_LOG_FILE_METRIC_EXPORTER=$(IMAGE_LOGFILEMETRICEXPORTER) \
go test -coverprofile=test.cov -race ./api/... ./internal/... `go list ./test/... | grep -Ev 'test/(e2e|functional|framework|client|helpers)'`
.PHONY: coverage
coverage: test-unit
go tool cover -html=test.cov -o $${ARTIFACTS_DIR:-.}/coverage.html
.PHONY: test-cluster
test-cluster:
go test -cover -race ./test/... -- -root=$(CURDIR)
OPENSHIFT_VERSIONS?="v4.14-v4.17"
# Generate bundle manifests and metadata, then validate generated files.
BUNDLE_VERSION?=$(VERSION)
CHANNEL=$(or $(filename $(OVERLAY)),stable-${LOGGING_VERSION})
BUNDLE_CHANNELS := --channels=$(CHANNEL)
BUNDLE_DEFAULT_CHANNEL := --default-channel=$(CHANNEL)
BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
# BUNDLE_GEN_FLAGS are the flags passed to the operator-sdk generate bundle command
BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(BUNDLE_VERSION) $(BUNDLE_METADATA_OPTS)
# USE_IMAGE_DIGESTS defines if images are resolved via tags or digests
# You can enable this value if you would like to use SHA Based Digests
# To enable set flag to true
USE_IMAGE_DIGESTS ?= false
ifeq ($(USE_IMAGE_DIGESTS), true)
BUNDLE_GEN_FLAGS += --use-image-digests
endif
.PHONY: bundle
bundle: $(GEN_TIMESTAMP) $(KUSTOMIZE) $(find config -name *.yaml) ## Generate operator bundle.
$(OPERATOR_SDK) generate kustomize manifests -q
$(KUSTOMIZE) build $(or $(OVERLAY),config/manifests) | $(OPERATOR_SDK) generate bundle $(BUNDLE_GEN_FLAGS)
hack/revert-bundle.sh
MANIFEST_VERSION=${LOGGING_VERSION} OPENSHIFT_VERSIONS=${OPENSHIFT_VERSIONS} CHANNELS=${CHANNELS} DEFAULT_CHANNEL=${DEFAULT_CHANNEL} hack/generate-bundle.sh
$(OPERATOR_SDK) bundle validate ./bundle
@touch $@
.PHONY: deploy-bundle
deploy-bundle: bundle bundle.Dockerfile
podman build -t $(BUNDLE_TAG) -f bundle.Dockerfile .
podman push --tls-verify=false ${BUNDLE_TAG}
@echo "To run the bundle without this Makefile:"
@echo " oc create ns $(NAMESPACE)"
@echo " $(OPERATOR_SDK) run bundle -n $(NAMESPACE) --install-mode OwnNamespace $(BUNDLE_TAG)"
@touch $@
.PHONY: clean-bundle
clean-bundle: $(OPERATOR_SDK)
$(OPERATOR_SDK) cleanup --delete-all cluster-logging
WATCH_EVENTS=oc get events -A --watch-only& trap "kill %%" EXIT;
WAIT_FOR_OPERATOR=oc wait -n $(NAMESPACE) --for=condition=available deployment/cluster-logging-operator
.PHONY: namespace
namespace:
echo '{"apiVersion": "v1", "kind": "Namespace","metadata":{"name":"$(NAMESPACE)","labels":{"openshift.io/cluster-monitoring":"true"}}}' | oc apply -f -
.PHONY: run-bundle
run-bundle: namespace $(OPERATOR_SDK) ## Run the overlay bundle image, assumes it has been pushed
$(OPERATOR_SDK) cleanup --delete-all cluster-logging || true
$(WATCH_EVENTS) $(OPERATOR_SDK) run bundle -n $(NAMESPACE) --install-mode OwnNamespace $(BUNDLE_TAG); $(WAIT_FOR_OPERATOR)
.PHONY: apply
apply: namespace $(OPERATOR_SDK) ## Install kustomized resources directly to the cluster.
$(OPERATOR_SDK) generate kustomize manifests -q
$(WATCH_EVENTS) $(KUSTOMIZE) build $(or $(OVERLAY),config/manifests) | oc apply -f -; $(WAIT_FOR_OPERATOR)
.PHONY: test-e2e
test-e2e:
exit 0
.PHONY: test-e2e-olm
# NOTE: This is the CI e2e entry point.
test-e2e-olm: $(JUNITREPORT)
RELATED_IMAGE_VECTOR=$(IMAGE_LOGGING_VECTOR) \
INCLUDES="$(E2E_TEST_INCLUDES)" CLF_INCLUDES="$(CLF_TEST_INCLUDES)" LOG_LEVEL=3 ES_LOGGING_VERSION=$(ES_LOGGING_VERSION) hack/test-e2e-olm.sh
.PHONY: test-e2e-local
test-e2e-local: $(JUNITREPORT) deploy-image
LOG_LEVEL=3 \
RELATED_IMAGE_VECTOR=$(IMAGE_LOGGING_VECTOR) \
CLF_INCLUDES=$(CLF_TEST_INCLUDES) \
INCLUDES=$(E2E_TEST_INCLUDES) \
IMAGE_CLUSTER_LOGGING_OPERATOR=image-registry.openshift-image-registry.svc:5000/openshift/origin-cluster-logging-operator:$(CURRENT_BRANCH) \
IMAGE_CLUSTER_LOGGING_OPERATOR_REGISTRY=image-registry.openshift-image-registry.svc:5000/openshift/cluster-logging-operator-registry:$(CURRENT_BRANCH) \
hack/test-e2e-olm.sh
.PHONY: test-e2e-clo-metric
test-e2e-clo-metric:
test/e2e/telemetry/clometrics_test.sh
.PHONY: test-svt
test-svt:
hack/svt/test-svt.sh
.PHONY: undeploy
undeploy:
hack/undeploy.sh
.PHONY: redeploy
redeploy:
$(MAKE) undeploy
$(MAKE) deploy
.PHONY: undeploy-all
undeploy-all: undeploy undeploy-elasticsearch-operator
.PHONY: cluster-logging-catalog
cluster-logging-catalog: cluster-logging-catalog-build cluster-logging-catalog-deploy
.PHONY: cluster-logging-cleanup
cluster-logging-cleanup: cluster-logging-operator-uninstall cluster-logging-catalog-uninstall
.PHONY: cluster-logging-catalog-build
# builds an operator-registry image containing the cluster-logging operator
cluster-logging-catalog-build: .target/cluster-logging-catalog-build
.target/cluster-logging-catalog-build: $(shell find olm_deploy -type f)
olm_deploy/scripts/catalog-build.sh
touch $@
.PHONY: cluster-logging-catalog-deploy
# deploys the operator registry image and creates a catalogsource referencing it
cluster-logging-catalog-deploy: $(shell find olm_deploy -type f)
olm_deploy/scripts/catalog-deploy.sh
.PHONY: cluster-logging-catalog-uninstall
# deletes the catalogsource and catalog namespace
cluster-logging-catalog-uninstall:
olm_deploy/scripts/catalog-uninstall.sh
.PHONY: cluster-logging-operator-install
# installs the cluster-logging operator from the deployed operator-registry/catalogsource.
cluster-logging-operator-install:
olm_deploy/scripts/operator-install.sh
.PHONY: cluster-logging-operator-uninstall
# uninstalls the cluster-logging operator
cluster-logging-operator-uninstall:
olm_deploy/scripts/operator-uninstall.sh
.PHONY: gen-dockerfiles
gen-dockerfiles:
./hack/generate-dockerfile-from-midstream > Dockerfile