-
Notifications
You must be signed in to change notification settings - Fork 89
/
Makefile
280 lines (223 loc) · 10.5 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
CURPATH=$(PWD)
export GOBIN=$(CURDIR)/bin
export PATH:=$(GOBIN):$(PATH)
include .bingo/Variables.mk
export GOROOT=$(shell go env GOROOT)
export GOFLAGS=
export GO111MODULE=on
export LOGGING_VERSION=5.8
export APP_NAME=elasticsearch-operator
export ARTIFACT_DIR?=./tmp/artifacts
export JUNIT_REPORT_OUTPUT_DIR=$(ARTIFACT_DIR)/junit
COVERAGE_DIR=$(ARTIFACT_DIR)/coverage
IMAGE_TAG?=127.0.0.1:5000/openshift/origin-$(APP_NAME):latest
APP_REPO=github.com/openshift/$(APP_NAME)
KUBECONFIG?=$(HOME)/.kube/config
MAIN_PKG=main.go
RUN_LOG?=elasticsearch-operator.log
RUN_PID?=elasticsearch-operator.pid
LOGGING_IMAGE_STREAM?=stable
OPERATOR_NAMESPACE=openshift-operators-redhat
DEPLOYMENT_NAMESPACE?=openshift-logging
REPLICAS?=0
OS_NAME=$(shell uname -s | tr '[:upper:]' '[:lower:]')
GO_FILES := $(shell find . -type f -name '*.go')
BUNDLE_FILES := $(shell find bundle/ -type f)
OTHER_FILES := $(shell find files/ -type f)
##@ 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%-32s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
##@ Development
.PHONY: all
all: build
.PHONY: artifactdir
artifactdir:
@mkdir -p $(ARTIFACT_DIR)
.PHONY: coveragedir
coveragedir: artifactdir
@mkdir -p $(COVERAGE_DIR)
.PHONY: junitreportdir
junitreportdir: artifactdir
@mkdir -p $(JUNIT_REPORT_OUTPUT_DIR)
.PHONY: gobindir
gobindir:
@mkdir -p $(GOBIN)
GEN_TIMESTAMP=.zz_generate_timestamp
.PHONY: generate
generate: $(OPERATOR_SDK) $(CONTROLLER_GEN) $(GEN_TIMESTAMP) ## Generate APIs and CustomResourceDefinition objects.
$(GEN_TIMESTAMP): $(shell find apis -name '*.go')
@$(CONTROLLER_GEN) object paths="./apis/..."
@$(CONTROLLER_GEN) crd:crdVersions=v1 rbac:roleName=elasticsearch-operator paths="./..." output:crd:artifacts:config=config/crd/bases
@$(MAKE) fmt
@touch $@
.PHONY: regenerate
regenerate: $(OPERATOR_SDK) $(CONTROLLER_GEN) ## Force generate CustomResourceDefinition objects.
@rm -f $(GEN_TIMESTAMP)
@$(MAKE) generate
# Generate bundle manifests and metadata, then validate generated files.
BUNDLE_VERSION?=$(LOGGING_VERSION).0
# Options for 'bundle-build'
BUNDLE_CHANNELS := --channels=stable,stable-${LOGGING_VERSION}
BUNDLE_DEFAULT_CHANNEL := --default-channel=stable
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: regenerate $(KUSTOMIZE) ## Generate operator bundle.
$(OPERATOR_SDK) generate kustomize manifests -q
$(KUSTOMIZE) build config/manifests | $(OPERATOR_SDK) generate bundle $(BUNDLE_GEN_FLAGS)
$(OPERATOR_SDK) bundle validate ./bundle
.PHONY: build
build: ## Build the operator binary.
@go build -o $(GOBIN)/elasticsearch-operator $(MAIN_PKG)
.PHONY: clean
clean: ## Clean tmp, _output dirs and go cache/testcache.
@rm -rf bin tmp _output
go clean -cache -testcache ./...
.PHONY: fmt
fmt: $(GOFUMPORTS) ## Run gofumpt against code.
@$(GOFUMPORTS) -l -w $(shell find internal apis controllers test version -name '*.go') ./*.go
.PHONY: lint
lint: $(GOLANGCI_LINT) fmt lint-prom lint-dockerfile ## Run golangci-lint against code.
@GOLANGCI_LINT_CACHE="$(CURDIR)/.cache" $(GOLANGCI_LINT) run -c golangci.yaml
.PHONY: lint-prom
lint-prom: $(PROMTOOL) ## Run promtool check against recording rules and alerts.
@$(PROMTOOL) check rules ./files/prometheus_recording_rules.yml
@$(PROMTOOL) check rules ./files/prometheus_alerts.yml
.PHONY: gen-dockerfiles
gen-dockerfiles: ## Generate dockerfile from midstream contents.
./hack/generate-dockerfile-from-midstream > Dockerfile && \
./hack/generate-dockerfile-from-midstream Dockerfile.in dev-meta.yaml > Dockerfile.dev
.PHONY: lint-dockerfile
lint-dockerfile: ## Lint for upstream/downstream dockerfile changes.
@hack/lint-dockerfile
.PHONY: image
image: .output/image ## Build operator container image.
.output/image: gen-dockerfiles $(GO_FILES) $(BUNDLE_FILES) $(OTHER_FILES)
podman build -f Dockerfile.dev -t $(IMAGE_TAG) .
@touch $@
##@ Testing
.PHONY: test-unit
test-unit: $(GO_JUNIT_REPORT) coveragedir junitreportdir test-unit-prom ## Run unit tests.
@set -o pipefail && \
go test -race -coverprofile=$(COVERAGE_DIR)/test-unit.cov ./internal/... ./apis/... ./controllers/... ./. 2>&1 | \
tee /dev/stderr | \
$(GO_JUNIT_REPORT) > $(JUNIT_REPORT_OUTPUT_DIR)/junit.xml
@grep -v 'zz_generated\.' $(COVERAGE_DIR)/test-unit.cov > $(COVERAGE_DIR)/nogen.cov
@go tool cover -html=$(COVERAGE_DIR)/nogen.cov -o $(COVERAGE_DIR)/test-unit-coverage.html
@go tool cover -func=$(COVERAGE_DIR)/nogen.cov | tail -n 1
.PHONY: test-unit-prom
test-unit-prom: $(PROMTOOL) ## Run prometheus unit tests.
@$(PROMTOOL) test rules ./test/files/prometheus-unit-tests/test.yml
.PHONY: test-e2e-upgrade
test-e2e-upgrade: ## Run e2e upgrate tests.
@hack/testing-olm-upgrade/test-upgrade-n-1-n.sh
.PHONY: test-e2e-upgrade-ci
# Run e2e upgrade tests on upstream CI.
test-e2e-upgrade-ci:
@DO_SETUP="false" hack/testing-olm-upgrade/test-upgrade-n-1-n.sh
# to use these targets, ensure the following env vars are set:
# either each IMAGE env var:
# IMAGE_ELASTICSEARCH_OPERATOR_REGISTRY
# IMAGE_ELASTICSEARCH_OPERATOR
# IMAGE_ELASTICSEARCH6
# IMAGE_ELASTICSEARCH_PROXY
# IMAGE_LOGGING_KIBANA6
#
# You must also set:
# ELASTICSEARCH_OPERATOR_NAMESPACE (Default: openshift-operators-redhat)
RANDOM_SUFFIX:=$(shell echo $$RANDOM)
TEST_NAMESPACE?="e2e-test-${RANDOM_SUFFIX}"
.PHONY: test-e2e-olm
test-e2e-olm: DEPLOYMENT_NAMESPACE="${TEST_NAMESPACE}" ## Run e2e tests.
test-e2e-olm: $(GO_JUNIT_REPORT) $(JUNITMERGE) $(JUNITREPORT) junitreportdir
TEST_NAMESPACE=${TEST_NAMESPACE} hack/test-e2e.sh
echo "Completed test-e2e"
$(JUNITMERGE) $$(find $$JUNIT_REPORT_OUTPUT_DIR -iname "*.xml") > $(JUNIT_REPORT_OUTPUT_DIR)/junit.xml
#
# test-e2e is a future replacement target for test-e2e-olm that is used only upstream CI, until we merge:
# https://github.com/openshift/release/pull/21383
# This PR will make use of CI-managed operator installs/cleanups using the bundle w/o olm_deploy.
#
E2E_RANDOM_SUFFIX:=$(shell echo $$RANDOM)
E2E_TEST_NAMESPACE?="e2e-test-${RANDOM_SUFFIX}"
.PHONY: test-e2e
test-e2e: DEPLOYMENT_NAMESPACE="${E2E_TEST_NAMESPACE}"
test-e2e: $(GO_JUNIT_REPORT) $(JUNITMERGE) $(JUNITREPORT) junitreportdir
TEST_NAMESPACE=${E2E_TEST_NAMESPACE} DO_SETUP="false" SKIP_CLEANUP="true" hack/test-e2e.sh
echo "Completed test-e2e"
$(JUNITMERGE) $$(find $$JUNIT_REPORT_OUTPUT_DIR -iname "*.xml") > $(JUNIT_REPORT_OUTPUT_DIR)/junit.xml
##@ Deployment
.PHONY: deploy
deploy: deploy-image ## Deploy operator registry and operator.
LOCAL_IMAGE_ELASTICSEARCH_OPERATOR_REGISTRY=127.0.0.1:5000/openshift/elasticsearch-operator-registry \
IMAGE_ELASTICSEARCH_OPERATOR_REGISTRY=127.0.0.1:5000/openshift/elasticsearch-operator-registry \
$(MAKE) elasticsearch-catalog-build && \
IMAGE_ELASTICSEARCH_OPERATOR_REGISTRY=image-registry.openshift-image-registry.svc:5000/openshift/elasticsearch-operator-registry \
IMAGE_ELASTICSEARCH_OPERATOR=image-registry.openshift-image-registry.svc:5000/openshift/origin-elasticsearch-operator:latest \
$(MAKE) elasticsearch-catalog-deploy && \
IMAGE_ELASTICSEARCH_OPERATOR=image-registry.openshift-image-registry.svc:5000/openshift/origin-elasticsearch-operator:latest \
$(MAKE) elasticsearch-operator-install
.PHONY: deploy-image
deploy-image: image ## Push operator image to cluster registry.
IMAGE_TAG=$(IMAGE_TAG) hack/deploy-image.sh
.PHONY: deploy-example
deploy-example: # Create an example Elasticsearch custom resource.
@oc create -n $(DEPLOYMENT_NAMESPACE) -f hack/cr.yaml
.PHONY: deploy-kibana
deploy-kibana: # Create an example Kibana custom resource.
@oc create -n $(DEPLOYMENT_NAMESPACE) -f hack/kibana-cr.yaml
.PHONY: deploy-all
deploy-all:
$(MAKE) deploy deploy-example deploy-kibana
.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: uninstall
uninstall:
$(MAKE) elasticsearch-catalog-uninstall
.PHONY: elasticsearch-catalog
elasticsearch-catalog: elasticsearch-catalog-build elasticsearch-catalog-deploy ## Build and deploy the elasticsearch operator registry.
.PHONY: elasticsearch-cleanup
elasticsearch-cleanup: elasticsearch-operator-uninstall elasticsearch-catalog-uninstall ## Cleanup operator-registry and operator deployments.
.PHONY: elasticsearch-catalog-build
# builds an operator-registry image containing the elasticsearch operator.
elasticsearch-catalog-build: ## Build elasticsearch operator registry.
olm_deploy/scripts/catalog-build.sh
.PHONY: elasticsearch-catalog-deploy
# deploys the operator registry image and creates a catalogsource referencing it
elasticsearch-catalog-deploy: ## Deploy elasticsearch operator registry.
olm_deploy/scripts/catalog-deploy.sh
.PHONY: elasticsearch-catalog-uninstall
# deletes the catalogsource and catalog namespace
elasticsearch-catalog-uninstall: ## Uninstall elasticsearch operator registry.
olm_deploy/scripts/catalog-uninstall.sh
.PHONY: elasticsearch-operator-install
# installs the elasticsearch operator from the deployed operator-registry/catalogsource.
elasticsearch-operator-install: ## Install the elasticsearch operator.
olm_deploy/scripts/operator-install.sh
.PHONY: elasticsearch-operator-uninstall
# uninstalls the elasticsearch operator
elasticsearch-operator-uninstall: ## Uninstall the elasticsearch operator.
olm_deploy/scripts/operator-uninstall.sh